#pragma once #include "serializer.h" #include struct Config { // Root directory of the project. **Not serialized** std::string projectRoot; // Location of compile_commands.json. std::string compilationDatabaseDirectory; // Cache directory for indexed files. std::string cacheDirectory; // Cache serialization format SerializeFormat cacheFormat = SerializeFormat::Json; // Value to use for clang -resource-dir if not present in // compile_commands.json. std::string resourceDirectory; std::vector extraClangArguments; std::vector indexWhitelist; std::vector indexBlacklist; // If true, project paths that were skipped by the whitelist/blacklist will // be logged. bool logSkippedPathsForIndex = false; // Maximum workspace search results. int maxWorkspaceSearchResults = 500; // If true, workspace search results will be dynamically rescored/reordered // as the search progresses. Some clients do their own ordering and assume // that the results stay sorted in the same order as the search progresses. bool sortWorkspaceSearchResults = true; // Force a certain number of indexer threads. If less than 1 a default value // should be used. int indexerCount = 0; // If false, the indexer will be disabled. bool enableIndexing = true; // If false, indexed files will not be written to disk. bool enableCacheWrite = true; // If false, the index will not be loaded from a previous run. bool enableCacheRead = true; // If true, cquery will send progress reports while indexing // How often should cquery send progress report messages? // -1: never // 0: as often as possible // xxx: at most every xxx milliseconds // // Empty progress reports (ie, idle) are delivered as often as they are // available and may exceed this value. // // This does not guarantee a progress report will be delivered every // interval; it could take significantly longer if cquery is completely idle. int progressReportFrequencyMs = 500; // If true, document links are reported for #include directives. bool showDocumentLinksOnIncludes = true; // Maximum path length to show in completion results. Paths longer than this // will be elided with ".." put at the front. Set to 0 or a negative number // to disable eliding. int includeCompletionMaximumPathLength = 30; // Whitelist that file paths will be tested against. If a file path does not // end in one of these values, it will not be considered for auto-completion. // An example value is { ".h", ".hpp" } // // This is significantly faster than using a regex. std::vector includeCompletionWhitelistLiteralEnding; // Regex patterns to match include completion candidates against. They // receive the absolute file path. // // For example, to hide all files in a /CACHE/ folder, use ".*/CACHE/.*" std::vector includeCompletionWhitelist; std::vector includeCompletionBlacklist; // If true, diagnostics from a full document parse will be reported. bool diagnosticsOnParse = true; // If true, diagnostics from code completion will be reported. bool diagnosticsOnCodeCompletion = true; // Enables code lens on parameter and function variables. bool codeLensOnLocalVariables = true; // Version of the client. If undefined the version check is skipped. Used to // inform users their vscode client is too old and needs to be updated. optional clientVersion; // If true parameter declarations are included in code completion when calling // a function or method bool enableSnippetInsertion = true; bool enableComments = false; //// For debugging // Dump AST after parsing if some pattern matches the source filename. std::vector dumpAST; }; MAKE_REFLECT_STRUCT(Config, compilationDatabaseDirectory, cacheDirectory, cacheFormat, resourceDirectory, extraClangArguments, indexWhitelist, indexBlacklist, logSkippedPathsForIndex, maxWorkspaceSearchResults, sortWorkspaceSearchResults, indexerCount, enableIndexing, enableCacheWrite, enableCacheRead, progressReportFrequencyMs, includeCompletionMaximumPathLength, includeCompletionWhitelistLiteralEnding, includeCompletionWhitelist, includeCompletionBlacklist, showDocumentLinksOnIncludes, diagnosticsOnParse, diagnosticsOnCodeCompletion, codeLensOnLocalVariables, clientVersion, enableSnippetInsertion, enableComments, dumpAST ); // Expected client version. We show an error if this doesn't match. constexpr const int kExpectedClientVersion = 3;