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; default = ""; }
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 {
430 return this.kind.icon();
434 public string tooltip {
436 GLib.debug("%s : %s", this.name, this.detail);
437 //var detail = this.detail == "" ? (this.kind.to_string() + ": " + this.name) : this.detail;
438 return GLib.Markup.escape_text(this.detail + "\nline: " + this.range.start.line.to_string());
442 public string sort_key {
444 return this.kind.sort_key().to_string() + "=" + this.name;
451 public class SymbolInformation : Object {
452 public string name { get; set; }
453 public SymbolKind kind { get; set; }
454 public Location location { get; set; }
455 public string? containerName { get; set; }
457 public SymbolInformation.from_document_symbol (DocumentSymbol dsym, string uri) {
458 this.name = dsym.name;
459 this.kind = dsym.kind;
460 // this.location = new Location (uri, dsym.range);
461 this.containerName = dsym.parent_name;
465 [CCode (default_value = "LSP_SYMBOL_KIND_Variable")]
466 public enum SymbolKind {
494 public string icon () {
498 // case SymbolKind.Text: return "completion-snippet-symbolic";
499 case SymbolKind.Method: return "lang-method-symbolic";
500 case SymbolKind.Function: return "lang-function-symbolic";
501 case SymbolKind.Constructor: return "lang-method-symbolic";
502 case SymbolKind.Field: return "lang-struct-field-symbolic";
503 case SymbolKind.Variable: return "lang-variable-symbolic";
504 case SymbolKind.Class: return "lang-class-symbolic";
505 case SymbolKind.Interface: return "lang-class-symbolic";
506 case SymbolKind.Module: return "lang-namespace-symbolic";
507 case SymbolKind.Property:return "lang-struct-field-symbolic";
508 //case SymbolKind.Unit: return "lang-variable-symbolic";
509 //case SymbolKind.Value: return "lang-variable-symbolic";
510 case SymbolKind.Enum: return "lang-enum-symbolic";
511 //case SymbolKind.Keyword: return "completion-word-symbolic";
512 //case SymbolKind.Snippet: return "completion-snippet-symbolic";
514 //case SymbolKind.Color: return "lang-typedef-symbolic";
515 case SymbolKind.File:return "lang-typedef-symbolic";
516 //case SymbolKind.Reference: return "lang-typedef-symbolic";
517 //case SymbolKind.Folder:return "lang-typedef-symbolic";
518 case SymbolKind.EnumMember: return "lang-typedef-symbolic";
519 case SymbolKind.Constant:return "lang-typedef-symbolic";
520 case SymbolKind.Struct: return "lang-struct-symbolic";
521 case SymbolKind.Event:return "lang-typedef-symbolic";
522 case SymbolKind.Operator:return "lang-typedef-symbolic";
523 case SymbolKind.TypeParameter:return "lang-typedef-symbolic";
526 return "completion-snippet-symbolic";
530 public int sort_key() {
533 case Enum : return 1;
534 case Class: return 2;
536 case Constructor : return 1;
537 case Method : return 2;
538 case Field : return 3;
539 case Property : return 3;
551 public class CompletionList : Object, Json.Serializable {
552 public bool isIncomplete { get; set; }
553 public Gee.List<CompletionItem> items { get; private set; default = new Gee.LinkedList<CompletionItem> (); }
555 public new void Json.Serializable.set_property (ParamSpec pspec, Value value) {
556 base.set_property (pspec.get_name (), value);
559 public new Value Json.Serializable.get_property (ParamSpec pspec) {
560 Value val = Value(pspec.value_type);
561 base.get_property (pspec.get_name (), ref val);
565 public unowned ParamSpec? find_property (string name) {
566 return this.get_class ().find_property (name);
569 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
570 if (property_name != "items")
571 return default_serialize_property (property_name, value, pspec);
572 var node = new Json.Node (Json.NodeType.ARRAY);
573 node.init_array (new Json.Array ());
574 var array = node.get_array ();
575 foreach (var child in items)
576 array.add_element (Json.gobject_serialize (child));
580 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node) {
581 error ("deserialization not supported");
585 [CCode (default_value = "LSP_COMPLETION_TRIGGER_KIND_Invoked")]
586 public enum CompletionTriggerKind {
588 * Completion was triggered by typing an identifier (24x7 code
589 * complete), manual invocation (e.g Ctrl+Space) or via API.
594 * Completion was triggered by a trigger character specified by
595 * the `triggerCharacters` properties of the `CompletionRegistrationOptions`.
597 TriggerCharacter = 2,
600 * Completion was re-triggered as the current completion list is incomplete.
602 TriggerForIncompleteCompletions = 3
605 public class CompletionContext : Object {
606 public CompletionTriggerKind triggerKind { get; set;}
607 public string? triggerCharacter { get; set; }
610 public class CompletionParams : TextDocumentPositionParams {
612 * The completion context. This is only available if the client specifies
613 * to send this using `ClientCapabilities.textDocument.completion.contextSupport === true`
615 public CompletionContext? context { get; set; }
618 public enum CompletionItemTag {
619 // Render a completion as obsolete, usually using a strike-out.
623 [CCode (default_value = "LSP_INSERT_TEXT_FORMAT_PlainText")]
624 public enum InsertTextFormat {
626 * The primary text to be inserted is treated as a plain string.
631 * The primary text to be inserted is treated as a snippet.
633 * A snippet can define tab stops and placeholders with `$1`, `$2`
634 * and `${3:foo}`. `$0` defines the final tab stop, it defaults to
635 * the end of the snippet. Placeholders with equal identifiers are linked,
636 * that is typing in one will update others too.
641 public class CompletionItem : Object, Gee.Hashable<CompletionItem>, Json.Serializable {
642 public string label { get; set; }
643 public CompletionItemKind kind { get; set; }
644 public string detail { get; set; }
645 public MarkupContent? documentation { get; set; }
646 public bool deprecated { get; set; }
647 public Gee.List<CompletionItemTag> tags { get; private set; default = new Gee.ArrayList<CompletionItemTag> (); }
648 public string? insertText { get; set; }
649 public InsertTextFormat insertTextFormat { get; set; default = InsertTextFormat.PlainText; }
652 private CompletionItem () {}
654 public CompletionItem.keyword (string keyword, string? insert_text = null, string? documentation = null) {
655 this.label = keyword;
656 this.kind = CompletionItemKind.Keyword;
657 this.insertText = insert_text;
658 if (insert_text != null && (insert_text.contains ("$0") || insert_text.contains ("${0")))
659 this.insertTextFormat = InsertTextFormat.Snippet;
660 if (documentation != null)
661 this.documentation = new MarkupContent.from_plaintext (documentation);
662 this._hash = @"$label $kind".hash ();
666 * A completion suggestion from an existing Vala symbol.
668 * @param instance_type the parent data type of data type of the expression where this symbol appears, or null
669 * @param sym the symbol itself
670 * @param scope the scope to display this in
671 * @param kind the kind of completion to display
672 * @param documentation the documentation to display
673 * @param label_override if non-null, override the displayed symbol name with this
676 public CompletionItem.from_symbol (Vala.DataType? instance_type, Vala.Symbol sym, Vala.Scope? scope,
677 CompletionItemKind kind,
678 Vls.DocComment? documentation, string? label_override = null) {
679 this.label = label_override ?? sym.name;
681 this.detail = Vls.CodeHelp.get_symbol_representation (instance_type, sym, scope, true, null, label_override, false);
682 this._hash = @"$label $kind".hash ();
684 if (documentation != null)
685 this.documentation = new MarkupContent.from_markdown (documentation.body);
687 var version = sym.get_attribute ("Version");
688 if (version != null && (version.get_bool ("deprecated") || version.get_string ("deprecated_since") != null)) {
689 this.tags.add (CompletionItemTag.Deprecated);
690 this.deprecated = true;
695 * A completion suggestion from a data type and a synthetic symbol name.
697 * @param symbol_type the data type of the symbol
698 * @param symbol_name the name of the synthetic symbol
699 * @param scope the scope that this completion item is displayed in, or null
700 * @param kind the type of completion to display
701 * @param documentation the documentation for this symbol, or null
704 public CompletionItem.from_synthetic_symbol (Vala.DataType symbol_type, string symbol_name, Vala.Scope? scope,
705 CompletionItemKind kind, Vls.DocComment? documentation) {
706 this.label = symbol_name;
708 this.detail = @"$(Vls.CodeHelp.get_symbol_representation (symbol_type, null, scope, true, null, null, false)) $symbol_name";
709 this._hash = @"$label $kind".hash ();
711 if (documentation != null)
712 this.documentation = new MarkupContent.from_markdown (documentation.body);
716 public CompletionItem.from_unimplemented_symbol (Vala.Symbol sym,
717 string label, CompletionItemKind kind,
719 Vls.DocComment? documentation) {
722 this.insertText = insert_text;
723 if (insert_text.contains ("$0") || insert_text.contains ("${0"))
724 this.insertTextFormat = InsertTextFormat.Snippet;
725 this._hash = @"$label $kind".hash ();
726 if (documentation != null)
727 this.documentation = new MarkupContent.from_markdown (documentation.body);
731 public uint hash () {
735 public bool equal_to (CompletionItem other) {
736 return other.label == this.label && other.kind == this.kind;
739 public new void Json.Serializable.set_property (ParamSpec pspec, Value value) {
740 base.set_property (pspec.get_name (), value);
743 public new Value Json.Serializable.get_property (ParamSpec pspec) {
744 Value val = Value(pspec.value_type);
745 base.get_property (pspec.get_name (), ref val);
749 public unowned ParamSpec? find_property (string name) {
750 return this.get_class ().find_property (name);
753 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
754 if (property_name != "tags")
755 return default_serialize_property (property_name, value, pspec);
757 var node = new Json.Node (Json.NodeType.ARRAY);
758 node.init_array (new Json.Array ());
759 var array = node.get_array ();
760 foreach (var tag in this.tags) {
761 array.add_int_element (tag);
766 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node)
768 if (property_name != "tags") {
769 return default_deserialize_property (property_name, out value, pspec, property_node);
771 value = GLib.Value (typeof(Gee.ArrayList));
772 if (property_node.get_node_type () != Json.NodeType.ARRAY) {
773 warning ("unexpected property node type for 'arguments' %s", property_node.get_node_type ().to_string ());
777 var arguments = new Gee.ArrayList<CompletionItemTag>();
779 property_node.get_array ().foreach_element ((array, index, element) => {
781 arguments.add ((CompletionItemTag) Json.gvariant_deserialize (element, null).get_int32() );
783 warning ("argument %u to command could not be deserialized: %s", index, e.message);
787 value.set_object (arguments);
792 public class MarkupContent : Object {
793 public string kind { get; set; }
794 public string value { get; set; }
796 private MarkupContent () {}
799 * Create a MarkupContent with plain text.
801 public MarkupContent.from_plaintext (string doc) {
802 this.kind = "plaintext";
807 * Create a MarkupContent with markdown text.
809 public MarkupContent.from_markdown (string doc) {
810 this.kind = "markdown";
815 [CCode (default_value = "LSP_COMPLETION_ITEM_KIND_Text")]
816 public enum CompletionItemKind {
845 * Capabilities of the client/editor for `textDocument/documentSymbol`
847 public class DocumentSymbolCapabilities : Object {
848 public bool hierarchicalDocumentSymbolSupport { get; set; }
852 * Capabilities of the client/editor for `textDocument/rename`
854 public class RenameClientCapabilities : Object {
855 public bool prepareSupport { get; set; }
859 * Capabilities of the client/editor pertaining to language features.
861 public class TextDocumentClientCapabilities : Object {
862 public DocumentSymbolCapabilities documentSymbol { get; set; default = new DocumentSymbolCapabilities ();}
863 public RenameClientCapabilities rename { get; set; default = new RenameClientCapabilities (); }
867 * Capabilities of the client/editor.
869 public class ClientCapabilities : Object {
870 public TextDocumentClientCapabilities textDocument { get; set; default = new TextDocumentClientCapabilities (); }
873 public class InitializeParams : Object {
874 public int processId { get; set; }
875 public string? rootPath { get; set; }
876 public string? rootUri { get; set; }
877 public ClientCapabilities capabilities { get; set; default = new ClientCapabilities (); }
880 public class SignatureInformation : Object, Json.Serializable {
881 public string label { get; set; }
882 public MarkupContent documentation { get; set; }
884 public Gee.List<ParameterInformation> parameters { get; private set; default = new Gee.LinkedList<ParameterInformation> (); }
886 public new void Json.Serializable.set_property (ParamSpec pspec, Value value) {
887 base.set_property (pspec.get_name (), value);
890 public new Value Json.Serializable.get_property (ParamSpec pspec) {
891 Value val = Value(pspec.value_type);
892 base.get_property (pspec.get_name (), ref val);
896 public unowned ParamSpec? find_property (string name) {
897 return this.get_class ().find_property (name);
900 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
901 if (property_name != "parameters")
902 return default_serialize_property (property_name, value, pspec);
903 var node = new Json.Node (Json.NodeType.ARRAY);
904 node.init_array (new Json.Array ());
905 var array = node.get_array ();
906 foreach (var child in parameters)
907 array.add_element (Json.gobject_serialize (child));
911 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node) {
912 error ("deserialization not supported");
916 public class SignatureHelp : Object, Json.Serializable {
917 public Gee.Collection<SignatureInformation> signatures { get; set; default = new Gee.ArrayList<SignatureInformation> (); }
918 public int activeSignature { get; set; }
919 public int activeParameter { get; set; }
921 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
922 if (property_name != "signatures")
923 return default_serialize_property (property_name, value, pspec);
925 var node = new Json.Node (Json.NodeType.ARRAY);
926 node.init_array (new Json.Array ());
927 var array = node.get_array ();
928 foreach (var child in signatures)
929 array.add_element (Json.gobject_serialize (child));
933 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node) {
934 error ("deserialization not supported");
938 public class ParameterInformation : Object {
939 public string label { get; set; }
940 public MarkupContent documentation { get; set; }
943 public class MarkedString : Object {
944 public MarkedString(string language, string value)
946 this.language = language;
948 GLib.debug("new marked string %s : %s", language, value);
950 public string language { get; set; }
951 public string value { get; set; }
954 public class Hover : Object, Json.Serializable {
955 public Gee.List<MarkedString> contents { get; set; default = new Gee.ArrayList<MarkedString> (); }
956 public Range range { get; set; }
958 public new void Json.Serializable.set_property (ParamSpec pspec, Value value) {
959 base.set_property (pspec.get_name (), value);
962 public new Value Json.Serializable.get_property (ParamSpec pspec) {
963 Value val = Value(pspec.value_type);
964 base.get_property (pspec.get_name (), ref val);
968 public unowned ParamSpec? find_property (string name) {
969 return this.get_class ().find_property (name);
972 public Json.Node serialize_property (string property_name, Value value, ParamSpec pspec) {
973 if (property_name != "contents")
974 return default_serialize_property (property_name, value, pspec);
975 var node = new Json.Node (Json.NodeType.ARRAY);
976 node.init_array (new Json.Array ());
977 var array = node.get_array ();
978 foreach (var child in contents) {
979 if (child.language != null)
980 array.add_element (Json.gobject_serialize (child));
982 array.add_element (new Json.Node (Json.NodeType.VALUE).init_string (child.value));
987 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node)
989 if (property_name == "contents") {
990 value = GLib.Value (typeof(Gee.ArrayList));
991 if (property_node.get_node_type () != Json.NodeType.ARRAY) {
992 warning ("unexpected property node type for 'arguments' %s", property_node.get_node_type ().to_string ());
995 var contents = new Gee.ArrayList<MarkedString>();
997 property_node.get_array ().foreach_element ((array, index, element) => {
999 var add = new MarkedString(
1000 array.get_object_element(index).get_string_member("language"),
1001 array.get_object_element(index).get_string_member("value")
1004 contents.add ( add );
1006 warning ("argument %u to command could not be deserialized: %s", index, e.message);
1009 value.set_object (contents);
1013 return default_deserialize_property (property_name, out value, pspec, property_node);
1018 * A textual edit applicable to a text document.
1020 public class TextEdit : Object {
1022 * The range of the text document to be manipulated. To insert
1023 * text into a document create a range where ``start === end``.
1025 public Range range { get; set; }
1028 * The string to be inserted. For delete operations use an
1031 public string newText { get; set; }
1033 public TextEdit (Range range, string new_text = "") {
1035 this.newText = new_text;
1040 * Describes textual changes on a single text document. The text document is
1041 * referred to as a {@link VersionedTextDocumentIdentifier} to allow clients to
1042 * check the text document version before an edit is applied. A
1043 * {@link TextDocumentEdit} describes all changes on a version ``Si`` and after they are
1044 * applied move the document to version ``Si+1``. So the creator of a
1045 * {@link TextDocumentEdit} doesn’t need to sort the array of edits or do any kind
1046 * of ordering. However the edits must be non overlapping.
1048 public class TextDocumentEdit : Object, Json.Serializable {
1050 * The text document to change.
1052 public VersionedTextDocumentIdentifier textDocument { get; set; }
1055 * The edits to be applied.
1057 public Gee.ArrayList<TextEdit> edits { get; set; default = new Gee.ArrayList<TextEdit> (); }
1059 public TextDocumentEdit (VersionedTextDocumentIdentifier text_document) {
1060 this.textDocument = text_document;
1063 public Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1064 if (property_name != "edits")
1065 return default_serialize_property (property_name, value, pspec);
1067 var node = new Json.Node (Json.NodeType.ARRAY);
1068 node.init_array (new Json.Array ());
1069 var array = node.get_array ();
1070 foreach (var text_edit in edits) {
1071 array.add_element (Json.gobject_serialize (text_edit));
1076 public bool deserialize_property (string property_name, out GLib.Value value, GLib.ParamSpec pspec, Json.Node property_node) {
1077 error ("deserialization not supported");
1081 public abstract class CommandLike : Object, Json.Serializable {
1083 * The identifier of the actual command handler.
1085 public string command { get; set; }
1088 * Arguments that the command handler should be invoked with.
1090 public Array<Variant>? arguments { get; set; }
1092 public Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1093 if (property_name != "arguments" || arguments == null)
1094 return default_serialize_property (property_name, value, pspec);
1096 var array = new Json.Array ();
1097 for (int i = 0; i < arguments.length; i++)
1098 array.add_element (Json.gvariant_serialize (arguments.index (i)));
1100 var node = new Json.Node (Json.NodeType.ARRAY);
1101 node.set_array (array);
1105 public bool deserialize_property (string property_name, out GLib.Value value, GLib.ParamSpec pspec, Json.Node property_node)
1107 if (property_name == "arguments") {
1108 value = GLib.Value (typeof(Array));
1109 if (property_node.get_node_type () != Json.NodeType.ARRAY) {
1110 warning ("unexpected property node type for 'arguments' %s", property_node.get_node_type ().to_string ());
1114 var arguments = new Array<Variant> ();
1116 property_node.get_array ().foreach_element ((array, index, element) => {
1118 arguments.append_val (Json.gvariant_deserialize (element, null));
1120 warning ("argument %u to command could not be deserialized: %s", index, e.message);
1124 value.set_boxed (arguments);
1126 } else if (property_name == "command") {
1127 // workaround for json-glib < 1.5.2 (Ubuntu 20.04 / eOS 6)
1128 if (property_node.get_value_type () != typeof (string)) {
1130 warning ("unexpected property node type for 'commands' %s", property_node.get_node_type ().to_string ());
1134 value = property_node.get_string ();
1137 return default_deserialize_property (property_name, out value, pspec, property_node);
1142 public class ExecuteCommandParams : CommandLike {
1146 * Represents a reference to a command. Provides a title which will be used
1147 * to represent a command in the UI. Commands are identified by a string
1148 * identifier. The recommended way to handle commands is to implement their
1149 * execution on the server side if the client and server provides the
1150 * corresponding capabilities. Alternatively the tool extension code could
1151 * handle the command. The protocol currently doesn’t specify a set of
1152 * well-known commands.
1154 public class Command : CommandLike {
1156 * The title of the command, like `save`.
1158 public string title { get; set; }
1162 * A code lens represents a command that should be shown along with
1163 * source text, like the number of references, a way to run tests, etc.
1165 * A code lens is _unresolved_ when no command is associated to it. For
1166 * performance reasons the creation of a code lens and resolving should be done
1169 public class CodeLens : Object {
1171 * The range in which this code lens is valid. Should only span a single
1174 public Range range { get; set; }
1177 * The command this code lens represents.
1179 public Command? command { get; set; }
1182 public class DocumentRangeFormattingParams : Object {
1183 public TextDocumentIdentifier textDocument { get; set; }
1184 public Range? range { get; set; }
1185 public FormattingOptions options { get; set; }
1188 public class FormattingOptions : Object {
1189 public uint tabSize { get; set; }
1190 public bool insertSpaces { get; set; }
1191 public bool trimTrailingWhitespace { get; set; }
1192 public bool insertFinalNewline { get; set; }
1193 public bool trimFinalNewlines { get; set; }
1196 public class CodeActionParams : Object {
1197 public TextDocumentIdentifier textDocument { get; set; }
1198 public Range range { get; set; }
1199 public CodeActionContext context { get; set; }
1203 public class CodeActionContext : Object, Json.Serializable {
1204 public Gee.List<Diagnostic> diagnostics { get; set; default = new Gee.ArrayList<Diagnostic> (); }
1205 public string[]? only { get; set; }
1207 public bool deserialize_property (string property_name, out Value value, ParamSpec pspec, Json.Node property_node) {
1208 if (property_name != "diagnostics")
1209 return default_deserialize_property (property_name, out value, pspec, property_node);
1210 var diags = new Gee.ArrayList<Diagnostic> ();
1211 property_node.get_array ().foreach_element ((array, index, element) => {
1213 diags.add (Vls.Util.parse_variant<Diagnostic> (Json.gvariant_deserialize (element, null)));
1215 warning ("argument %u could not be deserialized: %s", index, e.message);
1225 public class Diagnostics : Object, Json.Serializable
1227 public Diagnostics()
1229 this.diagnostics = new Gee.ArrayList<Diagnostic>((a,b) => {
1234 public string uri { get; set; }
1236 public int version { get; set; default = 0; }
1237 public Gee.ArrayList<Diagnostic>? diagnostics { get; set; }
1239 public string filename {
1241 return File.new_for_uri (this.uri).get_path();
1246 public bool deserialize_property (string property_name, out GLib.Value val, GLib.ParamSpec pspec, Json.Node property_node) {
1247 if (property_name == "diagnostics") {
1248 val = GLib.Value (typeof(Gee.ArrayList));
1249 var diags = new Gee.ArrayList<Diagnostic> ((a,b) => {
1252 if (property_node.get_node_type () != Json.NodeType.ARRAY) {
1253 val.set_object(diags);
1254 warning ("unexpected property node type for 'arguments' %s", property_node.get_node_type ().to_string ());
1260 property_node.get_array ().foreach_element ((array, index, element) => {
1262 diags.add (Json.gobject_deserialize (typeof (Lsp.Diagnostic), element) as Diagnostic );
1264 //warning ("argument %u to command could not be deserialized: %s", index, e.message);
1267 val.set_object(diags);
1272 return default_deserialize_property (property_name, out val, pspec, property_node);
1280 public class CodeAction : Object, Json.Serializable {
1281 public string title { get; set; }
1282 public string? kind { get; set; }
1283 public Gee.Collection<Diagnostic>? diagnostics { get; set; }
1284 public bool isPreferred { get; set; }
1285 public WorkspaceEdit? edit { get; set; }
1286 public Command? command { get; set; }
1287 public Object? data { get; set; }
1289 protected void add_diagnostic (Diagnostic diag) {
1290 if (diagnostics == null)
1291 diagnostics = new Gee.ArrayList<Diagnostic> ();
1292 diagnostics.add (diag);
1295 public override Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1296 if (property_name != "diagnostics")
1297 return default_serialize_property (property_name, value, pspec);
1299 var array = new Json.Array ();
1300 if (diagnostics != null)
1301 foreach (var text_edit in diagnostics)
1302 array.add_element (Json.gobject_serialize (text_edit));
1303 return new Json.Node.alloc ().init_array (array);
1307 public class WorkspaceEdit : Object, Json.Serializable {
1308 public Gee.List<TextDocumentEdit>? documentChanges { get; set; }
1310 public Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1311 if (property_name != "documentChanges")
1312 return default_serialize_property (property_name, value, pspec);
1314 var node = new Json.Node (Json.NodeType.ARRAY);
1315 node.init_array (new Json.Array ());
1316 if (documentChanges != null) {
1317 var array = node.get_array ();
1318 foreach (var text_edit in documentChanges) {
1319 array.add_element (Json.gobject_serialize (text_edit));
1327 public enum SymbolTags {
1332 public class CallHierarchyItem : Object, Json.Serializable {
1333 public string name { get; set; }
1334 public SymbolKind kind { get; set; }
1335 public SymbolTags tags { get; set; }
1336 public string? detail { get; set; }
1337 public string uri { get; set; }
1338 public Range range { get; set; }
1339 public Range selectionRange { get; set; }
1341 public override Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1342 if (property_name != "tags")
1343 return default_serialize_property (property_name, value, pspec);
1344 var array = new Json.Array ();
1345 if (SymbolTags.DEPRECATED in tags)
1346 array.add_int_element (SymbolTags.DEPRECATED);
1347 return new Json.Node.alloc ().init_array (array);
1350 public CallHierarchyItem.from_symbol (Vala.Symbol symbol) {
1351 this.name = symbol.get_full_name ();
1352 if (symbol is Vala.Method) {
1353 if (symbol.parent_symbol is Vala.Namespace)
1354 this.kind = SymbolKind.Function;
1356 this.kind = SymbolKind.Method;
1357 } else if (symbol is Vala.Signal) {
1358 this.kind = SymbolKind.Event;
1359 } else if (symbol is Vala.Constructor) {
1360 this.kind = SymbolKind.Constructor;
1362 this.kind = SymbolKind.Method;
1364 var version = symbol.get_attribute ("Version");
1365 if (version != null && (version.get_bool ("deprecated") || version.get_string ("deprecated_since") != null)) {
1366 this.tags |= SymbolTags.DEPRECATED;
1368 this.detail = Vls.CodeHelp.get_symbol_representation (null, symbol, null, true);
1369 this.uri = File.new_for_commandline_arg (symbol.source_reference.file.filename).get_uri ();
1370 this.range = new Range.from_sourceref (symbol.source_reference);
1371 if (symbol.comment != null)
1372 this.range = new Range.from_sourceref (symbol.comment.source_reference).union (this.range);
1373 if (symbol is Vala.Subroutine && ((Vala.Subroutine)symbol).body != null)
1374 this.range = new Range.from_sourceref (((Vala.Subroutine)symbol).body.source_reference).union (this.range);
1375 this.selectionRange = new Range.from_sourceref (symbol.source_reference);
1380 public class CallHierarchyIncomingCall : Json.Serializable, Object {
1382 * The method that calls the query method.
1384 public CallHierarchyItem from { get; set; }
1387 * The ranges at which the query method is called by `from`.
1389 public Gee.ArrayList<Range> fromRanges { get; set; default = new Gee.ArrayList<Range> (); }
1391 public override Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1392 if (property_name == "from")
1393 return default_serialize_property (property_name, value, pspec);
1394 var array = new Json.Array ();
1395 foreach (var range in fromRanges)
1396 array.add_element (Json.gobject_serialize (range));
1397 return new Json.Node.alloc ().init_array (array);
1401 public class CallHierarchyOutgoingCall : Json.Serializable, Object {
1403 * The method that the query method calls.
1405 public CallHierarchyItem to { get; set; }
1408 * The ranges at which the method is called by the query method.
1410 public Gee.ArrayList<Range> fromRanges { get; set; default = new Gee.ArrayList<Range> (); }
1412 public override Json.Node serialize_property (string property_name, GLib.Value value, GLib.ParamSpec pspec) {
1413 if (property_name == "to")
1414 return default_serialize_property (property_name, value, pspec);
1415 var array = new Json.Array ();
1416 foreach (var range in fromRanges)
1417 array.add_element (Json.gobject_serialize (range));
1418 return new Json.Node.alloc ().init_array (array);
1422 public class InlayHintParams : Json.Serializable, Object {
1423 public TextDocumentIdentifier textDocument { get; set; }
1424 public Range range { get; set; }
1427 public enum InlayHintKind {
1433 public class InlayHint : Object {
1434 public Position position { get; set; }
1435 public string label { get; set; }
1436 public InlayHintKind kind { get; set; }
1437 public string? tooltip { get; set; }
1438 public bool paddingLeft { get; set; }
1439 public bool paddingRight { get; set; }
1442 public class TypeHierarchyItem : Object, Json.Serializable {
1444 * The name of this item
1446 public string name { get; set; }
1449 * The kind of this item
1451 public SymbolKind kind { get; set; }
1454 * Tags for this item
1456 public SymbolTags tags { get; set; }
1459 * More detail for this item, e.g. the signature of a function.
1461 public string? detail { get; set; }
1464 * The resource identifier of this item.
1466 public string uri { get; set; }
1469 * The range enclosing this symbol not including leading/trailing
1470 * whitespace, but everything else, e.g. comments and code.
1472 public Range range { get; set; }
1475 * The range that should be selected and revealed when this symbol
1476 * is being picked, e.g. the name of a function. Must be contained
1477 * by {@link TypeHierarchyItem.range}
1479 public Range selectionRange { get; set; }
1481 private TypeHierarchyItem () {}
1483 public TypeHierarchyItem.from_symbol (Vala.TypeSymbol symbol) {
1484 this.name = symbol.get_full_name ();
1485 if (symbol is Vala.Class)
1486 this.kind = SymbolKind.Class;
1487 else if (symbol is Vala.Delegate)
1488 this.kind = SymbolKind.Interface;
1489 else if (symbol is Vala.Enum)
1490 this.kind = SymbolKind.Enum;
1491 else if (symbol is Vala.ErrorCode)
1492 this.kind = SymbolKind.EnumMember;
1493 else if (symbol is Vala.ErrorDomain)
1494 this.kind = SymbolKind.Enum;
1495 else if (symbol is Vala.Interface)
1496 this.kind = SymbolKind.Interface;
1497 else if (symbol is Vala.Struct)
1498 this.kind = SymbolKind.Struct;
1499 else if (symbol is Vala.TypeParameter)
1500 this.kind = SymbolKind.TypeParameter;
1502 this.kind = SymbolKind.Module;
1503 warning ("unexpected symbol kind in type hierarchy: `%s'", symbol.type_name);
1506 var version = symbol.get_attribute ("Version");
1507 if (version != null && (version.get_bool ("deprecated") || version.get_string ("deprecated_since") != null)) {
1508 this.tags |= SymbolTags.DEPRECATED;
1510 this.detail = Vls.CodeHelp.get_symbol_representation (null, symbol, null, true);
1511 this.uri = File.new_for_commandline_arg (symbol.source_reference.file.filename).get_uri ();
1512 this.range = new Range.from_sourceref (symbol.source_reference);
1513 this.selectionRange = this.range;
1515 // widen range to include all members
1516 if (symbol is Vala.ObjectTypeSymbol) {
1517 foreach (var member in ((Vala.ObjectTypeSymbol)symbol).get_members ()) {
1518 if (member.source_reference != null)
1519 this.range = this.range.union (new Range.from_sourceref (member.source_reference));
1521 } else if (symbol is Vala.Enum) {
1522 foreach (var member in ((Vala.Enum)symbol).get_values ()) {
1523 if (member.source_reference != null)
1524 this.range = this.range.union (new Range.from_sourceref (member.source_reference));
1526 foreach (var method in ((Vala.Enum)symbol).get_methods ()) {
1527 if (method.source_reference != null)
1528 this.range = this.range.union (new Range.from_sourceref (method.source_reference));
1530 } else if (symbol is Vala.ErrorDomain) {
1531 foreach (var member in ((Vala.ErrorDomain)symbol).get_codes ()) {
1532 if (member.source_reference != null)
1533 this.range = this.range.union (new Range.from_sourceref (member.source_reference));
1535 foreach (var method in ((Vala.ErrorDomain)symbol).get_methods ()) {
1536 if (method.source_reference != null)
1537 this.range = this.range.union (new Range.from_sourceref (method.source_reference));
1539 } else if (symbol is Vala.Struct) {
1540 foreach (var field in ((Vala.Struct)symbol).get_fields ()) {
1541 if (field.source_reference != null)
1542 this.range = this.range.union (new Range.from_sourceref (field.source_reference));
1544 foreach (var method in ((Vala.Struct)symbol).get_methods ()) {
1545 if (method.source_reference != null)
1546 this.range = this.range.union (new Range.from_sourceref (method.source_reference));