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; }
344 public Range range { get; set; }
345 public Range selectionRange { get; set; }
346 public GLib.ListStore children { get; set; default = new GLib.ListStore(typeof(DocumentSymbol)); }
347 public string? parent_name;
349 private DocumentSymbol () {}
352 * @param type the data type containing this symbol, if there was one (not available for Namespaces, for example)
353 * @param sym the symbol
356 public DocumentSymbol.from_vala_symbol (Vala.DataType? type, Vala.Symbol sym, SymbolKind kind) {
357 this.parent_name = sym.parent_symbol != null ? sym.parent_symbol.name : null;
358 this._initial_range = new Range.from_sourceref (sym.source_reference);
359 if (sym is Vala.Subroutine) {
360 var sub = (Vala.Subroutine) sym;
361 var body_sref = sub.body != null ? sub.body.source_reference : null;
362 // debug ("subroutine %s found (body @ %s)", sym.get_full_name (),
363 // body_sref != null ? body_sref.to_string () : null);
364 if (body_sref != null && (body_sref.begin.line < body_sref.end.line ||
365 val = GLib.Value (typeof(Gee.ArrayList)); body_sref.begin.line == body_sref.end.line && body_sref.begin.pos <= body_sref.end.pos)) {
366 this._initial_range = this._initial_range.union (new Range.from_sourceref (body_sref));
369 this.name = sym.name;
370 this.detail = Vls.CodeHelp.get_symbol_representation (type, sym, null, false);
372 this.selectionRange = new Range.from_sourceref (sym.source_reference);
373 this.deprecated = sym.version.deprecated;
376 public new void Json.Serializable.set_property (ParamSpec pspec, Value value) {
377 base.set_property (pspec.get_name (), value);
380 public new Value Json.Serializable.get_property (ParamSpec pspec) {
381 Value val = Value (pspec.value_type);
382 base.get_property (pspec.get_name (), ref val);
386 public unowned ParamSpec? find_property (string name) {
387 return this.get_class ().find_property (name);
390 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
391 // if (property_name != "children")
392 return default_serialize_property (property_name, value, pspec);
393 /*var node = new Json.Node (Json.NodeType.ARRAY);
394 node.init_array (new Json.Array ());
395 var array = node.get_array ();
396 foreach (var child in children)
397 array.add_element (Json.gobject_serialize (child));
402 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node)
404 GLib.debug("deserialise property %s" , property_name);
405 if (property_name != "children") {
406 return default_deserialize_property (property_name, out value, pspec, property_node);
408 value = GLib.Value (typeof(GLib.ListStore));
409 if (property_node.get_node_type () != Json.NodeType.ARRAY) {
410 GLib.debug ("unexpected property node type for 'arguments' %s", property_node.get_node_type ().to_string ());
413 GLib.debug("got child length of %d", (int) property_node.get_array ().get_length());
414 var arguments = new GLib.ListStore(typeof(DocumentSymbol));
416 property_node.get_array ().foreach_element ((array, index, element) => {
418 var add= Json.gobject_deserialize ( typeof (DocumentSymbol), array.get_element(index)) as DocumentSymbol;
419 arguments.append( add);
424 value.set_object (arguments);
427 public string symbol_icon {
433 case Lsp.CompletionItemKind.Text: return "completion-snippet-symbolic"
434 case Lsp.CompletionItemKind.Method: return "lang-method-symbolic";
435 case Lsp.CompletionItemKind.Function: return "lang-function-symbolic";
436 case Lsp.CompletionItemKind.Constructor: return "lang-method-symbolic";
437 case Lsp.CompletionItemKind.Field: return "lang-struct-field-symbolic";
438 case Lsp.CompletionItemKind.Variable: return "lang-variable-symbolic";
439 case Lsp.CompletionItemKind.Class: return "lang-class-symbolic";
440 case Lsp.CompletionItemKind.Interface: return "lang-class-symbolic";
441 case Lsp.CompletionItemKind.Module: return "lang-namespace-symbolic";
442 case Lsp.CompletionItemKind.Property:return "lang-struct-field-symbolic";
443 case Lsp.CompletionItemKind.Unit: return "lang-variable-symbolic";
444 case Lsp.CompletionItemKind.Value: return "lang-variable-symbolic";
445 case Lsp.CompletionItemKind.Enum: return "lang-enum-symbolic";
446 case Lsp.CompletionItemKind.Keyword: return "completion-word-symbolic";
447 case Lsp.CompletionItemKind.Snippet: return "completion-snippet-symbolic";
449 case Lsp.CompletionItemKind.Color: return "lang-typedef-symbolic";
450 case Lsp.CompletionItemKind.File:return "lang-typedef-symbolic";
451 case Lsp.CompletionItemKind.Reference: return "lang-typedef-symbolic";
452 case Lsp.CompletionItemKind.Folder:return "lang-typedef-symbolic";
453 case Lsp.CompletionItemKind.EnumMember: return "lang-typedef-symbolic";
454 case Lsp.CompletionItemKind.Constant:return "lang-typedef-symbolic";
455 case Lsp.CompletionItemKind.Struct: return "lang-struct-symbolic";
456 case Lsp.CompletionItemKind.Event:return "lang-typedef-symbolic";
457 case Lsp.CompletionItemKind.Operator:return "lang-typedef-symbolic";
458 case Lsp.CompletionItemKind.TypeParameter:return "lang-typedef-symbolic";
463 return "completion-snippet-symbolic";
474 public class SymbolInformation : Object {
475 public string name { get; set; }
476 public SymbolKind kind { get; set; }
477 public Location location { get; set; }
478 public string? containerName { get; set; }
480 public SymbolInformation.from_document_symbol (DocumentSymbol dsym, string uri) {
481 this.name = dsym.name;
482 this.kind = dsym.kind;
483 // this.location = new Location (uri, dsym.range);
484 this.containerName = dsym.parent_name;
488 [CCode (default_value = "LSP_SYMBOL_KIND_Variable")]
489 public enum SymbolKind {
518 public class CompletionList : Object, Json.Serializable {
519 public bool isIncomplete { get; set; }
520 public Gee.List<CompletionItem> items { get; private set; default = new Gee.LinkedList<CompletionItem> (); }
522 public new void Json.Serializable.set_property (ParamSpec pspec, Value value) {
523 base.set_property (pspec.get_name (), value);
526 public new Value Json.Serializable.get_property (ParamSpec pspec) {
527 Value val = Value(pspec.value_type);
528 base.get_property (pspec.get_name (), ref val);
532 public unowned ParamSpec? find_property (string name) {
533 return this.get_class ().find_property (name);
536 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
537 if (property_name != "items")
538 return default_serialize_property (property_name, value, pspec);
539 var node = new Json.Node (Json.NodeType.ARRAY);
540 node.init_array (new Json.Array ());
541 var array = node.get_array ();
542 foreach (var child in items)
543 array.add_element (Json.gobject_serialize (child));
547 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node) {
548 error ("deserialization not supported");
552 [CCode (default_value = "LSP_COMPLETION_TRIGGER_KIND_Invoked")]
553 public enum CompletionTriggerKind {
555 * Completion was triggered by typing an identifier (24x7 code
556 * complete), manual invocation (e.g Ctrl+Space) or via API.
561 * Completion was triggered by a trigger character specified by
562 * the `triggerCharacters` properties of the `CompletionRegistrationOptions`.
564 TriggerCharacter = 2,
567 * Completion was re-triggered as the current completion list is incomplete.
569 TriggerForIncompleteCompletions = 3
572 public class CompletionContext : Object {
573 public CompletionTriggerKind triggerKind { get; set;}
574 public string? triggerCharacter { get; set; }
577 public class CompletionParams : TextDocumentPositionParams {
579 * The completion context. This is only available if the client specifies
580 * to send this using `ClientCapabilities.textDocument.completion.contextSupport === true`
582 public CompletionContext? context { get; set; }
585 public enum CompletionItemTag {
586 // Render a completion as obsolete, usually using a strike-out.
590 [CCode (default_value = "LSP_INSERT_TEXT_FORMAT_PlainText")]
591 public enum InsertTextFormat {
593 * The primary text to be inserted is treated as a plain string.
598 * The primary text to be inserted is treated as a snippet.
600 * A snippet can define tab stops and placeholders with `$1`, `$2`
601 * and `${3:foo}`. `$0` defines the final tab stop, it defaults to
602 * the end of the snippet. Placeholders with equal identifiers are linked,
603 * that is typing in one will update others too.
608 public class CompletionItem : Object, Gee.Hashable<CompletionItem>, Json.Serializable {
609 public string label { get; set; }
610 public CompletionItemKind kind { get; set; }
611 public string detail { get; set; }
612 public MarkupContent? documentation { get; set; }
613 public bool deprecated { get; set; }
614 public Gee.List<CompletionItemTag> tags { get; private set; default = new Gee.ArrayList<CompletionItemTag> (); }
615 public string? insertText { get; set; }
616 public InsertTextFormat insertTextFormat { get; set; default = InsertTextFormat.PlainText; }
619 private CompletionItem () {}
621 public CompletionItem.keyword (string keyword, string? insert_text = null, string? documentation = null) {
622 this.label = keyword;
623 this.kind = CompletionItemKind.Keyword;
624 this.insertText = insert_text;
625 if (insert_text != null && (insert_text.contains ("$0") || insert_text.contains ("${0")))
626 this.insertTextFormat = InsertTextFormat.Snippet;
627 if (documentation != null)
628 this.documentation = new MarkupContent.from_plaintext (documentation);
629 this._hash = @"$label $kind".hash ();
633 * A completion suggestion from an existing Vala symbol.
635 * @param instance_type the parent data type of data type of the expression where this symbol appears, or null
636 * @param sym the symbol itself
637 * @param scope the scope to display this in
638 * @param kind the kind of completion to display
639 * @param documentation the documentation to display
640 * @param label_override if non-null, override the displayed symbol name with this
643 public CompletionItem.from_symbol (Vala.DataType? instance_type, Vala.Symbol sym, Vala.Scope? scope,
644 CompletionItemKind kind,
645 Vls.DocComment? documentation, string? label_override = null) {
646 this.label = label_override ?? sym.name;
648 this.detail = Vls.CodeHelp.get_symbol_representation (instance_type, sym, scope, true, null, label_override, false);
649 this._hash = @"$label $kind".hash ();
651 if (documentation != null)
652 this.documentation = new MarkupContent.from_markdown (documentation.body);
654 var version = sym.get_attribute ("Version");
655 if (version != null && (version.get_bool ("deprecated") || version.get_string ("deprecated_since") != null)) {
656 this.tags.add (CompletionItemTag.Deprecated);
657 this.deprecated = true;
662 * A completion suggestion from a data type and a synthetic symbol name.
664 * @param symbol_type the data type of the symbol
665 * @param symbol_name the name of the synthetic symbol
666 * @param scope the scope that this completion item is displayed in, or null
667 * @param kind the type of completion to display
668 * @param documentation the documentation for this symbol, or null
671 public CompletionItem.from_synthetic_symbol (Vala.DataType symbol_type, string symbol_name, Vala.Scope? scope,
672 CompletionItemKind kind, Vls.DocComment? documentation) {
673 this.label = symbol_name;
675 this.detail = @"$(Vls.CodeHelp.get_symbol_representation (symbol_type, null, scope, true, null, null, false)) $symbol_name";
676 this._hash = @"$label $kind".hash ();
678 if (documentation != null)
679 this.documentation = new MarkupContent.from_markdown (documentation.body);
683 public CompletionItem.from_unimplemented_symbol (Vala.Symbol sym,
684 string label, CompletionItemKind kind,
686 Vls.DocComment? documentation) {
689 this.insertText = insert_text;
690 if (insert_text.contains ("$0") || insert_text.contains ("${0"))
691 this.insertTextFormat = InsertTextFormat.Snippet;
692 this._hash = @"$label $kind".hash ();
693 if (documentation != null)
694 this.documentation = new MarkupContent.from_markdown (documentation.body);
698 public uint hash () {
702 public bool equal_to (CompletionItem other) {
703 return other.label == this.label && other.kind == this.kind;
706 public new void Json.Serializable.set_property (ParamSpec pspec, Value value) {
707 base.set_property (pspec.get_name (), value);
710 public new Value Json.Serializable.get_property (ParamSpec pspec) {
711 Value val = Value(pspec.value_type);
712 base.get_property (pspec.get_name (), ref val);
716 public unowned ParamSpec? find_property (string name) {
717 return this.get_class ().find_property (name);
720 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
721 if (property_name != "tags")
722 return default_serialize_property (property_name, value, pspec);
724 var node = new Json.Node (Json.NodeType.ARRAY);
725 node.init_array (new Json.Array ());
726 var array = node.get_array ();
727 foreach (var tag in this.tags) {
728 array.add_int_element (tag);
733 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node)
735 if (property_name != "tags") {
736 return default_deserialize_property (property_name, out value, pspec, property_node);
738 value = GLib.Value (typeof(Gee.ArrayList));
739 if (property_node.get_node_type () != Json.NodeType.ARRAY) {
740 warning ("unexpected property node type for 'arguments' %s", property_node.get_node_type ().to_string ());
744 var arguments = new Gee.ArrayList<CompletionItemTag>();
746 property_node.get_array ().foreach_element ((array, index, element) => {
748 arguments.add ((CompletionItemTag) Json.gvariant_deserialize (element, null).get_int32() );
750 warning ("argument %u to command could not be deserialized: %s", index, e.message);
754 value.set_object (arguments);
759 public class MarkupContent : Object {
760 public string kind { get; set; }
761 public string value { get; set; }
763 private MarkupContent () {}
766 * Create a MarkupContent with plain text.
768 public MarkupContent.from_plaintext (string doc) {
769 this.kind = "plaintext";
774 * Create a MarkupContent with markdown text.
776 public MarkupContent.from_markdown (string doc) {
777 this.kind = "markdown";
782 [CCode (default_value = "LSP_COMPLETION_ITEM_KIND_Text")]
783 public enum CompletionItemKind {
812 * Capabilities of the client/editor for `textDocument/documentSymbol`
814 public class DocumentSymbolCapabilities : Object {
815 public bool hierarchicalDocumentSymbolSupport { get; set; }
819 * Capabilities of the client/editor for `textDocument/rename`
821 public class RenameClientCapabilities : Object {
822 public bool prepareSupport { get; set; }
826 * Capabilities of the client/editor pertaining to language features.
828 public class TextDocumentClientCapabilities : Object {
829 public DocumentSymbolCapabilities documentSymbol { get; set; default = new DocumentSymbolCapabilities ();}
830 public RenameClientCapabilities rename { get; set; default = new RenameClientCapabilities (); }
834 * Capabilities of the client/editor.
836 public class ClientCapabilities : Object {
837 public TextDocumentClientCapabilities textDocument { get; set; default = new TextDocumentClientCapabilities (); }
840 public class InitializeParams : Object {
841 public int processId { get; set; }
842 public string? rootPath { get; set; }
843 public string? rootUri { get; set; }
844 public ClientCapabilities capabilities { get; set; default = new ClientCapabilities (); }
847 public class SignatureInformation : Object, Json.Serializable {
848 public string label { get; set; }
849 public MarkupContent documentation { get; set; }
851 public Gee.List<ParameterInformation> parameters { get; private set; default = new Gee.LinkedList<ParameterInformation> (); }
853 public new void Json.Serializable.set_property (ParamSpec pspec, Value value) {
854 base.set_property (pspec.get_name (), value);
857 public new Value Json.Serializable.get_property (ParamSpec pspec) {
858 Value val = Value(pspec.value_type);
859 base.get_property (pspec.get_name (), ref val);
863 public unowned ParamSpec? find_property (string name) {
864 return this.get_class ().find_property (name);
867 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
868 if (property_name != "parameters")
869 return default_serialize_property (property_name, value, pspec);
870 var node = new Json.Node (Json.NodeType.ARRAY);
871 node.init_array (new Json.Array ());
872 var array = node.get_array ();
873 foreach (var child in parameters)
874 array.add_element (Json.gobject_serialize (child));
878 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node) {
879 error ("deserialization not supported");
883 public class SignatureHelp : Object, Json.Serializable {
884 public Gee.Collection<SignatureInformation> signatures { get; set; default = new Gee.ArrayList<SignatureInformation> (); }
885 public int activeSignature { get; set; }
886 public int activeParameter { get; set; }
888 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
889 if (property_name != "signatures")
890 return default_serialize_property (property_name, value, pspec);
892 var node = new Json.Node (Json.NodeType.ARRAY);
893 node.init_array (new Json.Array ());
894 var array = node.get_array ();
895 foreach (var child in signatures)
896 array.add_element (Json.gobject_serialize (child));
900 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node) {
901 error ("deserialization not supported");
905 public class ParameterInformation : Object {
906 public string label { get; set; }
907 public MarkupContent documentation { get; set; }
910 public class MarkedString : Object {
911 public MarkedString(string language, string value)
913 this.language = language;
915 GLib.debug("new marked string %s : %s", language, value);
917 public string language { get; set; }
918 public string value { get; set; }
921 public class Hover : Object, Json.Serializable {
922 public Gee.List<MarkedString> contents { get; set; default = new Gee.ArrayList<MarkedString> (); }
923 public Range range { get; set; }
925 public new void Json.Serializable.set_property (ParamSpec pspec, Value value) {
926 base.set_property (pspec.get_name (), value);
929 public new Value Json.Serializable.get_property (ParamSpec pspec) {
930 Value val = Value(pspec.value_type);
931 base.get_property (pspec.get_name (), ref val);
935 public unowned ParamSpec? find_property (string name) {
936 return this.get_class ().find_property (name);
939 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
940 if (property_name != "contents")
941 return default_serialize_property (property_name, value, pspec);
942 var node = new Json.Node (Json.NodeType.ARRAY);
943 node.init_array (new Json.Array ());
944 var array = node.get_array ();
945 foreach (var child in contents) {
946 if (child.language != null)
947 array.add_element (Json.gobject_serialize (child));
949 array.add_element (new Json.Node (Json.NodeType.VALUE).init_string (child.value));
954 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node)
956 if (property_name == "contents") {
957 value = GLib.Value (typeof(Gee.ArrayList));
958 if (property_node.get_node_type () != Json.NodeType.ARRAY) {
959 warning ("unexpected property node type for 'arguments' %s", property_node.get_node_type ().to_string ());
962 var contents = new Gee.ArrayList<MarkedString>();
964 property_node.get_array ().foreach_element ((array, index, element) => {
966 var add = new MarkedString(
967 array.get_object_element(index).get_string_member("language"),
968 array.get_object_element(index).get_string_member("value")
971 contents.add ( add );
973 warning ("argument %u to command could not be deserialized: %s", index, e.message);
976 value.set_object (contents);
980 return default_deserialize_property (property_name, out value, pspec, property_node);
985 * A textual edit applicable to a text document.
987 public class TextEdit : Object {
989 * The range of the text document to be manipulated. To insert
990 * text into a document create a range where ``start === end``.
992 public Range range { get; set; }
995 * The string to be inserted. For delete operations use an
998 public string newText { get; set; }
1000 public TextEdit (Range range, string new_text = "") {
1002 this.newText = new_text;
1007 * Describes textual changes on a single text document. The text document is
1008 * referred to as a {@link VersionedTextDocumentIdentifier} to allow clients to
1009 * check the text document version before an edit is applied. A
1010 * {@link TextDocumentEdit} describes all changes on a version ``Si`` and after they are
1011 * applied move the document to version ``Si+1``. So the creator of a
1012 * {@link TextDocumentEdit} doesn’t need to sort the array of edits or do any kind
1013 * of ordering. However the edits must be non overlapping.
1015 public class TextDocumentEdit : Object, Json.Serializable {
1017 * The text document to change.
1019 public VersionedTextDocumentIdentifier textDocument { get; set; }
1022 * The edits to be applied.
1024 public Gee.ArrayList<TextEdit> edits { get; set; default = new Gee.ArrayList<TextEdit> (); }
1026 public TextDocumentEdit (VersionedTextDocumentIdentifier text_document) {
1027 this.textDocument = text_document;
1030 public Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1031 if (property_name != "edits")
1032 return default_serialize_property (property_name, value, pspec);
1034 var node = new Json.Node (Json.NodeType.ARRAY);
1035 node.init_array (new Json.Array ());
1036 var array = node.get_array ();
1037 foreach (var text_edit in edits) {
1038 array.add_element (Json.gobject_serialize (text_edit));
1043 public bool deserialize_property (string property_name, out GLib.Value value, GLib.ParamSpec pspec, Json.Node property_node) {
1044 error ("deserialization not supported");
1048 public abstract class CommandLike : Object, Json.Serializable {
1050 * The identifier of the actual command handler.
1052 public string command { get; set; }
1055 * Arguments that the command handler should be invoked with.
1057 public Array<Variant>? arguments { get; set; }
1059 public Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1060 if (property_name != "arguments" || arguments == null)
1061 return default_serialize_property (property_name, value, pspec);
1063 var array = new Json.Array ();
1064 for (int i = 0; i < arguments.length; i++)
1065 array.add_element (Json.gvariant_serialize (arguments.index (i)));
1067 var node = new Json.Node (Json.NodeType.ARRAY);
1068 node.set_array (array);
1072 public bool deserialize_property (string property_name, out GLib.Value value, GLib.ParamSpec pspec, Json.Node property_node)
1074 if (property_name == "arguments") {
1075 value = GLib.Value (typeof(Array));
1076 if (property_node.get_node_type () != Json.NodeType.ARRAY) {
1077 warning ("unexpected property node type for 'arguments' %s", property_node.get_node_type ().to_string ());
1081 var arguments = new Array<Variant> ();
1083 property_node.get_array ().foreach_element ((array, index, element) => {
1085 arguments.append_val (Json.gvariant_deserialize (element, null));
1087 warning ("argument %u to command could not be deserialized: %s", index, e.message);
1091 value.set_boxed (arguments);
1093 } else if (property_name == "command") {
1094 // workaround for json-glib < 1.5.2 (Ubuntu 20.04 / eOS 6)
1095 if (property_node.get_value_type () != typeof (string)) {
1097 warning ("unexpected property node type for 'commands' %s", property_node.get_node_type ().to_string ());
1101 value = property_node.get_string ();
1104 return default_deserialize_property (property_name, out value, pspec, property_node);
1109 public class ExecuteCommandParams : CommandLike {
1113 * Represents a reference to a command. Provides a title which will be used
1114 * to represent a command in the UI. Commands are identified by a string
1115 * identifier. The recommended way to handle commands is to implement their
1116 * execution on the server side if the client and server provides the
1117 * corresponding capabilities. Alternatively the tool extension code could
1118 * handle the command. The protocol currently doesn’t specify a set of
1119 * well-known commands.
1121 public class Command : CommandLike {
1123 * The title of the command, like `save`.
1125 public string title { get; set; }
1129 * A code lens represents a command that should be shown along with
1130 * source text, like the number of references, a way to run tests, etc.
1132 * A code lens is _unresolved_ when no command is associated to it. For
1133 * performance reasons the creation of a code lens and resolving should be done
1136 public class CodeLens : Object {
1138 * The range in which this code lens is valid. Should only span a single
1141 public Range range { get; set; }
1144 * The command this code lens represents.
1146 public Command? command { get; set; }
1149 public class DocumentRangeFormattingParams : Object {
1150 public TextDocumentIdentifier textDocument { get; set; }
1151 public Range? range { get; set; }
1152 public FormattingOptions options { get; set; }
1155 public class FormattingOptions : Object {
1156 public uint tabSize { get; set; }
1157 public bool insertSpaces { get; set; }
1158 public bool trimTrailingWhitespace { get; set; }
1159 public bool insertFinalNewline { get; set; }
1160 public bool trimFinalNewlines { get; set; }
1163 public class CodeActionParams : Object {
1164 public TextDocumentIdentifier textDocument { get; set; }
1165 public Range range { get; set; }
1166 public CodeActionContext context { get; set; }
1170 public class CodeActionContext : Object, Json.Serializable {
1171 public Gee.List<Diagnostic> diagnostics { get; set; default = new Gee.ArrayList<Diagnostic> (); }
1172 public string[]? only { get; set; }
1174 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node) {
1175 if (property_name != "diagnostics")
1176 return default_deserialize_property (property_name, out value, pspec, property_node);
1177 var diags = new Gee.ArrayList<Diagnostic> ();
1178 property_node.get_array ().foreach_element ((array, index, element) => {
1180 diags.add (Vls.Util.parse_variant<Diagnostic> (Json.gvariant_deserialize (element, null)));
1182 warning ("argument %u could not be deserialized: %s", index, e.message);
1192 public class Diagnostics : Object, Json.Serializable
1194 public Diagnostics()
1196 this.diagnostics = new Gee.ArrayList<Diagnostic>((a,b) => {
1201 public string uri { get; set; }
1203 public int version { get; set; default = 0; }
1204 public Gee.ArrayList<Diagnostic>? diagnostics { get; set; }
1206 public string filename {
1208 return File.new_for_uri (this.uri).get_path();
1213 public bool deserialize_property (string property_name, out GLib.Value val, GLib.ParamSpec pspec, Json.Node property_node) {
1214 if (property_name == "diagnostics") {
1215 val = GLib.Value (typeof(Gee.ArrayList));
1216 var diags = new Gee.ArrayList<Diagnostic> ((a,b) => {
1219 if (property_node.get_node_type () != Json.NodeType.ARRAY) {
1220 val.set_object(diags);
1221 warning ("unexpected property node type for 'arguments' %s", property_node.get_node_type ().to_string ());
1227 property_node.get_array ().foreach_element ((array, index, element) => {
1229 diags.add (Json.gobject_deserialize (typeof (Lsp.Diagnostic), element) as Diagnostic );
1231 //warning ("argument %u to command could not be deserialized: %s", index, e.message);
1234 val.set_object(diags);
1239 return default_deserialize_property (property_name, out val, pspec, property_node);
1247 public class CodeAction : Object, Json.Serializable {
1248 public string title { get; set; }
1249 public string? kind { get; set; }
1250 public Gee.Collection<Diagnostic>? diagnostics { get; set; }
1251 public bool isPreferred { get; set; }
1252 public WorkspaceEdit? edit { get; set; }
1253 public Command? command { get; set; }
1254 public Object? data { get; set; }
1256 protected void add_diagnostic (Diagnostic diag) {
1257 if (diagnostics == null)
1258 diagnostics = new Gee.ArrayList<Diagnostic> ();
1259 diagnostics.add (diag);
1262 public override Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1263 if (property_name != "diagnostics")
1264 return default_serialize_property (property_name, value, pspec);
1266 var array = new Json.Array ();
1267 if (diagnostics != null)
1268 foreach (var text_edit in diagnostics)
1269 array.add_element (Json.gobject_serialize (text_edit));
1270 return new Json.Node.alloc ().init_array (array);
1274 public class WorkspaceEdit : Object, Json.Serializable {
1275 public Gee.List<TextDocumentEdit>? documentChanges { get; set; }
1277 public Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1278 if (property_name != "documentChanges")
1279 return default_serialize_property (property_name, value, pspec);
1281 var node = new Json.Node (Json.NodeType.ARRAY);
1282 node.init_array (new Json.Array ());
1283 if (documentChanges != null) {
1284 var array = node.get_array ();
1285 foreach (var text_edit in documentChanges) {
1286 array.add_element (Json.gobject_serialize (text_edit));
1294 public enum SymbolTags {
1299 public class CallHierarchyItem : Object, Json.Serializable {
1300 public string name { get; set; }
1301 public SymbolKind kind { get; set; }
1302 public SymbolTags tags { get; set; }
1303 public string? detail { get; set; }
1304 public string uri { get; set; }
1305 public Range range { get; set; }
1306 public Range selectionRange { get; set; }
1308 public override Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1309 if (property_name != "tags")
1310 return default_serialize_property (property_name, value, pspec);
1311 var array = new Json.Array ();
1312 if (SymbolTags.DEPRECATED in tags)
1313 array.add_int_element (SymbolTags.DEPRECATED);
1314 return new Json.Node.alloc ().init_array (array);
1317 public CallHierarchyItem.from_symbol (Vala.Symbol symbol) {
1318 this.name = symbol.get_full_name ();
1319 if (symbol is Vala.Method) {
1320 if (symbol.parent_symbol is Vala.Namespace)
1321 this.kind = SymbolKind.Function;
1323 this.kind = SymbolKind.Method;
1324 } else if (symbol is Vala.Signal) {
1325 this.kind = SymbolKind.Event;
1326 } else if (symbol is Vala.Constructor) {
1327 this.kind = SymbolKind.Constructor;
1329 this.kind = SymbolKind.Method;
1331 var version = symbol.get_attribute ("Version");
1332 if (version != null && (version.get_bool ("deprecated") || version.get_string ("deprecated_since") != null)) {
1333 this.tags |= SymbolTags.DEPRECATED;
1335 this.detail = Vls.CodeHelp.get_symbol_representation (null, symbol, null, true);
1336 this.uri = File.new_for_commandline_arg (symbol.source_reference.file.filename).get_uri ();
1337 this.range = new Range.from_sourceref (symbol.source_reference);
1338 if (symbol.comment != null)
1339 this.range = new Range.from_sourceref (symbol.comment.source_reference).union (this.range);
1340 if (symbol is Vala.Subroutine && ((Vala.Subroutine)symbol).body != null)
1341 this.range = new Range.from_sourceref (((Vala.Subroutine)symbol).body.source_reference).union (this.range);
1342 this.selectionRange = new Range.from_sourceref (symbol.source_reference);
1347 public class CallHierarchyIncomingCall : Json.Serializable, Object {
1349 * The method that calls the query method.
1351 public CallHierarchyItem from { get; set; }
1354 * The ranges at which the query method is called by `from`.
1356 public Gee.ArrayList<Range> fromRanges { get; set; default = new Gee.ArrayList<Range> (); }
1358 public override Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1359 if (property_name == "from")
1360 return default_serialize_property (property_name, value, pspec);
1361 var array = new Json.Array ();
1362 foreach (var range in fromRanges)
1363 array.add_element (Json.gobject_serialize (range));
1364 return new Json.Node.alloc ().init_array (array);
1368 public class CallHierarchyOutgoingCall : Json.Serializable, Object {
1370 * The method that the query method calls.
1372 public CallHierarchyItem to { get; set; }
1375 * The ranges at which the method is called by the query method.
1377 public Gee.ArrayList<Range> fromRanges { get; set; default = new Gee.ArrayList<Range> (); }
1379 public override Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1380 if (property_name == "to")
1381 return default_serialize_property (property_name, value, pspec);
1382 var array = new Json.Array ();
1383 foreach (var range in fromRanges)
1384 array.add_element (Json.gobject_serialize (range));
1385 return new Json.Node.alloc ().init_array (array);
1389 public class InlayHintParams : Json.Serializable, Object {
1390 public TextDocumentIdentifier textDocument { get; set; }
1391 public Range range { get; set; }
1394 public enum InlayHintKind {
1400 public class InlayHint : Object {
1401 public Position position { get; set; }
1402 public string label { get; set; }
1403 public InlayHintKind kind { get; set; }
1404 public string? tooltip { get; set; }
1405 public bool paddingLeft { get; set; }
1406 public bool paddingRight { get; set; }
1409 public class TypeHierarchyItem : Object, Json.Serializable {
1411 * The name of this item
1413 public string name { get; set; }
1416 * The kind of this item
1418 public SymbolKind kind { get; set; }
1421 * Tags for this item
1423 public SymbolTags tags { get; set; }
1426 * More detail for this item, e.g. the signature of a function.
1428 public string? detail { get; set; }
1431 * The resource identifier of this item.
1433 public string uri { get; set; }
1436 * The range enclosing this symbol not including leading/trailing
1437 * whitespace, but everything else, e.g. comments and code.
1439 public Range range { get; set; }
1442 * The range that should be selected and revealed when this symbol
1443 * is being picked, e.g. the name of a function. Must be contained
1444 * by {@link TypeHierarchyItem.range}
1446 public Range selectionRange { get; set; }
1448 private TypeHierarchyItem () {}
1450 public TypeHierarchyItem.from_symbol (Vala.TypeSymbol symbol) {
1451 this.name = symbol.get_full_name ();
1452 if (symbol is Vala.Class)
1453 this.kind = SymbolKind.Class;
1454 else if (symbol is Vala.Delegate)
1455 this.kind = SymbolKind.Interface;
1456 else if (symbol is Vala.Enum)
1457 this.kind = SymbolKind.Enum;
1458 else if (symbol is Vala.ErrorCode)
1459 this.kind = SymbolKind.EnumMember;
1460 else if (symbol is Vala.ErrorDomain)
1461 this.kind = SymbolKind.Enum;
1462 else if (symbol is Vala.Interface)
1463 this.kind = SymbolKind.Interface;
1464 else if (symbol is Vala.Struct)
1465 this.kind = SymbolKind.Struct;
1466 else if (symbol is Vala.TypeParameter)
1467 this.kind = SymbolKind.TypeParameter;
1469 this.kind = SymbolKind.Module;
1470 warning ("unexpected symbol kind in type hierarchy: `%s'", symbol.type_name);
1473 var version = symbol.get_attribute ("Version");
1474 if (version != null && (version.get_bool ("deprecated") || version.get_string ("deprecated_since") != null)) {
1475 this.tags |= SymbolTags.DEPRECATED;
1477 this.detail = Vls.CodeHelp.get_symbol_representation (null, symbol, null, true);
1478 this.uri = File.new_for_commandline_arg (symbol.source_reference.file.filename).get_uri ();
1479 this.range = new Range.from_sourceref (symbol.source_reference);
1480 this.selectionRange = this.range;
1482 // widen range to include all members
1483 if (symbol is Vala.ObjectTypeSymbol) {
1484 foreach (var member in ((Vala.ObjectTypeSymbol)symbol).get_members ()) {
1485 if (member.source_reference != null)
1486 this.range = this.range.union (new Range.from_sourceref (member.source_reference));
1488 } else if (symbol is Vala.Enum) {
1489 foreach (var member in ((Vala.Enum)symbol).get_values ()) {
1490 if (member.source_reference != null)
1491 this.range = this.range.union (new Range.from_sourceref (member.source_reference));
1493 foreach (var method in ((Vala.Enum)symbol).get_methods ()) {
1494 if (method.source_reference != null)
1495 this.range = this.range.union (new Range.from_sourceref (method.source_reference));
1497 } else if (symbol is Vala.ErrorDomain) {
1498 foreach (var member in ((Vala.ErrorDomain)symbol).get_codes ()) {
1499 if (member.source_reference != null)
1500 this.range = this.range.union (new Range.from_sourceref (member.source_reference));
1502 foreach (var method in ((Vala.ErrorDomain)symbol).get_methods ()) {
1503 if (method.source_reference != null)
1504 this.range = this.range.union (new Range.from_sourceref (method.source_reference));
1506 } else if (symbol is Vala.Struct) {
1507 foreach (var field in ((Vala.Struct)symbol).get_fields ()) {
1508 if (field.source_reference != null)
1509 this.range = this.range.union (new Range.from_sourceref (field.source_reference));
1511 foreach (var method in ((Vala.Struct)symbol).get_methods ()) {
1512 if (method.source_reference != null)
1513 this.range = this.range.union (new Range.from_sourceref (method.source_reference));