Merge branch 'topic/ignore_files' into 'master'

Introduce `IDE.Ignored_Source_Files` project attribute

See merge request eng/ide/ada_language_server!2112

Author: reznikmm

source/ada/lsp-ada_driver.adb

@@ -26,8 +26,6 @@ with GNAT.OS_Lib;
 with GNAT.Strings;
 
 pragma Warnings (Off, "is an internal GNAT unit");
-with Gnatformat.Configuration;
-with LSP.Ada_Handlers.Open_ALS_Log_File_Commands;
 with System.Soft_Links;
 with System.Secondary_Stack;
 
@@ -42,35 +40,35 @@ with GNATCOLL.Traces;         use GNATCOLL.Traces;
 with GNATCOLL.VFS;            use GNATCOLL.VFS;
 with GNATCOLL.Utils;
 
+with Gnatformat.Configuration;
+
 with LSP.Ada_Commands;
-with LSP.Ada_Definition;
 with LSP.Ada_Declaration;
-with LSP.Ada_Document_Symbol;
+with LSP.Ada_Definition;
 with LSP.Ada_Did_Change_Configurations;
 with LSP.Ada_Did_Change_Document;
+with LSP.Ada_Document_Symbol;
 with LSP.Ada_Execute_Command;
 with LSP.Ada_Folding_Range;
-with LSP.Ada_Hover;
-with LSP.Ada_Prepare_Type_Hierarchy;
-with LSP.Ada_References;
-with LSP.Ada_Handlers;
 with LSP.Ada_Handlers.Executables_Commands;
+with LSP.Ada_Handlers.GPR_Dependencies_Commands;
 with LSP.Ada_Handlers.Mains_Commands;
 with LSP.Ada_Handlers.Named_Parameters_Commands;
 with LSP.Ada_Handlers.Object_Dir_Commands;
-with LSP.Ada_Handlers.Other_File_Commands;
+with LSP.Ada_Handlers.Open_ALS_Log_File_Commands;
 with LSP.Ada_Handlers.Open_Project_File_Commands;
+with LSP.Ada_Handlers.Other_File_Commands;
 with LSP.Ada_Handlers.Project_Attributes_Commands;
 with LSP.Ada_Handlers.Project_File_Commands;
 with LSP.Ada_Handlers.Project_Reload_Commands;
 with LSP.Ada_Handlers.Refactor.Add_Parameter;
+with LSP.Ada_Handlers.Refactor.Auto_Import;
 with LSP.Ada_Handlers.Refactor.Change_Parameter_Mode;
 with LSP.Ada_Handlers.Refactor.Change_Parameters_Default_Value;
 with LSP.Ada_Handlers.Refactor.Change_Parameters_Type;
 with LSP.Ada_Handlers.Refactor.Delete_Entity;
 with LSP.Ada_Handlers.Refactor.Extract_Subprogram;
 with LSP.Ada_Handlers.Refactor.Extract_Variable;
-with LSP.Ada_Handlers.Refactor.Auto_Import;
 with LSP.Ada_Handlers.Refactor.Inline_Variable;
 with LSP.Ada_Handlers.Refactor.Introduce_Parameter;
 with LSP.Ada_Handlers.Refactor.Move_Parameter;
@@ -82,10 +80,14 @@ with LSP.Ada_Handlers.Refactor.Sort_Dependencies;
 with LSP.Ada_Handlers.Refactor.Suppress_Seperate;
 with LSP.Ada_Handlers.Refactor.Swap_If_Else;
 with LSP.Ada_Handlers.Show_Dependencies_Commands;
-with LSP.Ada_Handlers.GPR_Dependencies_Commands;
 with LSP.Ada_Handlers.Source_Dirs_Commands;
 with LSP.Ada_Handlers.Suspend_Executions;
+with LSP.Ada_Handlers;
+with LSP.Ada_Hover;
 with LSP.Ada_Inline_Value;
+with LSP.Ada_Prepare_Type_Hierarchy;
+with LSP.Ada_Projects;
+with LSP.Ada_References;
 with LSP.Ada_Selection_Range;
 with LSP.Ada_Tokens_Full;
 with LSP.Ada_Tokens_Range;
@@ -95,9 +97,9 @@ with LSP.Default_Message_Handlers;
 with LSP.Env;
 with LSP.GNATCOLL_Trace_Streams;
 with LSP.GNATCOLL_Tracers;
-with LSP.GPR_Handlers;
-with LSP.GPR_External_Tools;
 with LSP.GPR_Did_Change_Document;
+with LSP.GPR_External_Tools;
+with LSP.GPR_Handlers;
 with LSP.Memory_Statistics;
 with LSP.Predefined_Completion;
 with LSP.Secure_Message_Loggers;
@@ -592,6 +594,7 @@ begin
    Ada.Text_IO.Set_Output (Ada.Text_IO.Standard_Error);
    --  Protect stdout from pollution by accidental Put_Line calls
 
+   LSP.Ada_Projects.Elaborate_GPR2;
    Gnatformat.Configuration.Elaborate_GPR2;
 
    declare

source/ada/lsp-ada_handlers-file_readers.adb

@@ -21,6 +21,9 @@ with GNAT.Strings;                 use GNAT.Strings;
 with GNATCOLL.Traces;              use GNATCOLL.Traces;
 with GNATCOLL.VFS;                 use GNATCOLL.VFS;
 
+with GPR2.Path_Name;
+with GPR2.Project.Attribute;
+
 with VSS.Strings;                  use VSS.Strings;
 pragma Warnings
   (Off, "unit ""VSS.Strings.Character_Iterators"" is not referenced");
@@ -31,6 +34,8 @@ with VSS.Strings.Converters.Decoders;
 with VSS.Strings.Conversions;
 
 with LSP.Ada_Documents;            use LSP.Ada_Documents;
+with LSP.Ada_Projects;
+
 with Libadalang.Preprocessing;     use Libadalang.Preprocessing;
 with Langkit_Support.File_Readers; use Langkit_Support.File_Readers;
 with Langkit_Support.Slocs;
@@ -45,7 +50,7 @@ package body LSP.Ada_Handlers.File_Readers is
    Me : constant Trace_Handle := Create ("ALS.FILE_READERS");
 
    procedure Read_And_Decode
-     (Filename : String;
+     (Filename : Virtual_File;
       Charset  : VSS.Strings.Virtual_String;
       Decoded  : out VSS.Strings.Virtual_String;
       Error    : out VSS.Strings.Virtual_String);
@@ -64,12 +69,96 @@ package body LSP.Ada_Handlers.File_Readers is
       --  present
    --  Default flags for the text decoder.
 
+   ----------------
+   -- Initialize --
+   ----------------
+
+   procedure Initialize
+     (Self : in out LSP_File_Reader'Class;
+      Tree : GPR2.Project.Tree.Object;
+      View : GPR2.Project.View.Object)
+   is
+      procedure Set_Line_Mode
+        (Config : in out Libadalang.Preprocessing.File_Config);
+      --  Used to force the preprocessing line mode to Blank_Lines, which
+      --  is needed to preserve the number of lines after preprocessing a
+      --  source file, otherwise LSP requests based on SLOCs will fail.
+
+      -------------------
+      -- Set_Line_Mode --
+      -------------------
+
+      procedure Set_Line_Mode
+        (Config : in out Libadalang.Preprocessing.File_Config) is
+      begin
+         if Config.Enabled then
+            Config.Line_Mode := Libadalang.Preprocessing.Blank_Lines;
+         end if;
+      end Set_Line_Mode;
+
+      procedure Read_Excluded_Source_Files;
+      --  Read IDE.Excluded_Source_Files value from the project if any
+
+      --------------------------------
+      -- Read_Excluded_Source_Files --
+      --------------------------------
+
+      procedure Read_Excluded_Source_Files is
+         Attribute : GPR2.Project.Attribute.Object;
+      begin
+         if View.Check_Attribute
+              (Name   => LSP.Ada_Projects.IDE.Excluded_Source_Files,
+               Result => Attribute)
+         then
+            for Value of Attribute.Values loop
+               declare
+                  Name : constant GPR2.Filename_Optional :=
+                    GPR2.Filename_Optional (Value.Text);
+
+                  Source : constant GPR2.Build.Source.Object :=
+                    (if GPR2.Is_Simple_Name (Name)
+                     then Tree.Root_Project.Visible_Source (Name)
+                     else GPR2.Build.Source.Undefined);
+               begin
+                  if Source.Is_Defined then
+                     Self.Excluded_Files.Insert
+                        (Source.Path_Name.Virtual_File);
+                  end if;
+               end;
+            end loop;
+         end if;
+      end Read_Excluded_Source_Files;
+
+      Default_Config : Libadalang.Preprocessing.File_Config;
+      File_Configs   : Libadalang.Preprocessing.File_Config_Maps.Map;
+
+   begin
+      Self.Preprocessing_Data := Libadalang.Preprocessing.No_Preprocessor_Data;
+
+      Read_Excluded_Source_Files;  --  Read IDE.Excluded_Source_Files attr
+
+      Libadalang.Preprocessing.Extract_Preprocessor_Data_From_Project
+        (Tree           => 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);
+
+      Self.Preprocessing_Data :=
+        Libadalang.Preprocessing.Create_Preprocessor_Data
+          (Default_Config, File_Configs);
+   end Initialize;
+
    ---------------------
    -- Read_And_Decode --
    ---------------------
 
    procedure Read_And_Decode
-     (Filename : String;
+     (Filename : Virtual_File;
       Charset  : VSS.Strings.Virtual_String;
       Decoded  : out VSS.Strings.Virtual_String;
       Error    : out VSS.Strings.Virtual_String)
@@ -80,7 +169,7 @@ package body LSP.Ada_Handlers.File_Readers is
    begin
       --  Read the file (this call uses MMAP)
 
-      Raw := Create_From_UTF8 (Filename).Read_File;
+      Raw := Filename.Read_File;
 
       if Raw = null then
          Decoded.Clear;
@@ -134,6 +223,7 @@ package body LSP.Ada_Handlers.File_Readers is
       URI : constant URIs.URI_String := URIs.Conversions.From_File (Filename);
 
       Doc   : Document_Access;
+      File : constant Virtual_File := Create_From_UTF8 (Filename);
       Text  : VSS.Strings.Virtual_String;
       Error : VSS.Strings.Virtual_String;
 
@@ -150,9 +240,13 @@ package body LSP.Ada_Handlers.File_Readers is
       if Doc /= null then
          Text := Doc.Text;
 
+      elsif Self.Excluded_Files.Contains (File) then
+         Contents :=
+           Langkit_Support.File_Readers.Create_Decoded_File_Contents ("");
+
       else
          Read_And_Decode
-           (Filename => Filename,
+           (Filename => File,
             Charset  => VSS.Strings.Conversions.To_Virtual_String (Charset),
             Decoded  => Text,
             Error    => Error);

source/ada/lsp-ada_handlers-file_readers.ads

@@ -16,32 +16,54 @@
 ------------------------------------------------------------------------------
 
 --  This package provides a Langkit File_Reader which is able to
---     - read files from open documents
---     - preprocess code on the fly
+--  - read files from open documents
+--  - return empty text if file is excluded
+--  - preprocess code on the fly
+
+with GPR2.Project.View;
 
 with Langkit_Support.File_Readers;
 with Langkit_Support.Diagnostics;
 with Libadalang.Preprocessing;
 
 package LSP.Ada_Handlers.File_Readers is
 
-   type LSP_File_Reader (Handler : access Message_Handler'Class) is new
-     Langkit_Support.File_Readers.File_Reader_Interface with
-   record
+   type LSP_File_Reader (Handler : access Message_Handler'Class) is
+     new Langkit_Support.File_Readers.File_Reader_Interface with private;
+
+   procedure Initialize
+     (Self : in out LSP_File_Reader'Class;
+      Tree : GPR2.Project.Tree.Object;
+      View : GPR2.Project.View.Object);
+   --  Extract the preprocessing options from the context's project
+   --  and create the file reader which will preprocess the files
+   --  accordingly.
+   --  Extract IDE.Excluded_Source_Files list from the project and keep it
+   --  to ignore such files when reading.
+
+private
+
+   type LSP_File_Reader (Handler : access Message_Handler'Class) is
+     new Langkit_Support.File_Readers.File_Reader_Interface
+   with record
       Preprocessing_Data : Libadalang.Preprocessing.Preprocessor_Data :=
-           Libadalang.Preprocessing.No_Preprocessor_Data;
+        Libadalang.Preprocessing.No_Preprocessor_Data;
+
+      Excluded_Files : LSP.Ada_File_Sets.File_Sets.Set;
+      --  Set of files from IDE.Excluded_Source_Files project attribute
    end record;
 
-   overriding procedure Read
+   overriding
+   procedure Read
      (Self        : LSP_File_Reader;
       Filename    : String;
       Charset     : String;
       Read_BOM    : Boolean;
       Contents    : out Langkit_Support.File_Readers.Decoded_File_Contents;
-      Diagnostics : in out
-        Langkit_Support.Diagnostics.Diagnostics_Vectors.Vector);
+      Diagnostics :
+        in out Langkit_Support.Diagnostics.Diagnostics_Vectors.Vector);
 
-   overriding procedure Release
-     (Self : in out LSP_File_Reader) is null;
+   overriding
+   procedure Release (Self : in out LSP_File_Reader) is null;
 
 end LSP.Ada_Handlers.File_Readers;

source/ada/lsp-ada_handlers-project_loading.adb

@@ -35,7 +35,6 @@ 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;
 with LSP.Ada_Context_Sets;
@@ -533,47 +532,11 @@ package body LSP.Ada_Handlers.Project_Loading is
            LSP.Ada_Handlers.File_Readers.LSP_File_Reader
              (Self'Unchecked_Access);
 
-         Default_Config : Libadalang.Preprocessing.File_Config;
-         File_Configs   : Libadalang.Preprocessing.File_Config_Maps.Map;
-
-         procedure Set_Line_Mode
-           (Config : in out Libadalang.Preprocessing.File_Config);
-         --  Used to force the preprocessing line mode to Blank_Lines, which
-         --  is needed to preserve the number of lines after preprocessing a
-         --  source file, otherwise LSP requests based on SLOCs will fail.
-
-         -------------------
-         -- Set_Line_Mode --
-         -------------------
-
-         procedure Set_Line_Mode
-           (Config : in out Libadalang.Preprocessing.File_Config) is
-         begin
-            if Config.Enabled then
-               Config.Line_Mode := Libadalang.Preprocessing.Blank_Lines;
-            end if;
-         end Set_Line_Mode;
-
       begin
-         --  Extract the preprocessing options from the context's project
-         --  and create the file reader which will preprocess the files
-         --  accordingly.
-
          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);
+            Reader.Initialize
+              (Tree => Self.Project_Tree,
+               View => View);
          exception
             --  Fallback to a degraded mode when failing to parse preprocessing
             --  options.
@@ -592,8 +555,6 @@ package body LSP.Ada_Handlers.Project_Loading is
                  & (C.Id)
                  & ", fallback to a degraded mode without support for "
                  & "preprocessing directives");
-               Reader.Preprocessing_Data :=
-                 Libadalang.Preprocessing.No_Preprocessor_Data;
          end;
 
          C.Initialize