Protocol.h File Reference

#include "URI.h"
#include <bitset>
#include <memory>
#include <optional>
#include <string>
#include <vector>
#include <llvm/ADT/SmallVector.h>
#include <llvm/Support/JSON.h>
#include <llvm/Support/raw_ostream.h>

Go to the source code of this file.

Classes
class	lspserver::LSPError
struct	lspserver::URIForFile
struct	lspserver::TextDocumentIdentifier
struct	lspserver::VersionedTextDocumentIdentifier
struct	lspserver::Position
struct	lspserver::Range
struct	lspserver::Location
struct	lspserver::ReferenceLocation
struct	lspserver::TextEdit
struct	lspserver::ChangeAnnotation
struct	lspserver::TextDocumentEdit
struct	lspserver::TextDocumentItem
struct	lspserver::NoParams
struct	lspserver::ClientCapabilities
struct	lspserver::ClangdCompileCommand
struct	lspserver::ConfigurationSettings
struct	lspserver::InitializationOptions
struct	lspserver::InitializeParams
struct	lspserver::WorkDoneProgressCreateParams
struct	lspserver::ProgressParams< T >
struct	lspserver::WorkDoneProgressBegin
struct	lspserver::WorkDoneProgressReport
	Reporting progress is done using the following payload. More...
struct	lspserver::WorkDoneProgressEnd
	Signals the end of progress reporting. More...
struct	lspserver::ShowMessageParams
struct	lspserver::DidOpenTextDocumentParams
struct	lspserver::DidCloseTextDocumentParams
struct	lspserver::DidSaveTextDocumentParams
struct	lspserver::TextDocumentContentChangeEvent
struct	lspserver::DidChangeTextDocumentParams
struct	lspserver::FileEvent
struct	lspserver::DidChangeWatchedFilesParams
struct	lspserver::DidChangeConfigurationParams
struct	lspserver::DocumentRangeFormattingParams
struct	lspserver::DocumentOnTypeFormattingParams
struct	lspserver::DocumentFormattingParams
struct	lspserver::DocumentSymbolParams
struct	lspserver::DiagnosticRelatedInformation
struct	lspserver::CodeDescription
	Structure to capture a description for an error code. More...
struct	lspserver::Diagnostic
struct	lspserver::LSPDiagnosticCompare
struct	lspserver::PublishDiagnosticsParams
struct	lspserver::CodeActionContext
struct	lspserver::CodeActionParams
struct	lspserver::WorkspaceEdit
struct	lspserver::TweakArgs
struct	lspserver::ExecuteCommandParams
struct	lspserver::Command
struct	lspserver::CodeAction
struct	lspserver::DocumentSymbol
struct	lspserver::SymbolInformation
struct	lspserver::WorkspaceSymbolParams
	The parameters of a Workspace Symbol Request. More...
struct	lspserver::ApplyWorkspaceEditParams
struct	lspserver::ApplyWorkspaceEditResponse
struct	lspserver::TextDocumentPositionParams
struct	lspserver::CompletionContext
struct	lspserver::CompletionParams
struct	lspserver::MarkupContent
struct	lspserver::Hover
struct	lspserver::CompletionItem
struct	lspserver::CompletionList
	Represents a collection of completion items to be presented in the editor. More...
struct	lspserver::ParameterInformation
	A single parameter of a particular signature. More...
struct	lspserver::SignatureInformation
	Represents the signature of something callable. More...
struct	lspserver::SignatureHelp
	Represents the signature of a callable. More...
struct	lspserver::RenameParams
struct	lspserver::DocumentHighlight
struct	lspserver::TypeHierarchyPrepareParams
struct	lspserver::TypeHierarchyItem
struct	lspserver::TypeHierarchyItem::ResolveParams
	Used to resolve a client provided item back. More...
struct	lspserver::ResolveTypeHierarchyItemParams
	Parameters for the typeHierarchy/resolve request. More...
struct	lspserver::CallHierarchyPrepareParams
	The parameter of a textDocument/prepareCallHierarchy request. More...
struct	lspserver::CallHierarchyItem
struct	lspserver::CallHierarchyIncomingCallsParams
	The parameter of a callHierarchy/incomingCalls request. More...
struct	lspserver::CallHierarchyIncomingCall
	Represents an incoming call, e.g. a caller of a method or constructor. More...
struct	lspserver::CallHierarchyOutgoingCallsParams
	The parameter of a callHierarchy/outgoingCalls request. More...
struct	lspserver::CallHierarchyOutgoingCall
struct	lspserver::InlayHintsParams
	A parameter literal used in inlay hint requests. More...
struct	lspserver::InlayHint
	Inlay hint information. More...
struct	lspserver::ReferenceContext
struct	lspserver::ReferenceParams
struct	lspserver::FileStatus
struct	lspserver::SemanticToken
struct	lspserver::SemanticTokens
	A versioned set of tokens. More...
struct	lspserver::SemanticTokensParams
	Body of textDocument/semanticTokens/full request. More...
struct	lspserver::SemanticTokensDeltaParams
struct	lspserver::SemanticTokensEdit
	Describes a replacement of a contiguous range of semanticTokens. More...
struct	lspserver::SemanticTokensOrDelta
struct	lspserver::InactiveRegionsParams
struct	lspserver::SelectionRangeParams
struct	lspserver::SelectionRange
struct	lspserver::DocumentLinkParams
	Parameters for the document link request. More...
struct	lspserver::DocumentLink
struct	lspserver::FoldingRangeParams
struct	lspserver::FoldingRange
	Stores information about a region of code that can be folded. More...
struct	lspserver::ASTParams
struct	lspserver::ASTNode
struct	lspserver::ConfigurationItem
struct	lspserver::ConfigurationParams
struct	llvm::format_provider< lspserver::Position >

Namespaces
namespace	lspserver
	Whether current platform treats paths case insensitively.
namespace	llvm

Typedefs
using	lspserver::ChangeAnnotationIdentifier = std::string
using	lspserver::InitializedParams = NoParams
using	lspserver::CompletionItemKindBitset = std::bitset<CompletionItemKindMax + 1>
using	lspserver::SymbolKindBitset = std::bitset<SymbolKindMax + 1>

Enumerations
enum class	lspserver::ErrorCode {   lspserver::ParseError = -32700 , lspserver::InvalidRequest = -32600 , lspserver::MethodNotFound = -32601 , lspserver::InvalidParams = -32602 ,   lspserver::InternalError = -32603 , lspserver::ServerNotInitialized = -32002 , lspserver::UnknownErrorCode = -32001 , lspserver::RequestCancelled = -32800 ,   lspserver::ContentModified = -32801 }
enum class	lspserver::TraceLevel { lspserver::Off = 0 , lspserver::Messages = 1 , lspserver::Verbose = 2 }
enum class	lspserver::TextDocumentSyncKind { lspserver::None = 0 , lspserver::Full = 1 , lspserver::Incremental = 2 }
enum class	lspserver::CompletionItemKind {   lspserver::Missing = 0 , lspserver::Text = 1 , lspserver::Method = 2 , lspserver::Function = 3 ,   lspserver::Constructor = 4 , lspserver::Field = 5 , lspserver::Variable = 6 , lspserver::Class = 7 ,   lspserver::Interface = 8 , lspserver::Module = 9 , lspserver::Property = 10 , lspserver::Unit = 11 ,   lspserver::Value = 12 , lspserver::Enum = 13 , lspserver::Keyword = 14 , lspserver::Snippet = 15 ,   lspserver::Color = 16 , lspserver::File = 17 , lspserver::Reference = 18 , lspserver::Folder = 19 ,   lspserver::EnumMember = 20 , lspserver::Constant = 21 , lspserver::Struct = 22 , lspserver::Event = 23 ,   lspserver::Operator = 24 , lspserver::TypeParameter = 25 }
	The kind of a completion entry. More...
enum class	lspserver::SymbolKind {   lspserver::File = 1 , lspserver::Module = 2 , lspserver::Namespace = 3 , lspserver::Package = 4 ,   lspserver::Class = 5 , lspserver::Method = 6 , lspserver::Property = 7 , lspserver::Field = 8 ,   lspserver::Constructor = 9 , lspserver::Enum = 10 , lspserver::Interface = 11 , lspserver::Function = 12 ,   lspserver::Variable = 13 , lspserver::Constant = 14 , lspserver::String = 15 , lspserver::Number = 16 ,   lspserver::Boolean = 17 , lspserver::Array = 18 , lspserver::Object = 19 , lspserver::Key = 20 ,   lspserver::Null = 21 , lspserver::EnumMember = 22 , lspserver::Struct = 23 , lspserver::Event = 24 ,   lspserver::Operator = 25 , lspserver::TypeParameter = 26 }
	A symbol kind. More...
enum class	lspserver::OffsetEncoding { lspserver::UnsupportedEncoding , lspserver::UTF16 , lspserver::UTF8 , lspserver::UTF32 }
enum class	lspserver::MarkupKind { lspserver::PlainText , lspserver::Markdown }
enum class	lspserver::MessageType { lspserver::Error = 1 , lspserver::Warning = 2 , lspserver::Info = 3 , lspserver::Log = 4 }
enum class	lspserver::FileChangeType { lspserver::Created = 1 , lspserver::Changed = 2 , lspserver::Deleted = 3 }
enum	lspserver::DiagnosticTag { lspserver::Unnecessary = 1 , lspserver::Deprecated = 2 }
enum class	lspserver::CompletionTriggerKind { lspserver::Invoked = 1 , lspserver::TriggerCharacter = 2 , lspserver::TriggerTriggerForIncompleteCompletions = 3 }
enum class	lspserver::InsertTextFormat { lspserver::Missing = 0 , lspserver::PlainText = 1 , lspserver::Snippet = 2 }
enum class	lspserver::DocumentHighlightKind { lspserver::Text = 1 , lspserver::Read = 2 , lspserver::Write = 3 }
enum class	lspserver::TypeHierarchyDirection { lspserver::Children = 0 , lspserver::Parents = 1 , lspserver::Both = 2 }
enum class	lspserver::SymbolTag { lspserver::Deprecated = 1 }
enum class	lspserver::InlayHintKind { lspserver::Type = 1 , lspserver::Parameter = 2 , lspserver::Designator = 3 }
	Inlay hint kinds. More...

Functions
llvm::json::Value	lspserver::toJSON (const URIForFile &U)
	Serialize/deserialize URIForFile to/from a string URI.
bool	lspserver::fromJSON (const llvm::json::Value &, URIForFile &, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const TextDocumentIdentifier &)
bool	lspserver::fromJSON (const llvm::json::Value &, TextDocumentIdentifier &, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const VersionedTextDocumentIdentifier &)
bool	lspserver::fromJSON (const llvm::json::Value &, VersionedTextDocumentIdentifier &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, Position &, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const Position &)
llvm::raw_ostream &	lspserver::operator<< (llvm::raw_ostream &, const Position &)
bool	lspserver::fromJSON (const llvm::json::Value &, Range &, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const Range &)
llvm::raw_ostream &	lspserver::operator<< (llvm::raw_ostream &, const Range &)
llvm::json::Value	lspserver::toJSON (const Location &)
bool	lspserver::fromJSON (const llvm::json::Value &, Location &, llvm::json::Path)
llvm::raw_ostream &	lspserver::operator<< (llvm::raw_ostream &, const Location &)
llvm::json::Value	lspserver::toJSON (const ReferenceLocation &)
llvm::raw_ostream &	lspserver::operator<< (llvm::raw_ostream &, const ReferenceLocation &)
bool	lspserver::operator== (const TextEdit &L, const TextEdit &R)
bool	lspserver::fromJSON (const llvm::json::Value &, TextEdit &, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const TextEdit &)
llvm::raw_ostream &	lspserver::operator<< (llvm::raw_ostream &, const TextEdit &)
bool	lspserver::fromJSON (const llvm::json::Value &, ChangeAnnotation &, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const ChangeAnnotation &)
bool	lspserver::fromJSON (const llvm::json::Value &, TextDocumentEdit &, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const TextDocumentEdit &)
bool	lspserver::fromJSON (const llvm::json::Value &, TextDocumentItem &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &E, TraceLevel &Out, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const NoParams &)
bool	lspserver::fromJSON (const llvm::json::Value &, NoParams &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, CompletionItemKind &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, CompletionItemKindBitset &, llvm::json::Path)
CompletionItemKind	lspserver::adjustKindToCapability (CompletionItemKind Kind, CompletionItemKindBitset &SupportedCompletionItemKinds)
bool	lspserver::fromJSON (const llvm::json::Value &, SymbolKind &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, SymbolKindBitset &, llvm::json::Path)
SymbolKind	lspserver::adjustKindToCapability (SymbolKind Kind, SymbolKindBitset &supportedSymbolKinds)
llvm::json::Value	lspserver::toJSON (const OffsetEncoding &)
bool	lspserver::fromJSON (const llvm::json::Value &, OffsetEncoding &, llvm::json::Path)
llvm::raw_ostream &	lspserver::operator<< (llvm::raw_ostream &, OffsetEncoding)
bool	lspserver::fromJSON (const llvm::json::Value &, MarkupKind &, llvm::json::Path)
llvm::raw_ostream &	lspserver::operator<< (llvm::raw_ostream &OS, MarkupKind)
bool	lspserver::fromJSON (const llvm::json::Value &, ClientCapabilities &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, ClangdCompileCommand &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, ConfigurationSettings &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, InitializationOptions &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, InitializeParams &, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const WorkDoneProgressCreateParams &P)
template<typename T >
llvm::json::Value	lspserver::toJSON (const ProgressParams< T > &P)
llvm::json::Value	lspserver::toJSON (const WorkDoneProgressBegin &)
llvm::json::Value	lspserver::toJSON (const WorkDoneProgressReport &)
llvm::json::Value	lspserver::toJSON (const WorkDoneProgressEnd &)
llvm::json::Value	lspserver::toJSON (const MessageType &)
llvm::json::Value	lspserver::toJSON (const ShowMessageParams &)
bool	lspserver::fromJSON (const llvm::json::Value &, DidOpenTextDocumentParams &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, DidCloseTextDocumentParams &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, DidSaveTextDocumentParams &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, TextDocumentContentChangeEvent &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, DidChangeTextDocumentParams &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &E, FileChangeType &Out, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, FileEvent &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, DidChangeWatchedFilesParams &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, DidChangeConfigurationParams &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, DocumentRangeFormattingParams &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, DocumentOnTypeFormattingParams &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, DocumentFormattingParams &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, DocumentSymbolParams &, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const DiagnosticRelatedInformation &)
llvm::json::Value	lspserver::toJSON (DiagnosticTag Tag)
llvm::json::Value	lspserver::toJSON (const CodeDescription &)
llvm::json::Value	lspserver::toJSON (const Diagnostic &)
bool	lspserver::fromJSON (const llvm::json::Value &, Diagnostic &, llvm::json::Path)
llvm::raw_ostream &	lspserver::operator<< (llvm::raw_ostream &, const Diagnostic &)
llvm::json::Value	lspserver::toJSON (const PublishDiagnosticsParams &)
bool	lspserver::fromJSON (const llvm::json::Value &, CodeActionContext &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, CodeActionParams &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, WorkspaceEdit &, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const WorkspaceEdit &WE)
bool	lspserver::fromJSON (const llvm::json::Value &, TweakArgs &, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const TweakArgs &A)
bool	lspserver::fromJSON (const llvm::json::Value &, ExecuteCommandParams &, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const Command &C)
llvm::json::Value	lspserver::toJSON (const CodeAction &)
llvm::raw_ostream &	lspserver::operator<< (llvm::raw_ostream &O, const DocumentSymbol &S)
llvm::json::Value	lspserver::toJSON (const DocumentSymbol &S)
llvm::json::Value	lspserver::toJSON (const SymbolInformation &)
llvm::raw_ostream &	lspserver::operator<< (llvm::raw_ostream &, const SymbolInformation &)
bool	lspserver::fromJSON (const llvm::json::Value &, WorkspaceSymbolParams &, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const ApplyWorkspaceEditParams &)
bool	lspserver::fromJSON (const llvm::json::Value &, ApplyWorkspaceEditResponse &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, TextDocumentPositionParams &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, CompletionContext &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, CompletionParams &, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const MarkupContent &MC)
bool	lspserver::fromJSON (const llvm::json::Value &, MarkupContent &, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const Hover &H)
llvm::json::Value	lspserver::toJSON (const CompletionItem &)
bool	lspserver::fromJSON (const llvm::json::Value &, CompletionItem &, llvm::json::Path)
llvm::raw_ostream &	lspserver::operator<< (llvm::raw_ostream &, const CompletionItem &)
bool	lspserver::operator< (const CompletionItem &, const CompletionItem &)
llvm::json::Value	lspserver::toJSON (const CompletionList &)
llvm::json::Value	lspserver::toJSON (const ParameterInformation &)
llvm::json::Value	lspserver::toJSON (const SignatureInformation &)
llvm::raw_ostream &	lspserver::operator<< (llvm::raw_ostream &, const SignatureInformation &)
llvm::json::Value	lspserver::toJSON (const SignatureHelp &)
bool	lspserver::fromJSON (const llvm::json::Value &, RenameParams &, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const DocumentHighlight &DH)
llvm::raw_ostream &	lspserver::operator<< (llvm::raw_ostream &, const DocumentHighlight &)
bool	lspserver::fromJSON (const llvm::json::Value &E, TypeHierarchyDirection &Out, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, TypeHierarchyPrepareParams &, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const TypeHierarchyItem::ResolveParams &)
bool	lspserver::fromJSON (const TypeHierarchyItem::ResolveParams &)
llvm::json::Value	lspserver::toJSON (const TypeHierarchyItem &)
llvm::raw_ostream &	lspserver::operator<< (llvm::raw_ostream &, const TypeHierarchyItem &)
bool	lspserver::fromJSON (const llvm::json::Value &, TypeHierarchyItem &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, ResolveTypeHierarchyItemParams &, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (SymbolTag)
llvm::json::Value	lspserver::toJSON (const CallHierarchyItem &)
bool	lspserver::fromJSON (const llvm::json::Value &, CallHierarchyItem &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &, CallHierarchyIncomingCallsParams &, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const CallHierarchyIncomingCall &)
bool	lspserver::fromJSON (const llvm::json::Value &, CallHierarchyOutgoingCallsParams &, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const CallHierarchyOutgoingCall &)
bool	lspserver::fromJSON (const llvm::json::Value &, InlayHintsParams &, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const InlayHintKind &)
llvm::json::Value	lspserver::toJSON (const InlayHint &)
bool	lspserver::operator== (const InlayHint &, const InlayHint &)
bool	lspserver::operator< (const InlayHint &, const InlayHint &)
llvm::raw_ostream &	lspserver::operator<< (llvm::raw_ostream &, InlayHintKind)
bool	lspserver::fromJSON (const llvm::json::Value &, ReferenceParams &, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const FileStatus &)
bool	lspserver::operator== (const SemanticToken &, const SemanticToken &)
llvm::json::Value	lspserver::toJSON (const SemanticTokens &)
bool	lspserver::fromJSON (const llvm::json::Value &, SemanticTokensParams &, llvm::json::Path)
bool	lspserver::fromJSON (const llvm::json::Value &Params, SemanticTokensDeltaParams &R, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const SemanticTokensEdit &)
llvm::json::Value	lspserver::toJSON (const SemanticTokensOrDelta &)
llvm::json::Value	lspserver::toJSON (const InactiveRegionsParams &InactiveRegions)
bool	lspserver::fromJSON (const llvm::json::Value &, SelectionRangeParams &, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const SelectionRange &)
bool	lspserver::fromJSON (const llvm::json::Value &, DocumentLinkParams &, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const DocumentLink &DocumentLink)
bool	lspserver::fromJSON (const llvm::json::Value &, FoldingRangeParams &, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const FoldingRange &Range)
bool	lspserver::fromJSON (const llvm::json::Value &, ASTParams &, llvm::json::Path)
llvm::json::Value	lspserver::toJSON (const ASTNode &)
llvm::raw_ostream &	lspserver::operator<< (llvm::raw_ostream &, const ASTNode &)
llvm::json::Value	lspserver::toJSON (const ConfigurationItem &)
llvm::json::Value	lspserver::toJSON (const ConfigurationParams &)

Variables
constexpr auto	lspserver::CompletionItemKindMin
constexpr auto	lspserver::CompletionItemKindMax
constexpr auto	lspserver::SymbolKindMin = static_cast<size_t>(SymbolKind::File)
constexpr auto	lspserver::SymbolKindMax = static_cast<size_t>(SymbolKind::TypeParameter)