Merge branch 'topic/vadim/docs' into 'master'

Testcases for objects and exceptions

See merge request eng/ide/gnatdoc!203

Author: godunko

source/gnatdoc-comments-helpers.adb

@@ -496,6 +496,7 @@ package body GNATdoc.Comments.Helpers is
                | Ada_Generic_Package_Decl
                | Ada_Generic_Subp_Decl
                | Ada_Incomplete_Type_Decl
+               | Ada_Number_Decl
                | Ada_Object_Decl
                | Ada_Package_Body
                | Ada_Package_Decl
@@ -511,7 +512,7 @@ package body GNATdoc.Comments.Helpers is
 
       All_Decls          : constant Libadalang.Analysis.Defining_Name_Array :=
         Name.P_All_Parts;
-      Most_Visible_Decl  : constant Libadalang.Analysis.Defining_Name :=
+      Most_Visible_Decl  : Libadalang.Analysis.Defining_Name :=
         (if Origin.Is_Null
            then Name.As_Defining_Name else Name.P_Most_Visible_Part (Origin));
       Most_Visible_Index : Positive := All_Decls'First;
@@ -527,6 +528,18 @@ package body GNATdoc.Comments.Helpers is
       Comment            : Structured_Comment;
 
    begin
+      --  LAL 20250922: `P_Most_Visible_Part` returns `null` for named
+      --  numbers.
+
+      if Most_Visible_Decl.Is_Null then
+         if Name.P_Basic_Decl.Kind = Ada_Number_Decl then
+            Most_Visible_Decl := Name.As_Defining_Name;
+
+         else
+            raise Program_Error;
+         end if;
+      end if;
+
       --  Lookup for index of most visible declaration
 
       for J in All_Decls'Range loop

testsuite/als_helper/exceptions.adb

@@ -0,0 +1,15 @@
+
+package body Exceptions is
+
+   procedure Dummy is
+   begin
+      begin
+         raise Test_Exception;
+
+      exception
+         when Test_Exception =>
+            null;
+      end;
+   end Dummy;
+
+end Exceptions;

testsuite/als_helper/exceptions.ads

@@ -0,0 +1,11 @@
+
+package Exceptions is
+
+   Test_Exception : exception;
+   --  Description of the exception
+
+private
+
+   procedure Dummy;
+
+end Exceptions;

testsuite/als_helper/exceptions_package.adb

@@ -0,0 +1,16 @@
+with Exceptions; use Exceptions;
+
+package body Exceptions_Package is
+
+   procedure Dummy is
+   begin
+      begin
+         raise Test_Exception;
+
+      exception
+         when Test_Exception =>
+            null;
+      end;
+   end Dummy;
+
+end Exceptions_Package;

testsuite/als_helper/exceptions_package.ads

@@ -0,0 +1,6 @@
+
+package Exceptions_Package is
+
+   procedure Dummy;
+
+end Exceptions_Package;

testsuite/als_helper/locations.json

@@ -87,6 +87,50 @@
     {"file": "discriminant_record_types_package.adb", "line": 36, "column": 26},
     //  reference: `Known_Discriminant_Private_Null_Record`
 
+    {"file": "objects.ads", "line": 4, "column": 4},
+    //  declaration: `Named_Number`
+    {"file": "objects.adb", "line": 7, "column": 30},
+    //  reference: `Named_Number`
+    {"file": "objects_package.adb", "line": 8, "column": 30},
+    //  reference: `Named_Number`
+
+    {"file": "objects.ads", "line": 7, "column": 4},
+    //  declaration `Public_Constant`
+    {"file": "objects.adb", "line": 14, "column": 30},
+    //  reference `Public_Constant`
+    {"file": "objects_package.adb", "line": 15, "column": 30},
+    //  reference `Public_Constant`
+
+    {"file": "objects.ads", "line": 10, "column": 4},
+    //  declaration `Private_Constant`
+    {"file": "objects.ads", "line": 21, "column": 4},
+    //  declaration `Private_Constant`
+    {"file": "objects.adb", "line": 21, "column": 30},
+    //  reference `Private_Constant`
+    {"file": "objects_package.adb", "line": 22, "column": 30},
+    //  reference `Private_Constant`
+
+    {"file": "objects.ads", "line": 13, "column": 4},
+    //  declaration of the object
+    {"file": "objects.adb", "line": 28, "column": 30},
+    //  reference of the object
+    {"file": "objects_package.adb", "line": 29, "column": 30},
+    //  reference of the object
+
+    {"file": "objects.ads", "line": 16, "column": 4},
+    //  declaration of the object with default value
+    {"file": "objects.adb", "line": 35, "column": 30},
+    //  reference of the object with default value
+    {"file": "objects_package.adb", "line": 36, "column": 30},
+    //  reference of the object with default value
+
+    {"file": "exceptions.ads", "line": 4, "column": 4},
+    //  declaration of the exception
+    {"file": "exceptions.adb", "line": 7, "column": 16},
+    //  reference of the exception
+    {"file": "exceptions_package.adb", "line": 8, "column": 16},
+    //  reference of the exception
+
     // {"file": "pkg1.ads", "line": 5, "column": 9},  // package specification name
     // {"file": "pkg1.ads", "line": 9, "column": 5},  // package specification end name
     // {"file": "pkg1.adb", "line": 5, "column": 14},  // package body name

testsuite/als_helper/objects.adb

@@ -0,0 +1,42 @@
+
+package body Objects is
+
+   procedure Dummy is
+   begin
+      declare
+         Object : Integer := Named_Number;
+
+      begin
+         null;
+      end;
+
+      declare
+         Object : Integer := Public_Constant;
+
+      begin
+         null;
+      end;
+
+      declare
+         Object : Integer := Private_Constant;
+
+      begin
+         null;
+      end;
+
+      declare
+         Object : Integer := Value;
+
+      begin
+         null;
+      end;
+
+      declare
+         Object : Integer := Value_Default;
+
+      begin
+         null;
+      end;
+   end Dummy;
+
+end Objects;

testsuite/als_helper/objects.ads

@@ -0,0 +1,26 @@
+
+package Objects is
+
+   Named_Number : constant := 2;
+   --  Description of the named number
+
+   Public_Constant : constant Integer := 3;
+   --  Description of the `Public_Constant`
+
+   Private_Constant : constant Integer;
+   --  Public description of the `Private_Constant`
+
+   Value : Integer;
+   --  Description of the object
+
+   Value_Default : Integer := 1;
+   --  Description of the object with default value
+
+private
+
+   Private_Constant : constant Integer := 4;
+   --  Private description of the `Private_Constant`
+
+   procedure Dummy;
+
+end Objects;

testsuite/als_helper/objects_package.adb

@@ -0,0 +1,43 @@
+with Objects; use Objects;
+
+package body Objects_Package is
+
+   procedure Dummy is
+   begin
+      declare
+         Object : Integer := Named_Number;
+
+      begin
+         null;
+      end;
+
+      declare
+         Object : Integer := Public_Constant;
+
+      begin
+         null;
+      end;
+
+      declare
+         Object : Integer := Private_Constant;
+
+      begin
+         null;
+      end;
+
+      declare
+         Object : Integer := Value;
+
+      begin
+         null;
+      end;
+
+      declare
+         Object : Integer := Value_Default;
+
+      begin
+         null;
+      end;
+   end Dummy;
+
+end Objects_Package;

testsuite/als_helper/objects_package.ads

@@ -0,0 +1,8 @@
+
+package Objects_Package is
+
+private
+
+   procedure Dummy;
+
+end Objects_Package;