difftreelog
Add location info to all sub-expressions
in: master
2 files changed
crates/jrsonnet-parser/src/expr.rsdiffbeforeafterboth--- a/crates/jrsonnet-parser/src/expr.rs
+++ b/crates/jrsonnet-parser/src/expr.rs
@@ -403,11 +403,3 @@
)
};
}
-
-/// Creates LocExpr without location info
-#[macro_export]
-macro_rules! loc_expr_todo {
- ($expr:expr) => {
- LocExpr(Rc::new($expr), None)
- };
-}
crates/jrsonnet-parser/src/lib.rsdiffbeforeafterboth1#![allow(clippy::redundant_closure_call)]23use peg::parser;4use std::{5 path::{Path, PathBuf},6 rc::Rc,7};8mod expr;9pub use expr::*;10pub use jrsonnet_interner::IStr;11pub use peg;1213pub struct ParserSettings {14 pub loc_data: bool,15 pub file_name: Rc<Path>,16}1718macro_rules! expr_bin {19 ($a:ident $op:ident $b:ident) => {20 loc_expr_todo!(Expr::BinaryOp($a, $op, $b))21 };22}23macro_rules! expr_un {24 ($op:ident $a:ident) => {25 loc_expr_todo!(Expr::UnaryOp($op, $a))26 };27}2829parser! {30 grammar jsonnet_parser() for str {31 use peg::ParseLiteral;3233 /// Standard C-like comments34 rule comment()35 = "//" (!['\n'][_])* "\n"36 / "/*" ("\\*/" / "\\\\" / (!("*/")[_]))* "*/"37 / "#" (!['\n'][_])* "\n"3839 rule single_whitespace() = quiet!{([' ' | '\r' | '\n' | '\t'] / comment())} / expected!("<whitespace>")40 rule _() = single_whitespace()*4142 /// For comma-delimited elements43 rule comma() = quiet!{_ "," _} / expected!("<comma>")44 rule alpha() -> char = c:$(['_' | 'a'..='z' | 'A'..='Z']) {c.chars().next().unwrap()}45 rule digit() -> char = d:$(['0'..='9']) {d.chars().next().unwrap()}46 rule end_of_ident() = !['0'..='9' | '_' | 'a'..='z' | 'A'..='Z']47 /// Sequence of digits48 rule uint_str() -> &'input str = a:$(digit()+) { a }49 /// Number in scientific notation format50 rule number() -> f64 = quiet!{a:$(uint_str() ("." uint_str())? (['e'|'E'] (s:['+'|'-'])? uint_str())?) {? a.parse().map_err(|_| "<number>") }} / expected!("<number>")5152 /// Reserved word followed by any non-alphanumberic53 rule reserved() = ("assert" / "else" / "error" / "false" / "for" / "function" / "if" / "import" / "importstr" / "in" / "local" / "null" / "tailstrict" / "then" / "self" / "super" / "true") end_of_ident()54 rule id() = quiet!{ !reserved() alpha() (alpha() / digit())*} / expected!("<identifier>")5556 rule keyword(id: &'static str) -> ()57 = ##parse_string_literal(id) end_of_ident()58 // Adds location data information to existing expression59 rule l(s: &ParserSettings, x: rule<Expr>) -> LocExpr60 = start:position!() v:x() end:position!() {loc_expr!(v, s.loc_data, (s.file_name.clone(), start, end))}6162 pub rule param(s: &ParserSettings) -> expr::Param = name:$(id()) expr:(_ "=" _ expr:expr(s){expr})? { expr::Param(name.into(), expr) }63 pub rule params(s: &ParserSettings) -> expr::ParamsDesc64 = params:param(s) ** comma() comma()? {65 let mut defaults_started = false;66 for param in ¶ms {67 defaults_started = defaults_started || param.1.is_some();68 assert_eq!(defaults_started, param.1.is_some(), "defauld parameters should be used after all positionals");69 }70 expr::ParamsDesc(Rc::new(params))71 }72 / { expr::ParamsDesc(Rc::new(Vec::new())) }7374 pub rule arg(s: &ParserSettings) -> (Option<IStr>, LocExpr)75 = quiet! { name:(s:$(id()) _ "=" _ {s})? expr:expr(s) {(name.map(Into::into), expr)} }76 / expected!("<argument>")7778 pub rule args(s: &ParserSettings) -> expr::ArgsDesc79 = args:arg(s)**comma() comma()? {?80 let unnamed_count = args.iter().take_while(|(n, _)| n.is_none()).count();81 let mut unnamed = Vec::with_capacity(unnamed_count);82 let mut named = Vec::with_capacity(args.len() - unnamed_count);83 let mut named_started = false;84 for (name, value) in args {85 if let Some(name) = name {86 named_started = true;87 named.push((name, value));88 } else {89 if named_started {90 return Err("<named argument>")91 }92 unnamed.push(value);93 }94 }95 Ok(expr::ArgsDesc::new(unnamed, named))96 }9798 pub rule bind(s: &ParserSettings) -> expr::BindSpec99 = name:$(id()) _ "=" _ expr:expr(s) {expr::BindSpec{name:name.into(), params: None, value: expr}}100 / name:$(id()) _ "(" _ params:params(s) _ ")" _ "=" _ expr:expr(s) {expr::BindSpec{name:name.into(), params: Some(params), value: expr}}101 pub rule assertion(s: &ParserSettings) -> expr::AssertStmt102 = keyword("assert") _ cond:expr(s) msg:(_ ":" _ e:expr(s) {e})? { expr::AssertStmt(cond, msg) }103104 pub rule whole_line() -> &'input str105 = str:$((!['\n'][_])* "\n") {str}106 pub rule string_block() -> String107 = "|||" (!['\n']single_whitespace())* "\n"108 empty_lines:$(['\n']*)109 prefix:[' ' | '\t']+ first_line:whole_line()110 lines:("\n" {"\n"} / [' ' | '\t']*<{prefix.len()}> s:whole_line() {s})*111 [' ' | '\t']*<, {prefix.len() - 1}> "|||"112 {let mut l = empty_lines.to_owned(); l.push_str(first_line); l.extend(lines); l}113 pub rule string() -> String114 = quiet!{ "\"" str:$(("\\\"" / "\\\\" / (!['"'][_]))*) "\"" {unescape::unescape(str).unwrap()}115 / "'" str:$(("\\'" / "\\\\" / (!['\''][_]))*) "'" {unescape::unescape(str).unwrap()}116 / "@'" str:$(("''" / (!['\''][_]))*) "'" {str.replace("''", "'")}117 / "@\"" str:$(("\"\"" / (!['"'][_]))*) "\"" {str.replace("\"\"", "\"")}118 / string_block() } / expected!("<string>")119120 pub rule field_name(s: &ParserSettings) -> expr::FieldName121 = name:$(id()) {expr::FieldName::Fixed(name.into())}122 / name:string() {expr::FieldName::Fixed(name.into())}123 / "[" _ expr:expr(s) _ "]" {expr::FieldName::Dyn(expr)}124 pub rule visibility() -> expr::Visibility125 = ":::" {expr::Visibility::Unhide}126 / "::" {expr::Visibility::Hidden}127 / ":" {expr::Visibility::Normal}128 pub rule field(s: &ParserSettings) -> expr::FieldMember129 = name:field_name(s) _ plus:"+"? _ visibility:visibility() _ value:expr(s) {expr::FieldMember{130 name,131 plus: plus.is_some(),132 params: None,133 visibility,134 value,135 }}136 / name:field_name(s) _ "(" _ params:params(s) _ ")" _ visibility:visibility() _ value:expr(s) {expr::FieldMember{137 name,138 plus: false,139 params: Some(params),140 visibility,141 value,142 }}143 pub rule obj_local(s: &ParserSettings) -> BindSpec144 = keyword("local") _ bind:bind(s) {bind}145 pub rule member(s: &ParserSettings) -> expr::Member146 = bind:obj_local(s) {expr::Member::BindStmt(bind)}147 / assertion:assertion(s) {expr::Member::AssertStmt(assertion)}148 / field:field(s) {expr::Member::Field(field)}149 pub rule objinside(s: &ParserSettings) -> expr::ObjBody150 = pre_locals:(b: obj_local(s) comma() {b})* "[" _ key:expr(s) _ "]" _ plus:"+"? _ ":" _ value:expr(s) post_locals:(comma() b:obj_local(s) {b})* _ forspec:forspec(s) others:(_ rest:compspec(s) {rest})? {151 let mut compspecs = vec![CompSpec::ForSpec(forspec)];152 compspecs.extend(others.unwrap_or_default());153 expr::ObjBody::ObjComp(expr::ObjComp{154 pre_locals,155 key,156 plus: plus.is_some(),157 value,158 post_locals,159 compspecs,160 })161 }162 / members:(member(s) ** comma()) comma()? {expr::ObjBody::MemberList(members)}163 pub rule ifspec(s: &ParserSettings) -> IfSpecData164 = keyword("if") _ expr:expr(s) {IfSpecData(expr)}165 pub rule forspec(s: &ParserSettings) -> ForSpecData166 = keyword("for") _ id:$(id()) _ keyword("in") _ cond:expr(s) {ForSpecData(id.into(), cond)}167 pub rule compspec(s: &ParserSettings) -> Vec<expr::CompSpec>168 = s:(i:ifspec(s) { expr::CompSpec::IfSpec(i) } / f:forspec(s) {expr::CompSpec::ForSpec(f)} ) ** _ {s}169 pub rule local_expr(s: &ParserSettings) -> LocExpr170 = l(s,<keyword("local") _ binds:bind(s) ** comma() _ ";" _ expr:expr(s) { Expr::LocalExpr(binds, expr) }>)171 pub rule string_expr(s: &ParserSettings) -> LocExpr172 = l(s, <s:string() {Expr::Str(s.into())}>)173 pub rule obj_expr(s: &ParserSettings) -> LocExpr174 = l(s,<"{" _ body:objinside(s) _ "}" {Expr::Obj(body)}>)175 pub rule array_expr(s: &ParserSettings) -> LocExpr176 = l(s,<"[" _ elems:(expr(s) ** comma()) _ comma()? "]" {Expr::Arr(elems)}>)177 pub rule array_comp_expr(s: &ParserSettings) -> LocExpr178 = l(s,<"[" _ expr:expr(s) _ comma()? _ forspec:forspec(s) _ others:(others: compspec(s) _ {others})? "]" {179 let mut specs = vec![CompSpec::ForSpec(forspec)];180 specs.extend(others.unwrap_or_default());181 Expr::ArrComp(expr, specs)182 }>)183 pub rule number_expr(s: &ParserSettings) -> LocExpr184 = l(s,<n:number() { expr::Expr::Num(n) }>)185 pub rule var_expr(s: &ParserSettings) -> LocExpr186 = l(s,<n:$(id()) { expr::Expr::Var(n.into()) }>)187 pub rule if_then_else_expr(s: &ParserSettings) -> LocExpr188 = l(s,<cond:ifspec(s) _ keyword("then") _ cond_then:expr(s) cond_else:(_ keyword("else") _ e:expr(s) {e})? {Expr::IfElse{189 cond,190 cond_then,191 cond_else,192 }}>)193194 pub rule literal(s: &ParserSettings) -> LocExpr195 = l(s,<v:(196 keyword("null") {LiteralType::Null}197 / keyword("true") {LiteralType::True}198 / keyword("false") {LiteralType::False}199 / keyword("self") {LiteralType::This}200 / keyword("$") {LiteralType::Dollar}201 / keyword("super") {LiteralType::Super}202 ) {Expr::Literal(v)}>)203204 pub rule expr_basic(s: &ParserSettings) -> LocExpr205 = literal(s)206207 / quiet!{l(s,<"$intrinsic(" name:$(id()) ")" {Expr::Intrinsic(name.into())}>)}208209 / string_expr(s) / number_expr(s)210 / array_expr(s)211 / obj_expr(s)212 / array_expr(s)213 / array_comp_expr(s)214215 / l(s,<keyword("importstr") _ path:string() {Expr::ImportStr(PathBuf::from(path))}>)216 / l(s,<keyword("import") _ path:string() {Expr::Import(PathBuf::from(path))}>)217218 / var_expr(s)219 / local_expr(s)220 / if_then_else_expr(s)221222 / l(s,<keyword("function") _ "(" _ params:params(s) _ ")" _ expr:expr(s) {Expr::Function(params, expr)}>)223 / l(s,<assertion:assertion(s) _ ";" _ expr:expr(s) { Expr::AssertExpr(assertion, expr) }>)224225 / l(s,<keyword("error") _ expr:expr(s) { Expr::ErrorStmt(expr) }>)226227 rule slice_part(s: &ParserSettings) -> Option<LocExpr>228 = e:(_ e:expr(s) _{e})? {e}229 pub rule slice_desc(s: &ParserSettings) -> SliceDesc230 = start:slice_part(s) ":" pair:(end:slice_part(s) step:(":" e:slice_part(s){e})? {(end, step.flatten())})? {231 let (end, step) = if let Some((end, step)) = pair {232 (end, step)233 }else{234 (None, None)235 };236237 SliceDesc { start, end, step }238 }239240 rule binop(x: rule<()>) -> ()241 = quiet!{ x() } / expected!("<binary op>")242 rule unaryop(x: rule<()>) -> ()243 = quiet!{ x() } / expected!("<unary op>")244245246 use BinaryOpType::*;247 use UnaryOpType::*;248 rule expr(s: &ParserSettings) -> LocExpr249 = start:position!() a:precedence! {250 a:(@) _ binop(<"||">) _ b:@ {expr_bin!(a Or b)}251 --252 a:(@) _ binop(<"&&">) _ b:@ {expr_bin!(a And b)}253 --254 a:(@) _ binop(<"|">) _ b:@ {expr_bin!(a BitOr b)}255 --256 a:@ _ binop(<"^">) _ b:(@) {expr_bin!(a BitXor b)}257 --258 a:(@) _ binop(<"&">) _ b:@ {expr_bin!(a BitAnd b)}259 --260 a:(@) _ binop(<"==">) _ b:@ {expr_bin!(a Eq b)}261 a:(@) _ binop(<"!=">) _ b:@ {expr_bin!(a Neq b)}262 --263 a:(@) _ binop(<"<">) _ b:@ {expr_bin!(a Lt b)}264 a:(@) _ binop(<">">) _ b:@ {expr_bin!(a Gt b)}265 a:(@) _ binop(<"<=">) _ b:@ {expr_bin!(a Lte b)}266 a:(@) _ binop(<">=">) _ b:@ {expr_bin!(a Gte b)}267 a:(@) _ binop(<keyword("in")>) _ b:@ {expr_bin!(a In b)}268 --269 a:(@) _ binop(<"<<">) _ b:@ {expr_bin!(a Lhs b)}270 a:(@) _ binop(<">>">) _ b:@ {expr_bin!(a Rhs b)}271 --272 a:(@) _ binop(<"+">) _ b:@ {expr_bin!(a Add b)}273 a:(@) _ binop(<"-">) _ b:@ {expr_bin!(a Sub b)}274 --275 a:(@) _ binop(<"*">) _ b:@ {expr_bin!(a Mul b)}276 a:(@) _ binop(<"/">) _ b:@ {expr_bin!(a Div b)}277 a:(@) _ binop(<"%">) _ b:@ {expr_bin!(a Mod b)}278 --279 unaryop(<"-">) _ b:@ {expr_un!(Minus b)}280 unaryop(<"!">) _ b:@ {expr_un!(Not b)}281 unaryop(<"~">) _ b:@ {expr_un!(BitNot b)}282 --283 a:(@) _ "[" _ s:slice_desc(s) _ "]" {loc_expr_todo!(Expr::Slice(a, s))}284 a:(@) _ "." _ s:$(id()) {loc_expr_todo!(Expr::Index(a, el!(Expr::Str(s.into()))))}285 a:(@) _ "[" _ s:expr(s) _ "]" {loc_expr_todo!(Expr::Index(a, s))}286 a:(@) _ "(" _ args:args(s) _ ")" ts:(_ keyword("tailstrict"))? {loc_expr_todo!(Expr::Apply(a, args, ts.is_some()))}287 a:(@) _ "{" _ body:objinside(s) _ "}" {loc_expr_todo!(Expr::ObjExtend(a, body))}288 --289 e:expr_basic(s) {e}290 "(" _ e:expr(s) _ ")" {loc_expr_todo!(Expr::Parened(e))}291 } end:position!() {292 let LocExpr(e, _) = a;293 LocExpr(e, if s.loc_data {294 Some(ExprLocation(s.file_name.clone(), start, end))295 } else {296 None297 })298 }299 / e:expr_basic(s) {e}300301 pub rule jsonnet(s: &ParserSettings) -> LocExpr = _ e:expr(s) _ {e}302 }303}304305pub type ParseError = peg::error::ParseError<peg::str::LineCol>;306pub fn parse(str: &str, settings: &ParserSettings) -> Result<LocExpr, ParseError> {307 jsonnet_parser::jsonnet(str, settings)308}309310#[macro_export]311macro_rules! el {312 ($expr:expr) => {313 LocExpr(std::rc::Rc::new($expr), None)314 };315}316317#[cfg(test)]318pub mod tests {319 use super::{expr::*, parse};320 use crate::ParserSettings;321 use std::path::PathBuf;322 use BinaryOpType::*;323324 macro_rules! parse {325 ($s:expr) => {326 parse(327 $s,328 &ParserSettings {329 loc_data: false,330 file_name: PathBuf::from("/test.jsonnet").into(),331 },332 )333 .unwrap()334 };335 }336337 mod expressions {338 use super::*;339340 pub fn basic_math() -> LocExpr {341 el!(Expr::BinaryOp(342 el!(Expr::Num(2.0)),343 Add,344 el!(Expr::BinaryOp(345 el!(Expr::Num(2.0)),346 Mul,347 el!(Expr::Num(2.0)),348 )),349 ))350 }351 }352353 #[test]354 fn multiline_string() {355 assert_eq!(356 parse!("|||\n Hello world!\n a\n|||"),357 el!(Expr::Str("Hello world!\n a\n".into())),358 );359 assert_eq!(360 parse!("|||\n Hello world!\n a\n|||"),361 el!(Expr::Str("Hello world!\n a\n".into())),362 );363 assert_eq!(364 parse!("|||\n\t\tHello world!\n\t\t\ta\n|||"),365 el!(Expr::Str("Hello world!\n\ta\n".into())),366 );367 assert_eq!(368 parse!("|||\n Hello world!\n a\n |||"),369 el!(Expr::Str("Hello world!\n a\n".into())),370 );371 }372373 #[test]374 fn slice() {375 parse!("a[1:]");376 parse!("a[1::]");377 parse!("a[:1:]");378 parse!("a[::1]");379 parse!("str[:len - 1]");380 }381382 #[test]383 fn string_escaping() {384 assert_eq!(385 parse!(r#""Hello, \"world\"!""#),386 el!(Expr::Str(r#"Hello, "world"!"#.into())),387 );388 assert_eq!(389 parse!(r#"'Hello \'world\'!'"#),390 el!(Expr::Str("Hello 'world'!".into())),391 );392 assert_eq!(parse!(r#"'\\\\'"#), el!(Expr::Str("\\\\".into())),);393 }394395 #[test]396 fn string_unescaping() {397 assert_eq!(398 parse!(r#""Hello\nWorld""#),399 el!(Expr::Str("Hello\nWorld".into())),400 );401 }402403 #[test]404 fn string_verbantim() {405 assert_eq!(406 parse!(r#"@"Hello\n""World""""#),407 el!(Expr::Str("Hello\\n\"World\"".into())),408 );409 }410411 #[test]412 fn imports() {413 assert_eq!(414 parse!("import \"hello\""),415 el!(Expr::Import(PathBuf::from("hello"))),416 );417 assert_eq!(418 parse!("importstr \"garnish.txt\""),419 el!(Expr::ImportStr(PathBuf::from("garnish.txt")))420 );421 }422423 #[test]424 fn empty_object() {425 assert_eq!(parse!("{}"), el!(Expr::Obj(ObjBody::MemberList(vec![]))));426 }427428 #[test]429 fn basic_math() {430 assert_eq!(431 parse!("2+2*2"),432 el!(Expr::BinaryOp(433 el!(Expr::Num(2.0)),434 Add,435 el!(Expr::BinaryOp(436 el!(Expr::Num(2.0)),437 Mul,438 el!(Expr::Num(2.0))439 ))440 ))441 );442 }443444 #[test]445 fn basic_math_with_indents() {446 assert_eq!(parse!("2 + 2 * 2 "), expressions::basic_math());447 }448449 #[test]450 fn basic_math_parened() {451 assert_eq!(452 parse!("2+(2+2*2)"),453 el!(Expr::BinaryOp(454 el!(Expr::Num(2.0)),455 Add,456 el!(Expr::Parened(expressions::basic_math())),457 ))458 );459 }460461 /// Comments should not affect parsing462 #[test]463 fn comments() {464 assert_eq!(465 parse!("2//comment\n+//comment\n3/*test*/*/*test*/4"),466 el!(Expr::BinaryOp(467 el!(Expr::Num(2.0)),468 Add,469 el!(Expr::BinaryOp(470 el!(Expr::Num(3.0)),471 Mul,472 el!(Expr::Num(4.0))473 ))474 ))475 );476 }477478 /// Comments should be able to be escaped479 #[test]480 fn comment_escaping() {481 assert_eq!(482 parse!("2/*\\*/+*/ - 22"),483 el!(Expr::BinaryOp(484 el!(Expr::Num(2.0)),485 Sub,486 el!(Expr::Num(22.0))487 ))488 );489 }490491 #[test]492 fn suffix() {493 // assert_eq!(parse!("std.test"), el!(Expr::Num(2.2)));494 // assert_eq!(parse!("std(2)"), el!(Expr::Num(2.2)));495 // assert_eq!(parse!("std.test(2)"), el!(Expr::Num(2.2)));496 // assert_eq!(parse!("a[b]"), el!(Expr::Num(2.2)))497 }498499 #[test]500 fn array_comp() {501 use Expr::*;502 assert_eq!(503 parse!("[std.deepJoin(x) for x in arr]"),504 el!(ArrComp(505 el!(Apply(506 el!(Index(el!(Var("std".into())), el!(Str("deepJoin".into())))),507 ArgsDesc::new(vec![el!(Var("x".into()))], vec![]),508 false,509 )),510 vec![CompSpec::ForSpec(ForSpecData(511 "x".into(),512 el!(Var("arr".into()))513 ))]514 )),515 )516 }517518 #[test]519 fn reserved() {520 use Expr::*;521 assert_eq!(parse!("null"), el!(Literal(LiteralType::Null)));522 assert_eq!(parse!("nulla"), el!(Var("nulla".into())));523 }524525 #[test]526 fn multiple_args_buf() {527 parse!("a(b, null_fields)");528 }529530 #[test]531 fn infix_precedence() {532 use Expr::*;533 assert_eq!(534 parse!("!a && !b"),535 el!(BinaryOp(536 el!(UnaryOp(UnaryOpType::Not, el!(Var("a".into())))),537 And,538 el!(UnaryOp(UnaryOpType::Not, el!(Var("b".into()))))539 ))540 );541 }542543 #[test]544 fn infix_precedence_division() {545 use Expr::*;546 assert_eq!(547 parse!("!a / !b"),548 el!(BinaryOp(549 el!(UnaryOp(UnaryOpType::Not, el!(Var("a".into())))),550 Div,551 el!(UnaryOp(UnaryOpType::Not, el!(Var("b".into()))))552 ))553 );554 }555556 #[test]557 fn double_negation() {558 use Expr::*;559 assert_eq!(560 parse!("!!a"),561 el!(UnaryOp(562 UnaryOpType::Not,563 el!(UnaryOp(UnaryOpType::Not, el!(Var("a".into()))))564 ))565 )566 }567568 #[test]569 fn array_test_error() {570 parse!("[a for a in b if c for e in f]");571 // ^^^^ failed code572 }573574 #[test]575 fn can_parse_stdlib() {576 parse!(jrsonnet_stdlib::STDLIB_STR);577 }578579 // From source code580 /*581 #[bench]582 fn bench_parse_peg(b: &mut Bencher) {583 b.iter(|| parse!(jrsonnet_stdlib::STDLIB_STR))584 }585 */586}