Merge branch 'origin/edge' into 'master'

For eng/shared/anod#412

Depends-On: eng/shared/anod!4533

Author: eliericha

.gitlab-ci.yml

@@ -140,7 +140,7 @@ test-vscode-extension:
 
     # Run VSCode extension tests
     - echo -e "\e[0Ksection_start:`date +%s`:test_vscode[collapsed=true]\r\e[0Kanod test vscode-extension"
-    - anod test vscode-extension --qualifier=$ACI_TRACK_QUALIFIER --minimal
+    - anod test vscode-extension $ACI_TRACK_QUALIFIER --minimal
 
     - VSCODE_BUILD_SPACE=$(anod info test vscode-extension $ACI_TRACK_QUALIFIER --show working_dir)
     - echo -e "\e[0Ksection_end:`date +%s`:test_vscode\r\e[0K"

doc/metaModel.json

@@ -9087,58 +9087,6 @@
 			],
 			"documentation": "Provider options for a [DocumentLinkRequest](#DocumentLinkRequest)."
 		},
-		{
-			"name": "FormattingOptions",
-			"properties": [
-				{
-					"name": "tabSize",
-					"type": {
-						"kind": "base",
-						"name": "uinteger"
-					},
-					"documentation": "Size of a tab in spaces."
-				},
-				{
-					"name": "insertSpaces",
-					"type": {
-						"kind": "base",
-						"name": "boolean"
-					},
-					"documentation": "Prefer spaces over tabs."
-				},
-				{
-					"name": "trimTrailingWhitespace",
-					"type": {
-						"kind": "base",
-						"name": "boolean"
-					},
-					"optional": true,
-					"documentation": "Trim trailing whitespace on a line.\n\n@since 3.15.0",
-					"since": "3.15.0"
-				},
-				{
-					"name": "insertFinalNewline",
-					"type": {
-						"kind": "base",
-						"name": "boolean"
-					},
-					"optional": true,
-					"documentation": "Insert a newline character at the end of the file if one does not exist.\n\n@since 3.15.0",
-					"since": "3.15.0"
-				},
-				{
-					"name": "trimFinalNewlines",
-					"type": {
-						"kind": "base",
-						"name": "boolean"
-					},
-					"optional": true,
-					"documentation": "Trim all newlines after the final newline at the end of the file.\n\n@since 3.15.0",
-					"since": "3.15.0"
-				}
-			],
-			"documentation": "Value-object describing what options formatting should use."
-		},
 		{
 			"name": "DocumentFormattingOptions",
 			"properties": [],

doc/metaModel.patch.json

@@ -132,6 +132,76 @@
       }
    ],
    "structures": [
+      {
+	 "name": "FormattingOptions",
+         "properties": [
+         {
+            "name": "tabSize",
+            "type": {
+               "kind": "base",
+               "name": "uinteger"
+            },
+            "documentation": "Size of a tab in spaces."
+	},
+	{
+            "name": "insertSpaces",
+            "type": {
+               "kind": "base",
+               "name": "boolean"
+            },
+            "documentation": "Prefer spaces over tabs."
+	},
+	{
+            "name": "trimTrailingWhitespace",
+            "type": {
+               "kind": "base",
+               "name": "boolean"
+            },
+            "optional": true,
+            "documentation": "Trim trailing whitespace on a line.\n\n@since 3.15.0",
+            "since": "3.15.0"
+	},
+	{
+            "name": "insertFinalNewline",
+            "type": {
+               "kind": "base",
+               "name": "boolean"
+            },
+            "optional": true,
+            "documentation": "Insert a newline character at the end of the file if one does not exist.\n\n@since 3.15.0",
+            "since": "3.15.0"
+         },
+         {
+            "name": "trimFinalNewlines",
+            "type": {
+               "kind": "base",
+               "name": "boolean"
+            },
+            "optional": true,
+            "documentation": "Trim all newlines after the final newline at the end of the file.\n\n@since 3.15.0",
+            "since": "3.15.0"
+         },
+         {
+            "name": "gnatFormatMaxSize",
+            "type": {
+               "kind": "base",
+               "name": "uinteger"
+            },
+            "optional": true,
+            "documentation": "Maximum line width for gnatformat"
+         },
+         {
+            "name": "gnatFormatContinuationLineIndent",
+            "type": {
+               "kind": "base",
+               "name": "uinteger"
+            },
+            "optional": true,
+            "documentation": "Continuation Line Indentation size (defaults to indentation-1) for gnatformat"
+         }
+         ],
+         "documentation": "Value-object describing what options formatting should use."
+      },
       {
          "name": "AlsCheckSyntaxParams",
          "properties": [

doc/settings.md

@@ -16,7 +16,8 @@ prefixing each setting name with `ada.`, e.g.
    "ada.scenarioVariables": {
        "LIBRARY_TYPE": "static"
    },
-   "ada.onTypeFormatting.indentOnly": true
+   "ada.onTypeFormatting.indentOnly": true,
+   "useGnatformat": true
 }
 ```
 
@@ -58,6 +59,7 @@ Ada Language Server understands these settings:
 * [relocateBuildTree](#relocatebuildtree)
 * [rootDir](#rootdir)
 * [enableDiagnostics](#enablediagnostics)
+* [projectDiagnostics](#projectdiagnostics)
 * [enableIndexing](#enableindexing)
 * [renameInComments](#renameincomments)
 * [namedNotationThreshold](#namednotationthreshold)
@@ -67,6 +69,7 @@ Ada Language Server understands these settings:
 * [followSymlinks](#followsymlinks)
 * [documentationStyle](#documentationstyle)
 * [onTypeFormatting.indentOnly](#ontypeformattingindentonly)
+* [useGnatformat](#usegnatformat)
 
 ----
 
@@ -141,6 +144,16 @@ The value is a boolean.
     'enableDiagnostics': false
 ```
 
+## projectDiagnostics
+
+This setting needs `enableDiagnostics` enabled and can be disabled to remove
+project related diagnotics.
+The value is a boolean.
+
+```javascript
+    'enableDiagnostics': false
+```
+
 ## enableIndexing
 
 By default, the server indexes the source files after loading a project,
@@ -275,3 +288,9 @@ An equivalent setting `gpr.trace.server` exists for tracing the communcation bet
 This option controls if the `textDocument/onTypeFormatting` request only indents a new line, or if
 it additionally tries to format the previous node. By default, this option is enabled, that is,
 `textDocument/onTypeFormatting` only indents new lines.
+
+## useGnatformat
+
+This option controls the formatting provider for the `textDocument/formatting`,
+`textDocument/rangeFormatting` and `textDocument/onTypeFormatting` request. By default, this option
+is enabled and ALS uses GNATformat as its formatting provider. If disabled, GNATpp is used instead.

doc/traces.md

@@ -61,3 +61,9 @@ in `initialize` response.
 Log lalpp output if `yes`.
 
     ALS.LAL_PP_OUTPUT_ON_FORMATTING=yes
+
+## `ALS.GNATFORMAT` (default no)
+
+Use GNATformat as format provider.
+
+    ALS.GNATFORMAT=yes

gnat/lsp_server.gpr

@@ -11,6 +11,7 @@ with "lal_refactor.gpr";
 with "ada_libfswatch.gpr";
 with "libgnatdoc.gpr";
 with "spawn.gpr";
+with "gnatformat.gpr";
 
 with "lsp_3_17";
 with "lsp_common";

integration/vscode/ada/package.json

@@ -297,6 +297,12 @@
                         },
                         "order": 1
                     },
+                    "ada.projectDiagnostics": {
+                        "scope": "window",
+                        "type": "boolean",
+                        "default": true,
+                        "description": "Controls whether or not the Ada Language Server should emit project diagnostics into the VS Code Problems view.\n\nNote: this setting is ignored if `ada.enableDiagnostics` is disabled and a workspace reload is necessary to refresh the diagnostics after modifying this setting."
+                    },
                     "ada.defaultCharset": {
                         "scope": "window",
                         "type": "string",
@@ -323,6 +329,12 @@
                 "title": "Formatting",
                 "order": 1,
                 "properties": {
+                    "ada.useGnatformat": {
+                        "scope": "window",
+                        "type": "boolean",
+                        "default": true,
+                        "markdownDescription": "Enable GNATformat as the formatting provider for Ada source files."
+                    },
                     "ada.onTypeFormatting.indentOnly": {
                         "scope": "window",
                         "type": "boolean",

integration/vscode/ada/src/ExtensionState.ts

@@ -47,7 +47,7 @@ export class ExtensionState {
     /**
      * The following fields are caches for ALS requests or costly properties.
      */
-    cachedProjectFile: string | undefined;
+    cachedProjectUri: vscode.Uri | undefined;
     cachedObjectDir: string | undefined;
     cachedMains: string[] | undefined;
     cachedExecutables: string[] | undefined;
@@ -57,7 +57,7 @@ export class ExtensionState {
     private sparkTaskProvider?: SimpleTaskProvider;
 
     public clearALSCache() {
-        this.cachedProjectFile = undefined;
+        this.cachedProjectUri = undefined;
         this.cachedObjectDir = undefined;
         this.cachedMains = undefined;
         this.cachedExecutables = undefined;
@@ -184,16 +184,26 @@ export class ExtensionState {
     };
 
     /**
-     * @returns the full path of the main project file from the ALS
+     * @returns the URI of the main project file from the ALS
      */
-    public async getProjectFile(): Promise<string> {
-        if (!this.cachedProjectFile) {
-            this.cachedProjectFile = (await this.adaClient.sendRequest(ExecuteCommandRequest.type, {
+    public async getProjectUri(): Promise<vscode.Uri | undefined> {
+        if (!this.cachedProjectUri) {
+            const strUri = (await this.adaClient.sendRequest(ExecuteCommandRequest.type, {
                 command: 'als-project-file',
             })) as string;
+            if (strUri != '') {
+                this.cachedProjectUri = vscode.Uri.parse(strUri, true);
+            }
         }
 
-        return this.cachedProjectFile;
+        return this.cachedProjectUri;
+    }
+
+    /**
+     * @returns the full path of the main project file from the ALS
+     */
+    public async getProjectFile(): Promise<string> {
+        return (await this.getProjectUri())?.fsPath ?? '';
     }
 
     /**

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

@@ -1,11 +1,10 @@
 import * as assert from 'assert';
 import { adaExtState } from '../../../src/extension';
-import { getProjectFile, getObjectDir } from '../../../src/helpers';
-import { assertEqualToFileContent, activate } from '../utils';
+import { getObjectDir } from '../../../src/helpers';
+import { activate, assertEqualToFileContent } from '../utils';
 
-import * as vscode from 'vscode';
 import { readFileSync, writeFileSync } from 'fs';
-import { basename } from 'path';
+import * as vscode from 'vscode';
 
 suite('Extensions Test Suite', function () {
     // Make sure the extension is activated
@@ -14,9 +13,14 @@ suite('Extensions Test Suite', function () {
     });
     test('Project File Response', async () => {
         if (vscode.workspace.workspaceFolders !== undefined) {
-            const result: string = await getProjectFile(adaExtState.adaClient);
-            const name = basename(result);
-            assert.strictEqual(name, 'prj.gpr');
+            // Uri obtained from the ALS
+            const alsUri = await adaExtState.getProjectUri();
+            // Uri manually computed based on the loaded workspace
+            const wsUri = vscode.Uri.joinPath(vscode.workspace.workspaceFolders[0].uri, 'prj.gpr');
+            // Ask for fsPath, it will resolve wsUri._fsPath
+            wsUri.fsPath != null
+            // Both should match
+            assert.deepStrictEqual(alsUri, wsUri);
         } else {
             throw new Error('No workspace folder found for the specified URI');
         }

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

@@ -30,13 +30,17 @@ suite('which and envHasExec', function () {
 suite('findAdaMain', function () {
     test('Find one main (simple case)', async function () {
         /* Test that findAdaMain works in a simple case */
-        const uri = Uri.joinPath(workspace.workspaceFolders![0].uri, 'src', 'main1.adb');
+        const folders = workspace.workspaceFolders;
+        assert(folders && folders.length > 0);
+        const uri = Uri.joinPath(folders[0].uri, 'src', 'main1.adb');
         const adaMain = await findAdaMain(uri.fsPath);
         assert(adaMain);
     });
     test('Find one main (case sensitivity)', async function () {
         /* Test the behavior of findAdaMain with respect to case sensitivity */
-        const uri_uppercase = Uri.joinPath(workspace.workspaceFolders![0].uri, 'src', 'MAIN1.ADB');
+        const folders = workspace.workspaceFolders;
+        assert(folders && folders.length > 0);
+        const uri_uppercase = Uri.joinPath(folders[0].uri, 'src', 'MAIN1.ADB');
         const adaMain_from_uppercase = await findAdaMain(uri_uppercase.fsPath);
 
         /* On Windows we should have a main here, otherwise we should not */