Module types

Expand description

Generated file from scip.proto

Modules§

Descriptor
Diagnostic: Represents a diagnostic, such as a compiler error or warning, which should be reported for a document.
Document: Document defines the metadata about a source file on disk.
Index: Index represents a complete SCIP index for a workspace this is rooted at a single directory. An Index message payload can have a large memory footprint and it’s therefore recommended to emit and consume an Index payload one field value at a time. To permit streaming consumption of an Index payload, the metadata field must appear at the start of the stream and must only appear once in the stream. Other field values may appear in any order.
Metadata
Occurrence: Occurrence associates a source position with a symbol and/or highlighting information.
Package: Unit of packaging and distribution.
Relationship
Symbol: Symbol is similar to a URI, it identifies a class, method, or a local variable. SymbolInformation contains rich metadata about symbols such as the docstring.
SymbolInformation: SymbolInformation defines metadata about a symbol, such as the symbol’s docstring or what package it’s defined it.
ToolInfo

DiagnosticTag
Language: Language standardises names of common programming languages that can be used for the Document.language field. The primary purpose of this enum is to prevent a situation where we have a single programming language ends up with multiple string representations. For example, the C++ language uses the name “CPP” in this enum and other names such as “cpp” are incompatible. Feel free to send a pull-request to add missing programming languages.
PositionEncoding: Encoding used to interpret the ‘character’ value in source ranges.
ProtocolVersion
Severity
SymbolRole: SymbolRole declares what “role” a symbol has in an occurrence. A role is encoded as a bitset where each bit represents a different role. For example, to determine if the Import role is set, test whether the second bit of the enum value is defined. In pseudocode, this can be implemented with the logic: const isImportRole = (role.value & SymbolRole.Import.value) > 0.
SyntaxKind
TextEncoding

file_descriptor: FileDescriptor object which allows dynamic access to files