Rework and improve limitation messaging

Signed-off-by: Jonatan Waern<[email protected]>

Author: JonatanWaern

CHANGELOG.md

@@ -5,7 +5,8 @@
 # Change Log
 
 # 0.9.15
-
+- Improved feedback to user when attempting to obtain symbol information on
+  a symbol inside an unused template.
 
 ## 0.9.14
 - Slight optimization to the memory usage of device-level analysis which

src/actions/requests.rs

@@ -15,7 +15,9 @@ use crate::actions::{AnalysisProgressKind, AnalysisWaitKind,
                      ContextDefinition, InitActionContext,
                      rpc_error_code};
 use crate::actions::notifications::ContextDefinitionKindParam;
-use crate::analysis::{ZeroSpan, ZeroFilePosition, SymbolRef};
+use crate::analysis::{Named, DeclarationSpan, LocationSpan, DLSLimitation,
+                      SymbolRef, ZeroFilePosition, ZeroSpan,
+                      isolated_template_limitation};
 use crate::analysis::reference::ReferenceKind;
 use crate::analysis::symbols::SimpleSymbol;
 use crate::config::Config;
@@ -43,8 +45,7 @@ pub use crate::lsp_data::request::{
 };
 
 pub use crate::lsp_data::{self as lsp_data, *};
-use crate::analysis::{Named, DeclarationSpan, LocationSpan,
-                      DLSLimitation, ISOLATED_TEMPLATE_LIMITATION};
+
 use crate::analysis::structure::objects::CompObjectKind;
 
 use crate::analysis::scope::{SymbolContext, SubSymbol, ContextKey, Scope};
@@ -127,11 +128,13 @@ where
 }
 
 
-pub const TYPE_SEMANTIC_LIMITATION: DLSLimitation = DLSLimitation {
-    issue_num: 65,
-    description: "The DLS does not currently support semantic analysis of \
-                  types, including reference finding",
-};
+pub fn type_semantic_limitation() -> DLSLimitation {
+    DLSLimitation {
+        issue_num: 65,
+        description: "The DLS does not currently support semantic analysis of \
+                      types, including reference finding".to_string(),
+    }
+}
 
 // TODO: This function is getting bloated, refactor into several smaller ones
 fn fp_to_symbol_refs<O: Output>
@@ -185,7 +188,7 @@ fn fp_to_symbol_refs<O: Output>
             // Should be guaranteed by the context reference lookup above
             // (isolated analysis does exist)
             if refr.reference_kind() == ReferenceKind::Type {
-                relevant_limitations.insert(TYPE_SEMANTIC_LIMITATION);
+                relevant_limitations.insert(type_semantic_limitation());
             }
 
             let first_context = analysis.first_context_at_pos(fp).unwrap();
@@ -210,9 +213,11 @@ fn fp_to_symbol_refs<O: Output>
                 definitions.append(
                     &mut device.symbols_of_ref(*refr.loc_span()));
             }
-            if let Some(ContextKey::Template(_)) = first_context {
+            if let Some(ContextKey::Template(templ)) = first_context {
                 if !any_template_used {
-                    relevant_limitations.insert(ISOLATED_TEMPLATE_LIMITATION);
+                    relevant_limitations.insert(
+                        isolated_template_limitation(templ.name.as_str())
+                    );
                 }
             }
         },

src/analysis/mod.rs

@@ -82,17 +82,16 @@ pub const IMPLICIT_IMPORTS: [&str; 2] = ["dml-builtins.dml",
 // The issue number is used as the _unique identifier_ for this
 // limitation, and should be the number of an open GITHUB
 // issue.
-#[allow(dead_code)]
-const EXAMPLE: DLSLimitation =
-    DLSLimitation {
-        issue_num: 42,
-        description: "Example of a DLS limitation",
-    };
+// Example:
+// DLSLimitation {
+//         issue_num: 42,
+//         description: "Example of a DLS limitation".to_string(),
+//     };
 
 #[derive(Clone, Debug, Eq, PartialEq, Hash,)]
 pub struct DLSLimitation {
     pub issue_num: u64,
-    pub description: &'static str,
+    pub description: String,
 }
 
 impl fmt::Display for DLSLimitation {
@@ -555,11 +554,17 @@ fn gather_scopes<'c>(next_scopes: Vec<&'c dyn Scope>,
     }
 }
 
-pub const ISOLATED_TEMPLATE_LIMITATION: DLSLimitation = DLSLimitation {
-    issue_num: 31,
-    description: "References from, and definitions inside, templates cannot \
-                  be evaluated without an instantiating object",
-};
+pub fn isolated_template_limitation(template_name: &str) -> DLSLimitation {
+    DLSLimitation {
+        issue_num: 31,
+        description:
+        format!("References from, and definitions inside, a template \
+                 cannot be evaluated \
+                 without an instantiating object. Open a device file \
+                 that uses the template '{}' to obtain such information.",
+                 template_name),
+    }
+}
 
 impl DeviceAnalysis {
     pub fn get_device_obj(&self) -> &DMLObject {
@@ -731,7 +736,9 @@ impl DeviceAnalysis {
                                 .get(loc))
                     {
                         if templ_impls.is_empty() {
-                            limitations.insert(ISOLATED_TEMPLATE_LIMITATION);
+                            limitations.insert(
+                                isolated_template_limitation(&templ.name)
+                            );
                         }
                         return self.contexts_to_objs(
                             templ_impls