3 * Copyright 2017-2019 Ben Iofel <ben@iofel.me>
4 * Copyright 2017-2020 Princeton Ferro <princetonferro@gmail.com>
5 * Copyright 2020 Sergii Fesenko <s.fesenko@outlook.com>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Lesser General Public License as published by
9 * the Free Software Foundation, either version 2.1 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 * Defines how the host (editor) should sync document changes to the language server.
25 [CCode (default_value = "LSP_TEXT_DOCUMENT_SYNC_KIND_Unset")]
26 public enum TextDocumentSyncKind {
29 * Documents should not be synced at all.
33 * Documents are synced by always sending the full content of the document.
37 * Documents are synced by sending the full content on open. After that only incremental
38 * updates to the document are sent.
43 public enum DiagnosticSeverity {
54 * Reports an information.
64 public class Position : Object, Gee.Comparable<Position> {
66 * Line position in a document (zero-based).
68 public uint line { get; set; default = -1; }
71 * Character offset on a line in a document (zero-based). Assuming that the line is
72 * represented as a string, the `character` value represents the gap between the
73 * `character` and `character + 1`.
75 * If the character value is greater than the line length it defaults back to the
78 public uint character { get; set; default = -1; }
80 public int compare_to (Position other) {
81 return line > other.line ? 1 :
83 (character > other.character ? 1 :
84 (character == other.character ? 0 : -1)) : -1);
86 public bool equals(Position o) {
87 return o.line == this.line && o.character == this.character;
90 public string to_string () {
91 return @"$line:$character";
94 public Position.from_libvala (Vala.SourceLocation sloc) {
96 character = sloc.column;
99 public Position dup () {
100 return this.translate ();
103 public Position translate (int dl = 0, int dc = 0) {
104 return new Position () {
105 line = this.line + dl,
106 character = this.character + dc
111 public class Range : Object, Gee.Hashable<Range>, Gee.Comparable<Range> {
113 public Range.simple(uint line, uint pos) {
114 var p = new Position () {
123 * The range's start position.
125 public Position start { get; set; }
128 * The range's end position.
130 public Position end { get; set; }
132 private string? filename;
134 public string to_string () { return (filename != null ? @"$filename:" : "") + @"$start -> $end"; }
136 public Range.from_pos (Position pos) {
138 this.end = pos.dup ();
141 public Range.from_sourceref (Vala.SourceReference sref) {
142 this.start = new Position.from_libvala (sref.begin);
143 this.end = new Position.from_libvala (sref.end);
144 this.start.character -= 1;
145 this.filename = sref.file.filename;
148 public uint hash () {
149 return this.to_string ().hash ();
152 public bool equal_to (Range other) { return this.to_string () == other.to_string (); }
153 public bool equals (Range o) {
154 return this.filename == o.filename && this.start.equals(o.start) && this.end.equals(o.end);
157 public int compare_to (Range other) {
158 return start.compare_to (other.start);
162 * Return a new range that includes `this` and `other`.
164 public Range union (Range other) {
165 var range = new Range () {
166 start = start.compare_to (other.start) < 0 ? start : other.start,
167 end = end.compare_to (other.end) < 0 ? other.end : end,
169 if (filename == other.filename)
170 range.filename = filename;
174 public bool contains (Position pos) {
175 return start.compare_to (pos) <= 0 && pos.compare_to (end) <= 0;
180 public class Diagnostic : Object {
182 public Diagnostic.simple ( int line, int character, string message)
184 this.message = message;
185 this.severity = DiagnosticSeverity.Error;
186 this.range = new Range.simple(line, character );
192 * The range at which the message applies.
194 public Range range { get; set; }
197 * The diagnostic's severity. Can be omitted. If omitted it is up to the
198 * client to interpret diagnostics as error, warning, info or hint.
200 public DiagnosticSeverity severity { get; set; }
203 * The diagnostic's code. Can be omitted.
205 public string? code { get; set; }
208 * A human-readable string describing the source of this
209 * diagnostic, e.g. 'typescript' or 'super lint'.
211 public string? source { get; set; }
214 * The diagnostic's message.
216 public string message { get; set; }
219 public string category {
221 switch(this.severity) {
223 case DiagnosticSeverity.Error :
225 case DiagnosticSeverity.Warning :
226 return this.message.contains("deprecated") ? "DEPR" : "WARN";
234 public bool equals(Lsp.Diagnostic o) {
235 var ret = this.range.equals(o.range) && this.severity == o.severity && this.message == o.message;
236 //GLib.debug("compare %s (%s == %s)", ret ? "YES" : "NO", this.to_string(), o.to_string());
241 public string to_string()
243 return "%s : %d - %s".printf(this.category, (int) this.range.start.line , this.message);
249 * An event describing a change to a text document. If range and rangeLength are omitted
250 * the new text is considered to be the full content of the document.
252 public class TextDocumentContentChangeEvent : Object {
253 public Range? range { get; set; }
254 public int rangeLength { get; set; }
255 public string text { get; set; }
258 public enum MessageType {
268 * An information message.
277 public class TextDocumentIdentifier : Object {
278 public string uri { get; set; }
281 public class VersionedTextDocumentIdentifier : TextDocumentIdentifier {
283 * The version number of this document. If a versioned text document identifier
284 * is sent from the server to the client and the file is not open in the editor
285 * (the server has not received an open notification before) the server can send
286 * `null` to indicate that the version is known and the content on disk is the
287 * master (as speced with document content ownership).
289 * The version number of a document will increase after each change, including
290 * undo/redo. The number doesn't need to be consecutive.
292 public int version { get; set; default = -1; }
295 public class TextDocumentPositionParams : Object {
296 public TextDocumentIdentifier textDocument { get; set; }
297 public Position position { get; set; }
300 public class ReferenceParams : TextDocumentPositionParams {
301 public class ReferenceContext : Object {
302 public bool includeDeclaration { get; set; }
304 public ReferenceContext? context { get; set; }
307 public class Location : Object {
308 public string uri { get; set; }
309 public Range range { get; set; }
311 public Location.from_sourceref (Vala.SourceReference sref) {
312 this (sref.file.filename, new Range.from_sourceref (sref));
315 public Location (string filename, Range range) {
316 this.uri = File.new_for_commandline_arg (filename).get_uri ();
321 [CCode (default_value = "LSP_DOCUMENT_HIGHLIGHT_KIND_Text")]
322 public enum DocumentHighlightKind {
328 public class DocumentHighlight : Object {
329 public Range range { get; set; }
330 public DocumentHighlightKind kind { get; set; }
333 public class DocumentSymbolParams: Object {
334 public TextDocumentIdentifier textDocument { get; set; }
337 public class DocumentSymbol : Object, Json.Serializable {
338 private Vala.SourceReference? _source_reference;
339 public string name { get; set; }
340 public string? detail { get; set; }
341 public SymbolKind kind { get; set; }
342 public bool deprecated { get; set; }
343 private Range? _initial_range;
346 if (_initial_range == null)
347 _initial_range = new Range.from_sourceref (children.first ()._source_reference);
349 return children.fold<Range> ((child, current_range) => current_range.union (child.range), _initial_range);
352 public Range selectionRange { get; set; }
353 public GLib.ListStore children { get; private set; default = new Glib.ListStore(typeof(DocumentSymbol)); }
354 public string? parent_name;
356 private DocumentSymbol () {}
359 * @param type the data type containing this symbol, if there was one (not available for Namespaces, for example)
360 * @param sym the symbol
363 public DocumentSymbol.from_vala_symbol (Vala.DataType? type, Vala.Symbol sym, SymbolKind kind) {
364 this.parent_name = sym.parent_symbol != null ? sym.parent_symbol.name : null;
365 this._initial_range = new Range.from_sourceref (sym.source_reference);
366 if (sym is Vala.Subroutine) {
367 var sub = (Vala.Subroutine) sym;
368 var body_sref = sub.body != null ? sub.body.source_reference : null;
369 // debug ("subroutine %s found (body @ %s)", sym.get_full_name (),
370 // body_sref != null ? body_sref.to_string () : null);
371 if (body_sref != null && (body_sref.begin.line < body_sref.end.line ||
372 val = GLib.Value (typeof(Gee.ArrayList)); body_sref.begin.line == body_sref.end.line && body_sref.begin.pos <= body_sref.end.pos)) {
373 this._initial_range = this._initial_range.union (new Range.from_sourceref (body_sref));
376 this.name = sym.name;
377 this.detail = Vls.CodeHelp.get_symbol_representation (type, sym, null, false);
379 this.selectionRange = new Range.from_sourceref (sym.source_reference);
380 this.deprecated = sym.version.deprecated;
383 public new void Json.Serializable.set_property (ParamSpec pspec, Value value) {
384 base.set_property (pspec.get_name (), value);
387 public new Value Json.Serializable.get_property (ParamSpec pspec) {
388 Value val = Value (pspec.value_type);
389 base.get_property (pspec.get_name (), ref val);
393 public unowned ParamSpec? find_property (string name) {
394 return this.get_class ().find_property (name);
397 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
398 // if (property_name != "children")
399 return default_serialize_property (property_name, value, pspec);
400 /*var node = new Json.Node (Json.NodeType.ARRAY);
401 node.init_array (new Json.Array ());
402 var array = node.get_array ();
403 foreach (var child in children)
404 array.add_element (Json.gobject_serialize (child));
409 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node)
412 if (property_name != "children") {
413 return default_deserialize_property (property_name, out value, pspec, property_node);
415 value = GLib.Value (typeof(GLib.ListStore));
416 if (property_node.get_node_type () != Json.NodeType.ARRAY) {
417 warning ("unexpected property node type for 'arguments' %s", property_node.get_node_type ().to_string ());
421 var arguments = new GLib.ListStore(typeof(DocumentSymbol));
423 property_node.get_array ().foreach_element ((array, index, element) => {
425 var add= Json.gobject_deserialize ( typeof (DocumentSymbol), array.get_element(index)) as DocumentSymbol;
426 arguments.append( add);
431 value.set_object (arguments);
436 public class SymbolInformation : Object {
437 public string name { get; set; }
438 public SymbolKind kind { get; set; }
439 public Location location { get; set; }
440 public string? containerName { get; set; }
442 public SymbolInformation.from_document_symbol (DocumentSymbol dsym, string uri) {
443 this.name = dsym.name;
444 this.kind = dsym.kind;
445 this.location = new Location (uri, dsym.range);
446 this.containerName = dsym.parent_name;
450 [CCode (default_value = "LSP_SYMBOL_KIND_Variable")]
451 public enum SymbolKind {
480 public class CompletionList : Object, Json.Serializable {
481 public bool isIncomplete { get; set; }
482 public Gee.List<CompletionItem> items { get; private set; default = new Gee.LinkedList<CompletionItem> (); }
484 public new void Json.Serializable.set_property (ParamSpec pspec, Value value) {
485 base.set_property (pspec.get_name (), value);
488 public new Value Json.Serializable.get_property (ParamSpec pspec) {
489 Value val = Value(pspec.value_type);
490 base.get_property (pspec.get_name (), ref val);
494 public unowned ParamSpec? find_property (string name) {
495 return this.get_class ().find_property (name);
498 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
499 if (property_name != "items")
500 return default_serialize_property (property_name, value, pspec);
501 var node = new Json.Node (Json.NodeType.ARRAY);
502 node.init_array (new Json.Array ());
503 var array = node.get_array ();
504 foreach (var child in items)
505 array.add_element (Json.gobject_serialize (child));
509 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node) {
510 error ("deserialization not supported");
514 [CCode (default_value = "LSP_COMPLETION_TRIGGER_KIND_Invoked")]
515 public enum CompletionTriggerKind {
517 * Completion was triggered by typing an identifier (24x7 code
518 * complete), manual invocation (e.g Ctrl+Space) or via API.
523 * Completion was triggered by a trigger character specified by
524 * the `triggerCharacters` properties of the `CompletionRegistrationOptions`.
526 TriggerCharacter = 2,
529 * Completion was re-triggered as the current completion list is incomplete.
531 TriggerForIncompleteCompletions = 3
534 public class CompletionContext : Object {
535 public CompletionTriggerKind triggerKind { get; set;}
536 public string? triggerCharacter { get; set; }
539 public class CompletionParams : TextDocumentPositionParams {
541 * The completion context. This is only available if the client specifies
542 * to send this using `ClientCapabilities.textDocument.completion.contextSupport === true`
544 public CompletionContext? context { get; set; }
547 public enum CompletionItemTag {
548 // Render a completion as obsolete, usually using a strike-out.
552 [CCode (default_value = "LSP_INSERT_TEXT_FORMAT_PlainText")]
553 public enum InsertTextFormat {
555 * The primary text to be inserted is treated as a plain string.
560 * The primary text to be inserted is treated as a snippet.
562 * A snippet can define tab stops and placeholders with `$1`, `$2`
563 * and `${3:foo}`. `$0` defines the final tab stop, it defaults to
564 * the end of the snippet. Placeholders with equal identifiers are linked,
565 * that is typing in one will update others too.
570 public class CompletionItem : Object, Gee.Hashable<CompletionItem>, Json.Serializable {
571 public string label { get; set; }
572 public CompletionItemKind kind { get; set; }
573 public string detail { get; set; }
574 public MarkupContent? documentation { get; set; }
575 public bool deprecated { get; set; }
576 public Gee.List<CompletionItemTag> tags { get; private set; default = new Gee.ArrayList<CompletionItemTag> (); }
577 public string? insertText { get; set; }
578 public InsertTextFormat insertTextFormat { get; set; default = InsertTextFormat.PlainText; }
581 private CompletionItem () {}
583 public CompletionItem.keyword (string keyword, string? insert_text = null, string? documentation = null) {
584 this.label = keyword;
585 this.kind = CompletionItemKind.Keyword;
586 this.insertText = insert_text;
587 if (insert_text != null && (insert_text.contains ("$0") || insert_text.contains ("${0")))
588 this.insertTextFormat = InsertTextFormat.Snippet;
589 if (documentation != null)
590 this.documentation = new MarkupContent.from_plaintext (documentation);
591 this._hash = @"$label $kind".hash ();
595 * A completion suggestion from an existing Vala symbol.
597 * @param instance_type the parent data type of data type of the expression where this symbol appears, or null
598 * @param sym the symbol itself
599 * @param scope the scope to display this in
600 * @param kind the kind of completion to display
601 * @param documentation the documentation to display
602 * @param label_override if non-null, override the displayed symbol name with this
605 public CompletionItem.from_symbol (Vala.DataType? instance_type, Vala.Symbol sym, Vala.Scope? scope,
606 CompletionItemKind kind,
607 Vls.DocComment? documentation, string? label_override = null) {
608 this.label = label_override ?? sym.name;
610 this.detail = Vls.CodeHelp.get_symbol_representation (instance_type, sym, scope, true, null, label_override, false);
611 this._hash = @"$label $kind".hash ();
613 if (documentation != null)
614 this.documentation = new MarkupContent.from_markdown (documentation.body);
616 var version = sym.get_attribute ("Version");
617 if (version != null && (version.get_bool ("deprecated") || version.get_string ("deprecated_since") != null)) {
618 this.tags.add (CompletionItemTag.Deprecated);
619 this.deprecated = true;
624 * A completion suggestion from a data type and a synthetic symbol name.
626 * @param symbol_type the data type of the symbol
627 * @param symbol_name the name of the synthetic symbol
628 * @param scope the scope that this completion item is displayed in, or null
629 * @param kind the type of completion to display
630 * @param documentation the documentation for this symbol, or null
633 public CompletionItem.from_synthetic_symbol (Vala.DataType symbol_type, string symbol_name, Vala.Scope? scope,
634 CompletionItemKind kind, Vls.DocComment? documentation) {
635 this.label = symbol_name;
637 this.detail = @"$(Vls.CodeHelp.get_symbol_representation (symbol_type, null, scope, true, null, null, false)) $symbol_name";
638 this._hash = @"$label $kind".hash ();
640 if (documentation != null)
641 this.documentation = new MarkupContent.from_markdown (documentation.body);
645 public CompletionItem.from_unimplemented_symbol (Vala.Symbol sym,
646 string label, CompletionItemKind kind,
648 Vls.DocComment? documentation) {
651 this.insertText = insert_text;
652 if (insert_text.contains ("$0") || insert_text.contains ("${0"))
653 this.insertTextFormat = InsertTextFormat.Snippet;
654 this._hash = @"$label $kind".hash ();
655 if (documentation != null)
656 this.documentation = new MarkupContent.from_markdown (documentation.body);
660 public uint hash () {
664 public bool equal_to (CompletionItem other) {
665 return other.label == this.label && other.kind == this.kind;
668 public new void Json.Serializable.set_property (ParamSpec pspec, Value value) {
669 base.set_property (pspec.get_name (), value);
672 public new Value Json.Serializable.get_property (ParamSpec pspec) {
673 Value val = Value(pspec.value_type);
674 base.get_property (pspec.get_name (), ref val);
678 public unowned ParamSpec? find_property (string name) {
679 return this.get_class ().find_property (name);
682 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
683 if (property_name != "tags")
684 return default_serialize_property (property_name, value, pspec);
686 var node = new Json.Node (Json.NodeType.ARRAY);
687 node.init_array (new Json.Array ());
688 var array = node.get_array ();
689 foreach (var tag in this.tags) {
690 array.add_int_element (tag);
695 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node)
697 if (property_name != "tags") {
698 return default_deserialize_property (property_name, out value, pspec, property_node);
700 value = GLib.Value (typeof(Gee.ArrayList));
701 if (property_node.get_node_type () != Json.NodeType.ARRAY) {
702 warning ("unexpected property node type for 'arguments' %s", property_node.get_node_type ().to_string ());
706 var arguments = new Gee.ArrayList<CompletionItemTag>();
708 property_node.get_array ().foreach_element ((array, index, element) => {
710 arguments.add ((CompletionItemTag) Json.gvariant_deserialize (element, null).get_int32() );
712 warning ("argument %u to command could not be deserialized: %s", index, e.message);
716 value.set_object (arguments);
721 public class MarkupContent : Object {
722 public string kind { get; set; }
723 public string value { get; set; }
725 private MarkupContent () {}
728 * Create a MarkupContent with plain text.
730 public MarkupContent.from_plaintext (string doc) {
731 this.kind = "plaintext";
736 * Create a MarkupContent with markdown text.
738 public MarkupContent.from_markdown (string doc) {
739 this.kind = "markdown";
744 [CCode (default_value = "LSP_COMPLETION_ITEM_KIND_Text")]
745 public enum CompletionItemKind {
774 * Capabilities of the client/editor for `textDocument/documentSymbol`
776 public class DocumentSymbolCapabilities : Object {
777 public bool hierarchicalDocumentSymbolSupport { get; set; }
781 * Capabilities of the client/editor for `textDocument/rename`
783 public class RenameClientCapabilities : Object {
784 public bool prepareSupport { get; set; }
788 * Capabilities of the client/editor pertaining to language features.
790 public class TextDocumentClientCapabilities : Object {
791 public DocumentSymbolCapabilities documentSymbol { get; set; default = new DocumentSymbolCapabilities ();}
792 public RenameClientCapabilities rename { get; set; default = new RenameClientCapabilities (); }
796 * Capabilities of the client/editor.
798 public class ClientCapabilities : Object {
799 public TextDocumentClientCapabilities textDocument { get; set; default = new TextDocumentClientCapabilities (); }
802 public class InitializeParams : Object {
803 public int processId { get; set; }
804 public string? rootPath { get; set; }
805 public string? rootUri { get; set; }
806 public ClientCapabilities capabilities { get; set; default = new ClientCapabilities (); }
809 public class SignatureInformation : Object, Json.Serializable {
810 public string label { get; set; }
811 public MarkupContent documentation { get; set; }
813 public Gee.List<ParameterInformation> parameters { get; private set; default = new Gee.LinkedList<ParameterInformation> (); }
815 public new void Json.Serializable.set_property (ParamSpec pspec, Value value) {
816 base.set_property (pspec.get_name (), value);
819 public new Value Json.Serializable.get_property (ParamSpec pspec) {
820 Value val = Value(pspec.value_type);
821 base.get_property (pspec.get_name (), ref val);
825 public unowned ParamSpec? find_property (string name) {
826 return this.get_class ().find_property (name);
829 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
830 if (property_name != "parameters")
831 return default_serialize_property (property_name, value, pspec);
832 var node = new Json.Node (Json.NodeType.ARRAY);
833 node.init_array (new Json.Array ());
834 var array = node.get_array ();
835 foreach (var child in parameters)
836 array.add_element (Json.gobject_serialize (child));
840 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node) {
841 error ("deserialization not supported");
845 public class SignatureHelp : Object, Json.Serializable {
846 public Gee.Collection<SignatureInformation> signatures { get; set; default = new Gee.ArrayList<SignatureInformation> (); }
847 public int activeSignature { get; set; }
848 public int activeParameter { get; set; }
850 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
851 if (property_name != "signatures")
852 return default_serialize_property (property_name, value, pspec);
854 var node = new Json.Node (Json.NodeType.ARRAY);
855 node.init_array (new Json.Array ());
856 var array = node.get_array ();
857 foreach (var child in signatures)
858 array.add_element (Json.gobject_serialize (child));
862 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node) {
863 error ("deserialization not supported");
867 public class ParameterInformation : Object {
868 public string label { get; set; }
869 public MarkupContent documentation { get; set; }
872 public class MarkedString : Object {
873 public MarkedString(string language, string value)
875 this.language = language;
877 GLib.debug("new marked string %s : %s", language, value);
879 public string language { get; set; }
880 public string value { get; set; }
883 public class Hover : Object, Json.Serializable {
884 public Gee.List<MarkedString> contents { get; set; default = new Gee.ArrayList<MarkedString> (); }
885 public Range range { get; set; }
887 public new void Json.Serializable.set_property (ParamSpec pspec, Value value) {
888 base.set_property (pspec.get_name (), value);
891 public new Value Json.Serializable.get_property (ParamSpec pspec) {
892 Value val = Value(pspec.value_type);
893 base.get_property (pspec.get_name (), ref val);
897 public unowned ParamSpec? find_property (string name) {
898 return this.get_class ().find_property (name);
901 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
902 if (property_name != "contents")
903 return default_serialize_property (property_name, value, pspec);
904 var node = new Json.Node (Json.NodeType.ARRAY);
905 node.init_array (new Json.Array ());
906 var array = node.get_array ();
907 foreach (var child in contents) {
908 if (child.language != null)
909 array.add_element (Json.gobject_serialize (child));
911 array.add_element (new Json.Node (Json.NodeType.VALUE).init_string (child.value));
916 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node)
918 if (property_name == "contents") {
919 value = GLib.Value (typeof(Gee.ArrayList));
920 if (property_node.get_node_type () != Json.NodeType.ARRAY) {
921 warning ("unexpected property node type for 'arguments' %s", property_node.get_node_type ().to_string ());
924 var contents = new Gee.ArrayList<MarkedString>();
926 property_node.get_array ().foreach_element ((array, index, element) => {
928 var add = new MarkedString(
929 array.get_object_element(index).get_string_member("language"),
930 array.get_object_element(index).get_string_member("value")
933 contents.add ( add );
935 warning ("argument %u to command could not be deserialized: %s", index, e.message);
938 value.set_object (contents);
942 return default_deserialize_property (property_name, out value, pspec, property_node);
947 * A textual edit applicable to a text document.
949 public class TextEdit : Object {
951 * The range of the text document to be manipulated. To insert
952 * text into a document create a range where ``start === end``.
954 public Range range { get; set; }
957 * The string to be inserted. For delete operations use an
960 public string newText { get; set; }
962 public TextEdit (Range range, string new_text = "") {
964 this.newText = new_text;
969 * Describes textual changes on a single text document. The text document is
970 * referred to as a {@link VersionedTextDocumentIdentifier} to allow clients to
971 * check the text document version before an edit is applied. A
972 * {@link TextDocumentEdit} describes all changes on a version ``Si`` and after they are
973 * applied move the document to version ``Si+1``. So the creator of a
974 * {@link TextDocumentEdit} doesn’t need to sort the array of edits or do any kind
975 * of ordering. However the edits must be non overlapping.
977 public class TextDocumentEdit : Object, Json.Serializable {
979 * The text document to change.
981 public VersionedTextDocumentIdentifier textDocument { get; set; }
984 * The edits to be applied.
986 public Gee.ArrayList<TextEdit> edits { get; set; default = new Gee.ArrayList<TextEdit> (); }
988 public TextDocumentEdit (VersionedTextDocumentIdentifier text_document) {
989 this.textDocument = text_document;
992 public Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
993 if (property_name != "edits")
994 return default_serialize_property (property_name, value, pspec);
996 var node = new Json.Node (Json.NodeType.ARRAY);
997 node.init_array (new Json.Array ());
998 var array = node.get_array ();
999 foreach (var text_edit in edits) {
1000 array.add_element (Json.gobject_serialize (text_edit));
1005 public bool deserialize_property (string property_name, out GLib.Value value, GLib.ParamSpec pspec, Json.Node property_node) {
1006 error ("deserialization not supported");
1010 public abstract class CommandLike : Object, Json.Serializable {
1012 * The identifier of the actual command handler.
1014 public string command { get; set; }
1017 * Arguments that the command handler should be invoked with.
1019 public Array<Variant>? arguments { get; set; }
1021 public Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1022 if (property_name != "arguments" || arguments == null)
1023 return default_serialize_property (property_name, value, pspec);
1025 var array = new Json.Array ();
1026 for (int i = 0; i < arguments.length; i++)
1027 array.add_element (Json.gvariant_serialize (arguments.index (i)));
1029 var node = new Json.Node (Json.NodeType.ARRAY);
1030 node.set_array (array);
1034 public bool deserialize_property (string property_name, out GLib.Value value, GLib.ParamSpec pspec, Json.Node property_node)
1036 if (property_name == "arguments") {
1037 value = GLib.Value (typeof(Array));
1038 if (property_node.get_node_type () != Json.NodeType.ARRAY) {
1039 warning ("unexpected property node type for 'arguments' %s", property_node.get_node_type ().to_string ());
1043 var arguments = new Array<Variant> ();
1045 property_node.get_array ().foreach_element ((array, index, element) => {
1047 arguments.append_val (Json.gvariant_deserialize (element, null));
1049 warning ("argument %u to command could not be deserialized: %s", index, e.message);
1053 value.set_boxed (arguments);
1055 } else if (property_name == "command") {
1056 // workaround for json-glib < 1.5.2 (Ubuntu 20.04 / eOS 6)
1057 if (property_node.get_value_type () != typeof (string)) {
1059 warning ("unexpected property node type for 'commands' %s", property_node.get_node_type ().to_string ());
1063 value = property_node.get_string ();
1066 return default_deserialize_property (property_name, out value, pspec, property_node);
1071 public class ExecuteCommandParams : CommandLike {
1075 * Represents a reference to a command. Provides a title which will be used
1076 * to represent a command in the UI. Commands are identified by a string
1077 * identifier. The recommended way to handle commands is to implement their
1078 * execution on the server side if the client and server provides the
1079 * corresponding capabilities. Alternatively the tool extension code could
1080 * handle the command. The protocol currently doesn’t specify a set of
1081 * well-known commands.
1083 public class Command : CommandLike {
1085 * The title of the command, like `save`.
1087 public string title { get; set; }
1091 * A code lens represents a command that should be shown along with
1092 * source text, like the number of references, a way to run tests, etc.
1094 * A code lens is _unresolved_ when no command is associated to it. For
1095 * performance reasons the creation of a code lens and resolving should be done
1098 public class CodeLens : Object {
1100 * The range in which this code lens is valid. Should only span a single
1103 public Range range { get; set; }
1106 * The command this code lens represents.
1108 public Command? command { get; set; }
1111 public class DocumentRangeFormattingParams : Object {
1112 public TextDocumentIdentifier textDocument { get; set; }
1113 public Range? range { get; set; }
1114 public FormattingOptions options { get; set; }
1117 public class FormattingOptions : Object {
1118 public uint tabSize { get; set; }
1119 public bool insertSpaces { get; set; }
1120 public bool trimTrailingWhitespace { get; set; }
1121 public bool insertFinalNewline { get; set; }
1122 public bool trimFinalNewlines { get; set; }
1125 public class CodeActionParams : Object {
1126 public TextDocumentIdentifier textDocument { get; set; }
1127 public Range range { get; set; }
1128 public CodeActionContext context { get; set; }
1132 public class CodeActionContext : Object, Json.Serializable {
1133 public Gee.List<Diagnostic> diagnostics { get; set; default = new Gee.ArrayList<Diagnostic> (); }
1134 public string[]? only { get; set; }
1136 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node) {
1137 if (property_name != "diagnostics")
1138 return default_deserialize_property (property_name, out value, pspec, property_node);
1139 var diags = new Gee.ArrayList<Diagnostic> ();
1140 property_node.get_array ().foreach_element ((array, index, element) => {
1142 diags.add (Vls.Util.parse_variant<Diagnostic> (Json.gvariant_deserialize (element, null)));
1144 warning ("argument %u could not be deserialized: %s", index, e.message);
1154 public class Diagnostics : Object, Json.Serializable
1156 public Diagnostics()
1158 this.diagnostics = new Gee.ArrayList<Diagnostic>((a,b) => {
1163 public string uri { get; set; }
1165 public int version { get; set; default = 0; }
1166 public Gee.ArrayList<Diagnostic>? diagnostics { get; set; }
1168 public string filename {
1170 return File.new_for_uri (this.uri).get_path();
1175 public bool deserialize_property (string property_name, out GLib.Value val, GLib.ParamSpec pspec, Json.Node property_node) {
1176 if (property_name == "diagnostics") {
1177 val = GLib.Value (typeof(Gee.ArrayList));
1178 var diags = new Gee.ArrayList<Diagnostic> ((a,b) => {
1181 if (property_node.get_node_type () != Json.NodeType.ARRAY) {
1182 val.set_object(diags);
1183 warning ("unexpected property node type for 'arguments' %s", property_node.get_node_type ().to_string ());
1189 property_node.get_array ().foreach_element ((array, index, element) => {
1191 diags.add (Json.gobject_deserialize (typeof (Lsp.Diagnostic), element) as Diagnostic );
1193 //warning ("argument %u to command could not be deserialized: %s", index, e.message);
1196 val.set_object(diags);
1201 return default_deserialize_property (property_name, out val, pspec, property_node);
1209 public class CodeAction : Object, Json.Serializable {
1210 public string title { get; set; }
1211 public string? kind { get; set; }
1212 public Gee.Collection<Diagnostic>? diagnostics { get; set; }
1213 public bool isPreferred { get; set; }
1214 public WorkspaceEdit? edit { get; set; }
1215 public Command? command { get; set; }
1216 public Object? data { get; set; }
1218 protected void add_diagnostic (Diagnostic diag) {
1219 if (diagnostics == null)
1220 diagnostics = new Gee.ArrayList<Diagnostic> ();
1221 diagnostics.add (diag);
1224 public override Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1225 if (property_name != "diagnostics")
1226 return default_serialize_property (property_name, value, pspec);
1228 var array = new Json.Array ();
1229 if (diagnostics != null)
1230 foreach (var text_edit in diagnostics)
1231 array.add_element (Json.gobject_serialize (text_edit));
1232 return new Json.Node.alloc ().init_array (array);
1236 public class WorkspaceEdit : Object, Json.Serializable {
1237 public Gee.List<TextDocumentEdit>? documentChanges { get; set; }
1239 public Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1240 if (property_name != "documentChanges")
1241 return default_serialize_property (property_name, value, pspec);
1243 var node = new Json.Node (Json.NodeType.ARRAY);
1244 node.init_array (new Json.Array ());
1245 if (documentChanges != null) {
1246 var array = node.get_array ();
1247 foreach (var text_edit in documentChanges) {
1248 array.add_element (Json.gobject_serialize (text_edit));
1256 public enum SymbolTags {
1261 public class CallHierarchyItem : Object, Json.Serializable {
1262 public string name { get; set; }
1263 public SymbolKind kind { get; set; }
1264 public SymbolTags tags { get; set; }
1265 public string? detail { get; set; }
1266 public string uri { get; set; }
1267 public Range range { get; set; }
1268 public Range selectionRange { get; set; }
1270 public override Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1271 if (property_name != "tags")
1272 return default_serialize_property (property_name, value, pspec);
1273 var array = new Json.Array ();
1274 if (SymbolTags.DEPRECATED in tags)
1275 array.add_int_element (SymbolTags.DEPRECATED);
1276 return new Json.Node.alloc ().init_array (array);
1279 public CallHierarchyItem.from_symbol (Vala.Symbol symbol) {
1280 this.name = symbol.get_full_name ();
1281 if (symbol is Vala.Method) {
1282 if (symbol.parent_symbol is Vala.Namespace)
1283 this.kind = SymbolKind.Function;
1285 this.kind = SymbolKind.Method;
1286 } else if (symbol is Vala.Signal) {
1287 this.kind = SymbolKind.Event;
1288 } else if (symbol is Vala.Constructor) {
1289 this.kind = SymbolKind.Constructor;
1291 this.kind = SymbolKind.Method;
1293 var version = symbol.get_attribute ("Version");
1294 if (version != null && (version.get_bool ("deprecated") || version.get_string ("deprecated_since") != null)) {
1295 this.tags |= SymbolTags.DEPRECATED;
1297 this.detail = Vls.CodeHelp.get_symbol_representation (null, symbol, null, true);
1298 this.uri = File.new_for_commandline_arg (symbol.source_reference.file.filename).get_uri ();
1299 this.range = new Range.from_sourceref (symbol.source_reference);
1300 if (symbol.comment != null)
1301 this.range = new Range.from_sourceref (symbol.comment.source_reference).union (this.range);
1302 if (symbol is Vala.Subroutine && ((Vala.Subroutine)symbol).body != null)
1303 this.range = new Range.from_sourceref (((Vala.Subroutine)symbol).body.source_reference).union (this.range);
1304 this.selectionRange = new Range.from_sourceref (symbol.source_reference);
1309 public class CallHierarchyIncomingCall : Json.Serializable, Object {
1311 * The method that calls the query method.
1313 public CallHierarchyItem from { get; set; }
1316 * The ranges at which the query method is called by `from`.
1318 public Gee.ArrayList<Range> fromRanges { get; set; default = new Gee.ArrayList<Range> (); }
1320 public override Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1321 if (property_name == "from")
1322 return default_serialize_property (property_name, value, pspec);
1323 var array = new Json.Array ();
1324 foreach (var range in fromRanges)
1325 array.add_element (Json.gobject_serialize (range));
1326 return new Json.Node.alloc ().init_array (array);
1330 public class CallHierarchyOutgoingCall : Json.Serializable, Object {
1332 * The method that the query method calls.
1334 public CallHierarchyItem to { get; set; }
1337 * The ranges at which the method is called by the query method.
1339 public Gee.ArrayList<Range> fromRanges { get; set; default = new Gee.ArrayList<Range> (); }
1341 public override Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1342 if (property_name == "to")
1343 return default_serialize_property (property_name, value, pspec);
1344 var array = new Json.Array ();
1345 foreach (var range in fromRanges)
1346 array.add_element (Json.gobject_serialize (range));
1347 return new Json.Node.alloc ().init_array (array);
1351 public class InlayHintParams : Json.Serializable, Object {
1352 public TextDocumentIdentifier textDocument { get; set; }
1353 public Range range { get; set; }
1356 public enum InlayHintKind {
1362 public class InlayHint : Object {
1363 public Position position { get; set; }
1364 public string label { get; set; }
1365 public InlayHintKind kind { get; set; }
1366 public string? tooltip { get; set; }
1367 public bool paddingLeft { get; set; }
1368 public bool paddingRight { get; set; }
1371 public class TypeHierarchyItem : Object, Json.Serializable {
1373 * The name of this item
1375 public string name { get; set; }
1378 * The kind of this item
1380 public SymbolKind kind { get; set; }
1383 * Tags for this item
1385 public SymbolTags tags { get; set; }
1388 * More detail for this item, e.g. the signature of a function.
1390 public string? detail { get; set; }
1393 * The resource identifier of this item.
1395 public string uri { get; set; }
1398 * The range enclosing this symbol not including leading/trailing
1399 * whitespace, but everything else, e.g. comments and code.
1401 public Range range { get; set; }
1404 * The range that should be selected and revealed when this symbol
1405 * is being picked, e.g. the name of a function. Must be contained
1406 * by {@link TypeHierarchyItem.range}
1408 public Range selectionRange { get; set; }
1410 private TypeHierarchyItem () {}
1412 public TypeHierarchyItem.from_symbol (Vala.TypeSymbol symbol) {
1413 this.name = symbol.get_full_name ();
1414 if (symbol is Vala.Class)
1415 this.kind = SymbolKind.Class;
1416 else if (symbol is Vala.Delegate)
1417 this.kind = SymbolKind.Interface;
1418 else if (symbol is Vala.Enum)
1419 this.kind = SymbolKind.Enum;
1420 else if (symbol is Vala.ErrorCode)
1421 this.kind = SymbolKind.EnumMember;
1422 else if (symbol is Vala.ErrorDomain)
1423 this.kind = SymbolKind.Enum;
1424 else if (symbol is Vala.Interface)
1425 this.kind = SymbolKind.Interface;
1426 else if (symbol is Vala.Struct)
1427 this.kind = SymbolKind.Struct;
1428 else if (symbol is Vala.TypeParameter)
1429 this.kind = SymbolKind.TypeParameter;
1431 this.kind = SymbolKind.Module;
1432 warning ("unexpected symbol kind in type hierarchy: `%s'", symbol.type_name);
1435 var version = symbol.get_attribute ("Version");
1436 if (version != null && (version.get_bool ("deprecated") || version.get_string ("deprecated_since") != null)) {
1437 this.tags |= SymbolTags.DEPRECATED;
1439 this.detail = Vls.CodeHelp.get_symbol_representation (null, symbol, null, true);
1440 this.uri = File.new_for_commandline_arg (symbol.source_reference.file.filename).get_uri ();
1441 this.range = new Range.from_sourceref (symbol.source_reference);
1442 this.selectionRange = this.range;
1444 // widen range to include all members
1445 if (symbol is Vala.ObjectTypeSymbol) {
1446 foreach (var member in ((Vala.ObjectTypeSymbol)symbol).get_members ()) {
1447 if (member.source_reference != null)
1448 this.range = this.range.union (new Range.from_sourceref (member.source_reference));
1450 } else if (symbol is Vala.Enum) {
1451 foreach (var member in ((Vala.Enum)symbol).get_values ()) {
1452 if (member.source_reference != null)
1453 this.range = this.range.union (new Range.from_sourceref (member.source_reference));
1455 foreach (var method in ((Vala.Enum)symbol).get_methods ()) {
1456 if (method.source_reference != null)
1457 this.range = this.range.union (new Range.from_sourceref (method.source_reference));
1459 } else if (symbol is Vala.ErrorDomain) {
1460 foreach (var member in ((Vala.ErrorDomain)symbol).get_codes ()) {
1461 if (member.source_reference != null)
1462 this.range = this.range.union (new Range.from_sourceref (member.source_reference));
1464 foreach (var method in ((Vala.ErrorDomain)symbol).get_methods ()) {
1465 if (method.source_reference != null)
1466 this.range = this.range.union (new Range.from_sourceref (method.source_reference));
1468 } else if (symbol is Vala.Struct) {
1469 foreach (var field in ((Vala.Struct)symbol).get_fields ()) {
1470 if (field.source_reference != null)
1471 this.range = this.range.union (new Range.from_sourceref (field.source_reference));
1473 foreach (var method in ((Vala.Struct)symbol).get_methods ()) {
1474 if (method.source_reference != null)
1475 this.range = this.range.union (new Range.from_sourceref (method.source_reference));