clang 19.0.0git
Public Member Functions | List of all members
clang::tooling::CompilationDatabasePlugin Class Referenceabstract

Interface for compilation database plugins. More...

#include "clang/Tooling/CompilationDatabasePluginRegistry.h"

Public Member Functions

virtual ~CompilationDatabasePlugin ()
virtual std::unique_ptr< CompilationDatabaseloadFromDirectory (StringRef Directory, std::string &ErrorMessage)=0
 Loads a compilation database from a build directory.

Detailed Description

Interface for compilation database plugins.

A compilation database plugin allows the user to register custom compilation databases that are picked up as compilation database if the corresponding library is linked in. To register a plugin, declare a static variable like:

static CompilationDatabasePluginRegistry::Add<MyDatabasePlugin>
X("my-compilation-database", "Reads my own compilation database");
#define X(type, name)
Definition: Value.h:143

Definition at line 28 of file CompilationDatabasePluginRegistry.h.

Constructor & Destructor Documentation

◆ ~CompilationDatabasePlugin()

CompilationDatabasePlugin::~CompilationDatabasePlugin ( )

Member Function Documentation

◆ loadFromDirectory()

virtual std::unique_ptr< CompilationDatabase > clang::tooling::CompilationDatabasePlugin::loadFromDirectory ( StringRef  Directory,
std::string &  ErrorMessage 
pure virtual

Loads a compilation database from a build directory.

See also

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