Merge branch 'gs_389' into 'master'

Support global/localVariables in semanticTokenModifiers

See merge request eng/ide/ada_language_server!2108

Author: ogorodnik

CHANGELOG.md

@@ -16,6 +16,7 @@ section below it for the last release. -->
 * Provide an integration of the [e3-testsuite](https://github.com/AdaCore/e3-testsuite) framework with the VS Code testing UI
 * Provide an interactive options picker for GNATprove invocations
 * Automatically open SARIF reports generated by GNATprove
+* New SemanticTokenModifiers for global/local variables have been added.
 
 ## 26.0.202507021
 

doc/Custom-colors-in-VS-Code.md

@@ -56,6 +56,8 @@ Ada Language Server uses next modifiers of tokens:
 | modification   | write access to a name
 | documentation  | ghost code or aspect
 | defaultLibrary | predefined name
+| globalVariable | the variable exists during all time program execution
+| localVariable  | the variable is local for the scope
 
 ## Example
 
@@ -135,6 +137,8 @@ Open `settings.json` and append next:
                 "*.modification": {"bold": true},
                 "*.deprecated": {"strikethrough": true},
                 "*.readonly": "#4FC1FF",
+                "*.globalVariable": "#C92002",
+                "*.localVariable": "#02A322",
                 "property.readonly": "#3E52EB",
                 "typeParameter.readonly": {"foreground": "#3E52EB", "italic": true},
                 "*.documentation": "#6A9955",

doc/extensions.md

@@ -69,6 +69,7 @@ related resources.
  * [Project file](project_file.md)
  * [Source dirs](source_dirs.md)
  * [Workspace symbol params](workspace_symbol_params.md)
+ * [Global/local variables](global_local_variables.md)
 
 ```{toctree}
 :maxdepth: 1

doc/global_local_variables.md

@@ -0,0 +1,17 @@
+# Global/Local Variables highlighting
+
+## Short introduction
+
+This feature uses custom modifiers for `SemanticTokenModifiers` to mark **global** and **local** variables in the `semanticTokens` request.
+
+## Change description
+
+We extend the `SemanticTokenModifiers` by adding extra modifiers:
+
+* `globalVariable`: Marks a **global variable**. This refers to a variable whose **lifetime is the same as the program itself** (program-level visibility and duration). These variables are typically declared in the declarative part of a library-level package:
+    * **Library-level packages**.
+    * **Nested packages**, **Protected Objects** or **Tasks** that are themselves declared at the library level. .
+    
+    The variable exists for the entire program execution and is not local to any locally declared subprogram or block.
+
+* `localVariable`: Marks a **local variable**. This refers to a variable whose name is declared within the **nearest enclosing declarative part** (e.g., within a subprogram body, a block statement). Their scope and lifetime are typically restricted to that specific program element.

source/ada/lsp-ada_highlighters.adb

@@ -17,6 +17,8 @@
 
 with GNATCOLL.Traces;
 
+with Laltools;
+with Laltools.Common;
 with Langkit_Support.Slocs;
 with Langkit_Support.Text;
 with Libadalang.Common; use Libadalang.Common;
@@ -477,6 +479,7 @@ package body LSP.Ada_Highlighters is
       use all type LSP.Enumerations.SemanticTokenTypes;
       use all type LSP.Enumerations.SemanticTokenModifiers;
       use type Libadalang.Analysis.Defining_Name;
+      use type Libadalang.Analysis.Ada_Node;
 
       procedure Highlight_Token
         (Token : Libadalang.Common.Token_Reference;
@@ -497,6 +500,9 @@ package body LSP.Ada_Highlighters is
       function Is_Predefined (Decl : Libadalang.Analysis.Basic_Decl)
         return Boolean;
 
+      procedure Get_Variable_Modifiers (Decl : Libadalang.Analysis.Basic_Decl);
+      --  Add variable's modifiers if Decl is a variable
+
       ------------------
       -- Has_Abstract --
       ------------------
@@ -741,10 +747,70 @@ package body LSP.Ada_Highlighters is
          end case;
       end To_Kind;
 
+      ----------------------------
+      -- Get_Variable_Modifiers --
+      ----------------------------
+
+      procedure Get_Variable_Modifiers
+        (Decl : Libadalang.Analysis.Basic_Decl)
+      is
+         --------------------------
+         -- Investigate_Variable --
+         --------------------------
+
+         procedure Investigate_Variable;
+         procedure Investigate_Variable is
+            use Libadalang.Analysis;
+            use Langkit_Support.Slocs;
+
+            Node_Enclosing_Declarative_Part : constant Declarative_Part :=
+                Laltools.Common.Get_Enclosing_Declarative_Part (Node);
+
+            Parent : Ada_Node;
+         begin
+            if Compare
+               (Node_Enclosing_Declarative_Part.Sloc_Range,
+                Decl.Sloc_Range.Start_Sloc) = Inside
+            then
+               Highlight_Token (Node.Token_Start, localVariable);
+
+            else
+               Parent := Decl.Parent;
+               while not Parent.Is_Null loop
+                  if Parent.Kind in Ada_Subp_Body_Range
+                    or else Parent.Kind in Ada_Entry_Body
+                  then
+                     return;
+                  end if;
+                  Parent := Parent.Parent;
+               end loop;
+
+               Highlight_Token (Node.Token_Start, globalVariable);
+            end if;
+         end Investigate_Variable;
+
+      begin
+         case Decl.Kind is
+            when Ada_Generic_Formal_Obj_Decl =>
+               Investigate_Variable;
+
+            when Ada_Entry_Index_Spec | Ada_Object_Decl |
+                 Ada_Single_Protected_Decl | Ada_Single_Task_Decl =>
+               Investigate_Variable;
+
+            when Ada_For_Loop_Var_Decl |
+                 Ada_Extended_Return_Stmt_Object_Decl =>
+               Highlight_Token (Node.Token_Start, localVariable);
+
+            when others =>
+               null;
+         end case;
+      end Get_Variable_Modifiers;
+
       Failsafe_Decl : Libadalang.Analysis.Refd_Decl;
-      Def  : Libadalang.Analysis.Defining_Name;
-      Decl : Libadalang.Analysis.Basic_Decl;
-      Kind : LSP.Enumerations.SemanticTokenTypes;
+      Def           : Libadalang.Analysis.Defining_Name;
+      Decl          : Libadalang.Analysis.Basic_Decl;
+      Kind          : LSP.Enumerations.SemanticTokenTypes;
    begin
       if Node.Kind not in Ada_Identifier | Ada_String_Literal then
          --  Highlight only identifiers and operator symbols
@@ -753,11 +819,10 @@ package body LSP.Ada_Highlighters is
 
       if Node.P_Is_Defining then
          Def := Node.P_Enclosing_Defining_Name;
-
          begin
             declare
                Is_Canonical : constant Boolean :=
-                  not Def.Is_Null and then Def.P_Canonical_Part = Def;
+                 not Def.Is_Null and then Def.P_Canonical_Part = Def;
             begin
                if Is_Canonical then
                   Highlight_Token (Node.Token_Start, declaration);
@@ -795,6 +860,14 @@ package body LSP.Ada_Highlighters is
                Highlight_Token (Node.Token_Start, Kind);
             end if;
 
+            if Kind = variable
+              --  not a declaration itself
+              and then Laltools.Common.
+                Find_First_Common_Parent (Decl, Node, True) /= Decl
+            then
+               Get_Variable_Modifiers (Decl);
+            end if;
+
             begin
                if Kind in variable | parameter | typeParameter | property
                  and then Decl.P_Is_Constant_Object
@@ -961,6 +1034,8 @@ package body LSP.Ada_Highlighters is
       Append_Modifier (modification, "modification");
       Append_Modifier (documentation, "documentation");
       Append_Modifier (defaultLibrary, "defaultLibrary");
+      Append_Modifier (globalVariable, "globalVariable");
+      Append_Modifier (localVariable, "localVariable");
 
       Obsolescent := +"Obsolescent";
       Ada_Package := +"Ada";

testsuite/ada_lsp/highlight_variables/a.adb

@@ -0,0 +1,18 @@
+
+with Ada.Text_IO;
+
+package body A is
+
+   C : Boolean := True;
+
+   -----------
+   -- Print --
+   -----------
+
+   procedure Print is
+      B : Boolean := True;
+   begin
+      Ada.Text_IO.Put_Line (B'Img & C'Img);
+   end Print;
+
+end A;

testsuite/ada_lsp/highlight_variables/a.ads

@@ -0,0 +1,5 @@
+package A is
+
+   procedure Print;
+
+end A;

testsuite/ada_lsp/highlight_variables/hello.gpr

@@ -0,0 +1,8 @@
+project Hello is
+
+   for Source_Dirs use (".");
+   for Object_Dir use "obj";
+   for Main use ("main.adb");
+   
+end Hello;
+

testsuite/ada_lsp/highlight_variables/main.adb

@@ -0,0 +1,7 @@
+
+with A;
+
+procedure Main is
+begin
+   A.Print;
+end Main;