clang-tools  14.0.0git
Public Attributes | List of all members
clang::clangd::InitializeParams Struct Reference

#include <Protocol.h>

Collaboration diagram for clang::clangd::InitializeParams:
Collaboration graph
[legend]

Public Attributes

llvm::Optional< int > processId
 The process Id of the parent process that started the server. More...
 
llvm::Optional< std::string > rootPath
 The rootPath of the workspace. More...
 
llvm::Optional< URIForFilerootUri
 The rootUri of the workspace. More...
 
ClientCapabilities capabilities
 The capabilities provided by the client (editor or tool) More...
 
llvm::json::Object rawCapabilities
 The same data as capabilities, but not parsed (to expose to modules). More...
 
llvm::Optional< TraceLeveltrace
 The initial trace setting. If omitted trace is disabled ('off'). More...
 
InitializationOptions initializationOptions
 User-provided initialization options. More...
 

Detailed Description

Definition at line 530 of file Protocol.h.

Member Data Documentation

◆ capabilities

ClientCapabilities clang::clangd::InitializeParams::capabilities

The capabilities provided by the client (editor or tool)

Definition at line 552 of file Protocol.h.

Referenced by clang::clangd::fromJSON().

◆ initializationOptions

InitializationOptions clang::clangd::InitializeParams::initializationOptions

User-provided initialization options.

Definition at line 560 of file Protocol.h.

Referenced by clang::clangd::fromJSON().

◆ processId

llvm::Optional<int> clang::clangd::InitializeParams::processId

The process Id of the parent process that started the server.

Is null if the process has not been started by another process. If the parent process is not alive then the server should exit (see exit notification) its process.

Definition at line 535 of file Protocol.h.

Referenced by clang::clangd::fromJSON().

◆ rawCapabilities

llvm::json::Object clang::clangd::InitializeParams::rawCapabilities

The same data as capabilities, but not parsed (to expose to modules).

Definition at line 554 of file Protocol.h.

Referenced by clang::clangd::fromJSON().

◆ rootPath

llvm::Optional<std::string> clang::clangd::InitializeParams::rootPath

The rootPath of the workspace.

Is null if no folder is open.

Deprecated:
in favour of rootUri.

Definition at line 541 of file Protocol.h.

Referenced by clang::clangd::fromJSON().

◆ rootUri

llvm::Optional<URIForFile> clang::clangd::InitializeParams::rootUri

The rootUri of the workspace.

Is null if no folder is open. If both rootPath and rootUri are set rootUri wins.

Definition at line 546 of file Protocol.h.

Referenced by clang::clangd::fromJSON().

◆ trace

llvm::Optional<TraceLevel> clang::clangd::InitializeParams::trace

The initial trace setting. If omitted trace is disabled ('off').

Definition at line 557 of file Protocol.h.

Referenced by clang::clangd::fromJSON().


The documentation for this struct was generated from the following file: