Merge branch 'topic/config-env-win' into 'master'

Fix accessing XDG_CONFIG_HOME and the user home directory on Windows

See merge request eng/ide/ada_language_server!1840

Author: eliericha

source/ada/lsp-env.adb

@@ -16,6 +16,7 @@
 ------------------------------------------------------------------------------
 
 with LSP.Utils;
+with VSS.Standard_Paths;
 
 package body LSP.Env is
 
@@ -24,55 +25,75 @@ package body LSP.Env is
    --------------
 
    function Home_Dir return GNATCOLL.VFS.Virtual_File is
+      Home_Path : constant VSS.Strings.Virtual_String :=
+        VSS.Standard_Paths.Writable_Location
+          (VSS.Standard_Paths.Home_Location);
    begin
-      if Home.Is_Empty then
+      if Home_Path.Is_Empty then
          raise Program_Error
-           with
-             "The HOME environment variable is empty, ALS cannot proceed safely.";
+           with "Unable to determine the user home location, ALS cannot proceed safely.";
+      else
+         declare
+            Result : constant GNATCOLL.VFS.Virtual_File :=
+              LSP.Utils.To_Virtual_File (Home_Path);
+         begin
+            if Result.Is_Directory then
+               return Result;
+            else
+               raise Program_Error
+                 with "The user home location is not a directory: " &
+                 Result.Display_Full_Name;
+            end if;
+         end;
       end if;
 
-      return LSP.Utils.To_Virtual_File (Home);
    end Home_Dir;
 
    -----------------
    -- ALS_Log_Dir --
    -----------------
 
-   function ALS_Log_Dir return GNATCOLL.VFS.Virtual_File
-   is ((if not ALS_Home.Is_Empty then LSP.Utils.To_Virtual_File (ALS_Home)
-        else
-          (if Home_Dir.Is_Directory then Home_Dir
-           else GNATCOLL.VFS.Create (".")))
-       / ".als");
+   function ALS_Log_Dir return GNATCOLL.VFS.Virtual_File is
+     ((if not ALS_Home.Is_Empty then LSP.Utils.To_Virtual_File (ALS_Home)
+       else
+         (if Home_Dir.Is_Directory then Home_Dir
+          else GNATCOLL.VFS.Create ("."))) /
+      ".als");
 
    ---------------------
    -- XDG_CONFIG_HOME --
    ---------------------
 
-   function XDG_CONFIG_HOME return VSS.Strings.Virtual_String
-   is (VSS.Application.System_Environment.Value
-         ("XDG_CONFIG_HOME",
-          LSP.Utils.To_Virtual_String (Home_Dir / ".config")));
+   function XDG_CONFIG_HOME return GNATCOLL.VFS.Virtual_File is
+      Xdg_Config_Home_Value : constant VSS.Strings.Virtual_String :=
+        VSS.Application.System_Environment.Value ("XDG_CONFIG_HOME");
+   begin
+      if not Xdg_Config_Home_Value.Is_Empty then
+         return LSP.Utils.To_Virtual_File (Xdg_Config_Home_Value);
+      else
+         return Home_Dir / ".config";
+      end if;
+   end XDG_CONFIG_HOME;
 
    -------------------------
    -- ALS_User_Config_Dir --
    -------------------------
 
-   function ALS_User_Config_Dir return GNATCOLL.VFS.Virtual_File
-   is (LSP.Utils.To_Virtual_File (XDG_CONFIG_HOME) / "als");
+   function ALS_User_Config_Dir return GNATCOLL.VFS.Virtual_File is
+     (XDG_CONFIG_HOME / "als");
 
    --------------------------
    -- ALS_User_Config_File --
    --------------------------
 
-   function ALS_User_Config_File return GNATCOLL.VFS.Virtual_File
-   is (ALS_User_Config_Dir / "config.json");
+   function ALS_User_Config_File return GNATCOLL.VFS.Virtual_File is
+     (ALS_User_Config_Dir / "config.json");
 
    -------------------------------
    -- ALS_Workspace_Config_File --
    -------------------------------
 
-   function ALS_Workspace_Config_File return GNATCOLL.VFS.Virtual_File
-   is (GNATCOLL.VFS.Create_From_Base (".als.json"));
+   function ALS_Workspace_Config_File return GNATCOLL.VFS.Virtual_File is
+     (GNATCOLL.VFS.Create_From_Base (".als.json"));
 
 end LSP.Env;

source/ada/lsp-env.ads

@@ -26,15 +26,12 @@ package LSP.Env is
    use type GNATCOLL.VFS.Virtual_File;
 
    Testing : constant Boolean :=
-      VSS.Application.System_Environment.Contains ("ALS_TESTING");
+     VSS.Application.System_Environment.Contains ("ALS_TESTING");
    --  Constant set to True when ALS is running within a testsuite.
 
-   Home : constant VSS.Strings.Virtual_String :=
-     VSS.Application.System_Environment.Value ("HOME");
-   --  Value of the HOME environment variable
-
    function Home_Dir return GNATCOLL.VFS.Virtual_File;
-   --  Directory pointed by the HOME environment variable
+   --  The user home directory on POSIX or the user profile directory on
+   --  Windows.
 
    ALS_Home : constant VSS.Strings.Virtual_String :=
      VSS.Application.System_Environment.Value ("ALS_HOME");
@@ -57,7 +54,7 @@ package LSP.Env is
    --
    --  In an exotic case where HOME is not defined, use the current directory
 
-   function XDG_CONFIG_HOME return VSS.Strings.Virtual_String;
+   function XDG_CONFIG_HOME return GNATCOLL.VFS.Virtual_File;
    --  The XDG_CONFIG_HOME environment variable, defaulting to $HOME/.config if
    --  unspecified.
    --