Merge remote-tracking branch 'origin/topic/etyp/compound-stmt'

zeek · Mar 6, 2025 · 8966228 · 8966228
2 parents 7d30d55 + 9152a06
commit 8966228
Show file tree

Hide file tree

Showing 11 changed files with 137 additions and 10 deletions.
diff --git a/CHANGES b/CHANGES
@@ -1,3 +1,13 @@
+1.13.0-dev.118 | 2025-03-06 09:05:38 -0500
+
+  * Fix `for` loop snippet to run as-is. (Evan Typanski, Corelight)
+
+  * GH-1538: Implement compound statements (`{...}`). (Evan Typanski, Corelight)
+
+    Closes #1538
+
+    The functionality was there, just not available in the parser.
+
 1.13.0-dev.115 | 2025-03-06 12:00:38 +0100
 
   * GH-1981: Reject function overloads which only differ in default'd parameters. (Benjamin Bannier, Corelight)

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-1.13.0-dev.115
+1.13.0-dev.118
diff --git a/doc/programming/language/examples/_statement-for.spicy b/doc/programming/language/examples/_statement-for.spicy
@@ -8,7 +8,7 @@ for ( i in b"abc" ) {
     print i;
 }
 
-local v = vector("a", "b", "c");
+global v = vector("a", "b", "c");
 
 for ( i in v )
     print i;
diff --git a/doc/programming/language/statements.rst b/doc/programming/language/statements.rst
@@ -118,7 +118,7 @@ Examples:
         print i;
     }
 
-    local v = vector("a", "b", "c");
+    global v = vector("a", "b", "c");
 
     for ( i in v )
         print i;

diff --git a/doc/programming/language/variables.rst b/doc/programming/language/variables.rst
@@ -36,9 +36,41 @@ prefixed with ``local`` this time:
     function f() {
         local x: bytes;
         local y = "Y";
-
     }
 
 Usual scoping rules apply to locals. Just like globals, locals are
 always initialized to a well-defined value: either their default if
 given, or the type's null value.
+
+Local variables can also have their visibility limited to a block
+enclosed by curly braces:
+
+.. spicy-code::
+
+    function f() {
+        {
+            local x = "One";
+            print x;
+        }
+        {
+            local x = "Two";
+            print x;
+        }
+
+        # Shadowing variables also works
+        local shadowed = "Outer";
+        {
+            local shadowed = "Inner";
+            print shadowed;
+        }
+        print shadowed;
+    }
+
+The above function would print:
+
+.. code::
+
+    One
+    Two
+    Inner
+    Outer
diff --git a/hilti/toolchain/src/compiler/parser/parser.yy b/hilti/toolchain/src/compiler/parser/parser.yy
@@ -36,7 +36,7 @@ namespace hilti { namespace detail { class Parser; } }
 
 %glr-parser
 %expect 113
-%expect-rr 209
+%expect-rr 211
 
 %{
 
@@ -467,8 +467,11 @@ opt_func_default_expr : '=' expr                 { $$ = std::move($2); }
 
 /* Statements */
 
-block         : braced_block                     { $$ = std::move($1); }
-              | stmt                             { $$ = builder->statementBlock({$1}, __loc__); }
+block         : stmt                             { if ( ! $1->isA<hilti::statement::Block>() )
+                                                     $$ = builder->statementBlock({std::move($1)}, __loc__);
+                                                   else
+                                                     $$ = std::move($1);
+                                                 }
               ;
 
 braced_block  : '{' opt_stmts '}'                { $$ = builder->statementBlock(std::move($2), __loc__); }
@@ -481,6 +484,7 @@ stmts         : stmts stmt                       { $$ = std::move($1); $$.push_b
 
 stmt          : stmt_expr ';'                    { $$ = std::move($1); }
               | stmt_decl                        { $$ = std::move($1); }
+              | braced_block                     { $$ = std::move($1); }
               | RETURN ';'                       { $$ = builder->statementReturn(__loc__); }
               | RETURN expr ';'                  { $$ = builder->statementReturn(std::move($2), __loc__); }
               | THROW expr ';'                   { $$ = builder->statementThrow(std::move($2), __loc__); }

diff --git a/spicy/toolchain/src/compiler/parser/parser.yy b/spicy/toolchain/src/compiler/parser/parser.yy
@@ -36,7 +36,7 @@ namespace spicy { namespace detail { class Parser; } }
 
 %glr-parser
 %expect 119
-%expect-rr 170
+%expect-rr 172
 
 %{
 
@@ -521,8 +521,11 @@ opt_init_expression : '=' expr                   { $$ = std::move($2); }
 
 /* Statements */
 
-block         : braced_block                     { $$ = std::move($1); }
-              | stmt                             { $$ = builder->statementBlock({$1}, __loc__); }
+block         : stmt                             { if ( ! $1->isA<hilti::statement::Block>() )
+                                                     $$ = builder->statementBlock({std::move($1)}, __loc__);
+                                                   else
+                                                     $$ = std::move($1);
+                                                 }
               ;
 
 braced_block  : '{' opt_stmts '}'                { $$ = builder->statementBlock(std::move($2), __loc__); }
@@ -535,6 +538,7 @@ stmts         : stmts stmt                       { $$ = std::move($1); $$.push_b
 
 stmt          : stmt_expr ';'                    { $$ = std::move($1); }
               | stmt_decl                        { $$ = std::move($1); }
+              | braced_block                     { $$ = std::move($1); }
               | ASSERT expr ';'                  { $$ = builder->statementAssert(std::move($2), {}, __loc__); }
               | ASSERT_EXCEPTION expr_no_or_error ':' expr ';'
                                                  { $$ = builder->statementAssert(hilti::statement::assert::Exception(), std::move($2), {}, std::move($4), __loc__); }

diff --git a/tests/Baseline/hilti.statements.block/output b/tests/Baseline/hilti.statements.block/output
@@ -0,0 +1,9 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+Testing block:
+1
+hello :)
+
+Testing shadowing:
+outer
+inner
+outer
diff --git a/tests/Baseline/spicy.statements.block/output b/tests/Baseline/spicy.statements.block/output
@@ -0,0 +1,9 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+Testing block:
+1
+hello :)
+
+Testing shadowing:
+outer
+inner
+outer
diff --git a/tests/hilti/statements/block.hlt b/tests/hilti/statements/block.hlt
@@ -0,0 +1,31 @@
+# @TEST-EXEC: ${HILTIC} -j %INPUT >output
+# @TEST-EXEC: btest-diff output
+
+module Block {
+
+import hilti;
+
+function void block() {
+    hilti::print("Testing block:");
+    {
+        local x = 1;
+        hilti::print(x);
+    }
+    local x = "hello :)";
+    hilti::print(x);
+}
+
+function void shadowed() {
+    hilti::print("\nTesting shadowing:");
+    local shadowed = "outer";
+    hilti::print(shadowed);
+    {
+        local shadowed = "inner";
+        hilti::print(shadowed);
+    }
+    hilti::print(shadowed);
+}
+
+block();
+shadowed();
+}
diff --git a/tests/spicy/statements/block.spicy b/tests/spicy/statements/block.spicy
@@ -0,0 +1,28 @@
+# @TEST-EXEC: ${SPICYC} -j %INPUT >output
+# @TEST-EXEC: btest-diff output
+
+module Block;
+
+function block() {
+    print "Testing block:";
+    {
+        local x = 1;
+        print x;
+    }
+    local x = "hello :)";
+    print x;
+}
+
+function shadow() {
+    print "\nTesting shadowing:";
+    local shadowed = "outer";
+    print shadowed;
+    {
+        local shadowed = "inner";
+        print shadowed;
+    }
+    print shadowed;
+}
+
+block();
+shadow();