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
1mod location;1mod location;
22
3use crate::{EvaluationState, LocError};3use crate::{error::Error, EvaluationState, LocError};
4pub use location::*;4pub use location::*;
5use std::path::PathBuf;5use std::path::PathBuf;
66
87 error: &LocError,87 error: &LocError,
88 ) -> Result<(), std::fmt::Error> {88 ) -> Result<(), std::fmt::Error> {
89 writeln!(out, "{}", error.error())?;89 writeln!(out, "{}", error.error())?;
90 if let Error::ImportSyntaxError {
91 path,
92 source_code,
93 error,
94 } = error.error()
95 {
96 use std::fmt::Write;
97 let mut n = self.resolver.resolve(path);
98 let mut offset = error.location.offset;
99 let is_eof = if offset >= source_code.len() {
100 offset = source_code.len() - 1;
101 true
102 } else {
103 false
104 };
105 let mut location = offset_to_location(source_code, &[offset])
106 .into_iter()
107 .next()
108 .unwrap();
109 if is_eof {
110 location.column += 1;
111 }
112
113 write!(n, ":").unwrap();
114 print_code_location(&mut n, &location, &location).unwrap();
115 write!(out, "{:<p$}{}", "", n, p = self.padding,)?;
116 }
90 let file_names = error117 let file_names = error
91 .trace()118 .trace()
92 .0119 .0
159pub struct ExplainingFormat {186pub struct ExplainingFormat {
160 pub resolver: PathResolver,187 pub resolver: PathResolver,
161}188}
162#[cfg(feature = "explaining-traces")]189#[cfg(feature = "explaining-traces")]
190impl TraceFormat for ExplainingFormat {
191 fn write_trace(
192 &self,
193 out: &mut dyn std::fmt::Write,
194 evaluation_state: &EvaluationState,
195 error: &LocError,
196 ) -> Result<(), std::fmt::Error> {
197 writeln!(out, "{}", error.error())?;
198 if let Error::ImportSyntaxError {
199 path,
200 source_code,
201 error,
202 } = error.error()
203 {
204 let mut offset = error.location.offset;
205 if offset >= source_code.len() {
206 offset = source_code.len() - 1;
207 }
208 let mut location = offset_to_location(source_code, &[offset])
209 .into_iter()
210 .next()
211 .unwrap();
212 if location.column >= 1 {
213 location.column -= 1;
214 }
215
216 self.print_snippet(
217 out,
218 source_code,
219 path,
220 &location,
221 &location,
222 "^ syntax error",
223 )?;
224 }
225 let trace = &error.trace();
226 for item in trace.0.iter() {
227 let desc = &item.desc;
228 let source = item.location.clone();
229 let start_end = evaluation_state.map_source_locations(&source.0, &[source.1, source.2]);
230
231 self.print_snippet(
232 out,
233 &evaluation_state.get_source(&source.0).unwrap(),
234 &source.0,
235 &start_end[0],
236 &start_end[1],
237 desc,
238 )?;
239 }
240 Ok(())
241 }
242}
243
163impl TraceFormat for ExplainingFormat {244impl ExplainingFormat {
164 fn write_trace(245 fn print_snippet(
165 &self,246 &self,
166 out: &mut dyn std::fmt::Write,247 out: &mut dyn std::fmt::Write,
167 evaluation_state: &EvaluationState,248 source: &str,
168 error: &LocError,249 origin: &PathBuf,
250 start: &CodeLocation,
251 end: &CodeLocation,
252 desc: &str,
169 ) -> Result<(), std::fmt::Error> {253 ) -> Result<(), std::fmt::Error> {
170 use annotate_snippets::{254 use annotate_snippets::{
171 display_list::{DisplayList, FormatOptions},255 display_list::{DisplayList, FormatOptions},
172 snippet::{AnnotationType, Slice, Snippet, SourceAnnotation},256 snippet::{AnnotationType, Slice, Snippet, SourceAnnotation},
173 };257 };
174 writeln!(out, "{}", error.error())?;258
175 let trace = &error.trace();259 let source_fragment: String = source
176 for item in trace.0.iter() {260 .chars()
177 let desc = &item.desc;261 .skip(start.line_start_offset)
178 let source = item.location.clone();262 .take(end.line_end_offset - end.line_start_offset)
179 let start_end = evaluation_state.map_source_locations(&source.0, &[source.1, source.2]);263 .collect();
180
181 let source_fragment: String = evaluation_state
182 .get_source(&source.0)
183 .unwrap()
184 .chars()
185 .skip(start_end[0].line_start_offset)
186 .take(start_end[1].line_end_offset - start_end[0].line_start_offset)
187 .collect();
188264
189 let origin = self.resolver.resolve(&source.0);265 let origin = self.resolver.resolve(origin);
190 let snippet = Snippet {266 let snippet = Snippet {
191 opt: FormatOptions {267 opt: FormatOptions {
192 color: true,268 color: true,
196 footer: vec![],272 footer: vec![],
197 slices: vec![Slice {273 slices: vec![Slice {
198 source: &source_fragment,274 source: &source_fragment,
199 line_start: start_end[0].line,275 line_start: start.line,
200 origin: Some(&origin),276 origin: Some(&origin),
201 fold: false,277 fold: false,
202 annotations: vec![SourceAnnotation {278 annotations: vec![SourceAnnotation {
203 label: desc,279 label: desc,
204 annotation_type: AnnotationType::Error,280 annotation_type: AnnotationType::Error,
205 range: (281 range: (
206 source.1 - start_end[0].line_start_offset,282 start.offset - start.line_start_offset,
207 source.2 - start_end[0].line_start_offset,283 end.offset - start.line_start_offset,
208 ),284 ),
209 }],285 }],
210 }],286 }],
211 };287 };
212288
213 let dl = DisplayList::from(snippet);289 let dl = DisplayList::from(snippet);
214 writeln!(out, "{}", dl)?;290 writeln!(out, "{}", dl)?;
215 }291
216 Ok(())292 Ok(())
217 }293 }
218}294}
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
--- a/crates/jrsonnet-parser/src/lib.rs
+++ b/crates/jrsonnet-parser/src/lib.rs
@@ -37,7 +37,7 @@
 		rule reserved() = ("assert" / "else" / "error" / "false" / "for" / "function" / "if" / "import" / "importstr" / "in" / "local" / "null" / "tailstrict" / "then" / "self" / "super" / "true") end_of_ident()
 		rule id() = quiet!{ !reserved() alpha() (alpha() / digit())*} / expected!("<identifier>")
 
-		rule keyword(id: &'static str)
+		rule keyword(id: &'static str) -> ()
 			= ##parse_string_literal(id) end_of_ident()
 		// Adds location data information to existing expression
 		rule l(s: &ParserSettings, x: rule<Expr>) -> LocExpr
@@ -85,11 +85,11 @@
 			  [' ' | '\t']*<, {prefix.len() - 1}> "|||"
 			  {let mut l = empty_lines.to_owned(); l.push_str(first_line); l.extend(lines); l}
 		pub rule string() -> String
-			= "\"" str:$(("\\\"" / "\\\\" / (!['"'][_]))*) "\"" {unescape::unescape(str).unwrap()}
+			= quiet!{ "\"" str:$(("\\\"" / "\\\\" / (!['"'][_]))*) "\"" {unescape::unescape(str).unwrap()}
 			/ "'" str:$(("\\'" / "\\\\" / (!['\''][_]))*) "'" {unescape::unescape(str).unwrap()}
 			/ "@'" str:$(("''" / (!['\''][_]))*) "'" {str.replace("''", "'")}
 			/ "@\"" str:$(("\"\"" / (!['"'][_]))*) "\"" {str.replace("\"\"", "\"")}
-			/ string_block()
+			/ string_block() } / expected!("<string>")
 
 		pub rule field_name(s: &ParserSettings) -> expr::FieldName
 			= name:$(id()) {expr::FieldName::Fixed(name.into())}
@@ -208,54 +208,59 @@
 				SliceDesc { start, end, step }
 			}
 
+		rule binop(x: rule<()>) -> ()
+			= quiet!{ x() } / expected!("<binary op>")
+		rule unaryop(x: rule<()>) -> ()
+			= quiet!{ x() } / expected!("<unary op>")
+
 		rule expr(s: &ParserSettings) -> LocExpr
 			= start:position!() a:precedence! {
-				a:(@) _ "||" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Or, b))}
+				a:(@) _ binop(<"||">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Or, b))}
 				--
-				a:(@) _ "&&" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::And, b))}
+				a:(@) _ binop(<"&&">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::And, b))}
 				--
-				a:(@) _ "|" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::BitOr, b))}
+				a:(@) _ binop(<"|">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::BitOr, b))}
 				--
-				a:@ _ "^" _ b:(@) {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::BitXor, b))}
+				a:@ _ binop(<"^">) _ b:(@) {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::BitXor, b))}
 				--
-				a:(@) _ "&" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::BitAnd, b))}
+				a:(@) _ binop(<"&">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::BitAnd, b))}
 				--
-				a:(@) _ "==" _ b:@ {loc_expr_todo!(Expr::Apply(
+				a:(@) _ binop(<"==">) _ b:@ {loc_expr_todo!(Expr::Apply(
 					el!(Expr::Intrinsic("equals".into())),
 					ArgsDesc(vec![Arg(None, a), Arg(None, b)]),
 					true
 				))}
-				a:(@) _ "!=" _ b:@ {loc_expr_todo!(Expr::UnaryOp(UnaryOpType::Not, el!(Expr::Apply(
+				a:(@) _ binop(<"!=">) _ b:@ {loc_expr_todo!(Expr::UnaryOp(UnaryOpType::Not, el!(Expr::Apply(
 					el!(Expr::Intrinsic("equals".into())),
 					ArgsDesc(vec![Arg(None, a), Arg(None, b)]),
 					true
 				))))}
 				--
-				a:(@) _ "<" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Lt, b))}
-				a:(@) _ ">" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Gt, b))}
-				a:(@) _ "<=" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Lte, b))}
-				a:(@) _ ">=" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Gte, b))}
-				a:(@) _ keyword("in") _ b:@ {loc_expr_todo!(Expr::Apply(
+				a:(@) _ binop(<"<">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Lt, b))}
+				a:(@) _ binop(<">">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Gt, b))}
+				a:(@) _ binop(<"<=">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Lte, b))}
+				a:(@) _ binop(<">=">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Gte, b))}
+				a:(@) _ binop(<keyword("in")>) _ b:@ {loc_expr_todo!(Expr::Apply(
 					el!(Expr::Intrinsic("objectHasEx".into())), ArgsDesc(vec![Arg(None, b), Arg(None, a), Arg(None, el!(Expr::Literal(LiteralType::True)))]),
 					true
 				))}
 				--
-				a:(@) _ "<<" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Lhs, b))}
-				a:(@) _ ">>" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Rhs, b))}
+				a:(@) _ binop(<"<<">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Lhs, b))}
+				a:(@) _ binop(<">>">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Rhs, b))}
 				--
-				a:(@) _ "+" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Add, b))}
-				a:(@) _ "-" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Sub, b))}
+				a:(@) _ binop(<"+">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Add, b))}
+				a:(@) _ binop(<"-">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Sub, b))}
 				--
-				a:(@) _ "*" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Mul, b))}
-				a:(@) _ "/" _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Div, b))}
-				a:(@) _ "%" _ b:@ {loc_expr_todo!(Expr::Apply(
+				a:(@) _ binop(<"*">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Mul, b))}
+				a:(@) _ binop(<"/">) _ b:@ {loc_expr_todo!(Expr::BinaryOp(a, BinaryOpType::Div, b))}
+				a:(@) _ binop(<"%">) _ b:@ {loc_expr_todo!(Expr::Apply(
 					el!(Expr::Intrinsic("mod".into())), ArgsDesc(vec![Arg(None, a), Arg(None, b)]),
 					false
 				))}
 				--
-						"-" _ b:@ {loc_expr_todo!(Expr::UnaryOp(UnaryOpType::Minus, b))}
-						"!" _ b:@ {loc_expr_todo!(Expr::UnaryOp(UnaryOpType::Not, b))}
-						"~" _ b:@ { loc_expr_todo!(Expr::UnaryOp(UnaryOpType::BitNot, b)) }
+						unaryop(<"-">) _ b:@ {loc_expr_todo!(Expr::UnaryOp(UnaryOpType::Minus, b))}
+						unaryop(<"!">) _ b:@ {loc_expr_todo!(Expr::UnaryOp(UnaryOpType::Not, b))}
+						unaryop(<"~">) _ b:@ { loc_expr_todo!(Expr::UnaryOp(UnaryOpType::BitNot, b)) }
 				--
 				a:(@) _ "[" _ s:slice_desc(s) _ "]" {loc_expr_todo!(Expr::Apply(
 					el!(Expr::Intrinsic("slice".into())),