Merge branch 'topic/generics' into 'master'

godunko · godunko · commit cab693eb0027 · 2023-06-23T10:24:36.000Z
Update tests after changes in GNATdoc

See merge request eng/ide/ada_language_server!1237
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -4,6 +4,7 @@ variables:
 
 stages:
   - build_and_test
+  - run_downstream_ci
 
 .detect-branches:
   #  Version 2.
@@ -156,3 +157,23 @@ build_and_test:
      reports:
        junit: xunit_output.xml
        lsif: dump.lsif
+
+.run_ci_common: &run_ci_common
+  stage: run_downstream_ci
+  rules:
+    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
+      when: manual
+  trigger:
+    strategy: depend
+  inherit:
+    variables: false
+  variables:
+    ACI_UPSTREAM_PROJECT_PATH: $CI_PROJECT_PATH
+    ACI_UPSTREAM_REF_NAME: $CI_COMMIT_REF_NAME
+    ACI_UPSTREAM_SOURCE_BRANCH: $CI_MERGE_REQUEST_SOURCE_BRANCH_NAME
+    ACI_UPSTREAM_TARGET_BRANCH: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME
+
+run_gs_ci:
+  <<: *run_ci_common
+  trigger:
+    project: eng/ide/gnatstudio
diff --git a/source/ada/lsp-lal_utils.adb b/source/ada/lsp-lal_utils.adb
@@ -806,13 +806,14 @@ package body LSP.Lal_Utils is
    is
       pragma Unreferenced (Trace);
 
-      Options : constant
+      Options    : constant
         GNATdoc.Comments.Options.Extractor_Options :=
           (Style    => Style,
            Pattern  => <>,
            Fallback => True);
-      Decl_Lines         : VSS.String_Vectors.Virtual_String_Vector;
-      Doc_Lines     : VSS.String_Vectors.Virtual_String_Vector;
+      Decl_Lines : VSS.String_Vectors.Virtual_String_Vector;
+      Doc_Lines  : VSS.String_Vectors.Virtual_String_Vector;
+
    begin
       --  Extract documentation with GNATdoc when supported.
 
@@ -827,7 +828,8 @@ package body LSP.Lal_Utils is
 
       --  If GNATdoc failed to compute the declaration text, use the old engine
       if Decl_Text.Is_Empty
-        or else not BD.P_Subp_Spec_Or_Null.Is_Null
+        or else (BD.Kind not in Ada_Enum_Literal_Decl
+                   and not BD.P_Subp_Spec_Or_Null.Is_Null)
       then
          --  For subprograms additional information is added, use old code to
          --  obtain it yet.
diff --git a/testsuite/ada_lsp/T713-012.completion.generic_package/test.json b/testsuite/ada_lsp/T713-012.completion.generic_package/test.json
@@ -275,7 +275,7 @@
                "result": {
                   "label": "Params of G",
                   "kind": 15,
-                  "detail": "generic\n    type Elt_Type(<>) is limited private;\n    type Elt_Ptr is access all Elt_Type;\npackage G is\n    type T(Length: Natural) is private;\n    type T_Ptr is access all T;\nprivate\n    type Elt_Array is array(Positive range <>) of Elt_Ptr;\n    type T(Length: Natural) is\n\trecord\n\t    Elts: Elt_Array(1..Length);\n\tend record;\nend G;",
+                  "detail": "generic\n    type Elt_Type(<>) is limited private;\n    type Elt_Ptr is access all Elt_Type;\npackage G",
                   "documentation": "at g.ads (3:1)\n\nSource:\n\n@formal Elt_Type\n@formal Elt_Ptr",
                   "sortText": "+0",
                   "insertText": "${1:Elt_Type : type Elt_Type(<>) is limited private;}, ${2:Elt_Ptr : type Elt_Ptr is access all Elt_Type;})$0",
@@ -516,7 +516,7 @@
                "result": {
                   "label": "Params of G",
                   "kind": 15,
-                  "detail": "generic\n    type Elt_Type(<>) is limited private;\n    type Elt_Ptr is access all Elt_Type;\npackage G is\n    type T(Length: Natural) is private;\n    type T_Ptr is access all T;\nprivate\n    type Elt_Array is array(Positive range <>) of Elt_Ptr;\n    type T(Length: Natural) is\n\trecord\n\t    Elts: Elt_Array(1..Length);\n\tend record;\nend G;",
+                  "detail": "generic\n    type Elt_Type(<>) is limited private;\n    type Elt_Ptr is access all Elt_Type;\npackage G",
                   "documentation": "at g.ads (3:1)\n\nSource:\n\n@formal Elt_Type\n@formal Elt_Ptr",
                   "sortText": "+0",
                   "insertText": " Elt_Ptr => ${2:type Elt_Ptr is access all Elt_Type;})$0",
diff --git a/testsuite/ada_lsp/UA28-007.Did_Rename_Files_0/test.json b/testsuite/ada_lsp/UA28-007.Did_Rename_Files_0/test.json
@@ -1318,7 +1318,7 @@
                   "contents": [
                      {
                         "language": "ada",
-                        "value": "package Qux "
+                        "value": "package Qux"
                      },
                      "at qux.ads (1:1)"
                   ]
@@ -1468,7 +1468,7 @@
                   "contents": [
                      {
                         "language": "ada",
-                        "value": "package Qux "
+                        "value": "package Qux"
                      },
                      "at qux.ads (1:1)"
                   ]
diff --git a/testsuite/ada_lsp/completion.invisible.runtime/test.json b/testsuite/ada_lsp/completion.invisible.runtime/test.json
@@ -211,7 +211,7 @@
                      {
                         "label": "Decimal (invisible)",
                         "kind": 9,
-                        "detail": "package Ada.Decimal ",
+                        "detail": "package Ada.Decimal",
                         "documentation": "at a-decima.ads (38:1)\n\nThe compiler makes a number of assumptions based on the following five\nconstants (e.g. there is an assumption that decimal values can always\nbe represented in 128-bit signed binary form), so code modifications are\nrequired to increase these constants.",
                         "sortText": "~100&08Decimal",
                         "filterText": "Decimal",
diff --git a/testsuite/ada_lsp/completion.invisible3/test.json b/testsuite/ada_lsp/completion.invisible3/test.json
@@ -155,7 +155,7 @@
                      {
                         "label": "ABC14 (invisible)",
                         "kind": 9,
-                        "detail": "generic\n      ABC13 : Integer;\npackage ABC14 ",
+                        "detail": "generic\n   ABC13 : Integer;\npackage ABC14",
                         "documentation": "at pkg.ads (19:4)",
                         "sortText": "~100&1ABC14",
                         "insertText": "ABC14",
diff --git a/testsuite/ada_lsp/completion.invisible4/test.json b/testsuite/ada_lsp/completion.invisible4/test.json
@@ -146,15 +146,15 @@
                      {
                         "label": "Child",
                         "kind": 9,
-                        "detail": "package Pkg_1.Child ",
+                        "detail": "package Pkg_1.Child",
                         "documentation": "at pkg_1-child.ads (3:1)",
                         "sortText": "100&1Child",
                         "additionalTextEdits": []
                      },
                      {
                         "label": "Child2 (invisible)",
                         "kind": 9,
-                        "detail": "package Pkg_1.Child2 ",
+                        "detail": "package Pkg_1.Child2",
                         "documentation": "at pkg_1-child2.ads (1:1)",
                         "sortText": "~100&2Child2",
                         "insertText": "Child2",
diff --git a/testsuite/ada_lsp/completion.invisible5/test.json b/testsuite/ada_lsp/completion.invisible5/test.json
@@ -146,7 +146,7 @@
                         {
                            "label": "Ada",
                            "kind": 9,
-                           "detail": "package Ada ",
+                           "detail": "package Ada",
                            "documentation": "<ANY>",
                            "sortText": "100&1Ada",
                            "additionalTextEdits": []
diff --git a/testsuite/ada_lsp/completion.snippet.formatting3/test.json b/testsuite/ada_lsp/completion.snippet.formatting3/test.json
@@ -278,7 +278,7 @@
                "result": {
                   "label": "Params of Foo_Bar",
                   "kind": 15,
-                  "detail": "generic\n      A      : Integer;\n      BBBBBB : Float;\n      CCCC   : String;\n      with procedure Bar (X : Integer);\n   package Foo_Bar is\n      procedure Do_Nothing;\n\n      procedure Do_Nothing is\n      begin\n         null;\n      end Do_Nothing;\n   end Foo_Bar;",
+                  "detail": "generic\n   A      : Integer;\n   BBBBBB : Float;\n   CCCC   : String;\n   with procedure Bar (X : Integer);\npackage Foo_Bar",
                   "documentation": "at foo.adb (3:4)",
                   "sortText": "+0",
                   "insertText": "A => ${1:A      : Integer;}, BBBBBB => ${2:BBBBBB : Float;}, CCCC => ${3:CCCC   : String;}, Bar => ${4:with procedure Bar (X : Integer);})$0",
diff --git a/testsuite/ada_lsp/completion.subp_parameters/test.json b/testsuite/ada_lsp/completion.subp_parameters/test.json
@@ -402,7 +402,7 @@
                         {
                            "label": "ASCII",
                            "kind": 9,
-                           "detail": "package ASCII ",
+                           "detail": "package ASCII",
                            "documentation": "<ANY>",
                            "additionalTextEdits": []
                         },

Original file line number	Diff line number	Diff line change
`@@ -1318,7 +1318,7 @@`
`1318`	`1318`	`"contents": [`
`1319`	`1319`	`{`
`1320`	`1320`	`"language": "ada",`
`1321`		`- "value": "package Qux "`
	`1321`	`+ "value": "package Qux"`
`1322`	`1322`	`},`
`1323`	`1323`	`"at qux.ads (1:1)"`
`1324`	`1324`	`]`
`@@ -1468,7 +1468,7 @@`
`1468`	`1468`	`"contents": [`
`1469`	`1469`	`{`
`1470`	`1470`	`"language": "ada",`
`1471`		`- "value": "package Qux "`
	`1471`	`+ "value": "package Qux"`
`1472`	`1472`	`},`
`1473`	`1473`	`"at qux.ads (1:1)"`
`1474`	`1474`	`]`
Original file line number	Diff line number	Diff line change
`@@ -211,7 +211,7 @@`
`211`	`211`	`{`
`212`	`212`	`"label": "Decimal (invisible)",`
`213`	`213`	`"kind": 9,`
`214`		`- "detail": "package Ada.Decimal ",`
	`214`	`+ "detail": "package Ada.Decimal",`
`215`	`215`	`"documentation": "at a-decima.ads (38:1)\n\nThe compiler makes a number of assumptions based on the following five\nconstants (e.g. there is an assumption that decimal values can always\nbe represented in 128-bit signed binary form), so code modifications are\nrequired to increase these constants.",`
`216`	`216`	`"sortText": "~100&08Decimal",`
`217`	`217`	`"filterText": "Decimal",`
Original file line number	Diff line number	Diff line change
`@@ -155,7 +155,7 @@`
`155`	`155`	`{`
`156`	`156`	`"label": "ABC14 (invisible)",`
`157`	`157`	`"kind": 9,`
`158`		`- "detail": "generic\n ABC13 : Integer;\npackage ABC14 ",`
	`158`	`+ "detail": "generic\n ABC13 : Integer;\npackage ABC14",`
`159`	`159`	`"documentation": "at pkg.ads (19:4)",`
`160`	`160`	`"sortText": "~100&1ABC14",`
`161`	`161`	`"insertText": "ABC14",`
Original file line number	Diff line number	Diff line change
`@@ -146,7 +146,7 @@`
`146`	`146`	`{`
`147`	`147`	`"label": "Ada",`
`148`	`148`	`"kind": 9,`
`149`		`- "detail": "package Ada ",`
	`149`	`+ "detail": "package Ada",`
`150`	`150`	`"documentation": "<ANY>",`
`151`	`151`	`"sortText": "100&1Ada",`
`152`	`152`	`"additionalTextEdits": []`
Original file line number	Diff line number	Diff line change
`@@ -402,7 +402,7 @@`
`402`	`402`	`{`
`403`	`403`	`"label": "ASCII",`
`404`	`404`	`"kind": 9,`
`405`		`- "detail": "package ASCII ",`
	`405`	`+ "detail": "package ASCII",`
`406`	`406`	`"documentation": "<ANY>",`
`407`	`407`	`"additionalTextEdits": []`
`408`	`408`	`},`