Skip to content

Latest commit

 

History

History
227 lines (120 loc) · 12.8 KB

lsp.md

File metadata and controls

227 lines (120 loc) · 12.8 KB

Supported LSP Requests

Standard

CodeCompass Specific Methods

textDocument/thisCalls

Returns the locations of function calls inside the function at the selected position.

Params: TextDocumentPositionParams

Response: Location | Location[] | null

textDocument/callsOfThis

Returns the locations where the function at the selected position is called.

Params: TextDocumentPositionParams

Response: Location | Location[] | null

textDocument/callee

Returns the locations of the definitions of the functions called by the function at the selected position.

Params: TextDocumentPositionParams

Response: Location | Location[] | null

textDocument/caller

Returns the locations of the definitions of the functions that call the function at the selected position.

Params: TextDocumentPositionParams

Response: Location | Location[] | null

textDocument/virtualCall

Returns the locations where the function at the selected position may be virtually called.

Params: TextDocumentPositionParams

Response: Location | Location[] | null

textDocument/functionPointerCall

Returns the locations where the function at the selected position is called through a function pointer.

Params: TextDocumentPositionParams

Response: Location | Location[] | null

textDocument/parameters

Returns the locations of the parameters of the function at the selected position.

Params: TextDocumentPositionParams

Response: Location | Location[] | null

textDocument/localVariables

Returns the locations of the local variables of the function at the selected position.

Params: TextDocumentPositionParams

Response: Location | Location[] | null

textDocument/overridden

Returns the locations of the functions the function at the selected position overrides.

Params: TextDocumentPositionParams

Response: Location | Location[] | null

textDocument/overriders

Returns the locations of the functions that override the function at the selected position.

Params: TextDocumentPositionParams

Response: Location | Location[] | null

textDocument/read

Returns the locations the variable at the selected position is read.

Params: TextDocumentPositionParams

Response: Location | Location[] | null

textDocument/write

Returns the locations where the variable at the selected position is written.

Params: TextDocumentPositionParams

Response: Location | Location[] | null

textDocument/signature

Returns the name of the AST node of the entity at the selected position.

Params: TextDocumentPositionParams

Response: string | null

textDocument/alias

Returns the locations of the type aliases of the type at the selected position.

Params: TextDocumentPositionParams

Response: Location | Location[] | null

textDocument/implements

Returns the locations of the types that inherit from the type at the selected position.

Params: TextDocumentPositionParams

Response: Location | Location[] | null

textDocument/dataMember

Returns the locations of the data members of the class at the selected position.

Params: TextDocumentPositionParams

Response: Location | Location[] | null

textDocument/methods

Returns the locations of the methods of the class at the selected position.

Params: TextDocumentPositionParams

Response: Location | Location[] | null

textDocument/friends

Returns the locations of the friends of the class at the selected position.

Params: TextDocumentPositionParams

Response: Location | Location[] | null

textDocument/underlyingType

Returns the location of the underlying type of the type alias at the selected position.

Params: TextDocumentPositionParams

Response: Location | Location[] | null

textDocument/enumConstants

Returns the locations of the constants of the enumeration at the selected position.

Params: TextDocumentPositionParams

Response: Location | Location[] | null

textDocument/expansion

Returns the locations of the expansions of the macro at the selected position.

Params: TextDocumentPositionParams

Response: Location | Location[] | null

textDocument/undefinition

Returns the locations of the undefinitions of the macro at the selected position.

Params: TextDocumentPositionParams

Response: Location | Location[] | null

textDocument/diagramTypes

Returns the names of diagram types available at the selected position.

Params: TextDocumentPositionParams

Response: string[] | null

textDocument/diagram

Returns a diagram of the selected type based on the selected position in SVG format.

Params: diagramParams

Response: string | null

directory/diagram

Returns a diagram of the selected type based on the selected module in SVG format.

Params: diagramParams

Response: string | null

CodeCompass Specific Types

DiagramParams

Parameters needed for diagram requests. Directory based diagrams do not need the position parameter. The diagramType should contain a valid diagram type name for the given language plugin. The textDocument/diagramTypes method can be used to access these for position dependant diagrams.

interface DiagramParams {
	textDocument: TextDocumentIdentifier;
	position?: Position;
	diagramType: string;
}