Improve README.md and code comments

reznikmm · reznikmm · commit eb9fb7d3c107 · 2023-02-10T12:00:50.000+02:00
diff --git a/README.md b/README.md
@@ -33,10 +33,6 @@ extension at
     - [Dependencies](#dependencies)
   - [Usage](#usage)
   - [Supported LSP Server Requests](#supported-lsp-server-requests)
-    - [General Requests](#general-requests)
-    - [Workspace Requests](#workspace-requests)
-    - [Synchronization Requests](#synchronization-requests)
-    - [Text Document Requests](#text-document-requests)
     - [Protocol extensions](#protocol-extensions)
   - [How to use the VScode extension](#how-to-use-the-vscode-extension)
     - [Getting started](#getting-started)
@@ -45,12 +41,13 @@ extension at
     - [Commands and shortcuts](#commands-and-shortcuts)
     - [Launch the extension to debug it](#launch-the-extension-to-debug-it)
     - [Configuration](#configuration)
-  - [Integration with Coc.NVim](#integration-with-cocnvim)
-  - [Integration with vim-lsp](#integration-with-vim-lsp)
-  - [Integration with LanguageClient-Neovim](#integration-with-languageclient-neovim)
-  - [Integration with Neovim's built-in LSP client](#integration-with-neovims-built-in-lsp-client)
+  - [Integration with other editors and IDEs](#integration-with-other-editors-and-ides)
+    - [Integration with Coc.NVim](#integration-with-cocnvim)
+    - [Integration with vim-lsp](#integration-with-vim-lsp)
+    - [Integration with LanguageClient-Neovim](#integration-with-languageclient-neovim)
+    - [Integration with Neovim's built-in LSP client](#integration-with-neovims-built-in-lsp-client)
     - [Integration with emacs lsp-mode](#integration-with-emacs-lsp-mode)
-  - [Integration with QtCreator](#integration-with-qtcreator)
+    - [Integration with QtCreator](#integration-with-qtcreator)
   - [Refactoring Tools](#refactoring-tools)
   - [Authors & Contributors](#authors--contributors)
   - [Contribute](#contribute)
@@ -78,7 +75,7 @@ To build the language server you need:
 * The [VSS](https://github.com/AdaCore/VSS) library
 * The [gnatdoc](https://github.com/AdaCore/gnatdoc) library
 * The [gpr](https://github.com/AdaCore/gpr) library
-* The a process [spawn](https://github.com/AdaCore/spawn) library
+* The process [spawn](https://github.com/AdaCore/spawn) library
 
 Project files of the libraries must be available via the `GPR_PROJECT_PATH`
 environment variable.
@@ -127,6 +124,11 @@ formatting might no succeed on incomplete/illegal code.
 
 * **Toooling support**: we currently provide minimal support for *SPARK* (see *Prove/Examine* tasks in the [Auto-detected tasks](#auto-detected-tasks) section), but there is no support for tools such as *CodePeer*, *GNATcheck*, *GNATtest* or *GNATcoverage*.
 
+* **Alire support**: if the root folder contains an `alire.toml` file and
+  there is `alr` executable in the `PATH`, then the language server fetches
+  the project's search path, environment variables and the project's file
+  name from the crate description.
+
 * **Project support**: there is no `Scenario` view: users should configure scenarios via the *ada.scenarioVariables* setting (see the settings list available [here](doc/refactoring_tools.md)). You can execute the *Ada: Reload project* command to reload your project after saving the new scenario values (use the *Ctrl+P* shortcut to invoke the **Command Palette**, allowing you to execute commands).
 
   Source directories from imported projects should be added in a [workspace file](https://code.visualstudio.com/docs/editor/workspaces#_multiroot-workspaces). If you already have a workspace file, the extension will propose you to automatically add all the source directories coming from imported projects to your workspace automatically at startup.
diff --git a/source/ada/lsp-ada_handlers-alire.adb b/source/ada/lsp-ada_handlers-alire.adb
@@ -138,19 +138,14 @@ package body LSP.Ada_Handlers.Alire is
       end if;
 
       Start_Alire (List (1), ALR.all, "--non-interactive", "show", Root);
-      loop
-         Spawn.Processes.Monitor_Loop (0.1);
-
-         exit when List (1).Process.Status = Spawn.Not_Running;
-      end loop;
-
       Start_Alire (List (2), ALR.all, "--non-interactive", "printenv", Root);
+
       loop
          Spawn.Processes.Monitor_Loop (0.1);
 
-         exit when List (2).Process.Status = Spawn.Not_Running;
+         exit when
+           (for all Item of List => Item.Process.Status = Spawn.Not_Running);
       end loop;
-      --  TODO: Fix spawn and wait both process with a single loop
 
       Decoder.Initialize ("utf-8");
       GNAT.OS_Lib.Free (ALR);
diff --git a/source/ada/lsp-ada_handlers-alire.ads b/source/ada/lsp-ada_handlers-alire.ads
@@ -39,6 +39,6 @@ package LSP.Ada_Handlers.Alire is
       Error       : out VSS.Strings.Virtual_String;
       Search_Path : out VSS.String_Vectors.Virtual_String_Vector;
       Scenario    : in out Scenario_Variable_List);
-   --  THe same, but when without fetching the project file.
+   --  The same as above, but without fetching the project file
 
 end LSP.Ada_Handlers.Alire;
diff --git a/source/ada/lsp-ada_handlers.adb b/source/ada/lsp-ada_handlers.adb
@@ -275,16 +275,16 @@ package body LSP.Ada_Handlers is
    --     * if a project (and optionally a scenario) was specified by
    --       the user via the workspace/didChangeConfiguration notification or
    --       Initialize request, attempt to use this.
-   --       If there is `alire.toml` in the root, then run `alr` to find
-   --       search path and extra scenario variables.
+   --       If there is an `alire.toml` file in the root directory, then run
+   --       `alr` to find search path and extra scenario variables.
    --       If this fails to load, then report an error, but do not attempt to
    --       load another project.
-   --     => This case is handled by a call to Load_Project in
+   --     => This case is handled by a call to Reload_Project in
    --        Change_Configuration.
    --
    --     * if no project was specified by the user, then run `alr` in the
    --       root directory to get project file name from alire.toml (take the
-   --       vefy first project if many or crate name if none).
+   --       very first project if many or crate name if none).
    --       Otherwise look in the root directory, mimicking the behavior of
    --       gprbuild :
    --          * if there are zero .gpr files in this directory, load the
@@ -331,21 +331,29 @@ package body LSP.Ada_Handlers is
       Charset             : VSS.Strings.Virtual_String;
       Status              : Load_Project_Status);
    --  Attempt to load the given project file, with the scenario provided.
-   --  This unloads all currently loaded project contexts.
+   --  This unloads all currently loaded project contexts. This factorizes code
+   --  between Load_Project_With_Alire and Ensure_Project_Loaded.
 
    procedure Load_Project_With_Alire
      (Self                : access Message_Handler;
-      Project_File        : VSS.Strings.Virtual_String;
+      Project_File        : VSS.Strings.Virtual_String := "";
       Scenario_Variables  : Scenario_Variable_List;
-      Charset             : VSS.Strings.Virtual_String;
-      Status              : Load_Project_Status);
+      Charset             : VSS.Strings.Virtual_String);
+   --  Core procedure to find project, search path, scenario and load the
+   --  project.
+   --
+   --  @param Self                 The message handler itself
+   --  @param Project_File         GPR, if set by the user in settings
+   --  @param Scenario_Variables   Scenario as set by the user in settings
+   --  @param Charset              Charset, if set by the user in settings
+   --
    --  Load a project with a help of alire. If there is `alire.toml` in the
-   --  root directory and `alr` in the `PATH`, then
-   --  * use Alire to setup project search path, extra scenario variables (and
-   --    a project file name if Project_File is empty).
-   --  * load project
-   --  If Project_File is not empty then load it even if there is no alire.toml
-   --  or `alr`.
+   --  root directory and `alr` in the `PATH`, then use Alire to setup project
+   --  search path, extra scenario variables (and a project file name if
+   --  Project_File is empty). If Alire reports error then show it to the
+   --  user and fallback to an implicit project.
+   --
+   --  If Alire succeed or no alire/crate then load project if provided.
 
    procedure Mark_Source_Files_For_Indexing (Self : access Message_Handler);
    --  Mark all sources in all projects for indexing. This factorizes code
@@ -674,8 +682,7 @@ package body LSP.Ada_Handlers is
          Self.Load_Project_With_Alire
            (Self.Project_File,
             Self.Scenario_Variables,
-            Self.Charset,
-            Self.Project_Status);
+            Self.Charset);
       end if;
    end Reload_Project;
 
@@ -772,8 +779,7 @@ package body LSP.Ada_Handlers is
       Self.Load_Project_With_Alire
         (Project_File        => VSS.Strings.Empty_Virtual_String,
          Scenario_Variables  => Self.Scenario_Variables,
-         Charset             => Self.Charset,
-         Status              => Alire_Project);
+         Charset             => Self.Charset);
 
       if not Self.Contexts.Is_Empty then
          --  Some project was found by alire and loaded. We are done!
@@ -4963,13 +4969,13 @@ package body LSP.Ada_Handlers is
 
    procedure Load_Project_With_Alire
      (Self                : access Message_Handler;
-      Project_File        : VSS.Strings.Virtual_String;
+      Project_File        : VSS.Strings.Virtual_String := "";
       Scenario_Variables  : Scenario_Variable_List;
-      Charset             : VSS.Strings.Virtual_String;
-      Status              : Load_Project_Status)
+      Charset             : VSS.Strings.Virtual_String)
    is
 
       Has_Alire   : Boolean;
+      Status      : Load_Project_Status;
       Errors      : VSS.Strings.Virtual_String;
       Project     : VSS.Strings.Virtual_String := Project_File;
       Search_Path : VSS.String_Vectors.Virtual_String_Vector;
@@ -4992,6 +4998,8 @@ package body LSP.Ada_Handlers is
                Project     => Project,
                Search_Path => Search_Path,
                Scenario    => Scenario);
+
+            Status := Alire_Project;
          else
 
             LSP.Ada_Handlers.Alire.Run_Alire
@@ -5000,6 +5008,8 @@ package body LSP.Ada_Handlers is
                Error       => Errors,
                Search_Path => Search_Path,
                Scenario    => Scenario);
+
+            Status := Valid_Project_Configured;
          end if;
 
          if Has_Alire and then not Errors.Is_Empty then
@@ -5026,47 +5036,48 @@ package body LSP.Ada_Handlers is
             pragma Assert (not Project.Is_Empty);
 
             Self.Trace.Trace
-              ("Project:" & VSS.Strings.Conversions.To_UTF_8_String (Project));
+              (Message => "Project:"
+                 & VSS.Strings.Conversions.To_UTF_8_String (Project));
 
-            Self.Trace.Trace ("Search Path:");
+            Self.Trace.Trace (Message => "Search Path:");
             for Item of Search_Path loop
                Self.Trace.Trace
-                 (VSS.Strings.Conversions.To_UTF_8_String (Item));
+                 (Message => VSS.Strings.Conversions.To_UTF_8_String (Item));
             end loop;
 
             Self.Trace.Trace ("Scenario:");
             for J in 1 .. Scenario.Names.Length loop
                Self.Trace.Trace
-                 (VSS.Strings.Conversions.To_UTF_8_String
+                 (Message => VSS.Strings.Conversions.To_UTF_8_String
                     (Scenario.Names (J))
                   & "="
                   & VSS.Strings.Conversions.To_UTF_8_String
                       (Scenario.Values (J)));
             end loop;
 
             Self.Load_Project
-              (Project,
-               Search_Path,
-               Scenario,
-               (if Charset.Is_Empty then UTF_8 else Charset),
-               Status);
+              (Project_File => Project,
+               Search_Path  => Search_Path,
+               Scenario     => Scenario,
+               Charset      => (if Charset.Is_Empty then UTF_8 else Charset),
+               Status       => Status);
             --  Alire projects tend to use utf-8
 
             return;
          else
-            Self.Trace.Trace ("No alr in the PATH.");
+            Self.Trace.Trace (Message => "No alr in the PATH.");
          end if;
       end if;
 
       --  There is no alire.toml or no alr, but we know the project, load it
       if not Project.Is_Empty then
 
          Self.Load_Project
-           (Project,
-            VSS.String_Vectors.Empty_Virtual_String_Vector,
-            Scenario_Variables,
-            Charset,
-            Status);
+           (Project_File => Project,
+            Search_Path  => VSS.String_Vectors.Empty_Virtual_String_Vector,
+            Scenario     => Scenario_Variables,
+            Charset      => Charset,
+            Status       => Valid_Project_Configured);
       end if;
    end Load_Project_With_Alire;
 
diff --git a/testsuite/ada_lsp/show_dependencies.aggregate/test.json b/testsuite/ada_lsp/show_dependencies.aggregate/test.json
@@ -179,19 +179,19 @@
                "result": [
                   {
                      "uri": "$URI{common/common_pack.ads}",
-                     "projectUri": "$URI{}/"
+                     "projectUri": "$URI{}${DIR_SEP}"
                   },
                   {
                      "uri": "$URI{common/common_pack.ads}",
-                     "projectUri": "$URI{}/"
+                     "projectUri": "$URI{}${DIR_SEP}"
                   },
                   {
                      "uri": "$URI{p/main.adb}",
-                     "projectUri": "$URI{}/"
+                     "projectUri": "$URI{}${DIR_SEP}"
                   },
                   {
                      "uri": "$URI{q/main.adb}",
-                     "projectUri": "$URI{}/"
+                     "projectUri": "$URI{}${DIR_SEP}"
                   }
                ]
             }

Original file line number	Diff line number	Diff line change
`@@ -179,19 +179,19 @@`
`179`	`179`	`"result": [`
`180`	`180`	`{`
`181`	`181`	`"uri": "$URI{common/common_pack.ads}",`
`182`		`- "projectUri": "$URI{}/"`
	`182`	`+ "projectUri": "$URI{}${DIR_SEP}"`
`183`	`183`	`},`
`184`	`184`	`{`
`185`	`185`	`"uri": "$URI{common/common_pack.ads}",`
`186`		`- "projectUri": "$URI{}/"`
	`186`	`+ "projectUri": "$URI{}${DIR_SEP}"`
`187`	`187`	`},`
`188`	`188`	`{`
`189`	`189`	`"uri": "$URI{p/main.adb}",`
`190`		`- "projectUri": "$URI{}/"`
	`190`	`+ "projectUri": "$URI{}${DIR_SEP}"`
`191`	`191`	`},`
`192`	`192`	`{`
`193`	`193`	`"uri": "$URI{q/main.adb}",`
`194`		`- "projectUri": "$URI{}/"`
	`194`	`+ "projectUri": "$URI{}${DIR_SEP}"`
`195`	`195`	`}`
`196`	`196`	`]`
`197`	`197`	`}`