clang::clangd::config::Provider Class Reference

A source of configuration fragments. More...

#include <ConfigProvider.h>

Public Member Functions
virtual	~Provider ()=default
Config	getConfig (const Params &, DiagnosticCallback) const
	Build a config based on this provider. More...

Static Public Member Functions
static std::unique_ptr< Provider >	fromYAMLFile (llvm::StringRef AbsPath, llvm::StringRef Directory, const ThreadsafeFS &, bool Trusted=false)
	Reads fragments from a single YAML file with a fixed path. More...
static std::unique_ptr< Provider >	fromAncestorRelativeYAMLFiles (llvm::StringRef RelPath, const ThreadsafeFS &, bool Trusted=false)
static std::unique_ptr< Provider >	combine (std::vector< const Provider * >)
	A provider that includes fragments from all the supplied providers. More...

Detailed Description

A source of configuration fragments.

Generally these providers reflect a fixed policy for obtaining config, but return different concrete configuration over time. e.g. a provider that reads config from files is responsive to file changes.

Definition at line 62 of file ConfigProvider.h.

Constructor & Destructor Documentation

~Provider()

virtual clang::clangd::config::Provider::~Provider ( )

virtualdefault

Member Function Documentation

combine()

std::unique_ptr< Provider > clang::clangd::config::Provider::combine ( std::vector< const Provider * >  Providers )

static

A provider that includes fragments from all the supplied providers.

Order is preserved; later providers take precedence over earlier ones.

Definition at line 146 of file ConfigProvider.cpp.

fromAncestorRelativeYAMLFiles()

std::unique_ptr< Provider > clang::clangd::config::Provider::fromAncestorRelativeYAMLFiles ( llvm::StringRef  RelPath, const ThreadsafeFS &  FS, bool  Trusted = false  )

static

Definition at line 83 of file ConfigProvider.cpp.

fromYAMLFile()

std::unique_ptr< Provider > clang::clangd::config::Provider::fromYAMLFile ( llvm::StringRef  AbsPath, llvm::StringRef  Directory, const ThreadsafeFS &  FS, bool  Trusted = false  )

static

Reads fragments from a single YAML file with a fixed path.

If non-empty, Directory will be used to resolve relative paths in the fragments.

Definition at line 55 of file ConfigProvider.cpp.

getConfig()

Config clang::clangd::config::Provider::getConfig	(	const Params &	P,
		DiagnosticCallback	DC
	)		const

Build a config based on this provider.

Definition at line 168 of file ConfigProvider.cpp.

References C, clang::clangd::config::Params::Path, SPAN_ATTACH, and Tracer.

---

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

• ConfigProvider.h
• ConfigProvider.cpp