cargo fmt and unadded file

Author: pickx

.circleci/config.yml

@@ -23,7 +23,7 @@ orbs:
 jobs:
   unit-tests:
     docker:
-      - image: cimg/rust:1.65.0
+      - image: cimg/rust:1.72.0
     steps:
       - checkout
       - run:

src/parse/helpers/slot.rs

@@ -0,0 +1,76 @@
+use super::*;
+
+fn single_slot_access() -> impl Parser<Token, (), Error = Simple<Token>> {
+    let pos = one_of([Token::Slot, Token::Offset]).then(num());
+    pos.delimited_by(just(Token::RoundOpen), just(Token::RoundClose))
+        .ignored()
+}
+
+fn double_slot_access() -> impl Parser<Token, (), Error = Simple<Token>> {
+    let pos = one_of([Token::Slot, Token::Offset]).then(num());
+    pos.separated_by(just(Token::Comma))
+        .exactly(2)
+        .delimited_by(just(Token::RoundOpen), just(Token::RoundClose))
+        .ignored()
+}
+
+fn array_or_map_access() -> impl Parser<Token, (), Error = Simple<Token>> {
+    let pos = one_of([Token::Key, Token::Index]).then(named_param());
+    pos.delimited_by(just(Token::SquareOpen), just(Token::SquareClose))
+        .ignored()
+}
+
+fn named_slot_pattern() -> impl Parser<Token, (), Error = Simple<Token>> {
+    choice((ident().ignored(), one_of(USABLE_KEYWORDS).ignored()))
+}
+
+fn static_slot_pattern() -> impl Parser<Token, (), Error = Simple<Token>> {
+    choice((
+        named_slot_pattern(),
+        single_slot_access(),
+        double_slot_access(),
+    ))
+    .separated_by(dot())
+    .at_least(1)
+    .ignored()
+}
+
+pub fn slot_pattern() -> impl Parser<Token, Span, Error = Simple<Token>> {
+    let ending = choice((
+        array_or_map_access(),
+        dot().then(named_slot_pattern()).ignored(),
+        dot().then(single_slot_access()).ignored(),
+    ));
+
+    let slot_pattern_nested = recursive(|slot_pattern_nested| {
+        static_slot_pattern()
+            .then(ending.repeated().at_least(1))
+            .then(slot_pattern_nested.or_not())
+            .ignored()
+    });
+
+    slot_pattern_nested
+        .or(static_slot_pattern())
+        .map_with_span(|_, span| span)
+}
+
+fn dot() -> impl Parser<Token, (), Error = Simple<Token>> {
+    just(Token::Dot).ignored()
+}
+
+const USABLE_KEYWORDS: [Token; 14] = [
+    Token::Exists,
+    Token::ForAll,
+    Token::Using,
+    Token::As,
+    Token::Return,
+    Token::Import,
+    Token::Use,
+    Token::Builtin,
+    Token::Override,
+    Token::Sig,
+    Token::Description,
+    Token::Invariant,
+    Token::Preserved,
+    Token::Old,
+];

src/parse/tests.rs

@@ -170,7 +170,9 @@ fn parsing_params() {
     "};
 
     let parsed = parse_exactly_one(src).unwrap();
-    let Ast::Function { name, params, .. } = parsed.ast else { panic!() };
+    let Ast::Function { name, params, .. } = parsed.ast else {
+        panic!()
+    };
     assert_eq!(name, "goodMath");
 
     let expected_params = [
@@ -203,7 +205,9 @@ fn comments_in_element() {
     "};
 
     let parsed = parse_exactly_one(src).unwrap();
-    let Ast::Rule { name, params, .. } = parsed.ast else { panic!() };
+    let Ast::Rule { name, params, .. } = parsed.ast else {
+        panic!()
+    };
 
     assert_eq!(name, "ofLaw");
 
@@ -392,7 +396,9 @@ fn multiline_slashed_freeform_concatenates_to_a_single_comment() {
     let element = &parsed[0];
 
     let expected = "## Verification of ERC1155Burnable\n\n`ERC1155Burnable` extends the `ERC1155` functionality by wrapping the internal\nmethods `_burn` and `_burnBatch` in the public methods `burn` and `burnBatch`,\nadding a requirement that the caller of either method be the account holding\nthe tokens or approved to act on that account's behalf.\n\n### Assumptions and Simplifications\n\n- No changes made using the harness\n\n### Properties";
-    let Ast::FreeFormComment { text } = &element.ast else { panic!("should have been parsed as documentation"); };
+    let Ast::FreeFormComment { text } = &element.ast else {
+        panic!("should have been parsed as documentation");
+    };
     assert_eq!(text, expected);
 }
 
@@ -418,7 +424,9 @@ fn crlf() {
 
     let parsed = Builder::new(&src_with_crlf_encoding).build().unwrap();
 
-    let Ast::FreeFormComment { text } = &parsed[0].ast else { panic!() };
+    let Ast::FreeFormComment { text } = &parsed[0].ast else {
+        panic!()
+    };
 
     assert_eq!(
         text,
@@ -460,7 +468,9 @@ fn freeform_stars_without_text() {
 
     let parsed = Builder::new(src).build().unwrap();
 
-    let Ast::FreeFormComment { text } = &parsed[0].ast else { panic!() };
+    let Ast::FreeFormComment { text } = &parsed[0].ast else {
+        panic!()
+    };
     assert!(text.is_empty());
 }
 
@@ -553,7 +563,9 @@ fn blocks_where_brackets_are_not_separated_by_whitespace() {
     "};
 
     let element = parse_exactly_one(src).unwrap();
-    let Ast::Rule { filters, .. } = &element.ast else { panic!() };
+    let Ast::Rule { filters, .. } = &element.ast else {
+        panic!()
+    };
 
     assert_eq!(filters.as_ref().unwrap(), "{f -> !f.isView}");
 }
@@ -576,10 +588,14 @@ fn variable_char_lengths() {
     let parsed = Builder::new(src).build().unwrap();
     assert_eq!(parsed.len(), 3);
 
-    let Ast::FreeFormComment { text } = &parsed[0].ast else { panic!(); };
+    let Ast::FreeFormComment { text } = &parsed[0].ast else {
+        panic!();
+    };
     assert_eq!(text, "🔥🔥🔥💯 frfr");
 
-    let Ast::FreeFormComment { text } = &parsed[2].ast else { panic!(); };
+    let Ast::FreeFormComment { text } = &parsed[2].ast else {
+        panic!();
+    };
     assert_eq!(text, "Text");
 
     assert_eq!(parsed[0].raw(), "/***\n🔥🔥🔥💯 frfr\n*/");

src/parse/tests/cvl2.rs

@@ -31,7 +31,12 @@ fn invariant_requires_semicolon() {
 
     let with_semicolon = "invariant validityOfTokens() true;";
     let parsed = parse_exactly_one(with_semicolon).unwrap();
-    let Ast::Invariant { name, invariant, .. } = parsed.ast else { panic!() };
+    let Ast::Invariant {
+        name, invariant, ..
+    } = parsed.ast
+    else {
+        panic!()
+    };
     assert_eq!(name, "validityOfTokens");
     assert_eq!(invariant, "true");
 }
@@ -43,7 +48,9 @@ fn rule_keyword_is_mandatory() {
 
     let with_kw = "rule onlyOwnerCanDecrease() { }";
     let parsed = parse_exactly_one(with_kw).unwrap();
-    let Ast::Rule { name, .. } = parsed.ast else { panic!() };
+    let Ast::Rule { name, .. } = parsed.ast else {
+        panic!()
+    };
     assert_eq!(name, "onlyOwnerCanDecrease")
 }
 
@@ -52,7 +59,9 @@ fn rule_keyword_is_mandatory() {
 fn underscores_and_dots_in_function_names() {
     let func = "function _.hello.world_(int fizz, int buzz) {\nreturn\n}";
     let parsed = parse_exactly_one(func).unwrap();
-    let Ast::Function { name, .. } = parsed.ast else { panic!() };
+    let Ast::Function { name, .. } = parsed.ast else {
+        panic!()
+    };
 
     assert_eq!(name, "_.hello.world_");
 }
@@ -157,7 +166,14 @@ fn hook_sload1() {
         }
     "};
     let parsed = parse_exactly_one(src).unwrap();
-    let Ast::HookSload { loaded, slot_pattern, block } = parsed.ast else { panic!() };
+    let Ast::HookSload {
+        loaded,
+        slot_pattern,
+        block,
+    } = parsed.ast
+    else {
+        panic!()
+    };
 
     assert_eq!(loaded.name, "value");
     assert_eq!(loaded.ty, "uint256");
@@ -169,7 +185,14 @@ fn hook_sload1() {
 fn hook_sload2() {
     let src = "hook Sload uint256 imp (slot 50801780122331352337026042894847907698553222651959119521779622085092237899971/*0x7050c9e0f4ca769c69bd3a8ef740bc37934f8e2c036e5a723fd8ee048ed3f8c3*/) STORAGE {}";
     let parsed = parse_exactly_one(src).unwrap();
-    let Ast::HookSload { loaded, slot_pattern, .. } = parsed.ast else { panic!() };
+    let Ast::HookSload {
+        loaded,
+        slot_pattern,
+        ..
+    } = parsed.ast
+    else {
+        panic!()
+    };
 
     assert_eq!(loaded.name, "imp");
     assert_eq!(loaded.ty, "uint256");
@@ -184,7 +207,14 @@ fn hook_sload3() {
         }
     "};
     let parsed = parse_exactly_one(src).unwrap();
-    let Ast::HookSload { loaded, slot_pattern, .. } = parsed.ast else { panic!() };
+    let Ast::HookSload {
+        loaded,
+        slot_pattern,
+        ..
+    } = parsed.ast
+    else {
+        panic!()
+    };
 
     assert_eq!(loaded.name, "value");
     assert_eq!(loaded.ty, "uint");
@@ -199,7 +229,14 @@ fn hook_sload4() {
         }
     "};
     let parsed = parse_exactly_one(src).unwrap();
-    let Ast::HookSload { loaded, slot_pattern, block } = parsed.ast else { panic!() };
+    let Ast::HookSload {
+        loaded,
+        slot_pattern,
+        block,
+    } = parsed.ast
+    else {
+        panic!()
+    };
 
     assert_eq!(loaded.name, "owner");
     assert_eq!(loaded.ty, "uint");
@@ -216,7 +253,15 @@ fn hook_sstore1() {
         hook Sstore _list .(offset 0)[INDEX uint256 index] bytes32 newValue (bytes32 oldValue) STORAGE { }
     "};
     let parsed = parse_exactly_one(src).unwrap();
-    let Ast::HookSstore { stored, old, slot_pattern, .. } = parsed.ast else { panic!() };
+    let Ast::HookSstore {
+        stored,
+        old,
+        slot_pattern,
+        ..
+    } = parsed.ast
+    else {
+        panic!()
+    };
 
     assert_eq!(stored.name, "newValue");
     let old = old.unwrap();
@@ -233,7 +278,15 @@ fn hook_sstore2() {
         }
     "};
     let parsed = parse_exactly_one(src).unwrap();
-    let Ast::HookSstore { stored, old, slot_pattern, block } = parsed.ast else { panic!() };
+    let Ast::HookSstore {
+        stored,
+        old,
+        slot_pattern,
+        block,
+    } = parsed.ast
+    else {
+        panic!()
+    };
 
     assert_eq!(stored.name, "value");
     assert!(old.is_none());
@@ -250,7 +303,15 @@ fn hook_sstore3() {
         }
     "};
     let parsed = parse_exactly_one(src).unwrap();
-    let Ast::HookSstore { stored, old, slot_pattern, block } = parsed.ast else { panic!() };
+    let Ast::HookSstore {
+        stored,
+        old,
+        slot_pattern,
+        block,
+    } = parsed.ast
+    else {
+        panic!()
+    };
 
     assert_eq!(stored.name, "v");
     assert!(old.is_none());
@@ -268,7 +329,9 @@ fn hook_create() {
         hook Create (address createdAddress) { }
     "};
     let parsed = parse_exactly_one(src).unwrap();
-    let Ast::HookCreate { created, block } = parsed.ast else { panic!() };
+    let Ast::HookCreate { created, block } = parsed.ast else {
+        panic!()
+    };
 
     assert_eq!(created.name, "createdAddress");
     assert_eq!(created.ty, "address");
@@ -283,7 +346,15 @@ fn hook_opcode1() {
         };
     "};
     let parsed = parse_exactly_one(src).unwrap();
-    let Ast::HookOpcode { opcode, params, returns, block } = parsed.ast else { panic!() };
+    let Ast::HookOpcode {
+        opcode,
+        params,
+        returns,
+        block,
+    } = parsed.ast
+    else {
+        panic!()
+    };
 
     assert_eq!(opcode, "EXTCODESIZE");
     let param = params.into_iter().exactly_one().unwrap();
@@ -303,7 +374,15 @@ fn hook_opcode2() {
         }
     "};
     let parsed = parse_exactly_one(src).unwrap();
-    let Ast::HookOpcode { opcode, params, returns, block } = parsed.ast else { panic!() };
+    let Ast::HookOpcode {
+        opcode,
+        params,
+        returns,
+        block,
+    } = parsed.ast
+    else {
+        panic!()
+    };
 
     assert_eq!(opcode, "GASPRICE");
     assert!(params.is_empty());