Merge branch 'topic/#1668' into 'master'

Recover when failing to parse preprocessing options

See merge request eng/ide/ada_language_server!2025

Author: AnthonyLeonardoGracio

source/ada/lsp-ada_handlers-file_readers.adb

@@ -166,7 +166,7 @@ package body LSP.Ada_Handlers.File_Readers is
          end if;
       end if;
 
-      --  If we have preprocessing data, use LAL's API to preoprocess the file.
+      --  If we have preprocessing data, use LAL's API to preprocess the file.
       --  Otherwise, just decode the contents of the document/file.
 
       if Self.Preprocessing_Data /= No_Preprocessor_Data then

source/ada/lsp-ada_handlers-project_loading.adb

@@ -34,6 +34,7 @@ with GPR2.Reporter;
 pragma Warnings (Off, "unit ""GPR2.Build.Source.Sets"" is not referenced");
 with GPR2.Build.Source.Sets;
 
+with Langkit_Support.Errors;
 with Libadalang.Preprocessing;
 with Libadalang.Project_Provider;
 with LSP.Ada_Contexts;
@@ -558,20 +559,42 @@ package body LSP.Ada_Handlers.Project_Loading is
          --  and create the file reader which will preprocess the files
          --  accordingly.
 
-         Libadalang.Preprocessing.Extract_Preprocessor_Data_From_Project
-           (Tree           => Self.Project_Tree,
-            Project        => View,
-            Default_Config => Default_Config,
-            File_Configs   => File_Configs);
-
-         Libadalang.Preprocessing.Iterate
-           (Default_Config => Default_Config,
-            File_Configs   => File_Configs,
-            Process        => Set_Line_Mode'Access);
-
-         Reader.Preprocessing_Data :=
-           Libadalang.Preprocessing.Create_Preprocessor_Data
-             (Default_Config, File_Configs);
+         begin
+            Libadalang.Preprocessing.Extract_Preprocessor_Data_From_Project
+              (Tree           => Self.Project_Tree,
+               Project        => View,
+               Default_Config => Default_Config,
+               File_Configs   => File_Configs);
+
+            Libadalang.Preprocessing.Iterate
+              (Default_Config => Default_Config,
+               File_Configs   => File_Configs,
+               Process        => Set_Line_Mode'Access);
+
+            Reader.Preprocessing_Data :=
+              Libadalang.Preprocessing.Create_Preprocessor_Data
+                (Default_Config, File_Configs);
+         exception
+            --  Fallback to a degraded mode when failing to parse preprocessing
+            --  options.
+            when E : Langkit_Support.Errors.Syntax_Error =>
+            Self.Send_Messages
+              (Show     => True,
+               Messages =>
+                 ["Failed to load preprocessing options: please ensure"
+                  & " your preprocessing definitions are syntactically correct."],
+               Severity => LSP.Enumerations.Error,
+               File     => GNATCOLL.VFS.No_File);
+            Tracer.Trace_Exception
+              (Error   => E,
+               Message =>
+                 "Failed to parse preprocessing options for Context Id: "
+                 & (C.Id)
+                 & ", fallback to a degraded mode without support for "
+                 & "preprocessing directives");
+               Reader.Preprocessing_Data :=
+                 Libadalang.Preprocessing.No_Preprocessor_Data;
+         end;
 
          C.Initialize
            (Reader,

testsuite/ada_lsp/als.1668.bad_preprocessing_options/default.gpr

@@ -0,0 +1,6 @@
+project Default is
+   package Compiler is
+      for Switches ("Ada") use
+        ("-gnatep=" & Default'Project_Dir & "prep.def");
+   end Compiler;
+end Default;

testsuite/ada_lsp/als.1668.bad_preprocessing_options/main.adb

@@ -0,0 +1,11 @@
+with Ada.Text_IO;
+procedure Main is
+    Var : constant Integer := 10;
+begin
+  # if VERSION = "1" then
+   Ada.Text_IO.Put_Line ("Version 1");
+  # else
+   Ada.Text_IO.Put_Line ("Version 2");
+  # end if;
+   Ada.Text_IO.Put_Line ("Var = " & Var'Img);
+end Main;

testsuite/ada_lsp/als.1668.bad_preprocessing_options/prep.def

@@ -0,0 +1 @@
+-DVERSION=1

testsuite/ada_lsp/als.1668.bad_preprocessing_options/test.json

@@ -0,0 +1,119 @@
+[
+   {
+      "comment": [
+         "This test checks that we fallback to a degraded mode when failing to parse ",
+         "preprocessing options, warning the user via a message when it's the case."
+      ]
+   },
+   {
+      "start": {
+         "cmd": ["${ALS}"]
+      }
+   },
+   {
+      "send": {
+         "request": {
+            "jsonrpc": "2.0",
+            "id": 1,
+            "method": "initialize",
+            "params": {
+               "rootUri": "$URI{.}",
+               "initializationOptions": {
+                  "ada": {
+                     "projectFile": "$URI{default.gpr}",
+                     "showNotificationsOnErrors": true
+                  }
+               },
+               "capabilities": {}
+            }
+         },
+         "wait": []
+      }
+   },
+   {
+      "send": {
+         "request": {
+            "jsonrpc": "2.0",
+            "method": "initialized"
+         },
+         "wait": [
+            {
+               "method": "window/showMessage",
+               "params": {
+                  "type": 1,
+                  "message": "Failed to load preprocessing options: please ensure your preprocessing definitions are syntactically correct."
+               }
+            }
+         ]
+      }
+   },
+   {
+      "send": {
+         "request": {
+            "jsonrpc": "2.0",
+            "method": "textDocument/didOpen",
+            "params": {
+               "textDocument": {
+                  "uri": "$URI{main.adb}",
+                  "languageId": "Ada",
+                  "version": 0,
+                  "text": "with Ada.Text_IO;\nprocedure Main is\n    Var : constant Integer := 10;\nbegin\n  # if VERSION = \"1\" then\n   Ada.Text_IO.Put_Line (\"Version 1\");\n  # else\n   Ada.Text_IO.Put_Line (\"Version 2\");\n  # end if;\n   Ada.Text_IO.Put_Line (\"Var = \" & Var'Img);\nend Main;\n"
+               }
+            }
+         },
+         "wait": []
+      }
+   },
+   {
+      "comment": "Check that basic navigation still works in degraded mode",
+      "send": {
+         "request": {
+            "jsonrpc": "2.0",
+            "id": 7,
+            "method": "textDocument/definition",
+            "params": {
+               "textDocument": {
+                  "uri": "$URI{main.adb}"
+               },
+               "position": {
+                  "line": 9,
+                  "character": 36
+               }
+            }
+         },
+         "wait": [
+            {
+               "id": 7,
+               "result": {
+                  "uri": "$URI{main.adb}",
+                  "range": {
+                     "start": {
+                        "line": 2,
+                        "character": 4
+                     },
+                     "end": {
+                        "line": 2,
+                        "character": 7
+                     }
+                  }
+               }
+            }
+         ]
+      }
+   },
+   {
+      "send": {
+         "request": {
+            "jsonrpc": "2.0",
+            "id": 5,
+            "method": "shutdown"
+         },
+         "wait": []
+      }
+   },
+   {
+      "stop": {
+         "exit_code": 0
+      }
+   }
+]

testsuite/ada_lsp/als.1668.bad_preprocessing_options/test.yaml

@@ -0,0 +1 @@
+title: 'als.1668.bad_preprocessing_options'