1#[cfg(feature = "explaining-traces")]2use std::cell::RefCell;3use std::{4 any::Any,5 path::{Path, PathBuf},6};78use jrsonnet_gcmodule::Trace;9use jrsonnet_ir::CodeLocation;10#[cfg(feature = "explaining-traces")]11use jrsonnet_ir::Span;1213use crate::{Error, error::ErrorKind};141516#[derive(Clone, Trace)]17pub enum PathResolver {18 19 FileName,20 21 Absolute,22 23 Relative(PathBuf),24}2526impl PathResolver {27 28 pub fn new_cwd_fallback() -> Self {29 std::env::current_dir().map_or(Self::Absolute, Self::Relative)30 }31 pub fn resolve(&self, from: &Path) -> String {32 match self {33 Self::FileName => from34 .file_name()35 .expect("file name exists")36 .to_string_lossy()37 .into_owned(),38 Self::Absolute => from.to_string_lossy().into_owned(),39 Self::Relative(base) => {40 if from.is_relative() {41 return from.to_string_lossy().into_owned();42 }43 pathdiff::diff_paths(from, base)44 .expect("base is absolute")45 .to_string_lossy()46 .into_owned()47 }48 }49 }50}515253#[allow(clippy::module_name_repetitions)]54pub trait TraceFormat: Trace {55 fn write_trace(56 &self,57 out: &mut dyn std::fmt::Write,58 error: &Error,59 ) -> Result<(), std::fmt::Error>;60 fn format(&self, error: &Error) -> Result<String, std::fmt::Error> {61 let mut out = String::new();62 self.write_trace(&mut out, error)?;63 Ok(out)64 }65 fn as_any(&self) -> &dyn Any;66 fn as_any_mut(&mut self) -> &mut dyn Any;67}6869fn print_code_location(70 out: &mut impl std::fmt::Write,71 start: &CodeLocation,72 end: &CodeLocation,73) -> Result<(), std::fmt::Error> {74 if start.line == end.line {75 if start.column == end.column {76 write!(out, "{}:{}", start.line, end.column.saturating_sub(1))?;77 } else {78 write!(out, "{}:{}-{}", start.line, start.column - 1, end.column)?;79 }80 } else {81 write!(82 out,83 "{}:{}-{}:{}",84 start.line,85 end.column.saturating_sub(1),86 start.line,87 end.column88 )?;89 }90 Ok(())91}929394#[derive(Trace)]95pub struct CompactFormat {96 pub resolver: PathResolver,97 pub max_trace: usize,98 pub padding: usize,99}100impl Default for CompactFormat {101 fn default() -> Self {102 Self {103 resolver: PathResolver::Absolute,104 max_trace: 20,105 padding: 4,106 }107 }108}109110impl TraceFormat for CompactFormat {111 fn write_trace(112 &self,113 out: &mut dyn std::fmt::Write,114 error: &Error,115 ) -> Result<(), std::fmt::Error> {116 write!(out, "{}", error.error())?;117 if let ErrorKind::ImportSyntaxError { path, error } = error.error() {118 use std::fmt::Write;119120 writeln!(out)?;121 let mut n = path.source_path().path().map_or_else(122 || path.source_path().to_string(),123 |r| self.resolver.resolve(r),124 );125 let mut offset = error.location.1 as usize;126 let is_eof = if offset >= path.code().len() {127 offset = path.code().len().saturating_sub(1);128 true129 } else {130 false131 };132 #[expect(clippy::cast_possible_truncation, reason = "code is limited by 4gb")]133 let mut location = path134 .map_source_locations(&[offset as u32])135 .into_iter()136 .next()137 .unwrap();138 if is_eof {139 location.column += 1;140 }141142 write!(n, ":").unwrap();143 print_code_location(&mut n, &location, &location).unwrap();144 write!(out, "{:<p$}{n}", "", p = self.padding)?;145 }146 let file_names = error147 .trace()148 .0149 .iter()150 .map(|el| &el.location)151 .map(|location| {152 use std::fmt::Write;153 #[allow(clippy::option_if_let_else)]154 if let Some(location) = location {155 let mut resolved_path = match location.0.source_path().path() {156 Some(r) => self.resolver.resolve(r),157 None => location.0.source_path().to_string(),158 };159 160 let location = location.0.map_source_locations(&[location.1, location.2]);161 write!(resolved_path, ":").unwrap();162 print_code_location(&mut resolved_path, &location[0], &location[1]).unwrap();163 write!(resolved_path, ":").unwrap();164 Some(resolved_path)165 } else {166 None167 }168 })169 .collect::<Vec<_>>();170 let align = file_names171 .iter()172 .flatten()173 .map(String::len)174 .max()175 .unwrap_or(0);176 for (el, file) in error.trace().0.iter().zip(file_names) {177 writeln!(out)?;178 if let Some(file) = file {179 write!(180 out,181 "{:<p$}{:<w$} {}",182 "",183 file,184 el.desc,185 p = self.padding,186 w = align187 )?;188 } else {189 write!(out, "{:<p$}{}", "", el.desc, p = self.padding,)?;190 }191 }192 Ok(())193 }194195 fn as_any(&self) -> &dyn Any {196 self197 }198199 fn as_any_mut(&mut self) -> &mut dyn Any {200 self201 }202}203204#[derive(Trace)]205pub struct JsFormat {206 pub max_trace: usize,207}208impl TraceFormat for JsFormat {209 fn write_trace(210 &self,211 out: &mut dyn std::fmt::Write,212 error: &Error,213 ) -> Result<(), std::fmt::Error> {214 write!(out, "{}", error.error())?;215 for item in &error.trace().0 {216 writeln!(out)?;217 let desc = &item.desc;218 if let Some(source) = &item.location {219 let start_end = source.0.map_source_locations(&[source.1, source.2]);220 let resolved_path = source.0.source_path().path().map_or_else(221 || source.0.source_path().to_string(),222 |r| r.display().to_string(),223 );224225 write!(226 out,227 " at {} ({}:{}:{})",228 desc, resolved_path, start_end[0].line, start_end[0].column,229 )?;230 } else {231 write!(out, " during {desc}")?;232 }233 }234 Ok(())235 }236237 fn as_any(&self) -> &dyn Any {238 self239 }240241 fn as_any_mut(&mut self) -> &mut dyn Any {242 self243 }244}245246#[cfg(feature = "explaining-traces")]247#[derive(Trace)]248pub struct HiDocFormat {249 pub resolver: PathResolver,250 pub max_trace: usize,251}252#[cfg(feature = "explaining-traces")]253impl TraceFormat for HiDocFormat {254 fn write_trace(255 &self,256 out: &mut dyn std::fmt::Write,257 error: &Error,258 ) -> Result<(), std::fmt::Error> {259 struct ResetData {260 loc: Span,261 }262 use hi_doc::{Formatting, SnippetBuilder, Text, source_to_ansi};263264 write!(out, "{}", error.error())?;265 if let ErrorKind::ImportSyntaxError { path, error } = error.error() {266 writeln!(out)?;267 let mut builder = SnippetBuilder::new(path.code());268 builder269 .error(Text::fragment("syntax error", Formatting::default()))270 .range(error.location.range())271 .build();272 let source = builder.build();273 let ansi = source_to_ansi(&source);274 write!(out, "{ansi}")?;275 }276 if let ErrorKind::StaticAnalysisError(diagnostics) = error.error() {277 use crate::analyze::DiagLevel;278 let mut builder: Option<SnippetBuilder> = None;279 let mut current_src: Option<&str> = None;280 let flush = |builder: Option<SnippetBuilder>,281 out: &mut dyn std::fmt::Write|282 -> Result<(), std::fmt::Error> {283 if let Some(b) = builder {284 let ansi = source_to_ansi(&b.build());285 write!(out, "\n{}", ansi.trim_end())?;286 }287 Ok(())288 };289 for diag in diagnostics {290 if let Some(span) = &diag.span {291 let src = span.0.code();292 if current_src != Some(src) {293 flush(builder.take(), out)?;294 builder = Some(SnippetBuilder::new(src));295 current_src = Some(src);296 }297 let b = builder.as_mut().unwrap();298 let ab = match diag.level {299 DiagLevel::Error => {300 b.error(Text::fragment(diag.message.clone(), Formatting::default()))301 }302 DiagLevel::Warning => {303 b.warning(Text::fragment(diag.message.clone(), Formatting::default()))304 }305 };306 ab.range(span.range()).build();307 } else {308 flush(builder.take(), out)?;309 current_src = None;310 let prefix = match diag.level {311 DiagLevel::Error => "error",312 DiagLevel::Warning => "warning",313 };314 write!(out, "\n{prefix}: {}", diag.message)?;315 }316 }317 flush(builder, out)?;318 }319 let trace = &error.trace();320 let snippet_builder: RefCell<Option<SnippetBuilder>> = RefCell::new(None);321 let mut last_location: Option<Span> = None;322 let mut flush_builder = |data: Option<ResetData>| {323 use std::fmt::Write;324 let mut out = String::new();325 let location_changed = if let Some(ResetData { loc }) = &data {326 if last_location.as_ref().map(|l| l.0.code()) != Some(loc.0.code()) {327 true328 } else if let (Some(last), new) = (&last_location, loc) {329 330 last.1 > new.1 || last.2 > new.2331 } else {332 false333 }334 } else {335 true336 };337 if location_changed {338 if let Some(builder) = snippet_builder.borrow_mut().take() {339 let rendered = builder.build();340 let ansi = source_to_ansi(&rendered);341 if let Some(loc) = &last_location {342 let _ = writeln!(out, "...at {}", loc.0.source_path());343 }344 let _ = write!(out, "{}", ansi.trim_end());345 }346 last_location = None;347348 if let Some(ResetData { loc }) = data {349 *snippet_builder.borrow_mut() = Some(SnippetBuilder::new(loc.0.code()));350 last_location = Some(loc);351 }352 }353 if out.is_empty() {354 return None;355 }356 Some(out)357 };358 for item in &trace.0 {359 let desc = &item.desc;360 if let Some(source) = &item.location {361 if let Some(flushed) = flush_builder(Some(ResetData {362 loc: source.clone(),363 })) {364 writeln!(out)?;365 write!(out, "{flushed}")?;366 }367 let mut builder = snippet_builder.borrow_mut();368 let builder = builder.as_mut().unwrap();369 builder370 .note(Text::fragment(desc, Formatting::default()))371 .range(source.1 as usize..=(source.2 as usize - 1).max(source.1 as usize))372 .build();373 } else {374 if let Some(flushed) = flush_builder(None) {375 writeln!(out)?;376 write!(out, "{flushed}")?;377 }378 writeln!(out)?;379 write!(out, " {desc}")?;380 }381 }382383 if let Some(flushed) = flush_builder(None) {384 writeln!(out)?;385 write!(out, "{flushed}")?;386 }387 Ok(())388 }389390 fn as_any(&self) -> &dyn Any {391 self392 }393394 fn as_any_mut(&mut self) -> &mut dyn Any {395 self396 }397}