Merge remote branch 'origin/master' into edge

Author: automatic-merge

README.md

@@ -144,6 +144,8 @@ formatting might no succeed on incomplete/illegal code.
 
 You can use the VS Code `Issue Reporter` to report issues. Just click on the `Help -> Report Issue` menu, select `An extension` for the `File on` entry and `Language Support for Ada` for the extension name. Put as many information you can in the description, like steps to reproduce, stacktraces or system information (VS Code automatically includes it by default). This will create a GitHub issue in the [Ada Language Server](https://github.com/AdaCore/ada_language_server/) repository.
 
+ALS log files can be found under the `~/.als` directory (`%USERPROFILE%/.als` on Windows). Feel free to attach them on the issues, it helps a lot for further investigation, specially when the `ALS.IN` and `ALS.OUT` traces are enabled (more info about traces configuration can be found [here](doc/traces.md).)
+
 
 ### Getting started
 

doc/HACKING.md

@@ -2,11 +2,31 @@
 
 ## Dependencies
 
-The Ada Language Server depends on the following:
+The Ada Language Server depends on a number of tools and libraries listed [on the main page](https://github.com/AdaCore/ada_language_server#dependencies).
 
- * VSS: https://github.com/AdaCore/VSS
- * (optional) ada_libfswatch: https://github.com/AdaCore/ada_libfswatch,
-   to activate filesystem monitoring.
+## Coding
+
+The ALS repository includes a template VS Code workspace at
+`.vscode/settings.json.tmpl`. This allows developers to instantiate the
+workspace locally and customize it to their liking, in particular the
+`terminal.integrated.env.<os>` setting to set `PATH` and `GPR_PROJECT_PATH` as
+needed to provided tools and dependencies to the development environment.
+
+To instantiate the VS Code workspace, simply run `make configure`. Then open VS
+Code at the root of the ALS repository.
+
+At the first run, the workspace will recommend installing a set of extensions
+including a released version of the `Language Support for Ada` extension which
+is produced from this repository. That allows you to work with the Ada codebase
+of the ALS.
+
+## Building
+
+To build the ALS, run:
+
+```sh
+make
+```
 
 ## Debugging
 
@@ -40,7 +60,7 @@ This is very useful to resolve unexpected memory consumption issues.
 
 To get a symbolic backtrace you need the debug information files. For the
 release you can download them from
-[GitHub Release](https://github.com/AdaCore/ada_language_server/releases) 
+[GitHub Release](https://github.com/AdaCore/ada_language_server/releases)
 Assets. Assets contain an archive per platform with the ALS
 executable and debug information files (`.debug` file on Linux/Windows and
 `.dSYM` directory for Mac OS X). Extract the debug information to the directory
@@ -84,30 +104,11 @@ To write a functional test for Ada Language Server:
 
 Run `make vscode-test` to run the VS Code testsuite.
 
-### VS Code grammar tests
-
-The following is under `integration/vscode/ada/`.
-
-The grammars under `syntaxes/` are in production. An advanced classifier for Ada
-is under `advanced/`; this one is not in production at the moment. The testsuite
-supports testing all grammars.
-
-Tests for the grammars are in `testsuite_grammar`, with one test per subdirectory.
-
- * To run the full testsuite, call `./run_grammar_tests.sh`
- * To run one individual test, pass its directory as parameter to
-   that script, for instance `./run_grammar_tests.sh testsuite_grammar/hello`
-
-To create new tests, do the following:
-
-  * Create a directory for it, for instance `testsuite_grammar/newtest`
-  * Add `.ads`, `.adb` or `.gpr` sources in that directory
-  * Run the driver: the first run will create the baselines under the form
-    of `.snap.syntaxes` and `.snap.advanced` files.
+If you open the ALS repository in VS Code, it is also possible to run VS Code
+integration tests using the provided launch configurations:
 
-The engine for the test driver is implemented using
-[vscode-tmgrammartest](https://github.com/PanAeon/vscode-tmgrammar-test):
-see the full documentation there.
+- `(vscode) Run testsuite 'general'`
+- `(vscode) Run testsuite 'gnattest'`
 
 ### Other tests
 

integration/vscode/ada/test/suite/general/tasks.test.ts

@@ -140,7 +140,7 @@ suite('GPR Tasks Provider', function () {
         // via project attributes
         const expectedCmd = `gprbuild -P ${def.configuration.projectFile} ${
             def.configuration.main ?? ''
-        } -cargs -gnatef && obj/main1exec`;
+        } -cargs -gnatef && obj/main1exec${process.platform == 'win32' ? '.exe' : ''}`;
 
         assert.strictEqual(actualCmd, expectedCmd);
     });

scripts/replay.py

@@ -1,25 +1,44 @@
 #!/usr/bin/env python
 
-""" Development utility to replay the most recent trace file, and output it
-as protocol strings. This assumes that the trace file is in ~/.als/in.txt
-
-To use this, do
-
-   replay.py > log
-
-then you can replay at will with
+"""
+Development utility to replay an ALS session based on a log file containing
+the ALS.IN and ALS.OUT traces, and output it as protocol strings.
 
-  ada_language_server < log
+Usage: replay.py --log-file <path_to_log_file> --output-file <output_file>
 """
 
-import os
+import argparse
 from json_transformations import python_to_protocol_string, traces_to_test
 
-als_dir = os.path.join(os.path.expanduser('~'), '.als')
-inout_file = os.path.join(als_dir, 'inout.txt')
+
+argParser = argparse.ArgumentParser()
+argParser.add_argument(
+    "-l",
+    "--log-file",
+    help="Path to the log file containing ALS.IN and ALS.OUT traces.",
+    required=True,
+)
+argParser.add_argument(
+    "-o",
+    "--output-file",
+    help="Path to the output file containing all the ALS requests retrieved "
+    + "from the log file. Then you can replay a session like this: "
+    + "ada_language_server < <output_file>",
+    required=False,
+)
+args = argParser.parse_args()
+
+inout_file = args.log_file
+output_file = args.output_file
 test = traces_to_test(inout_file, None, True)
 result = ""
 for x in test:
     if "send" in x:
         result += python_to_protocol_string([x["send"]["request"]])
-print(result + "\r")
+
+# Print on stdout if no output file has been specified
+if output_file:
+    with open(output_file, "w") as file:
+        file.write(result + "\r")
+else:
+    print(result + "\r")

source/ada/lsp-ada_handlers-symbols.adb

@@ -302,12 +302,47 @@ package body LSP.Ada_Handlers.Symbols is
 
          for Child of Node.Children loop
             if not Child.Is_Null then
-               Walk (Child, Next_Level, Children);
+               Walk
+                 (Node         => Child,
+                  Nested_Level => Next_Level,
+                  Vector       => Children);
                exit when Self.Is_Canceled.all;
             end if;
          end loop;
 
          case Node.Kind is
+         when Libadalang.Common.Ada_Ada_Node_List_Range =>
+
+            --  Check if we are dealing with a list of with-clauses nodes
+            --  ('namespace' symbol kind). If yes, create a 'fake' parent
+            --  item called 'With clauses' and put every with-clause within it.
+            if Children.Length > 0 then
+               declare
+                  First_Item : constant LSP.Structures.DocumentSymbol :=
+                    LSP.Structures.Get_DocumentSymbol_Constant_Reference
+                      (Children, 1);
+                  Package_Deps_Item : LSP.Structures.DocumentSymbol;
+               begin
+                  if First_Item.kind = Namespace then
+                     Package_Deps_Item :=
+                       (name              => VSS.Strings.To_Virtual_String
+                          ("With clauses"),
+                        detail            => VSS.Strings.Empty_Virtual_String,
+                        kind              => Namespace,
+                        deprecated        => (Is_Set => False),
+                        tags              => LSP.Constants.Empty,
+                        a_range           => First_Item.a_range,
+                        selectionRange    => First_Item.a_range,
+                        children          => Children,
+                        others            => <>);
+                     Vector.Append (Package_Deps_Item);
+                  else
+                     for J in 1 .. Children.Length loop
+                        Vector.Append (Children (J));
+                     end loop;
+                  end if;
+               end;
+            end if;
          when Libadalang.Common.Ada_Basic_Decl =>
             declare
                Decl : constant Libadalang.Analysis.Basic_Decl :=