fix expression

.gitignore

@@ -3,4 +3,6 @@ node_modules
 .vscode-test
 /target
 Cargo.lock
-assets
+assets
+*.new
+*.pending-snap

Cargo.toml

@@ -10,5 +10,6 @@ syntax = {path = './crates/syntax', version = "0.1.0"}
 circom-lsp = {path = './crates/lsp', version = "*"}
 common = { path = './crates/common', version = "*"}
 database = {path = "./crates/database", version = "*"}
+
 [workspace.package]
 rust-version = "1.71"

SNAPSHOT_TEST.md

@@ -0,0 +1,11 @@
+# Snapshot Test
+
+* Run all tests:
+    ```
+    cargo test
+    ```
+
+* Review snapshot changes
+    ```
+    cargo insta review
+    ```

crates/lsp/src/global_state.rs

@@ -44,9 +44,15 @@ impl From<DidChangeTextDocumentParams> for TextDocument {
     }
 }
 
+/// state of all (circom) source file
 pub struct GlobalState {
+    /// file id - ast from that file content
     pub ast_map: DashMap<String, AstCircomProgram>,
+
+    /// file id - file content (+ end lines)
     pub file_map: DashMap<String, FileDB>,
+
+    /// file id - database (template in4, function in4...)
     pub db: SemanticDB,
 }
 
@@ -71,13 +77,17 @@ impl GlobalState {
         ast: &AstCircomProgram,
         token: &SyntaxToken,
     ) -> Vec<Location> {
+        // look up token in current file
         let semantic_data = self.db.semantic.get(&root.file_id).unwrap();
         let mut result = lookup_definition(root, ast, semantic_data, token);
 
         if token.kind() == TokenKind::CircomString {
             return result;
         }
 
+        // if can not find that token in current file,
+        // and if token in a component call / declaration
+        // continue looking up in libs
         let p = root.get_path();
 
         if lookup_node_wrap_token(TokenKind::ComponentDecl, token).is_some()
@@ -98,17 +108,27 @@ impl GlobalState {
                 }
             }
         }
+
         result
     }
 
     pub fn goto_definition_handler(&self, id: RequestId, params: GotoDefinitionParams) -> Response {
+        eprint!("-------------------");
+        // path to the element we want to get definition
+        // TODO eg: file/line/start column..end column
         let uri = params.text_document_position_params.text_document.uri;
 
+        // abtract syntax tree for the element from that uri
+        // TODO eg:
         let ast = self.ast_map.get(&uri.to_string()).unwrap();
+        // the file contains the element from that uri
+        // TODO eg:
         let file = self.file_map.get(&uri.to_string()).unwrap();
 
         let mut locations = Vec::new();
 
+        // extract token from ast at position (file, params position)
+        // TODO eg:
         if let Some(token) =
             lookup_token_at_postion(&file, &ast, params.text_document_position_params.position)
         {
@@ -126,6 +146,11 @@ impl GlobalState {
         }
     }
 
+    /// update a file of (circom) source code
+    /// parse new code --> syntax tree
+    /// remove old data of that file in semantic database
+    /// add new data (circom_program_semantic) + related libs into database
+    /// update corresponding file-map and ast-map in global-state
     pub fn handle_update(&mut self, text_document: &TextDocument) -> Result<()> {
         let text = &text_document.text;
         let url = &text_document.uri.to_string();

crates/lsp/src/handler/goto_definition.rs

@@ -16,6 +16,7 @@ use syntax::syntax_node::SyntaxToken;
 
 use crate::database::{FileDB, SemanticData, TokenId};
 
+// find the first ancestor with given kind of a syntax token
 pub fn lookup_node_wrap_token(ast_type: TokenKind, token: &SyntaxToken) -> Option<SyntaxNode> {
     let mut p = token.parent();
     while let Some(t) = p {
@@ -27,6 +28,7 @@ pub fn lookup_node_wrap_token(ast_type: TokenKind, token: &SyntaxToken) -> Optio
     None
 }
 
+// return an Identifier/CircomString token at a position
 pub fn lookup_token_at_postion(
     file: &FileDB,
     ast: &AstCircomProgram,
@@ -47,6 +49,7 @@ pub fn lookup_token_at_postion(
     })
 }
 
+// find all template name (in component declaration) which are used inside a template
 pub fn lookup_component(template: &AstTemplateDef, text: SyntaxText) -> Option<AstTemplateName> {
     if let Some(statements) = template.statements() {
         for component in statements.find_children::<AstComponentDecl>() {
@@ -60,6 +63,8 @@ pub fn lookup_component(template: &AstTemplateDef, text: SyntaxText) -> Option<A
     None
 }
 
+// if token in an include statement
+// add lib path (location of source code of that library) into result
 pub fn jump_to_lib(file: &FileDB, token: &SyntaxToken) -> Vec<Location> {
     if let Some(include_lib) = lookup_node_wrap_token(TokenKind::IncludeKw, token) {
         if let Some(ast_include) = AstInclude::cast(include_lib) {
@@ -86,22 +91,27 @@ pub fn lookup_definition(
     token: &SyntaxToken,
 ) -> Vec<Location> {
     let template_list = ast.template_list();
+    // TODO: extract function list
 
     let mut res = Vec::new();
 
     if token.kind() == TokenKind::CircomString {
         return jump_to_lib(file, token);
     }
 
+    // signal from other template
+    // eg: in1, in2 from component call mul(in1, in2)
     let mut signal_outside = false;
 
     if let Some(component_call) = lookup_node_wrap_token(TokenKind::ComponentCall, token) {
         // find template called.
         if let Some(ast_component_call) = AstComponentCall::cast(component_call) {
             if let Some(signal) = ast_component_call.signal() {
+                // if target token is the parameter of a component call
+                // TODO: go to params in template!!! (failed)
                 if signal.syntax().text() == token.text() {
                     signal_outside = true;
-                    // lookup template of componenet
+                    // lookup template of component
                     if let Some(current_template) =
                         lookup_node_wrap_token(TokenKind::TemplateDef, token)
                     {
@@ -131,6 +141,8 @@ pub fn lookup_definition(
     }
 
     if !signal_outside {
+        // look up token in template information
+        // (template name, signal/variable/component in template)
         for template in template_list {
             let template_name = template.name().unwrap();
             if template_name.name().unwrap().syntax().text() == token.text() {
@@ -160,6 +172,9 @@ pub fn lookup_definition(
                 res.extend(component_decl);
             }
         }
+
+        // TODO: look up token in function information
+        // (function name, signal/variable/component in function)
     }
 
     res.into_iter()
@@ -189,7 +204,7 @@ mod tests {
         pragma circom 2.0.0;
 
         template X() {
-            signal x = 10;
+            signal x[100];
             signal input x = 10;
            component x = Multiplier2();
            component y = X();
@@ -230,9 +245,7 @@ template Y() {
         let syntax_node = SyntaxTreeBuilder::syntax_tree(&source);
 
         if let Some(program_ast) = AstCircomProgram::cast(syntax_node) {
-            for template in program_ast.template_list() {
-                println!("{template:?}");
-            }
+            println!("program: {}", program_ast.syntax().text().to_string());
 
             let inputs = program_ast.template_list()[0]
                 .func_body()

crates/parser/Cargo.toml

@@ -11,7 +11,16 @@ lsp-types = {version = "0.94.1", features = ["proposed"]}
 rowan = "0.15.15"
 num-traits = "0.2"
 num-derive = "0.2"
-
+serde = "1.0.216"
 
 [profile.dev]
-debug = 2
+debug = 2
+
+[dev-dependencies]
+# for snapshot testing, yaml format
+insta = { version = "1.41.1", features = ["yaml"] }
+
+[profile.dev.package]
+# compile slightly slower once, but use less memory, have faster diffs
+insta.opt-level = 3
+similar.opt-level = 3

crates/parser/src/event.rs

@@ -1,8 +1,9 @@
 use crate::token_kind::TokenKind;
 
-#[derive(Debug, Clone, Copy)]
+#[derive(Debug, Clone)]
 pub enum Event {
     Open { kind: TokenKind },
     Close,
     TokenPosition(usize),
+    ErrorReport(String),
 }

crates/parser/src/grammar.rs

@@ -6,7 +6,7 @@ mod declaration;
 mod expression;
 mod function;
 mod include;
-mod list_identity;
+mod list;
 mod main_component;
 mod pragma;
 mod statement;

crates/parser/src/grammar/block.rs

@@ -1,13 +1,23 @@
 use super::*;
 
+/*
+{
+    <declaration>/<statement>
+    <declaration>/<statement>
+    ....
+    <declaration>/<statement>
+}
+*/
 pub fn block(p: &mut Parser) {
     p.inc_rcurly();
 
+    // TODO: why do not use expect for { and }
     if !p.at(LCurly) {
         p.advance_with_error("Miss {");
     } else {
         let m = p.open();
-        p.eat(LCurly);
+        p.expect(LCurly);
+
         let stmt_marker = p.open();
         while !p.at(RCurly) && !p.eof() {
             let kind = p.current();
@@ -31,7 +41,6 @@ pub fn block(p: &mut Parser) {
         p.close(stmt_marker, StatementList);
 
         p.expect(RCurly);
-
         p.close(m, Block);
 
         p.dec_rcurly();