clang-tools  14.0.0git
Classes | Public Member Functions | Friends | List of all members
clang::clangd::DirectoryBasedGlobalCompilationDatabase Class Reference

Gets compile args from tooling::CompilationDatabases built for parent directories. More...

#include <GlobalCompilationDatabase.h>

Inheritance diagram for clang::clangd::DirectoryBasedGlobalCompilationDatabase:
Inheritance graph
[legend]
Collaboration diagram for clang::clangd::DirectoryBasedGlobalCompilationDatabase:
Collaboration graph
[legend]

Classes

class  BroadcastThread
 
class  DirectoryCache
 
struct  Options
 

Public Member Functions

 DirectoryBasedGlobalCompilationDatabase (const Options &Opts)
 
 ~DirectoryBasedGlobalCompilationDatabase () override
 
llvm::Optional< tooling::CompileCommand > getCompileCommand (PathRef File) const override
 Scans File's parents looking for compilation databases. More...
 
llvm::Optional< ProjectInfogetProjectInfo (PathRef File) const override
 Returns the path to first directory containing a compilation database in File's parents. More...
 
bool blockUntilIdle (Deadline Timeout) const override
 If the CDB does any asynchronous work, wait for it to complete. More...
 
- Public Member Functions inherited from clang::clangd::GlobalCompilationDatabase
virtual ~GlobalCompilationDatabase ()=default
 
virtual tooling::CompileCommand getFallbackCommand (PathRef File) const
 Makes a guess at how to build a file. More...
 
CommandChanged::Subscription watch (CommandChanged::Listener L) const
 The callback is notified when files may have new compile commands. More...
 

Friends

class DirectoryBasedGlobalCompilationDatabaseCacheTest
 

Additional Inherited Members

- Public Types inherited from clang::clangd::GlobalCompilationDatabase
using CommandChanged = Event< std::vector< std::string > >
 
- Protected Attributes inherited from clang::clangd::GlobalCompilationDatabase
CommandChanged OnCommandChanged
 

Detailed Description

Gets compile args from tooling::CompilationDatabases built for parent directories.

Definition at line 92 of file GlobalCompilationDatabase.h.

Constructor & Destructor Documentation

◆ DirectoryBasedGlobalCompilationDatabase()

clang::clangd::DirectoryBasedGlobalCompilationDatabase::DirectoryBasedGlobalCompilationDatabase ( const Options Opts)

◆ ~DirectoryBasedGlobalCompilationDatabase()

clang::clangd::DirectoryBasedGlobalCompilationDatabase::~DirectoryBasedGlobalCompilationDatabase ( )
overridedefault

Member Function Documentation

◆ blockUntilIdle()

bool clang::clangd::DirectoryBasedGlobalCompilationDatabase::blockUntilIdle ( Deadline  D) const
overridevirtual

If the CDB does any asynchronous work, wait for it to complete.

For use in tests.

Reimplemented from clang::clangd::GlobalCompilationDatabase.

Definition at line 728 of file GlobalCompilationDatabase.cpp.

◆ getCompileCommand()

llvm::Optional< tooling::CompileCommand > clang::clangd::DirectoryBasedGlobalCompilationDatabase::getCompileCommand ( PathRef  File) const
overridevirtual

Scans File's parents looking for compilation databases.

Any extra flags will be added. Might trigger OnCommandChanged, if CDB wasn't broadcasted yet.

Implements clang::clangd::GlobalCompilationDatabase.

Definition at line 362 of file GlobalCompilationDatabase.cpp.

References clang::clangd::log(), clang::clangd::DirectoryBasedGlobalCompilationDatabase::Options::RevalidateAfter, and clang::clangd::DirectoryBasedGlobalCompilationDatabase::Options::RevalidateMissingAfter.

◆ getProjectInfo()

llvm::Optional< ProjectInfo > clang::clangd::DirectoryBasedGlobalCompilationDatabase::getProjectInfo ( PathRef  File) const
overridevirtual

Returns the path to first directory containing a compilation database in File's parents.

Reimplemented from clang::clangd::GlobalCompilationDatabase.

Definition at line 734 of file GlobalCompilationDatabase.cpp.

Friends And Related Function Documentation

◆ DirectoryBasedGlobalCompilationDatabaseCacheTest

Definition at line 162 of file GlobalCompilationDatabase.h.


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