1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117 | ------------------------------------------------------------------------------
-- Language Server Protocol --
-- --
-- Copyright (C) 2018-2021, AdaCore --
-- --
-- This is free software; you can redistribute it and/or modify it under --
-- terms of the GNU General Public License as published by the Free Soft- --
-- ware Foundation; either version 3, or (at your option) any later ver- --
-- sion. This software is distributed in the hope that it will be useful, --
-- but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHAN- --
-- TABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public --
-- License for more details. You should have received a copy of the GNU --
-- General Public License distributed with this software; see file --
-- COPYING3. If not, go to http://www.gnu.org/licenses for a complete copy --
-- of the license. --
------------------------------------------------------------------------------
--
-- This package provides types to support completions in Ada Language server.
with Ada.Containers.Hashed_Maps;
with Ada.Strings.Hash_Case_Insensitive;
with Langkit_Support.Slocs;
with Langkit_Support.Text;
with Libadalang.Analysis;
with Libadalang.Common;
limited with LSP.Ada_Contexts;
limited with LSP.Ada_Completions.Filters;
with LSP.Messages;
package LSP.Ada_Completions is
function Hash (Name : Libadalang.Analysis.Defining_Name)
return Ada.Containers.Hash_Type is
(Ada.Strings.Hash_Case_Insensitive (
Langkit_Support.Text.To_UTF8 (Name.Full_Sloc_Image)));
function Is_Full_Sloc_Equal
(Left, Right : Libadalang.Analysis.Defining_Name) return Boolean;
-- Compare the two nodes using full sloc image (filename + sloc). Needed
-- for completion, since LAL can return several times the same declaration
-- and specially subprograms from generic instantiations.
type Name_Information is record
Is_Dot_Call : Boolean;
-- True if we are dealing with a dotted call.
Is_Visible : Boolean;
-- True if the item is visible from the withed/used packages, False
-- otherwise.
Use_Snippets : Boolean;
-- True if it's a snippet completion item.
Pos : Integer := -1;
-- The position of the item in the fully computed completion list. Used
-- for sorting properly the items on client-side.
end record;
package Completion_Maps is new Ada.Containers.Hashed_Maps
(Key_Type => Libadalang.Analysis.Defining_Name,
Element_Type => Name_Information,
Hash => Hash,
Equivalent_Keys => Is_Full_Sloc_Equal,
"=" => "=");
type Completion_Provider is abstract tagged limited null record;
procedure Propose_Completion
(Self : Completion_Provider;
Sloc : Langkit_Support.Slocs.Source_Location;
Token : Libadalang.Common.Token_Reference;
Node : Libadalang.Analysis.Ada_Node;
Filter : in out LSP.Ada_Completions.Filters.Filter;
Names : in out Ada_Completions.Completion_Maps.Map;
Result : in out LSP.Messages.CompletionList) is abstract;
-- Populate Names and Result with completions for given Source_Location.
-- Names works for defining name completions to create snippets and to
-- avoid duplicates. The Token's span encloses Sloc or Sloc can be at the
-- next character after the Token if the token not a trivia.
--
-- Example: abc; or abc<space>
-- Cursor: ^ ^
-- Consider `abc;` or `abc<space>` and Sloc is a character after `c`, then
-- Token is `abc`, because a user expect it to te completed.
-- The Node is immediate enclosing AST node for the token.
-- The Filter could be used to quick check common completion contexts.
procedure Write_Completions
(Context : LSP.Ada_Contexts.Context;
Names : Completion_Maps.Map;
Named_Notation_Threshold : Natural;
Compute_Doc_And_Details : Boolean;
Result : in out LSP.Messages.CompletionItem_Vector);
-- Convert all the completion Names into LSP completion items' results.
-- Named_Notation_Threshold defines the number of parameters/components at
-- which point named notation is used for subprogram/aggregate completion
-- snippets.
-- If Compute_Doc_And_Details is True, the 'detail' and 'documentation'
-- fields for all the resulting completion items will be computed
-- immediately, which might take time.
generic
with function Has_Been_Canceled return Boolean;
procedure Generic_Write_Symbols
(Names : Completion_Maps.Map;
Result : in out LSP.Messages.Symbol_Vector);
type Completion_Provider_Access is access all
LSP.Ada_Completions.Completion_Provider'Class;
type Completion_Provider_List is array (Positive range <>) of
Completion_Provider_Access;
end LSP.Ada_Completions;
|