Rename on_comment_parsed method to on_comment for consistency acr…

…oss grammar traits

crates/parol-ls/src/parol_ls_grammar.rs

@@ -721,7 +721,7 @@ impl ParolLsGrammarTrait for ParolLsGrammar {
         Ok(())
     }
 
-    fn on_comment_parsed(&mut self, token: Token<'_>) {
+    fn on_comment(&mut self, token: Token<'_>) {
         self.comments.push_back(OwnedToken(token.into_owned()))
     }
 }

crates/parol-ls/src/parol_ls_grammar_trait.rs

@@ -197,7 +197,7 @@ pub trait ParolLsGrammarTrait {
 
     /// This method provides skipped language comments.
     /// If you need comments please provide your own implementation of this method.
-    fn on_comment_parsed(&mut self, _token: Token<'_>) {}
+    fn on_comment(&mut self, _token: Token<'_>) {}
 }
 
 // -------------------------------------------------------------------------------------------------
@@ -3235,7 +3235,7 @@ impl<'t> UserActionsTrait<'t> for ParolLsGrammarAuto<'t, '_> {
         }
     }
 
-    fn on_comment_parsed(&mut self, token: Token<'t>) {
-        self.user_grammar.on_comment_parsed(token)
+    fn on_comment(&mut self, token: Token<'t>) {
+        self.user_grammar.on_comment(token)
     }
 }

crates/parol/src/generators/grammar_type_generator.rs

@@ -34,7 +34,7 @@ pub struct GrammarTypeInfo {
 
     /// The type id of the *semantic actions trait* that contains functions for each non-terminal of
     /// the given grammar.
-    /// It also contains the function 'on_comment_parsed' that is called when a comment is parsed.
+    /// It also contains the function 'on_comment' that is called when a comment is parsed.
     /// The user action trait is created in global scope.
     /// The type name is <`GrammarName`>GrammarTrait
     pub(crate) semantic_actions_trait_id: Option<SymbolId>,
@@ -48,8 +48,8 @@ pub struct GrammarTypeInfo {
 
     /// The type id of the user action trait that contains only two functions.
     /// The first calls the adapter functions in the adapter struct.
-    /// The second function 'on_comment_parsed' is called when a comment is parsed. This function
-    /// calls the user action function 'on_comment_parsed' in the semantic actions trait.
+    /// The second function 'on_comment' is called when a comment is parsed. This function
+    /// calls the user action function 'on_comment' in the semantic actions trait.
     /// This trait created in global scope.
     /// The type name is always 'UserActionsTrait' and it is the interface called by the parser.
     pub(crate) parser_interface_trait_id: Option<SymbolId>,
@@ -130,14 +130,14 @@ impl GrammarTypeInfo {
             .symbol_table
             .insert_global_type("Token", TypeEntrails::Token)?;
 
-        // Insert the fix 'on_comment_parsed' function into the semantic actions trait to avoid name
+        // Insert the fix 'on_comment' function into the semantic actions trait to avoid name
         // clashes with a possible non-terminal 'OnCommentParsed'
-        let on_comment_parsed_id = me.symbol_table.insert_type(
+        let on_comment_id = me.symbol_table.insert_type(
             me.semantic_actions_trait_id.unwrap(),
-            "on_comment_parsed",
+            "on_comment",
             TypeEntrails::Function(Function::default()),
         )?;
-        let function_type_id = me.symbol_table.symbol_as_type(on_comment_parsed_id).my_id();
+        let function_type_id = me.symbol_table.symbol_as_type(on_comment_id).my_id();
         me.symbol_table.insert_instance(
             function_type_id,
             "token",
@@ -243,7 +243,7 @@ impl GrammarTypeInfo {
             )
             .symbols
             .iter()
-            .filter(|s| self.symbol_table.symbol(**s).name() != "on_comment_parsed")
+            .filter(|s| self.symbol_table.symbol(**s).name() != "on_comment")
             .cloned()
             .collect::<Vec<_>>()
     }

crates/parol/src/generators/template_data.rs

@@ -202,16 +202,16 @@ impl std::fmt::Display for UserTraitData<'_> {
                 /// All functions have default implementations."
         )?;
         let user_trait_functions = user_trait_functions.join("\n\n");
-        let on_comment_parsed_comment = r"
+        let on_comment_comment = r"
 
                 /// This method provides skipped language comments.
                 /// If you need comments please provide your own implementation of this method.
             ";
         f.write_fmt(ume::ume! {
             pub trait #trait_name #lifetime {
                 #user_trait_functions
-                #on_comment_parsed_comment
-                fn on_comment_parsed(&mut self, _token: Token #anonymous_lifetime) {}
+                #on_comment_comment
+                fn on_comment(&mut self, _token: Token #anonymous_lifetime) {}
             }
         })?;
 
@@ -351,8 +351,8 @@ impl std::fmt::Display for UserTraitData<'_> {
                         }
                     }
                     #blank_line
-                    fn on_comment_parsed(&mut self, token: Token<'t>) {
-                        self.user_grammar.on_comment_parsed(token)
+                    fn on_comment(&mut self, token: Token<'t>) {
+                        self.user_grammar.on_comment(token)
                     }
                 }
             })?;

crates/parol/src/parser/parol_grammar_trait.rs

@@ -191,7 +191,7 @@ pub trait ParolGrammarTrait<'t> {
 
     /// This method provides skipped language comments.
     /// If you need comments please provide your own implementation of this method.
-    fn on_comment_parsed(&mut self, _token: Token<'t>) {}
+    fn on_comment(&mut self, _token: Token<'t>) {}
 }
 
 // -------------------------------------------------------------------------------------------------
@@ -2950,7 +2950,7 @@ impl<'t> UserActionsTrait<'t> for ParolGrammarAuto<'t, '_> {
         }
     }
 
-    fn on_comment_parsed(&mut self, token: Token<'t>) {
-        self.user_grammar.on_comment_parsed(token)
+    fn on_comment(&mut self, token: Token<'t>) {
+        self.user_grammar.on_comment(token)
     }
 }

crates/parol_runtime/src/lr_parser/parser_types.rs

@@ -315,7 +315,7 @@ impl<'t> LRParser<'t> {
                     self.parse_tree_stack.push(LRParseTree::Terminal(t.clone()));
                 }
                 if t.is_comment_token() {
-                    user_actions.on_comment_parsed(t);
+                    user_actions.on_comment(t);
                 }
                 Ok::<(), ParolError>(())
             })

crates/parol_runtime/src/parser/parser_types.rs

@@ -681,7 +681,7 @@ impl<'t> LLKParser<'t> {
                         })?;
                 }
                 if t.is_comment_token() {
-                    user_actions.on_comment_parsed(t);
+                    user_actions.on_comment(t);
                 }
                 Ok::<(), ParolError>(())
             })

crates/parol_runtime/src/parser/user_access.rs

@@ -28,5 +28,5 @@ pub trait UserActionsTrait<'t> {
     /// This can improve handling of comments that are not captured by the grammar definition
     /// itself.
     ///
-    fn on_comment_parsed(&mut self, _token: Token<'t>);
+    fn on_comment(&mut self, _token: Token<'t>);
 }

examples/basic_interpreter/basic_grammar_trait.rs

@@ -246,7 +246,7 @@ pub trait BasicGrammarTrait<'t> {
 
     /// This method provides skipped language comments.
     /// If you need comments please provide your own implementation of this method.
-    fn on_comment_parsed(&mut self, _token: Token<'t>) {}
+    fn on_comment(&mut self, _token: Token<'t>) {}
 }
 
 // -------------------------------------------------------------------------------------------------
@@ -2854,7 +2854,7 @@ impl<'t> UserActionsTrait<'t> for BasicGrammarAuto<'t, '_> {
         }
     }
 
-    fn on_comment_parsed(&mut self, token: Token<'t>) {
-        self.user_grammar.on_comment_parsed(token)
+    fn on_comment(&mut self, token: Token<'t>) {
+        self.user_grammar.on_comment(token)
     }
 }

examples/boolean_parser/boolean_grammar_trait.rs

@@ -126,7 +126,7 @@ pub trait BooleanGrammarTrait<'t> {
 
     /// This method provides skipped language comments.
     /// If you need comments please provide your own implementation of this method.
-    fn on_comment_parsed(&mut self, _token: Token<'t>) {}
+    fn on_comment(&mut self, _token: Token<'t>) {}
 }
 
 // -------------------------------------------------------------------------------------------------
@@ -1271,7 +1271,7 @@ impl<'t> UserActionsTrait<'t> for BooleanGrammarAuto<'t, '_> {
         }
     }
 
-    fn on_comment_parsed(&mut self, token: Token<'t>) {
-        self.user_grammar.on_comment_parsed(token)
+    fn on_comment(&mut self, token: Token<'t>) {
+        self.user_grammar.on_comment(token)
     }
 }

examples/calc/calc_grammar_trait.rs

@@ -181,7 +181,7 @@ pub trait CalcGrammarTrait<'t> {
 
     /// This method provides skipped language comments.
     /// If you need comments please provide your own implementation of this method.
-    fn on_comment_parsed(&mut self, _token: Token<'t>) {}
+    fn on_comment(&mut self, _token: Token<'t>) {}
 }
 
 // -------------------------------------------------------------------------------------------------
@@ -2099,7 +2099,7 @@ impl<'t> UserActionsTrait<'t> for CalcGrammarAuto<'t, '_> {
         }
     }
 
-    fn on_comment_parsed(&mut self, token: Token<'t>) {
-        self.user_grammar.on_comment_parsed(token)
+    fn on_comment(&mut self, token: Token<'t>) {
+        self.user_grammar.on_comment(token)
     }
 }

examples/calc_lr/calc_grammar_trait.rs

@@ -181,7 +181,7 @@ pub trait CalcGrammarTrait<'t> {
 
     /// This method provides skipped language comments.
     /// If you need comments please provide your own implementation of this method.
-    fn on_comment_parsed(&mut self, _token: Token<'t>) {}
+    fn on_comment(&mut self, _token: Token<'t>) {}
 }
 
 // -------------------------------------------------------------------------------------------------
@@ -2096,7 +2096,7 @@ impl<'t> UserActionsTrait<'t> for CalcGrammarAuto<'t, '_> {
         }
     }
 
-    fn on_comment_parsed(&mut self, token: Token<'t>) {
-        self.user_grammar.on_comment_parsed(token)
+    fn on_comment(&mut self, token: Token<'t>) {
+        self.user_grammar.on_comment(token)
     }
 }

examples/json_parser/json_grammar_trait.rs

@@ -56,7 +56,7 @@ pub trait JsonGrammarTrait<'t> {
 
     /// This method provides skipped language comments.
     /// If you need comments please provide your own implementation of this method.
-    fn on_comment_parsed(&mut self, _token: Token<'t>) {}
+    fn on_comment(&mut self, _token: Token<'t>) {}
 }
 
 // -------------------------------------------------------------------------------------------------
@@ -801,7 +801,7 @@ impl<'t> UserActionsTrait<'t> for JsonGrammarAuto<'t, '_> {
         }
     }
 
-    fn on_comment_parsed(&mut self, token: Token<'t>) {
-        self.user_grammar.on_comment_parsed(token)
+    fn on_comment(&mut self, token: Token<'t>) {
+        self.user_grammar.on_comment(token)
     }
 }

examples/keywords/keywords_grammar_trait.rs

@@ -61,7 +61,7 @@ pub trait KeywordsGrammarTrait<'t> {
 
     /// This method provides skipped language comments.
     /// If you need comments please provide your own implementation of this method.
-    fn on_comment_parsed(&mut self, _token: Token<'t>) {}
+    fn on_comment(&mut self, _token: Token<'t>) {}
 }
 
 // -------------------------------------------------------------------------------------------------
@@ -557,7 +557,7 @@ impl<'t> UserActionsTrait<'t> for KeywordsGrammarAuto<'t, '_> {
         }
     }
 
-    fn on_comment_parsed(&mut self, token: Token<'t>) {
-        self.user_grammar.on_comment_parsed(token)
+    fn on_comment(&mut self, token: Token<'t>) {
+        self.user_grammar.on_comment(token)
     }
 }

examples/keywords2/keywords_grammar_trait.rs

@@ -61,7 +61,7 @@ pub trait KeywordsGrammarTrait<'t> {
 
     /// This method provides skipped language comments.
     /// If you need comments please provide your own implementation of this method.
-    fn on_comment_parsed(&mut self, _token: Token<'t>) {}
+    fn on_comment(&mut self, _token: Token<'t>) {}
 }
 
 // -------------------------------------------------------------------------------------------------
@@ -557,7 +557,7 @@ impl<'t> UserActionsTrait<'t> for KeywordsGrammarAuto<'t, '_> {
         }
     }
 
-    fn on_comment_parsed(&mut self, token: Token<'t>) {
-        self.user_grammar.on_comment_parsed(token)
+    fn on_comment(&mut self, token: Token<'t>) {
+        self.user_grammar.on_comment(token)
     }
 }

examples/list/list_grammar_trait.rs

@@ -42,7 +42,7 @@ pub trait ListGrammarTrait {
 
     /// This method provides skipped language comments.
     /// If you need comments please provide your own implementation of this method.
-    fn on_comment_parsed(&mut self, _token: Token<'_>) {}
+    fn on_comment(&mut self, _token: Token<'_>) {}
 }
 
 // -------------------------------------------------------------------------------------------------
@@ -398,7 +398,7 @@ impl<'t> UserActionsTrait<'t> for ListGrammarAuto<'t, '_> {
         }
     }
 
-    fn on_comment_parsed(&mut self, token: Token<'t>) {
-        self.user_grammar.on_comment_parsed(token)
+    fn on_comment(&mut self, token: Token<'t>) {
+        self.user_grammar.on_comment(token)
     }
 }

examples/list_lr/list_grammar_trait.rs

@@ -37,7 +37,7 @@ pub trait ListGrammarTrait {
 
     /// This method provides skipped language comments.
     /// If you need comments please provide your own implementation of this method.
-    fn on_comment_parsed(&mut self, _token: Token<'_>) {}
+    fn on_comment(&mut self, _token: Token<'_>) {}
 }
 
 // -------------------------------------------------------------------------------------------------
@@ -321,7 +321,7 @@ impl<'t> UserActionsTrait<'t> for ListGrammarAuto<'t, '_> {
         }
     }
 
-    fn on_comment_parsed(&mut self, token: Token<'t>) {
-        self.user_grammar.on_comment_parsed(token)
+    fn on_comment(&mut self, token: Token<'t>) {
+        self.user_grammar.on_comment(token)
     }
 }

examples/oberon2/oberon2_grammar_trait.rs

@@ -386,7 +386,7 @@ pub trait Oberon2GrammarTrait<'t> {
 
     /// This method provides skipped language comments.
     /// If you need comments please provide your own implementation of this method.
-    fn on_comment_parsed(&mut self, _token: Token<'t>) {}
+    fn on_comment(&mut self, _token: Token<'t>) {}
 }
 
 // -------------------------------------------------------------------------------------------------
@@ -7247,7 +7247,7 @@ impl<'t> UserActionsTrait<'t> for Oberon2GrammarAuto<'t, '_> {
         }
     }
 
-    fn on_comment_parsed(&mut self, token: Token<'t>) {
-        self.user_grammar.on_comment_parsed(token)
+    fn on_comment(&mut self, token: Token<'t>) {
+        self.user_grammar.on_comment(token)
     }
 }

examples/oberon_0/oberon_0_grammar_trait.rs

@@ -256,7 +256,7 @@ pub trait Oberon0GrammarTrait<'t> {
 
     /// This method provides skipped language comments.
     /// If you need comments please provide your own implementation of this method.
-    fn on_comment_parsed(&mut self, _token: Token<'t>) {}
+    fn on_comment(&mut self, _token: Token<'t>) {}
 }
 
 // -------------------------------------------------------------------------------------------------
@@ -4847,7 +4847,7 @@ impl<'t> UserActionsTrait<'t> for Oberon0GrammarAuto<'t, '_> {
         }
     }
 
-    fn on_comment_parsed(&mut self, token: Token<'t>) {
-        self.user_grammar.on_comment_parsed(token)
+    fn on_comment(&mut self, token: Token<'t>) {
+        self.user_grammar.on_comment(token)
     }
 }

examples/scanner_states/scanner_states_grammar_trait.rs

@@ -66,7 +66,7 @@ pub trait ScannerStatesGrammarTrait<'t> {
 
     /// This method provides skipped language comments.
     /// If you need comments please provide your own implementation of this method.
-    fn on_comment_parsed(&mut self, _token: Token<'t>) {}
+    fn on_comment(&mut self, _token: Token<'t>) {}
 }
 
 // -------------------------------------------------------------------------------------------------
@@ -666,7 +666,7 @@ impl<'t> UserActionsTrait<'t> for ScannerStatesGrammarAuto<'t, '_> {
         }
     }
 
-    fn on_comment_parsed(&mut self, token: Token<'t>) {
-        self.user_grammar.on_comment_parsed(token)
+    fn on_comment(&mut self, token: Token<'t>) {
+        self.user_grammar.on_comment(token)
     }
 }

examples/scanner_states_lr/scanner_states_grammar_trait.rs

@@ -66,7 +66,7 @@ pub trait ScannerStatesGrammarTrait<'t> {
 
     /// This method provides skipped language comments.
     /// If you need comments please provide your own implementation of this method.
-    fn on_comment_parsed(&mut self, _token: Token<'t>) {}
+    fn on_comment(&mut self, _token: Token<'t>) {}
 }
 
 // -------------------------------------------------------------------------------------------------
@@ -693,7 +693,7 @@ impl<'t> UserActionsTrait<'t> for ScannerStatesGrammarAuto<'t, '_> {
         }
     }
 
-    fn on_comment_parsed(&mut self, token: Token<'t>) {
-        self.user_grammar.on_comment_parsed(token)
+    fn on_comment(&mut self, token: Token<'t>) {
+        self.user_grammar.on_comment(token)
     }
 }