clang/Index/IndexingOptions.h

0001 //===--- IndexingOptions.h - Options for indexing ---------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLVM_CLANG_INDEX_INDEXINGOPTIONS_H
0010 #define LLVM_CLANG_INDEX_INDEXINGOPTIONS_H
0011
0012 #include "clang/Frontend/FrontendOptions.h"
0013 #include <memory>
0014 #include <string>
0015
0016 namespace clang {
0017 class Decl;
0018 namespace index {
0019
0020 struct IndexingOptions {
0021   enum class SystemSymbolFilterKind {
0022     None,
0023     DeclarationsOnly,
0024     All,
0025   };
0026
0027   SystemSymbolFilterKind SystemSymbolFilter =
0028       SystemSymbolFilterKind::DeclarationsOnly;
0029   bool IndexFunctionLocals = false;
0030   bool IndexImplicitInstantiation = false;
0031   bool IndexMacros = true;
0032   // Whether to index macro definitions in the Preprocessor when preprocessor
0033   // callback is not available (e.g. after parsing has finished). Note that
0034   // macro references are not available in Preprocessor.
0035   bool IndexMacrosInPreprocessor = false;
0036   // Has no effect if IndexFunctionLocals are false.
0037   bool IndexParametersInDeclarations = false;
0038   bool IndexTemplateParameters = false;
0039
0040   // If set, skip indexing inside some declarations for performance.
0041   // This prevents traversal, so skipping a struct means its declaration an
0042   // members won't be indexed, but references elsewhere to that struct will be.
0043   // Currently this is only checked for top-level declarations.
0044   std::function<bool(const Decl *)> ShouldTraverseDecl;
0045 };
0046
0047 } // namespace index
0048 } // namespace clang
0049
0050 #endif // LLVM_CLANG_INDEX_INDEXINGOPTIONS_H