Add is_third_party library config

Author: kraigher

vhdl_lang/src/config.rs

@@ -25,6 +25,7 @@ pub struct Config {
 pub struct LibraryConfig {
     name: String,
     patterns: Vec<String>,
+    pub(crate) is_third_party: bool,
 }
 
 impl LibraryConfig {
@@ -156,11 +157,23 @@ impl Config {
                 patterns.push(path);
             }
 
+            let mut is_third_party = false;
+            if let Some(opt) = lib.get("is_third_party") {
+                if let Some(opt) = opt.as_bool() {
+                    is_third_party = opt;
+                } else {
+                    return Err(format!(
+                        "Expected is_third_party to be boolean for library {name}"
+                    ));
+                }
+            }
+
             libraries.insert(
                 name.to_owned(),
                 LibraryConfig {
                     name: name.to_owned(),
                     patterns,
+                    is_third_party,
                 },
             );
         }
@@ -199,13 +212,7 @@ impl Config {
                     &library.name
                 )));
             } else {
-                self.libraries.insert(
-                    library.name.clone(),
-                    LibraryConfig {
-                        name: library.name.clone(),
-                        patterns: library.patterns.clone(),
-                    },
-                );
+                self.libraries.insert(library.name.clone(), library.clone());
             }
         }
     }

vhdl_lang/src/lint/dead_code.rs

@@ -18,6 +18,7 @@ use crate::data::DiagnosticHandler;
 use crate::data::Symbol;
 use crate::syntax::TokenAccess;
 use crate::AnyEntKind;
+use crate::Config;
 use crate::Design;
 use crate::Diagnostic;
 use crate::EntRef;
@@ -206,6 +207,7 @@ impl UnusedDeclarationsLinter {
     pub fn lint(
         &mut self,
         root: &DesignRoot,
+        config: &Config,
         analyzed_units: &[UnitId],
         diagnostics: &mut dyn DiagnosticHandler,
     ) {
@@ -229,11 +231,6 @@ impl UnusedDeclarationsLinter {
             let key = (unit.library_name().clone(), unit.primary_name().clone());
 
             if let Some(library) = root.get_lib(unit.library_name()) {
-                if *library.name() == root.symbol_utf8("ieee") {
-                    // Do not check dead code in ieee library
-                    continue;
-                }
-
                 self.diagnostics.entry(key).or_insert_with(|| {
                     find_unused_declarations(root, library, unit.primary_name())
                         .into_iter()
@@ -248,8 +245,12 @@ impl UnusedDeclarationsLinter {
             }
         }
 
-        for unit_diagnostics in self.diagnostics.values() {
-            diagnostics.append(unit_diagnostics.iter().cloned());
+        for ((library_name, _), unit_diagnostics) in self.diagnostics.iter() {
+            if let Some(library_config) = config.get_library(&library_name.name_utf8()) {
+                if !library_config.is_third_party {
+                    diagnostics.append(unit_diagnostics.iter().cloned());
+                }
+            }
         }
     }
 }

vhdl_lang/src/main.rs

@@ -70,15 +70,15 @@ fn main() {
         let iterations = 10;
         println!("Running {iterations} iterations for benchmarking");
         for _ in 0..(iterations - 1) {
-            let mut project = Project::from_config(&config, &mut NullMessages);
+            let mut project = Project::from_config(config.clone(), &mut NullMessages);
             project.analyse();
         }
         iterations
     } else {
         1
     };
 
-    let mut project = Project::from_config(&config, &mut msg_printer);
+    let mut project = Project::from_config(config, &mut msg_printer);
     let mut diagnostics = project.analyse();
     let duration = start.elapsed().unwrap() / iterations;
 

vhdl_lang/src/project.rs

@@ -16,6 +16,7 @@ use std::path::{Path, PathBuf};
 
 pub struct Project {
     parser: VHDLParser,
+    config: Config,
     root: DesignRoot,
     files: FnvHashMap<PathBuf, SourceFile>,
     empty_libraries: FnvHashSet<Symbol>,
@@ -31,24 +32,24 @@ impl Project {
             empty_libraries: FnvHashSet::default(),
             parser,
             lint: Default::default(),
+            config: Config::default(),
         }
     }
 
     /// Create instance from given configuration.
     /// Files referred by configuration are parsed into corresponding libraries.
-    pub fn from_config(config: &Config, messages: &mut dyn MessageHandler) -> Project {
+    pub fn from_config(config: Config, messages: &mut dyn MessageHandler) -> Project {
         let mut project = Project::new();
-
-        let files = project.load_files_from_config(config, messages);
+        let files = project.load_files_from_config(&config, messages);
         project.parse_and_add_files(files, messages);
-
+        project.config = config;
         project
     }
 
     /// Replace active project configuration.
     /// The design state is reset, new files are added and parsed. Existing source files will be
     /// kept and parsed from in-memory source (required for incremental document updates).
-    pub fn update_config(&mut self, config: &Config, messages: &mut dyn MessageHandler) {
+    pub fn update_config(&mut self, config: Config, messages: &mut dyn MessageHandler) {
         self.parser = VHDLParser::default();
         self.root = DesignRoot::new(self.parser.symbols.clone());
 
@@ -61,7 +62,7 @@ impl Project {
         // Files might already be part of self.files, these have to be parsed
         // from in-memory source. New files can be parsed as usual.
         let (known_files, new_files) = self
-            .load_files_from_config(config, messages)
+            .load_files_from_config(&config, messages)
             .into_iter()
             .partition(|(file_name, _library_names)| self.files.contains_key(file_name));
 
@@ -75,6 +76,7 @@ impl Project {
             }
         }
 
+        self.config = config;
         self.parse_and_add_files(new_files, messages);
     }
 
@@ -227,7 +229,7 @@ impl Project {
 
         let analyzed_units = self.root.analyze(&mut diagnostics);
         self.lint
-            .lint(&self.root, &analyzed_units, &mut diagnostics);
+            .lint(&self.root, &self.config, &analyzed_units, &mut diagnostics);
 
         diagnostics
     }
@@ -384,15 +386,15 @@ lib.files = ['file.vhd']
 
         let config = Config::from_str(config_str, root.path()).unwrap();
         let mut messages = Vec::new();
-        let mut project = Project::from_config(&config, &mut messages);
+        let mut project = Project::from_config(config, &mut messages);
         assert_eq!(messages, vec![]);
         check_no_diagnostics(&project.analyse());
     }
 
     #[test]
     fn unmapped_libraries_are_analyzed() {
         let mut messages = Vec::new();
-        let mut project = Project::from_config(&Config::default(), &mut messages);
+        let mut project = Project::from_config(Config::default(), &mut messages);
         assert_eq!(messages, vec![]);
         let diagnostics = project.analyse();
         check_no_diagnostics(&diagnostics);
@@ -466,7 +468,7 @@ use_lib.files = ['use_file.vhd']
 
         let config = Config::from_str(config_str, root.path()).unwrap();
         let mut messages = Vec::new();
-        let mut project = Project::from_config(&config, &mut messages);
+        let mut project = Project::from_config(config, &mut messages);
         assert_eq!(messages, vec![]);
         check_no_diagnostics(&project.analyse());
     }
@@ -516,7 +518,7 @@ lib2.files = ['file2.vhd']
 
         let config = Config::from_str(config_str, &root).unwrap();
         let mut messages = Vec::new();
-        let mut project = Project::from_config(&config, &mut messages);
+        let mut project = Project::from_config(config, &mut messages);
         assert_eq!(messages, vec![]);
         check_no_diagnostics(&project.analyse());
 
@@ -621,7 +623,7 @@ lib.files = ['file2.vhd']
         let config2 = Config::from_str(config_str2, &root).unwrap();
 
         let mut messages = Vec::new();
-        let mut project = Project::from_config(&config1, &mut messages);
+        let mut project = Project::from_config(config1, &mut messages);
         assert_eq!(messages, vec![]);
 
         // Invalid library should only be reported in source1
@@ -631,7 +633,7 @@ lib.files = ['file2.vhd']
         assert_eq!(diagnostics[1].pos.source, source1); // No declaration
 
         // Change configuration file
-        project.update_config(&config2, &mut messages);
+        project.update_config(config2, &mut messages);
         assert_eq!(messages, vec![]);
 
         // Invalid library should only be reported in source2

vhdl_libraries/vhdl_ls.toml

@@ -1,9 +1,7 @@
 [libraries]
-std.files = [
-'std/*.vhd',
-]
-ieee.files = [
-'ieee2008/*.vhdl',
-'synopsys/*.vhdl',
-'vital2000/*.vhdl',
-]
+
+std.files = ['std/*.vhd']
+std.is_third_party = true
+
+ieee.files = ['ieee2008/*.vhdl', 'synopsys/*.vhdl', 'vital2000/*.vhdl']
+ieee.is_third_party = true

vhdl_ls/src/vhdl_server.rs

@@ -110,7 +110,7 @@ impl VHDLServer {
     pub fn initialize_request(&mut self, init_params: InitializeParams) -> InitializeResult {
         self.config_file = self.root_uri_config_file(&init_params);
         let config = self.load_config();
-        self.project = Project::from_config(&config, &mut self.message_filter());
+        self.project = Project::from_config(config, &mut self.message_filter());
         self.init_params = Some(init_params);
         let trigger_chars: Vec<String> = r".".chars().map(|ch| ch.to_string()).collect();
 
@@ -255,7 +255,7 @@ impl VHDLServer {
                 let config = self.load_config();
 
                 self.project
-                    .update_config(&config, &mut self.message_filter());
+                    .update_config(config, &mut self.message_filter());
                 self.publish_diagnostics();
             }
         }