Merge branch 'main' into fix-off-by-one-line-reporting

Author: jvsqzj

CHANGELOG.md

@@ -4,12 +4,29 @@
 -->
 # Change Log
 
+## 0.9.13
+- Corrected the name of "explicit\_param\_decls" provisional. Note that it still
+  has no semantic effect.
+- The parameter declaration patterns ":=" and ": \<type\> = \<val\>" are now
+  correctly parsed.
+- You can now annotate dml source to disable reporting of specific lints for specific files or lines,
+  see [USAGE.md](USAGE.md) for instructions on how to use it
+- Disabled the invariant check for the parameter 'size' to be set on register
+  objects. Will be re-enabled when constant-folding is added to the DLS.
+- Fixed issue where statements under top-level in-eachs were not correctly tracked.
+- Moved storage of reference->symbol mapping to on-demand timing, should significantly speed
+  up device analysises
+
 ## 0.9.12
 - Added 'simics\_util\_vect' as a known provisional (with no DLS semantics)
 - Diagnostics sent from the server will now indicate their source as 'dml' or 'dml-lint'
 - Linting warnings can now annotate their messages with which linting rule enforces it. You can turn this off by setting 'annotate_lints' to 'false' in your lint config file
 - Minor fixes to the description of linting messages
 - Fixed an issue where diagnostics would sometime be reported within the wrong file
+- Corrected incorrect parsing around tuple-declared 'local' variables in for-loops
+- Added the ability to declare 'saved' or 'session' variables in for-loops
+- Added functionality for goto-def/decl/ref to or from variables declared
+  within a function scope.
 
 ## 0.9.11
 - Fixed deadlock when a configuration update happens

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "dls"
-version = "0.9.12"
+version = "0.9.13"
 edition = "2018"
 authors = []
 description = "Simics DML language server"

README.md

@@ -9,7 +9,7 @@ editors, and other tools with information about DML device and common code.
 It currently supports basic syntax error reporting, symbol search,
 'goto-definition', 'goto-implementation', 'goto-reference', and 'goto-base'.
 It also has some basic configurable linting support, in the form of warning
-messages.
+messages. For user-targeted instructions, see [USAGE.md](USAGE.md).
 
 Future planned features are extended semantic and type analysis, basic
 refactoring patterns, improved language construct templates, renaming

USAGE.md

@@ -0,0 +1,47 @@
+<!--
+  © 2024 Intel Corporation
+  SPDX-License-Identifier: Apache-2.0 and MIT
+-->
+# Usage Instructions
+This document describes general instructions and advice directed at
+end-users of the DML language server. For advice or details on
+client implementation see [clients.md](clients.md). This document
+_only_ pertains to details that are client-agnostic. For client-specific
+details consult the documentation of the client.
+
+As this file is currently a work in progress, relevant details may be
+missing or incomplete.
+
+## In-Line Linting Configuration
+It may be desireable to control linting on a per-file basis, rather than
+relying on the linting configuration. This can be done with in-line
+linting configuration inside comments.
+
+The general syntax is:
+`// dls-lint: <command>=<target>`
+Note that only one-line comments are allowed, and only if no text is between
+the comment start and 'dls-lint'.
+
+Currently supported commands are:
+* 'allow-file' Will not report the lint rule specified by \<target> for the
+   entire file, regardless of where 'allow-file' is declared
+* 'allow' Will not report the lint rule specified by \<target> for the next
+   line without a leading comment, or for the current line if declared
+   outside a leading comment.
+
+Lint warnings will report which rule caused them in their message, which is the
+same identifier used for \<target>.
+
+For example
+```
+// dls-lint: allow-file=long_lines
+method now_we_can_declare_this_method_with_a_really_really_really_really_long name() {
+
+// dls-lint: allow=nsp_unary
+// dls-lint: allow=indent_no_tabs
+	param p = (1 ++ *
+            4); // dls-lint: allow=indent_paren_expr
+}
+```
+Will allow 'long_lines' globally, 'nsp_unary' and 'indent_no_tabs' on the
+`param p = (1 ++ *` line, and 'indent_paren_expr' on the `'4);` line.

src/actions/requests.rs

@@ -8,7 +8,6 @@ use serde::{Deserialize, Serialize};
 use serde_json::Value;
 use std::collections::HashSet;
 use std::path::Path;
-use std::sync::Arc;
 
 use crate::actions::hover;
 use crate::actions::{AnalysisProgressKind, AnalysisWaitKind,
@@ -192,7 +191,6 @@ fn fp_to_symbol_refs<O: Output>
             for device in analysis.filtered_device_analysises_containing_file(
                 &canon_path,
                 filter.as_ref()) {
-                debug!("reference info is {:?}", device.reference_info.keys());
                 // NOTE: This ends up being the correct place to warn users
                 // about references inside uninstantiated templates,
                 // but we have to perform some extra work to find out we are
@@ -206,12 +204,9 @@ fn fp_to_symbol_refs<O: Output>
                             any_template_used = true;
                         }
                 }
-                if let Some(defs) = device.reference_info.get(
-                    refr.loc_span()) {
-                    for def in defs {
-                        definitions.push(Arc::clone(def));
-                    }
-                }
+
+                definitions.append(
+                    &mut device.symbols_of_ref(*refr.loc_span()));
             }
             if let Some(ContextKey::Template(_)) = first_context {
                 if !any_template_used {