Merge pull request #361 from Schottkyc137/lint-sensitivity-lists

Add a linter for sensitivity lists

Author: Schottkyc137

vhdl_lang/src/ast/search.rs

@@ -508,6 +508,24 @@ impl Search for SensitivityList {
     }
 }
 
+impl Search for ProcessStatement {
+    fn search(&self, ctx: &dyn TokenAccess, searcher: &mut impl Searcher) -> SearchResult {
+        let ProcessStatement {
+            postponed: _,
+            sensitivity_list,
+            decl,
+            statements,
+            end_label_pos: _,
+            ..
+        } = self;
+        if let Some(sensitivity_list) = sensitivity_list {
+            return_if_found!(sensitivity_list.item.search(ctx, searcher));
+        }
+        return_if_found!(decl.search(ctx, searcher));
+        statements.search(ctx, searcher)
+    }
+}
+
 impl Search for LabeledConcurrentStatement {
     fn search(&self, ctx: &dyn TokenAccess, searcher: &mut impl Searcher) -> SearchResult {
         return_if_found!(searcher
@@ -523,19 +541,7 @@ impl Search for LabeledConcurrentStatement {
                 return_if_found!(block.statements.search(ctx, searcher));
             }
             ConcurrentStatement::Process(ref process) => {
-                let ProcessStatement {
-                    postponed: _,
-                    sensitivity_list,
-                    decl,
-                    statements,
-                    end_label_pos: _,
-                    ..
-                } = process;
-                if let Some(sensitivity_list) = sensitivity_list {
-                    return_if_found!(sensitivity_list.item.search(ctx, searcher));
-                }
-                return_if_found!(decl.search(ctx, searcher));
-                return_if_found!(statements.search(ctx, searcher));
+                return_if_found!(process.search(ctx, searcher));
             }
             ConcurrentStatement::ForGenerate(ref gen) => {
                 return_if_found!(searcher

vhdl_lang/src/ast/util.rs

@@ -339,6 +339,19 @@ impl Name {
         }
     }
 
+    /// Like [self.get_suffix_reference], but disregards final indexes, such as
+    /// `foo.bar.baz(0)`
+    pub fn get_suffix_reference_disregard_index(&self) -> Option<EntityId> {
+        use Name::*;
+        match self {
+            Designator(suffix) => suffix.reference.get(),
+            Selected(_, suffix) => suffix.item.reference.get(),
+            Slice(name, _) => name.item.get_suffix_reference_disregard_index(),
+            CallOrIndexed(coi) => coi.name.item.get_suffix_reference_disregard_index(),
+            _ => None,
+        }
+    }
+
     pub fn prefix(&self) -> Option<&Designator> {
         match self {
             Self::Attribute(attr) => attr.name.item.prefix(),

vhdl_lang/src/data/error_codes.rs

@@ -410,6 +410,33 @@ pub enum ErrorCode {
     /// ```
     UnassociatedContext,
 
+    /// A signal is missing in the sensitivity list
+    ///
+    /// # Example
+    /// ```vhdl
+    /// foo: process(y) is
+    /// begin
+    ///     bar <= x;
+    /// end;
+    /// ```
+    ///
+    /// The signal `x` is read by the process `foo`, but it is not part
+    /// of the sensitivity list.
+    MissingInSensitivityList,
+
+    /// A signal is present in a sensitivity list, but never used
+    ///
+    /// # Example
+    /// ```vhdl
+    /// foo: process(x, y) is
+    /// begin
+    ///     bar <= x;
+    /// end;
+    /// ```
+    ///
+    /// Both signals `x` and `y` are specified in the process, but only x is read.
+    SuperfluousInSensitivityList,
+
     // Misc
     /// An internal error that signifies that some precondition within vhdl_lang wasn't met.
     /// If an error with this error code occurs,
@@ -494,7 +521,9 @@ impl Default for SeverityMap {
             | InvalidCall => Some(Error),
             Unused
             | UnnecessaryWorkLibrary
-            | UnassociatedContext => Some(Warning),
+            | UnassociatedContext
+            | MissingInSensitivityList
+            | SuperfluousInSensitivityList => Some(Warning),
             Internal => Some(Error),
             Related => Some(Hint)
         };

vhdl_lang/src/lint.rs

@@ -5,3 +5,4 @@
 // Copyright (c) 2022, Olof Kraigher [email protected]
 
 pub mod dead_code;
+pub mod sensitivity_list;