//===--- IndexingAction.h - Frontend index action ---------------*- C++ -*-===//
|
//
|
// The LLVM Compiler Infrastructure
|
//
|
// This file is distributed under the University of Illinois Open Source
|
// License. See LICENSE.TXT for details.
|
//
|
//===----------------------------------------------------------------------===//
|
|
#ifndef LLVM_CLANG_INDEX_INDEXINGACTION_H
|
#define LLVM_CLANG_INDEX_INDEXINGACTION_H
|
|
#include "clang/Basic/LLVM.h"
|
#include "clang/Lex/PPCallbacks.h"
|
#include "clang/Lex/Preprocessor.h"
|
#include "llvm/ADT/ArrayRef.h"
|
#include <memory>
|
|
namespace clang {
|
class ASTContext;
|
class ASTReader;
|
class ASTUnit;
|
class Decl;
|
class FrontendAction;
|
|
namespace serialization {
|
class ModuleFile;
|
}
|
|
namespace index {
|
class IndexDataConsumer;
|
|
struct IndexingOptions {
|
enum class SystemSymbolFilterKind {
|
None,
|
DeclarationsOnly,
|
All,
|
};
|
|
SystemSymbolFilterKind SystemSymbolFilter
|
= SystemSymbolFilterKind::DeclarationsOnly;
|
bool IndexFunctionLocals = false;
|
bool IndexImplicitInstantiation = false;
|
// Whether to index macro definitions in the Preprocesor when preprocessor
|
// callback is not available (e.g. after parsing has finished). Note that
|
// macro references are not available in Proprocessor.
|
bool IndexMacrosInPreprocessor = false;
|
};
|
|
/// Creates a frontend action that indexes all symbols (macros and AST decls).
|
/// \param WrappedAction another frontend action to wrap over or null.
|
std::unique_ptr<FrontendAction>
|
createIndexingAction(std::shared_ptr<IndexDataConsumer> DataConsumer,
|
IndexingOptions Opts,
|
std::unique_ptr<FrontendAction> WrappedAction);
|
|
/// Recursively indexes all decls in the AST.
|
void indexASTUnit(ASTUnit &Unit, IndexDataConsumer &DataConsumer,
|
IndexingOptions Opts);
|
|
/// Recursively indexes \p Decls.
|
void indexTopLevelDecls(ASTContext &Ctx, Preprocessor &PP,
|
ArrayRef<const Decl *> Decls,
|
IndexDataConsumer &DataConsumer, IndexingOptions Opts);
|
|
/// Creates a PPCallbacks that indexes macros and feeds macros to \p Consumer.
|
/// The caller is responsible for calling `Consumer.setPreprocessor()`.
|
std::unique_ptr<PPCallbacks> indexMacrosCallback(IndexDataConsumer &Consumer,
|
IndexingOptions Opts);
|
|
/// Recursively indexes all top-level decls in the module.
|
void indexModuleFile(serialization::ModuleFile &Mod, ASTReader &Reader,
|
IndexDataConsumer &DataConsumer, IndexingOptions Opts);
|
|
} // namespace index
|
} // namespace clang
|
|
#endif
|
