InsightDatabase Class Reference

Track compile statements to support code insight services More...

#include <cc/build/InsightDatabase>

Inheritance diagram for InsightDatabase:

Public Member Functions
	InsightDatabase ()=default
	Create a null compile database.
	InsightDatabase (const String &projectPath)
	Load a compile database from projectPath.
void	insert (const String &sourcePath, const String &command, const String &outputPath)
	Insert a new compile command into the compile database.
void	touch (const String &outputPath)
	Tell the database that the path is still in use.
void	sync ()
	Write compile database back to disk.
String	path () const
	File path of the compile_commands.json.
Public Member Functions inherited from Object
	Object ()=default
	Create a null object.
	operator bool () const
	Check if this is a non-null object.
bool	isNull () const
	Check if this is a null object.
int	useCount () const
	Reference count.
template<class T>
bool	is () const
	Check if this object is of type T.
template<class T>
T	as () const
	Cast this object to type T.
bool	isWeak () const
	Check if the underlying object reference is weak.
bool	operator== (const Object &other) const
	Equality operator.
std::strong_ordering	operator<=> (const Object &other) const
	Ordering operator.

Additional Inherited Members
Public Types inherited from Object
using	NullAccess = cc::NullAccess
	Error thrown when trying to access a null object.
using	VirginityTestFailed = cc::VirginityTestFailed
	Error thrown when trying to initialize an object with a non-virgin state.
Protected Member Functions inherited from Object
template<class T>
T	weak () const
template<class T>
void	initOnce ()
	Create the object state when called the first time.
template<class T>
void	initOncePerThread ()
	Create a distinct object state for each thread when called the first time in that thread.
	Object (State *newState)
	Initialize object with newState.
	Object (State *state, Alias)
	Object (State *state, Weak)
Object &	operator= (std::nullptr_t)
Static Protected Member Functions inherited from Object
template<class T>
static T	alias (const State *state)
	Create an alias object for the given state.
template<class T>
static T	weak (const State *state)
Protected Attributes inherited from Object
Handle< State >	me
	Internal object state

Detailed Description

Track compile statements to support code insight services

This class generates a "compilation database" as needed for clangd.

See the following links for more details:

• https://clangd.llvm.org/installation
• https://clang.llvm.org/docs/JSONCompilationDatabase.html

Constructor & Destructor Documentation

InsightDatabase() [1/2]

InsightDatabase ( )

default

Create a null compile database.

InsightDatabase() [2/2]

InsightDatabase ( const String & projectPath )

explicit

Load a compile database from projectPath.

Member Function Documentation

insert()

void insert	(	const String &	sourcePath,
		const String &	command,
		const String &	outputPath )

Insert a new compile command into the compile database.

Parameters

sourcePath	Absolute path of the source file
command	Compile command
outputPath	Path of generated object file

touch()

void touch

(

const String &

outputPath

)

Tell the database that the path is still in use.

sync()

void sync

(

)

Write compile database back to disk.

path()

String path

(

)

const

File path of the compile_commands.json.