clang::clangd::remote::Marshaller Class Reference

A notable exception is URI translation. More...

#include <Marshalling.h>

Public Member Functions
	Marshaller ()=delete
	Marshaller (llvm::StringRef RemoteIndexRoot, llvm::StringRef LocalIndexRoot)
llvm::Expected< clangd::Symbol >	fromProtobuf (const Symbol &Message)
llvm::Expected< clangd::Ref >	fromProtobuf (const Ref &Message)
llvm::Expected< clangd::ContainedRefsResult >	fromProtobuf (const ContainedRef &Message)
llvm::Expected< std::pair< clangd::SymbolID, clangd::Symbol > >	fromProtobuf (const Relation &Message)
llvm::Expected< clangd::LookupRequest >	fromProtobuf (const LookupRequest *Message)
llvm::Expected< clangd::FuzzyFindRequest >	fromProtobuf (const FuzzyFindRequest *Message)
llvm::Expected< clangd::RefsRequest >	fromProtobuf (const RefsRequest *Message)
llvm::Expected< clangd::ContainedRefsRequest >	fromProtobuf (const ContainedRefsRequest *Message)
llvm::Expected< clangd::RelationsRequest >	fromProtobuf (const RelationsRequest *Message)
LookupRequest	toProtobuf (const clangd::LookupRequest &From)
	toProtobuf() functions serialize native clangd types and strip IndexRoot from the file paths specific to indexing machine.
FuzzyFindRequest	toProtobuf (const clangd::FuzzyFindRequest &From)
RefsRequest	toProtobuf (const clangd::RefsRequest &From)
ContainedRefsRequest	toProtobuf (const clangd::ContainedRefsRequest &From)
RelationsRequest	toProtobuf (const clangd::RelationsRequest &From)
llvm::Expected< Symbol >	toProtobuf (const clangd::Symbol &From)
llvm::Expected< Ref >	toProtobuf (const clangd::Ref &From)
llvm::Expected< ContainedRef >	toProtobuf (const clangd::ContainedRefsResult &From)
llvm::Expected< Relation >	toProtobuf (const clangd::SymbolID &Subject, const clangd::Symbol &Object)
llvm::Expected< std::string >	relativePathToURI (llvm::StringRef RelativePath)
	Translates RelativePath into the absolute path and builds URI for the user machine.
llvm::Expected< std::string >	uriToRelativePath (llvm::StringRef URI)
	Translates a URI from the server's backing index to a relative path suitable to send over the wire to the client.

Detailed Description

A notable exception is URI translation.

Because paths to files are different on indexing machine and client machine ("/remote/machine/projects/llvm-project/llvm/include/HelloWorld.h" versus "/usr/local/username/llvm-project/llvm/include/HelloWorld.h"), they need to be converted appropriately. Remote machine strips the prefix (RemoteIndexRoot) from the absolute path and passes paths relative to the project root over the wire ("include/HelloWorld.h" in this example). The indexed project root is passed to the remote server. Client receives this relative path and constructs a URI that points to the relevant file in the filesystem. The relative path is appended to LocalIndexRoot to construct the full path and build the final URI.

Definition at line 36 of file Marshalling.h.

Constructor & Destructor Documentation

Marshaller() [1/2]

clang::clangd::remote::Marshaller::Marshaller ( )

delete

Marshaller() [2/2]

clang::clangd::remote::Marshaller::Marshaller	(	llvm::StringRef	RemoteIndexRoot,
		llvm::StringRef	LocalIndexRoot
	)

Definition at line 57 of file Marshalling.cpp.

Member Function Documentation

fromProtobuf() [1/9]

llvm::Expected< clangd::ContainedRefsResult > clang::clangd::remote::Marshaller::fromProtobuf

(

const ContainedRef &

Message

)

Definition at line 210 of file Marshalling.cpp.

References clang::clangd::error(), fromProtobuf(), and clang::clangd::SymbolID::fromStr().

fromProtobuf() [2/9]

llvm::Expected< clangd::ContainedRefsRequest > clang::clangd::remote::Marshaller::fromProtobuf

(

const ContainedRefsRequest *

Message

)

Definition at line 130 of file Marshalling.cpp.

References clang::clangd::error(), clang::clangd::SymbolID::fromStr(), ID, clang::clangd::ContainedRefsRequest::ID, and clang::clangd::ContainedRefsRequest::Limit.

fromProtobuf() [3/9]

llvm::Expected< clangd::FuzzyFindRequest > clang::clangd::remote::Marshaller::fromProtobuf

(

const FuzzyFindRequest *

Message

)

Definition at line 89 of file Marshalling.cpp.

References clang::clangd::Type.

fromProtobuf() [4/9]

llvm::Expected< clangd::LookupRequest > clang::clangd::remote::Marshaller::fromProtobuf

(

const LookupRequest *

Message

)

Definition at line 79 of file Marshalling.cpp.

References clang::clangd::LookupRequest::IDs.

fromProtobuf() [5/9]

llvm::Expected< clangd::Ref > clang::clangd::remote::Marshaller::fromProtobuf

(

const Ref &

Message

)

Definition at line 197 of file Marshalling.cpp.

References clang::clangd::error(), and fromProtobuf().

fromProtobuf() [6/9]

llvm::Expected< clangd::RefsRequest > clang::clangd::remote::Marshaller::fromProtobuf

(

const RefsRequest *

Message

)

Definition at line 113 of file Marshalling.cpp.

References clang::clangd::All, clang::clangd::RefsRequest::Filter, clang::clangd::RefsRequest::IDs, clang::clangd::RefsRequest::Limit, and clang::clangd::RefsRequest::WantContainer.

fromProtobuf() [7/9]

llvm::Expected< std::pair< clangd::SymbolID, clangd::Symbol > > clang::clangd::remote::Marshaller::fromProtobuf

(

const Relation &

Message

)

Definition at line 231 of file Marshalling.cpp.

References clang::clangd::error(), fromProtobuf(), clang::clangd::SymbolID::fromStr(), and clang::clangd::Object.

fromProtobuf() [8/9]

llvm::Expected< clangd::RelationsRequest > clang::clangd::remote::Marshaller::fromProtobuf

(

const RelationsRequest *

Message

)

Definition at line 144 of file Marshalling.cpp.

References clang::clangd::error(), clang::clangd::RelationsRequest::Limit, clang::clangd::RelationsRequest::Predicate, and clang::clangd::RelationsRequest::Subjects.

fromProtobuf() [9/9]

llvm::Expected< clangd::Symbol > clang::clangd::remote::Marshaller::fromProtobuf

(

const Symbol &

Message

)

Definition at line 158 of file Marshalling.cpp.

References clang::clangd::Declaration, clang::clangd::Definition, clang::clangd::error(), fromProtobuf(), clang::clangd::SymbolID::fromStr(), ID, and clang::clangd::Remote.

Referenced by fromProtobuf().

relativePathToURI()

llvm::Expected< std::string > clang::clangd::remote::Marshaller::relativePathToURI

(

llvm::StringRef

RelativePath

)

Translates RelativePath into the absolute path and builds URI for the user machine.

This translation happens on the client side with the RelativePath received from remote index server and IndexRoot is provided by the client.

The relative path passed over the wire has unix slashes.

Definition at line 370 of file Marshalling.cpp.

References clang::clangd::URI::createFile(), and clang::clangd::error().

toProtobuf() [1/9]

ContainedRefsRequest clang::clangd::remote::Marshaller::toProtobuf

(

const clangd::ContainedRefsRequest &

From

)

Definition at line 283 of file Marshalling.cpp.

References clang::clangd::ContainedRefsRequest::ID, clang::clangd::ContainedRefsRequest::Limit, and clang::clangd::SymbolID::str().

toProtobuf() [2/9]

llvm::Expected< ContainedRef > clang::clangd::remote::Marshaller::toProtobuf

(

const clangd::ContainedRefsResult &

From

)

Definition at line 347 of file Marshalling.cpp.

References clang::clangd::ContainedRefsResult::Kind, clang::clangd::ContainedRefsResult::Location, clang::clangd::SymbolID::str(), clang::clangd::ContainedRefsResult::Symbol, and toProtobuf().

toProtobuf() [3/9]

FuzzyFindRequest clang::clangd::remote::Marshaller::toProtobuf

(

const clangd::FuzzyFindRequest &

From

)

Definition at line 250 of file Marshalling.cpp.

References clang::clangd::FuzzyFindRequest::AnyScope, clang::clangd::FuzzyFindRequest::Limit, clang::clangd::FuzzyFindRequest::PreferredTypes, clang::clangd::FuzzyFindRequest::ProximityPaths, clang::clangd::FuzzyFindRequest::Query, clang::clangd::FuzzyFindRequest::RestrictForCodeCompletion, clang::clangd::FuzzyFindRequest::Scopes, and clang::clangd::Type.

toProtobuf() [4/9]

LookupRequest clang::clangd::remote::Marshaller::toProtobuf

(

const clangd::LookupRequest &

From

)

toProtobuf() functions serialize native clangd types and strip IndexRoot from the file paths specific to indexing machine.

fromProtobuf() functions deserialize clangd types and translate relative paths into machine-native URIs.

Definition at line 243 of file Marshalling.cpp.

References clang::clangd::LookupRequest::IDs, and clang::clangd::SymbolID::str().

Referenced by toProtobuf().

toProtobuf() [5/9]

llvm::Expected< Ref > clang::clangd::remote::Marshaller::toProtobuf

(

const clangd::Ref &

From

)

Definition at line 336 of file Marshalling.cpp.

References clang::clangd::Ref::Kind, clang::clangd::Ref::Location, and toProtobuf().

toProtobuf() [6/9]

RefsRequest clang::clangd::remote::Marshaller::toProtobuf

(

const clangd::RefsRequest &

From

)

Definition at line 271 of file Marshalling.cpp.

References clang::clangd::RefsRequest::Filter, ID, clang::clangd::RefsRequest::IDs, clang::clangd::RefsRequest::Limit, and clang::clangd::RefsRequest::WantContainer.

toProtobuf() [7/9]

RelationsRequest clang::clangd::remote::Marshaller::toProtobuf

(

const clangd::RelationsRequest &

From

)

Definition at line 291 of file Marshalling.cpp.

References ID, clang::clangd::RelationsRequest::Limit, clang::clangd::RelationsRequest::Predicate, and clang::clangd::RelationsRequest::Subjects.

toProtobuf() [8/9]

llvm::Expected< Symbol > clang::clangd::remote::Marshaller::toProtobuf

(

const clangd::Symbol &

From

)

Definition at line 301 of file Marshalling.cpp.

References clang::clangd::Symbol::CanonicalDeclaration, clang::clangd::Symbol::CompletionSnippetSuffix, clang::clangd::Declaration, clang::clangd::Definition, clang::clangd::Symbol::Definition, clang::clangd::Symbol::Documentation, clang::clangd::SymbolLocation::FileURI, clang::clangd::Symbol::Flags, clang::clangd::Symbol::ID, clang::clangd::Symbol::IncludeHeaders, clang::clangd::Symbol::Name, clang::clangd::Symbol::References, clang::clangd::Symbol::ReturnType, clang::clangd::Symbol::Scope, clang::clangd::Symbol::Signature, clang::clangd::SymbolID::str(), clang::clangd::Symbol::SymInfo, clang::clangd::Symbol::TemplateSpecializationArgs, toProtobuf(), and clang::clangd::Symbol::Type.

toProtobuf() [9/9]

llvm::Expected< Relation > clang::clangd::remote::Marshaller::toProtobuf	(	const clangd::SymbolID &	Subject,
		const clangd::Symbol &	Object
	)

Definition at line 358 of file Marshalling.cpp.

References clang::clangd::Object, clang::clangd::SymbolID::str(), and toProtobuf().

uriToRelativePath()

llvm::Expected< std::string > clang::clangd::remote::Marshaller::uriToRelativePath

(

llvm::StringRef

URI

)

Translates a URI from the server's backing index to a relative path suitable to send over the wire to the client.

Definition at line 383 of file Marshalling.cpp.

References clang::clangd::error(), and clang::clangd::URI::parse().

---

The documentation for this class was generated from the following files:

• Marshalling.h
• Marshalling.cpp