#include <ClangTidyOptions.h>

Inheritance diagram for clang::tidy::FileOptionsBaseProvider:

[legend]

Classes
struct	OptionsCache

Protected Types
using	ConfigFileHandler = std::pair< std::string, std::function< llvm::ErrorOr< ClangTidyOptions >(llvm::MemoryBufferRef)> >

using	ConfigFileHandlers = std::vector< ConfigFileHandler >
	Configuration file handlers listed in the order of priority.

Protected Member Functions
	FileOptionsBaseProvider (ClangTidyGlobalOptions GlobalOptions, ClangTidyOptions DefaultOptions, ClangTidyOptions OverrideOptions, llvm::IntrusiveRefCntPtr< llvm::vfs::FileSystem > FS)

	FileOptionsBaseProvider (ClangTidyGlobalOptions GlobalOptions, ClangTidyOptions DefaultOptions, ClangTidyOptions OverrideOptions, ConfigFileHandlers ConfigHandlers)

void	addRawFileOptions (llvm::StringRef AbsolutePath, std::vector< OptionsSource > &CurOptions)

llvm::ErrorOr< llvm::SmallString< 128 > >	getNormalizedAbsolutePath (llvm::StringRef AbsolutePath)

std::optional< OptionsSource >	tryReadConfigFile (llvm::StringRef Directory)
	Try to read configuration files from `Directory` using registered `ConfigHandlers`.

Protected Attributes
struct clang::tidy::FileOptionsBaseProvider::OptionsCache	CachedOptions

ClangTidyOptions	OverrideOptions

ConfigFileHandlers	ConfigHandlers

llvm::IntrusiveRefCntPtr< llvm::vfs::FileSystem >	FS

Additional Inherited Members
Public Types inherited from clang::tidy::ClangTidyOptionsProvider
using	OptionsSource = std::pair< ClangTidyOptions, std::string >
	ClangTidyOptions and its source.

Public Member Functions inherited from clang::tidy::DefaultOptionsProvider
	DefaultOptionsProvider (ClangTidyGlobalOptions GlobalOptions, ClangTidyOptions Options)

const ClangTidyGlobalOptions &	getGlobalOptions () override
	Returns global options, which are independent of the file.

std::vector< OptionsSource >	getRawOptions (llvm::StringRef FileName) override
	Returns an ordered vector of OptionsSources, in order of increasing priority.

Public Member Functions inherited from clang::tidy::ClangTidyOptionsProvider
virtual	~ClangTidyOptionsProvider ()

virtual const ClangTidyGlobalOptions &	getGlobalOptions ()=0
	Returns global options, which are independent of the file.

virtual std::vector< OptionsSource >	getRawOptions (llvm::StringRef FileName)=0
	Returns an ordered vector of OptionsSources, in order of increasing priority.

ClangTidyOptions	getOptions (llvm::StringRef FileName)
	Returns options applying to a specific translation unit with the specified `FileName`.

Static Public Attributes inherited from clang::tidy::ClangTidyOptionsProvider
static const char	OptionsSourceTypeDefaultBinary []

static const char	OptionsSourceTypeCheckCommandLineOption []

static const char	OptionsSourceTypeConfigCommandLineOption []

Detailed Description

Definition at line 203 of file ClangTidyOptions.h.

Member Typedef Documentation

◆ ConfigFileHandler

using clang::tidy::FileOptionsBaseProvider::ConfigFileHandler = std::pair<std::string, std::function<llvm::ErrorOr<ClangTidyOptions> (llvm::MemoryBufferRef)> >

protected

Definition at line 207 of file ClangTidyOptions.h.

◆ ConfigFileHandlers

using clang::tidy::FileOptionsBaseProvider::ConfigFileHandlers = std::vector<ConfigFileHandler>

protected

Configuration file handlers listed in the order of priority.

Custom configuration file formats can be supported by constructing the list of handlers and passing it to the appropriate FileOptionsProvider constructor. E.g. initialization of a FileOptionsProvider with support of a custom configuration file format for files named ".my-tidy-config" could look similar to this:

FileOptionsProvider::ConfigFileHandlers ConfigHandlers;
ConfigHandlers.emplace_back(".my-tidy-config", parseMyConfigFormat);
ConfigHandlers.emplace_back(".clang-tidy", parseConfiguration);
return std::make_unique<FileOptionsProvider>(
    GlobalOptions, DefaultOptions, OverrideOptions, ConfigHandlers);

With the order of handlers shown above, the ".my-tidy-config" file would take precedence over ".clang-tidy" if both reside in the same directory.

Definition at line 226 of file ClangTidyOptions.h.

Constructor & Destructor Documentation

◆ FileOptionsBaseProvider() [1/2]

clang::tidy::FileOptionsBaseProvider::FileOptionsBaseProvider	(	ClangTidyGlobalOptions	GlobalOptions,
		ClangTidyOptions	DefaultOptions,
		ClangTidyOptions	OverrideOptions,
		llvm::IntrusiveRefCntPtr< llvm::vfs::FileSystem >	FS
	)

protected

Definition at line 316 of file ClangTidyOptions.cpp.

References ConfigHandlers, FS, and clang::tidy::parseConfiguration().

◆ FileOptionsBaseProvider() [2/2]

clang::tidy::FileOptionsBaseProvider::FileOptionsBaseProvider	(	ClangTidyGlobalOptions	GlobalOptions,
		ClangTidyOptions	DefaultOptions,
		ClangTidyOptions	OverrideOptions,
		FileOptionsBaseProvider::ConfigFileHandlers	ConfigHandlers
	)