V119-052: Add a code sample for custom environments

This shows an example of VS Code workspace that modifies some
environment variables at startup.

Author: AnthonyLeonardoGracio

integration/vscode/Code Samples/custom_env/README.md

@@ -0,0 +1,25 @@
+# Workspace-specific environment
+
+This folder contains a `custom_env.code-workspace` file that setups a custom
+environment for this workspace, setting and modifying some environment variables.
+
+In particular it modifies `GPR_PROJECT_PATH` environment variable in order
+to be able to build the `default.gpr` project, which includes a project
+without specifying a path to it. You can find more information on the
+`GPR_PROJECT_PATH` environment variable and on how to import other projects
+[here](https://docs.adacore.com/gprbuild-docs/html/gprbuild_ug/gnat_project_manager.html?highlight=gpr_project_path#importing-projects).
+
+It also sets the `MAIN_NUMBER` scenario variable to `MAIN_2` when loading
+the workspace, instead of the default `MAIN_1` value.
+More information on scenario variables is available [here](https://docs.adacore.com/gprbuild-docs/html/gprbuild_ug/gnat_project_manager.html?highlight=gpr_project_path#scenarios-in-projects).
+
+Note that you can set and/or modify any environment variable, including the
+`PATH` if you want to use a different Ada toolchain for this project.
+
+# Run the Code Sample
+
+Open VS Code and click on the `File -> Open Workspace From File...` menu
+and select the `custom_env.code-workspace` file present in this folder.
+
+You can then build the project by clicking on the `Terminal -> Run Task...` menu,
+and by selecting the `gprbuild -> ada: Build current project` task.

integration/vscode/Code Samples/custom_env/custom_env.code-workspace

@@ -0,0 +1,38 @@
+{
+	"folders": [
+		{
+			"path": "."
+		}
+	],
+	"settings": {
+		"ada.projectFile": "default.gpr",
+
+		// Set a workspace-specific environment for Linux/OSX platforms
+		"terminal.integrated.env.linux": {
+			//  Set MAIN_NUMBER scenario variable to MAIN_2 directly from the environment
+			"MAIN_NUMBER": "MAIN_2",
+
+			//  Optionally, you can append the Ada toolchain of your choice to the PATH environment variable
+			//  if you want to use a different toolchain.
+			//  "PATH": "<PATH_TO_TOOLCHAIN>:${env:PATH}",
+
+			//  Append the path to the directory containing print_utils.gpr project file dependency to
+			//  the GPR_PROJECT_PATH environment variable
+			"GPR_PROJECT_PATH": "./imported:${env:GPR_PROJECT_PATH}"
+		},
+
+		// Set a workspace-specific environment for Windows
+		"terminal.integrated.env.windows": {
+			//  Set MAIN_NUMBER scenario variable to MAIN_2 directly from the environment
+			"MAIN_NUMBER": "MAIN_2",
+
+			//  Optionally, you can append the Ada toolchain of your choice to the PATH environment variable
+			//  if you want to use a different toolchain.
+			//  "PATH": "<PATH_TO_TOOLCHAIN>;${env:PATH}",
+
+			//  Append the path to the directory containing print_utils.gpr project file dependency to
+			//  the GPR_PROJECT_PATH environment variable
+			"GPR_PROJECT_PATH": ".\\imported;${env:GPR_PROJECT_PATH}:"
+		}
+	}
+}

integration/vscode/Code Samples/custom_env/default.gpr

@@ -0,0 +1,27 @@
+with "print_utils.gpr";
+
+project Default is
+
+   for Source_Dirs use ("src");
+   for Object_Dir use "obj";
+   type MAIN_NUMBER_Type is
+      ("MAIN_1", "MAIN_2");
+   MAIN_NUMBER : MAIN_NUMBER_Type := external ("MAIN_NUMBER", "MAIN_1");
+
+   case MAIN_NUMBER is
+      when "MAIN_2" =>
+         for Main use ("main_2.adb");
+
+      when "MAIN_1" =>
+         for Main use ("main_1.adb");
+   end case;
+
+   --  Use the same executable name for main source files
+   package Builder is
+      for Executable ("main_1.adb") use "main";
+      for Executable ("main_2.adb") use "main";
+   end Builder;
+
+   for Create_Missing_Dirs use "True";
+
+end Default;

integration/vscode/Code Samples/custom_env/imported/print.adb

@@ -0,0 +1,6 @@
+with Ada.Text_IO;
+
+procedure Print (S : String) is
+begin
+   Ada.Text_IO.Put_Line (S);
+end Print;

integration/vscode/Code Samples/custom_env/imported/print_utils.gpr

@@ -0,0 +1,2 @@
+project Print_Utils is
+end Print_Utils;

integration/vscode/Code Samples/custom_env/src/main_2.adb

@@ -0,0 +1,6 @@
+with Ada.Text_IO;
+
+procedure Main_2 is
+begin
+   Ada.Text_IO.Put_Line ("Main 2");
+end Main_2;

source/ada/lsp-ada_driver.adb

@@ -170,6 +170,10 @@ procedure LSP.Ada_Driver is
 
    ALS_Home               : constant VSS.Strings.Virtual_String :=
      VSS.Application.System_Environment.Value ("ALS_HOME");
+   GPR_Path               : constant VSS.Strings.Virtual_String :=
+     VSS.Application.System_Environment.Value ("GPR_PROJECT_PATH");
+   Path                   : constant VSS.Strings.Virtual_String :=
+     VSS.Application.System_Environment.Value ("PATH");
    Home_Dir               : constant Virtual_File :=
      Create_From_UTF8
        (VSS.Strings.Conversions.To_UTF_8_String
@@ -271,6 +275,10 @@ begin
 
    Server_Trace.Trace ("Initializing server ...");
 
+   Server_Trace.Trace
+     ("GPR PATH: " & VSS.Strings.Conversions.To_UTF_8_String (GPR_Path));
+   Server_Trace.Trace
+     ("PATH: " & VSS.Strings.Conversions.To_UTF_8_String (Path));
    --  Start monitoring the memory if the memory monitor trace is active
 
    Memory_Monitor_Enabled := Create ("DEBUG.ADA_MEMORY").Is_Active;