generated from itdominator/Python-With-Gtk-Template
566 lines
21 KiB
Python
566 lines
21 KiB
Python
import enum
|
|
|
|
|
|
|
|
def to_type(o, new_type):
|
|
'''
|
|
Helper funciton that receives an object or a dict and convert it to a new
|
|
given type.
|
|
|
|
:param object|dict o: The object to convert
|
|
:param Type new_type: The type to convert to.
|
|
'''
|
|
|
|
return o if new_type == type(o) else new_type(**o)
|
|
|
|
|
|
class Position(object):
|
|
def __init__(self, line, character):
|
|
"""
|
|
Constructs a new Position instance.
|
|
|
|
:param int line: Line position in a document (zero-based).
|
|
:param int character: Character offset on a line in a document
|
|
(zero-based).
|
|
"""
|
|
self.line = line
|
|
self.character = character
|
|
|
|
|
|
class Range(object):
|
|
def __init__(self, start, end):
|
|
"""
|
|
Constructs a new Range instance.
|
|
|
|
:param Position start: The range's start position.
|
|
:param Position end: The range's end position.
|
|
"""
|
|
self.start = to_type(start, Position)
|
|
self.end = to_type(end, Position)
|
|
|
|
|
|
class Location(object):
|
|
"""
|
|
Represents a location inside a resource, such as a line inside a text file.
|
|
"""
|
|
|
|
def __init__(self, uri, range):
|
|
"""
|
|
Constructs a new Location instance.
|
|
|
|
:param str uri: Resource file.
|
|
:param Range range: The range inside the file
|
|
"""
|
|
self.uri = uri
|
|
self.range = to_type(range, Range)
|
|
|
|
|
|
class LocationLink(object):
|
|
"""
|
|
Represents a link between a source and a target location.
|
|
"""
|
|
|
|
def __init__(self, originSelectionRange, targetUri, targetRange, targetSelectionRange):
|
|
"""
|
|
Constructs a new LocationLink instance.
|
|
|
|
:param Range originSelectionRange: Span of the origin of this link.
|
|
Used as the underlined span for mouse interaction. Defaults to the word range at the mouse position.
|
|
:param str targetUri: The target resource identifier of this link.
|
|
:param Range targetRange: The full target range of this link. If the target for example is a symbol then target
|
|
range is the range enclosing this symbol not including leading/trailing whitespace but everything else
|
|
like comments. This information is typically used to highlight the range in the editor.
|
|
:param Range targetSelectionRange: The range that should be selected and revealed when this link is being followed,
|
|
e.g the name of a function. Must be contained by the the `targetRange`. See also `DocumentSymbol#range`
|
|
"""
|
|
self.originSelectionRange = to_type(originSelectionRange, Range)
|
|
self.targetUri = targetUri
|
|
self.targetRange = to_type(targetRange, Range)
|
|
self.targetSelectionRange = to_type(targetSelectionRange, Range)
|
|
|
|
|
|
class Diagnostic(object):
|
|
def __init__(self, range, severity, code, source, message, relatedInformation):
|
|
"""
|
|
Constructs a new Diagnostic instance.
|
|
:param Range range: The range at which the message applies.Resource file.
|
|
:param int severity: The diagnostic's severity. Can be omitted. If omitted it is up to the
|
|
client to interpret diagnostics as error, warning, info or hint.
|
|
:param str code: The diagnostic's code, which might appear in the user interface.
|
|
:param str source: A human-readable string describing the source of this
|
|
diagnostic, e.g. 'typescript' or 'super lint'.
|
|
:param str message: The diagnostic's message.
|
|
:param list relatedInformation: An array of related diagnostic information, e.g. when symbol-names within
|
|
a scope collide all definitions can be marked via this property.
|
|
"""
|
|
self.range = range
|
|
self.severity = severity
|
|
self.code = code
|
|
self.source = source
|
|
self.message = message
|
|
self.relatedInformation = relatedInformation
|
|
|
|
|
|
class DiagnosticSeverity(object):
|
|
Error = 1
|
|
Warning = 2 # TODO: warning is known in python
|
|
Information = 3
|
|
Hint = 4
|
|
|
|
|
|
class DiagnosticRelatedInformation(object):
|
|
def __init__(self, location, message):
|
|
"""
|
|
Constructs a new Diagnostic instance.
|
|
:param Location location: The location of this related diagnostic information.
|
|
:param str message: The message of this related diagnostic information.
|
|
"""
|
|
self.location = location
|
|
self.message = message
|
|
|
|
|
|
class Command(object):
|
|
def __init__(self, title, command, arguments):
|
|
"""
|
|
Constructs a new Diagnostic instance.
|
|
:param str title: Title of the command, like `save`.
|
|
:param str command: The identifier of the actual command handler.
|
|
:param list argusments: Arguments that the command handler should be invoked with.
|
|
"""
|
|
self.title = title
|
|
self.command = command
|
|
self.arguments = arguments
|
|
|
|
|
|
class TextDocumentItem(object):
|
|
"""
|
|
An item to transfer a text document from the client to the server.
|
|
"""
|
|
def __init__(self, uri, languageId, version, text):
|
|
"""
|
|
Constructs a new Diagnostic instance.
|
|
|
|
:param DocumentUri uri: Title of the command, like `save`.
|
|
:param str languageId: The identifier of the actual command handler.
|
|
:param int version: Arguments that the command handler should be invoked with.
|
|
:param str text: Arguments that the command handler should be invoked with.
|
|
"""
|
|
self.uri = uri
|
|
self.languageId = languageId
|
|
self.version = version
|
|
self.text = text
|
|
|
|
|
|
class TextDocumentIdentifier(object):
|
|
"""
|
|
Text documents are identified using a URI. On the protocol level, URIs are passed as strings.
|
|
"""
|
|
def __init__(self, uri):
|
|
"""
|
|
Constructs a new TextDocumentIdentifier instance.
|
|
|
|
:param DocumentUri uri: The text document's URI.
|
|
"""
|
|
self.uri = uri
|
|
|
|
|
|
class VersionedTextDocumentIdentifier(TextDocumentIdentifier):
|
|
"""
|
|
An identifier to denote a specific version of a text document.
|
|
"""
|
|
def __init__(self, uri, version):
|
|
"""
|
|
Constructs a new TextDocumentIdentifier instance.
|
|
|
|
:param DocumentUri uri: The text document's URI.
|
|
:param int version: The version number of this document. If a versioned
|
|
text document identifier is sent from the server to the client and
|
|
the file is not open in the editor (the server has not received an
|
|
open notification before) the server can send `null` to indicate
|
|
that the version is known and the content on disk is the truth (as
|
|
speced with document content ownership).
|
|
The version number of a document will increase after each change, including
|
|
undo/redo. The number doesn't need to be consecutive.
|
|
"""
|
|
super(VersionedTextDocumentIdentifier, self).__init__(uri)
|
|
self.version = version
|
|
|
|
|
|
class TextDocumentContentChangeEvent(object):
|
|
"""
|
|
An event describing a change to a text document. If range and rangeLength are omitted
|
|
the new text is considered to be the full content of the document.
|
|
"""
|
|
def __init__(self, range, rangeLength, text):
|
|
"""
|
|
Constructs a new TextDocumentContentChangeEvent instance.
|
|
|
|
:param Range range: The range of the document that changed.
|
|
:param int rangeLength: The length of the range that got replaced.
|
|
:param str text: The new text of the range/document.
|
|
"""
|
|
self.range = range
|
|
self.rangeLength = rangeLength
|
|
self.text = text
|
|
|
|
|
|
class TextDocumentPositionParams(object):
|
|
"""
|
|
A parameter literal used in requests to pass a text document and a position inside that document.
|
|
"""
|
|
def __init__(self, textDocument, position):
|
|
"""
|
|
Constructs a new TextDocumentPositionParams instance.
|
|
|
|
:param TextDocumentIdentifier textDocument: The text document.
|
|
:param Position position: The position inside the text document.
|
|
"""
|
|
self.textDocument = textDocument
|
|
self.position = position
|
|
|
|
|
|
class LANGUAGE_IDENTIFIER(object):
|
|
BAT = "bat"
|
|
BIBTEX = "bibtex"
|
|
CLOJURE = "clojure"
|
|
COFFESCRIPT = "coffeescript"
|
|
C = "c"
|
|
CPP = "cpp"
|
|
CSHARP = "csharp"
|
|
CSS = "css"
|
|
DIFF = "diff"
|
|
DOCKERFILE = "dockerfile"
|
|
FSHARP = "fsharp"
|
|
GIT_COMMIT = "git-commit"
|
|
GIT_REBASE = "git-rebase"
|
|
GO = "go"
|
|
GROOVY = "groovy"
|
|
HANDLEBARS = "handlebars"
|
|
HTML = "html"
|
|
INI = "ini"
|
|
JAVA = "java"
|
|
JAVASCRIPT = "javascript"
|
|
JSON = "json"
|
|
LATEX = "latex"
|
|
LESS = "less"
|
|
LUA = "lua"
|
|
MAKEFILE = "makefile"
|
|
MARKDOWN = "markdown"
|
|
OBJECTIVE_C = "objective-c"
|
|
OBJECTIVE_CPP = "objective-cpp"
|
|
Perl = "perl"
|
|
PHP = "php"
|
|
POWERSHELL = "powershell"
|
|
PUG = "jade"
|
|
PYTHON = "python"
|
|
R = "r"
|
|
RAZOR = "razor"
|
|
RUBY = "ruby"
|
|
RUST = "rust"
|
|
SASS = "sass"
|
|
SCSS = "scss"
|
|
ShaderLab = "shaderlab"
|
|
SHELL_SCRIPT = "shellscript"
|
|
SQL = "sql"
|
|
SWIFT = "swift"
|
|
TYPE_SCRIPT = "typescript"
|
|
TEX = "tex"
|
|
VB = "vb"
|
|
XML = "xml"
|
|
XSL = "xsl"
|
|
YAML = "yaml"
|
|
|
|
|
|
class SymbolKind(enum.Enum):
|
|
File = 1
|
|
Module = 2
|
|
Namespace = 3
|
|
Package = 4
|
|
Class = 5
|
|
Method = 6
|
|
Property = 7
|
|
Field = 8
|
|
Constructor = 9
|
|
Enum = 10
|
|
Interface = 11
|
|
Function = 12
|
|
Variable = 13
|
|
Constant = 14
|
|
String = 15
|
|
Number = 16
|
|
Boolean = 17
|
|
Array = 18
|
|
Object = 19
|
|
Key = 20
|
|
Null = 21
|
|
EnumMember = 22
|
|
Struct = 23
|
|
Event = 24
|
|
Operator = 25
|
|
TypeParameter = 26
|
|
|
|
|
|
class SymbolInformation(object):
|
|
"""
|
|
Represents information about programming constructs like variables, classes, interfaces etc.
|
|
"""
|
|
def __init__(self, name, kind, location, containerName = None, deprecated = False):
|
|
"""
|
|
Constructs a new SymbolInformation instance.
|
|
|
|
:param str name: The name of this symbol.
|
|
:param int kind: The kind of this symbol.
|
|
:param bool Location: The location of this symbol. The location's range is used by a tool
|
|
to reveal the location in the editor. If the symbol is selected in the
|
|
tool the range's start information is used to position the cursor. So
|
|
the range usually spans more then the actual symbol's name and does
|
|
normally include things like visibility modifiers.
|
|
|
|
The range doesn't have to denote a node range in the sense of a abstract
|
|
syntax tree. It can therefore not be used to re-construct a hierarchy of
|
|
the symbols.
|
|
:param str containerName: The name of the symbol containing this symbol. This information is for
|
|
user interface purposes (e.g. to render a qualifier in the user interface
|
|
if necessary). It can't be used to re-infer a hierarchy for the document
|
|
symbols.
|
|
:param bool deprecated: Indicates if this symbol is deprecated.
|
|
"""
|
|
self.name = name
|
|
self.kind = SymbolKind(kind)
|
|
self.deprecated = deprecated
|
|
self.location = to_type(location, Location)
|
|
self.containerName = containerName
|
|
|
|
|
|
class ParameterInformation(object):
|
|
"""
|
|
Represents a parameter of a callable-signature. A parameter can
|
|
have a label and a doc-comment.
|
|
"""
|
|
def __init__(self, label, documentation = ""):
|
|
"""
|
|
Constructs a new ParameterInformation instance.
|
|
|
|
:param str label: The label of this parameter. Will be shown in the UI.
|
|
:param str documentation: The human-readable doc-comment of this parameter. Will be shown in the UI but can be omitted.
|
|
"""
|
|
self.label = label
|
|
self.documentation = documentation
|
|
|
|
|
|
class SignatureInformation(object):
|
|
"""
|
|
Represents the signature of something callable. A signature
|
|
can have a label, like a function-name, a doc-comment, and
|
|
a set of parameters.
|
|
"""
|
|
def __init__(self, label, documentation = "", parameters = []):
|
|
"""
|
|
Constructs a new SignatureInformation instance.
|
|
|
|
:param str label: The label of this signature. Will be shown in the UI.
|
|
:param str documentation: The human-readable doc-comment of this signature. Will be shown in the UI but can be omitted.
|
|
:param ParameterInformation[] parameters: The parameters of this signature.
|
|
"""
|
|
self.label = label
|
|
self.documentation = documentation
|
|
self.parameters = [to_type(parameter, ParameterInformation) for parameter in parameters]
|
|
|
|
|
|
class SignatureHelp(object):
|
|
"""
|
|
Signature help represents the signature of something
|
|
callable. There can be multiple signature but only one
|
|
active and only one active parameter.
|
|
"""
|
|
def __init__(self, signatures, activeSignature = 0, activeParameter = 0):
|
|
"""
|
|
Constructs a new SignatureHelp instance.
|
|
|
|
:param SignatureInformation[] signatures: One or more signatures.
|
|
:param int activeSignature:
|
|
:param int activeParameter:
|
|
"""
|
|
self.signatures = [to_type(signature, SignatureInformation) for signature in signatures]
|
|
self.activeSignature = activeSignature
|
|
self.activeParameter = activeParameter
|
|
|
|
|
|
class CompletionTriggerKind(object):
|
|
Invoked = 1
|
|
TriggerCharacter = 2
|
|
TriggerForIncompleteCompletions = 3
|
|
|
|
|
|
class CompletionContext(object):
|
|
"""
|
|
Contains additional information about the context in which a completion request is triggered.
|
|
"""
|
|
def __init__(self, triggerKind, triggerCharacter = None):
|
|
"""
|
|
Constructs a new CompletionContext instance.
|
|
|
|
:param CompletionTriggerKind triggerKind: How the completion was triggered.
|
|
:param str triggerCharacter: The trigger character (a single character) that has trigger code complete.
|
|
Is undefined if `triggerKind !== CompletionTriggerKind.TriggerCharacter`
|
|
"""
|
|
self.triggerKind = triggerKind
|
|
if triggerCharacter:
|
|
self.triggerCharacter = triggerCharacter
|
|
|
|
|
|
class TextEdit(object):
|
|
"""
|
|
A textual edit applicable to a text document.
|
|
"""
|
|
def __init__(self, range, newText):
|
|
"""
|
|
:param Range range: The range of the text document to be manipulated. To insert
|
|
text into a document create a range where start === end.
|
|
:param str newText: The string to be inserted. For delete operations use an empty string.
|
|
"""
|
|
self.range = range
|
|
self.newText = newText
|
|
|
|
|
|
class InsertTextFormat(object):
|
|
PlainText = 1
|
|
Snippet = 2
|
|
|
|
|
|
class CompletionItem(object):
|
|
"""
|
|
"""
|
|
def __init__(self, label, \
|
|
kind = None, \
|
|
detail = None, \
|
|
documentation = None, \
|
|
deprecated = None, \
|
|
preselect = None, \
|
|
sortText = None, \
|
|
filterText = None, \
|
|
insertText = None, \
|
|
insertTextFormat = None, \
|
|
textEdit = None, \
|
|
additionalTextEdits = None, \
|
|
commitCharacters = None, \
|
|
command = None, \
|
|
data = None, \
|
|
score = 0.0
|
|
):
|
|
"""
|
|
:param str label: The label of this completion item. By default also the text that is inserted when selecting
|
|
this completion.
|
|
:param int kind: The kind of this completion item. Based of the kind an icon is chosen by the editor.
|
|
:param str detail: A human-readable string with additional information about this item, like type or symbol information.
|
|
:param tr ocumentation: A human-readable string that represents a doc-comment.
|
|
:param bool deprecated: Indicates if this item is deprecated.
|
|
:param bool preselect: Select this item when showing. Note: that only one completion item can be selected and that the
|
|
tool / client decides which item that is. The rule is that the first item of those that match best is selected.
|
|
:param str sortText: A string that should be used when comparing this item with other items. When `falsy` the label is used.
|
|
:param str filterText: A string that should be used when filtering a set of completion items. When `falsy` the label is used.
|
|
:param str insertText: A string that should be inserted into a document when selecting this completion. When `falsy` the label is used.
|
|
The `insertText` is subject to interpretation by the client side. Some tools might not take the string literally. For example
|
|
VS Code when code complete is requested in this example `con<cursor position>` and a completion item with an `insertText` of `console` is provided it
|
|
will only insert `sole`. Therefore it is recommended to use `textEdit` instead since it avoids additional client side interpretation.
|
|
@deprecated Use textEdit instead.
|
|
:param InsertTextFormat insertTextFormat: The format of the insert text. The format applies to both the `insertText` property
|
|
and the `newText` property of a provided `textEdit`.
|
|
:param TextEdit textEdit: An edit which is applied to a document when selecting this completion. When an edit is provided the value of `insertText` is ignored.
|
|
Note:* The range of the edit must be a single line range and it must contain the position at which completion
|
|
has been requested.
|
|
:param TextEdit additionalTextEdits: An optional array of additional text edits that are applied when selecting this completion.
|
|
Edits must not overlap (including the same insert position) with the main edit nor with themselves.
|
|
Additional text edits should be used to change text unrelated to the current cursor position
|
|
(for example adding an import statement at the top of the file if the completion item will
|
|
insert an unqualified type).
|
|
:param str commitCharacters: An optional set of characters that when pressed while this completion is active will accept it first and
|
|
then type that character. *Note* that all commit characters should have `length=1` and that superfluous
|
|
characters will be ignored.
|
|
:param Command command: An optional command that is executed *after* inserting this completion. Note: that
|
|
additional modifications to the current document should be described with the additionalTextEdits-property.
|
|
:param data: An data entry field that is preserved on a completion item between a completion and a completion resolve request.
|
|
:param float score: Score of the code completion item.
|
|
"""
|
|
self.label = label
|
|
self.kind = kind
|
|
self.detail = detail
|
|
self.documentation = documentation
|
|
self.deprecated = deprecated
|
|
self.preselect = preselect
|
|
self.sortText = sortText
|
|
self.filterText = filterText
|
|
self.insertText = insertText
|
|
self.insertTextFormat = insertTextFormat
|
|
self.textEdit = textEdit
|
|
self.additionalTextEdits = additionalTextEdits
|
|
self.commitCharacters = commitCharacters
|
|
self.command = command
|
|
self.data = data
|
|
self.score = score
|
|
|
|
|
|
class CompletionItemKind(enum.Enum):
|
|
Text = 1
|
|
Method = 2
|
|
Function = 3
|
|
Constructor = 4
|
|
Field = 5
|
|
Variable = 6
|
|
Class = 7
|
|
Interface = 8
|
|
Module = 9
|
|
Property = 10
|
|
Unit = 11
|
|
Value = 12
|
|
Enum = 13
|
|
Keyword = 14
|
|
Snippet = 15
|
|
Color = 16
|
|
File = 17
|
|
Reference = 18
|
|
Folder = 19
|
|
EnumMember = 20
|
|
Constant = 21
|
|
Struct = 22
|
|
Event = 23
|
|
Operator = 24
|
|
TypeParameter = 25
|
|
|
|
|
|
class CompletionList(object):
|
|
"""
|
|
Represents a collection of [completion items](#CompletionItem) to be preselect in the editor.
|
|
"""
|
|
def __init__(self, isIncomplete, items):
|
|
"""
|
|
Constructs a new CompletionContext instance.
|
|
|
|
:param bool isIncomplete: This list it not complete. Further typing should result in recomputing this list.
|
|
:param CompletionItem items: The completion items.
|
|
"""
|
|
self.isIncomplete = isIncomplete
|
|
self.items = [to_type(i, CompletionItem) for i in items]
|
|
|
|
class ErrorCodes(enum.Enum):
|
|
# Defined by JSON RPC
|
|
ParseError = -32700
|
|
InvalidRequest = -32600
|
|
MethodNotFound = -32601
|
|
InvalidParams = -32602
|
|
InternalError = -32603
|
|
serverErrorStart = -32099
|
|
serverErrorEnd = -32000
|
|
ServerNotInitialized = -32002
|
|
UnknownErrorCode = -32001
|
|
|
|
# Defined by the protocol.
|
|
RequestCancelled = -32800
|
|
ContentModified = -32801
|
|
|
|
class ResponseError(Exception):
|
|
def __init__(self, code, message, data = None):
|
|
self.code = code
|
|
self.message = message
|
|
if data:
|
|
self.data = data |