git.delta.rocks / jrsonnet / refs/commits / 3b72cd84a927

difftreelog

Merge pull request #27 from CertainLach/syntax-error-display

Yaroslav Bulyukin2020-11-17parents: #036eddf #1ca5234.patch.diff
in: master
Syntax error display

8 files changed

modifiedCargo.lockdiffbeforeafterboth
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -7,6 +7,7 @@
 checksum = "5c96c3d1062ea7101741480185a6a1275eab01cbe8b20e378d1311bc056d2e08"
 dependencies = [
  "unicode-width",
+ "yansi-term",
 ]
 
 [[package]]
@@ -513,3 +514,12 @@
 version = "0.4.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"
+
+[[package]]
+name = "yansi-term"
+version = "0.1.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fe5c30ade05e61656247b2e334a031dfd0cc466fadef865bdcdea8d537951bf1"
+dependencies = [
+ "winapi",
+]
modifiedcrates/jrsonnet-evaluator/Cargo.tomldiffbeforeafterboth
--- a/crates/jrsonnet-evaluator/Cargo.toml
+++ b/crates/jrsonnet-evaluator/Cargo.toml
@@ -55,6 +55,7 @@
 # Explaining traces
 [dependencies.annotate-snippets]
 version = "0.9.0"
+features = ["color"]
 optional = true
 
 [build-dependencies]
modifiedcrates/jrsonnet-evaluator/src/error.rsdiffbeforeafterboth
--- a/crates/jrsonnet-evaluator/src/error.rs
+++ b/crates/jrsonnet-evaluator/src/error.rs
@@ -78,7 +78,11 @@
 	ImportBadFileUtf8(PathBuf),
 	#[error("tried to import {1} from {0}, but imports is not supported")]
 	ImportNotSupported(PathBuf, PathBuf),
-	#[error("syntax error")]
+	#[error(
+		"syntax error, expected one of {}, got {:?}",
+		.error.expected,
+		.source_code.chars().nth(error.location.offset).map(|c| c.to_string()).unwrap_or_else(|| "EOF".into())
+	)]
 	ImportSyntaxError {
 		path: Rc<PathBuf>,
 		source_code: Rc<str>,
modifiedcrates/jrsonnet-evaluator/src/evaluate.rsdiffbeforeafterboth
--- a/crates/jrsonnet-evaluator/src/evaluate.rs
+++ b/crates/jrsonnet-evaluator/src/evaluate.rs
@@ -419,18 +419,12 @@
 	use Expr::*;
 	let LocExpr(expr, loc) = expr;
 	Ok(match &**expr {
-		Literal(LiteralType::This) => Val::Obj(
-			context
-				.this()
-				.clone()
-				.ok_or_else(|| CantUseSelfOutsideOfObject)?,
-		),
-		Literal(LiteralType::Dollar) => Val::Obj(
-			context
-				.dollar()
-				.clone()
-				.ok_or_else(|| NoTopLevelObjectFound)?,
-		),
+		Literal(LiteralType::This) => {
+			Val::Obj(context.this().clone().ok_or(CantUseSelfOutsideOfObject)?)
+		}
+		Literal(LiteralType::Dollar) => {
+			Val::Obj(context.dollar().clone().ok_or(NoTopLevelObjectFound)?)
+		}
 		Literal(LiteralType::True) => Val::Bool(true),
 		Literal(LiteralType::False) => Val::Bool(false),
 		Literal(LiteralType::Null) => Val::Null,
modifiedcrates/jrsonnet-evaluator/src/trace/location.rsdiffbeforeafterboth
--- a/crates/jrsonnet-evaluator/src/trace/location.rs
+++ b/crates/jrsonnet-evaluator/src/trace/location.rs
@@ -1,5 +1,7 @@
 #[derive(Clone, PartialEq, Debug)]
 pub struct CodeLocation {
+	pub offset: usize,
+
 	pub line: usize,
 	pub column: usize,
 
@@ -25,6 +27,7 @@
 
 	let mut out = vec![
 		CodeLocation {
+			offset: 0,
 			column: 0,
 			line: 0,
 			line_start_offset: 0,
@@ -40,6 +43,7 @@
 			Some(x) if x.0 == pos => {
 				let out_idx = x.1;
 				with_no_known_line_ending.push(out_idx);
+				out[out_idx].offset = pos;
 				out[out_idx].line = line;
 				out[out_idx].column = column;
 				out[out_idx].line_start_offset = this_line_offset;
@@ -82,12 +86,14 @@
 			),
 			vec![
 				CodeLocation {
+					offset: 0,
 					line: 1,
 					column: 2,
 					line_start_offset: 0,
-					line_end_offset: 11
+					line_end_offset: 11,
 				},
 				CodeLocation {
+					offset: 14,
 					line: 2,
 					column: 4,
 					line_start_offset: 12,
modifiedcrates/jrsonnet-evaluator/src/trace/mod.rsdiffbeforeafterboth
--- a/crates/jrsonnet-evaluator/src/trace/mod.rs
+++ b/crates/jrsonnet-evaluator/src/trace/mod.rs
@@ -1,6 +1,6 @@
 mod location;
 
-use crate::{EvaluationState, LocError};
+use crate::{error::Error, EvaluationState, LocError};
 pub use location::*;
 use std::path::PathBuf;
 
@@ -87,6 +87,33 @@
 		error: &LocError,
 	) -> Result<(), std::fmt::Error> {
 		writeln!(out, "{}", error.error())?;
+		if let Error::ImportSyntaxError {
+			path,
+			source_code,
+			error,
+		} = error.error()
+		{
+			use std::fmt::Write;
+			let mut n = self.resolver.resolve(path);
+			let mut offset = error.location.offset;
+			let is_eof = if offset >= source_code.len() {
+				offset = source_code.len() - 1;
+				true
+			} else {
+				false
+			};
+			let mut location = offset_to_location(source_code, &[offset])
+				.into_iter()
+				.next()
+				.unwrap();
+			if is_eof {
+				location.column += 1;
+			}
+
+			write!(n, ":").unwrap();
+			print_code_location(&mut n, &location, &location).unwrap();
+			write!(out, "{:<p$}{}", "", n, p = self.padding,)?;
+		}
 		let file_names = error
 			.trace()
 			.0
@@ -167,52 +194,101 @@
 		evaluation_state: &EvaluationState,
 		error: &LocError,
 	) -> Result<(), std::fmt::Error> {
-		use annotate_snippets::{
-			display_list::{DisplayList, FormatOptions},
-			snippet::{AnnotationType, Slice, Snippet, SourceAnnotation},
-		};
 		writeln!(out, "{}", error.error())?;
+		if let Error::ImportSyntaxError {
+			path,
+			source_code,
+			error,
+		} = error.error()
+		{
+			let mut offset = error.location.offset;
+			if offset >= source_code.len() {
+				offset = source_code.len() - 1;
+			}
+			let mut location = offset_to_location(source_code, &[offset])
+				.into_iter()
+				.next()
+				.unwrap();
+			if location.column >= 1 {
+				location.column -= 1;
+			}
+
+			self.print_snippet(
+				out,
+				source_code,
+				path,
+				&location,
+				&location,
+				"^ syntax error",
+			)?;
+		}
 		let trace = &error.trace();
 		for item in trace.0.iter() {
 			let desc = &item.desc;
 			let source = item.location.clone();
 			let start_end = evaluation_state.map_source_locations(&source.0, &[source.1, source.2]);
 
-			let source_fragment: String = evaluation_state
-				.get_source(&source.0)
-				.unwrap()
-				.chars()
-				.skip(start_end[0].line_start_offset)
-				.take(start_end[1].line_end_offset - start_end[0].line_start_offset)
-				.collect();
+			self.print_snippet(
+				out,
+				&evaluation_state.get_source(&source.0).unwrap(),
+				&source.0,
+				&start_end[0],
+				&start_end[1],
+				desc,
+			)?;
+		}
+		Ok(())
+	}
+}
+
+impl ExplainingFormat {
+	fn print_snippet(
+		&self,
+		out: &mut dyn std::fmt::Write,
+		source: &str,
+		origin: &PathBuf,
+		start: &CodeLocation,
+		end: &CodeLocation,
+		desc: &str,
+	) -> Result<(), std::fmt::Error> {
+		use annotate_snippets::{
+			display_list::{DisplayList, FormatOptions},
+			snippet::{AnnotationType, Slice, Snippet, SourceAnnotation},
+		};
+
+		let source_fragment: String = source
+			.chars()
+			.skip(start.line_start_offset)
+			.take(end.line_end_offset - end.line_start_offset)
+			.collect();
 
-			let origin = self.resolver.resolve(&source.0);
-			let snippet = Snippet {
-				opt: FormatOptions {
-					color: true,
-					..Default::default()
-				},
-				title: None,
-				footer: vec![],
-				slices: vec![Slice {
-					source: &source_fragment,
-					line_start: start_end[0].line,
-					origin: Some(&origin),
-					fold: false,
-					annotations: vec![SourceAnnotation {
-						label: desc,
-						annotation_type: AnnotationType::Error,
-						range: (
-							source.1 - start_end[0].line_start_offset,
-							source.2 - start_end[0].line_start_offset,
-						),
-					}],
+		let origin = self.resolver.resolve(origin);
+		let snippet = Snippet {
+			opt: FormatOptions {
+				color: true,
+				..Default::default()
+			},
+			title: None,
+			footer: vec![],
+			slices: vec![Slice {
+				source: &source_fragment,
+				line_start: start.line,
+				origin: Some(&origin),
+				fold: false,
+				annotations: vec![SourceAnnotation {
+					label: desc,
+					annotation_type: AnnotationType::Error,
+					range: (
+						start.offset - start.line_start_offset,
+						end.offset - start.line_start_offset,
+					),
 				}],
-			};
+			}],
+		};
 
-			let dl = DisplayList::from(snippet);
-			writeln!(out, "{}", dl)?;
-		}
+		let dl = DisplayList::from(snippet);
+		writeln!(out, "{}", dl)?;
+
 		Ok(())
 	}
 }
modifiedcrates/jrsonnet-evaluator/src/val.rsdiffbeforeafterboth
--- a/crates/jrsonnet-evaluator/src/val.rs
+++ b/crates/jrsonnet-evaluator/src/val.rs
@@ -349,7 +349,7 @@
 					for v in arr.iter() {
 						out.push_str("---\n");
 						out.push_str(&v.manifest(format)?);
-						out.push_str("\n");
+						out.push('\n');
 					}
 					out.push_str("...");
 				}
modifiedcrates/jrsonnet-parser/src/lib.rsdiffbeforeafterboth
37		rule reserved() = ("assert" / "else" / "error" / "false" / "for" / "function" / "if" / "import" / "importstr" / "in" / "local" / "null" / "tailstrict" / "then" / "self" / "super" / "true") end_of_ident()37		rule reserved() = ("assert" / "else" / "error" / "false" / "for" / "function" / "if" / "import" / "importstr" / "in" / "local" / "null" / "tailstrict" / "then" / "self" / "super" / "true") end_of_ident()
38		rule id() = quiet!{ !reserved() alpha() (alpha() / digit())*} / expected!("<identifier>")38		rule id() = quiet!{ !reserved() alpha() (alpha() / digit())*} / expected!("<identifier>")
3939
40		rule keyword(id: &'static str)40		rule keyword(id: &'static str) -> ()
41			= ##parse_string_literal(id) end_of_ident()41			= ##parse_string_literal(id) end_of_ident()
42		// Adds location data information to existing expression42		// Adds location data information to existing expression
43		rule l(s: &ParserSettings, x: rule<Expr>) -> LocExpr43		rule l(s: &ParserSettings, x: rule<Expr>) -> LocExpr
85			  [' ' | '\t']*<, {prefix.len() - 1}> "|||"85			  [' ' | '\t']*<, {prefix.len() - 1}> "|||"
86			  {let mut l = empty_lines.to_owned(); l.push_str(first_line); l.extend(lines); l}86			  {let mut l = empty_lines.to_owned(); l.push_str(first_line); l.extend(lines); l}
87		pub rule string() -> String87		pub rule string() -> String
88			= "\"" str:$(("\\\"" / "\\\\" / (!['"'][_]))*) "\"" {unescape::unescape(str).unwrap()}88			= quiet!{ "\"" str:$(("\\\"" / "\\\\" / (!['"'][_]))*) "\"" {unescape::unescape(str).unwrap()}
89			/ "'" str:$(("\\'" / "\\\\" / (!['\''][_]))*) "'" {unescape::unescape(str).unwrap()}89			/ "'" str:$(("\\'" / "\\\\" / (!['\''][_]))*) "'" {unescape::unescape(str).unwrap()}
90			/ "@'" str:$(("''" / (!['\''][_]))*) "'" {str.replace("''", "'")}90			/ "@'" str:$(("''" / (!['\''][_]))*) "'" {str.replace("''", "'")}
91			/ "@\"" str:$(("\"\"" / (!['"'][_]))*) "\"" {str.replace("\"\"", "\"")}91			/ "@\"" str:$(("\"\"" / (!['"'][_]))*) "\"" {str.replace("\"\"", "\"")}
92			/ string_block()92			/ string_block() } / expected!("<string>")
9393
94		pub rule field_name(s: &ParserSettings) -> expr::FieldName94		pub rule field_name(s: &ParserSettings) -> expr::FieldName
95			= name:$(id()) {expr::FieldName::Fixed(name.into())}95			= name:$(id()) {expr::FieldName::Fixed(name.into())}
208				SliceDesc { start, end, step }208				SliceDesc { start, end, step }
209			}209			}
210
211		rule binop(x: rule<()>) -> ()
212			= quiet!{ x() } / expected!("<binary op>")
213		rule unaryop(x: rule<()>) -> ()
214			= quiet!{ x() } / expected!("<unary op>")
210215
211		rule expr(s: &ParserSettings) -> LocExpr216		rule expr(s: &ParserSettings) -> LocExpr
212			= start:position!() a:precedence! {217			= start:position!() a:precedence! {
213				a:(@) _ "||" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Or, b))}218				a:(@) _ binop(<"||">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Or, b))}
214				--219				--
215				a:(@) _ "&&" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::And, b))}220				a:(@) _ binop(<"&&">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::And, b))}
216				--221				--
217				a:(@) _ "|" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::BitOr, b))}222				a:(@) _ binop(<"|">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::BitOr, b))}
218				--223				--
219				a:@ _ "^" _ b:(@) {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::BitXor, b))}224				a:@ _ binop(<"^">) _ b:(@) {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::BitXor, b))}
220				--225				--
221				a:(@) _ "&" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::BitAnd, b))}226				a:(@) _ binop(<"&">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::BitAnd, b))}
222				--227				--
223				a:(@) _ "==" _ b:@ {loc_expr_todo!(Expr::Apply(228				a:(@) _ binop(<"==">) _ b:@ {loc_expr_todo!(Expr::Apply(
224					el!(Expr::Intrinsic("equals".into())),229					el!(Expr::Intrinsic("equals".into())),
225					ArgsDesc(vec![Arg(None, a), Arg(None, b)]),230					ArgsDesc(vec![Arg(None, a), Arg(None, b)]),
226					true231					true
227				))}232				))}
228				a:(@) _ "!=" _ b:@ {loc_expr_todo!(Expr::UnaryOp(UnaryOpType::Not, el!(Expr::Apply(233				a:(@) _ binop(<"!=">) _ b:@ {loc_expr_todo!(Expr::UnaryOp(UnaryOpType::Not, el!(Expr::Apply(
229					el!(Expr::Intrinsic("equals".into())),234					el!(Expr::Intrinsic("equals".into())),
230					ArgsDesc(vec![Arg(None, a), Arg(None, b)]),235					ArgsDesc(vec![Arg(None, a), Arg(None, b)]),
231					true236					true
232				))))}237				))))}
233				--238				--
234				a:(@) _ "<" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Lt, b))}239				a:(@) _ binop(<"<">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Lt, b))}
235				a:(@) _ ">" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Gt, b))}240				a:(@) _ binop(<">">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Gt, b))}
236				a:(@) _ "<=" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Lte, b))}241				a:(@) _ binop(<"<=">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Lte, b))}
237				a:(@) _ ">=" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Gte, b))}242				a:(@) _ binop(<">=">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Gte, b))}
238				a:(@) _ keyword("in") _ b:@ {loc_expr_todo!(Expr::Apply(243				a:(@) _ binop(<keyword("in")>) _ b:@ {loc_expr_todo!(Expr::Apply(
239					el!(Expr::Intrinsic("objectHasEx".into())), ArgsDesc(vec![Arg(None, b), Arg(None, a), Arg(None, el!(Expr::Literal(LiteralType::True)))]),244					el!(Expr::Intrinsic("objectHasEx".into())), ArgsDesc(vec![Arg(None, b), Arg(None, a), Arg(None, el!(Expr::Literal(LiteralType::True)))]),
240					true245					true
241				))}246				))}
242				--247				--
243				a:(@) _ "<<" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Lhs, b))}248				a:(@) _ binop(<"<<">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Lhs, b))}
244				a:(@) _ ">>" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Rhs, b))}249				a:(@) _ binop(<">>">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Rhs, b))}
245				--250				--
246				a:(@) _ "+" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Add, b))}251				a:(@) _ binop(<"+">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Add, b))}
247				a:(@) _ "-" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Sub, b))}252				a:(@) _ binop(<"-">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Sub, b))}
248				--253				--
249				a:(@) _ "*" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Mul, b))}254				a:(@) _ binop(<"*">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Mul, b))}
250				a:(@) _ "/" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Div, b))}255				a:(@) _ binop(<"/">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Div, b))}
251				a:(@) _ "%" _ b:@ {loc_expr_todo!(Expr::Apply(256				a:(@) _ binop(<"%">) _ b:@ {loc_expr_todo!(Expr::Apply(
252					el!(Expr::Intrinsic("mod".into())), ArgsDesc(vec![Arg(None, a), Arg(None, b)]),257					el!(Expr::Intrinsic("mod".into())), ArgsDesc(vec![Arg(None, a), Arg(None, b)]),
253					false258					false
254				))}259				))}
255				--260				--
256						"-" _ b:@ {loc_expr_todo!(Expr::UnaryOp(UnaryOpType::Minus, b))}261						unaryop(<"-">) _ b:@ {loc_expr_todo!(Expr::UnaryOp(UnaryOpType::Minus, b))}
257						"!" _ b:@ {loc_expr_todo!(Expr::UnaryOp(UnaryOpType::Not, b))}262						unaryop(<"!">) _ b:@ {loc_expr_todo!(Expr::UnaryOp(UnaryOpType::Not, b))}
258						"~" _ b:@ { loc_expr_todo!(Expr::UnaryOp(UnaryOpType::BitNot, b)) }263						unaryop(<"~">) _ b:@ { loc_expr_todo!(Expr::UnaryOp(UnaryOpType::BitNot, b)) }
259				--264				--
260				a:(@) _ "[" _ s:slice_desc(s) _ "]" {loc_expr_todo!(Expr::Apply(265				a:(@) _ "[" _ s:slice_desc(s) _ "]" {loc_expr_todo!(Expr::Apply(
261					el!(Expr::Intrinsic("slice".into())),266					el!(Expr::Intrinsic("slice".into())),