Debian Codegraph @

llvm-project/clang-tools-extra/clangd/Config.h

raw
1 //===--- Config.h - User configuration of clangd behavior --------*- C++-*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // Various clangd features have configurable behaviour (or can be disabled).
10 // This file defines "resolved" configuration seen by features within clangd.
11 // For example, settings may vary per-file, the resolved Config only contains
12 // settings that apply to the current file.
13 //
14 // This is distinct from how the config is specified by the user (Fragment)
15 // interpreted (CompiledFragment), and combined (Provider).
16 // ConfigFragment.h describes the steps to add a new configuration option.
17 //
18 // Because this structure is shared throughout clangd, it's a potential source
19 // of layering problems. Config should be expressed in terms of simple
20 // vocabulary types where possible.
21 //
22 //===----------------------------------------------------------------------===//
23
24 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANGD_CONFIG_H
25 #define LLVM_CLANG_TOOLS_EXTRA_CLANGD_CONFIG_H
26
27 #include "support/Context.h"
28 #include "llvm/ADT/FunctionExtras.h"
29 #include "llvm/ADT/StringMap.h"
30 #include "llvm/ADT/StringSet.h"
31 #include <functional>
32 #include <optional>
33 #include <string>
34 #include <vector>
35
36 namespace clang {
37 namespace clangd {
38
39 /// Settings that express user/project preferences and control clangd behavior.
40 ///
41 /// Generally, features should consume Config::current() and the caller is
42 /// responsible for setting it appropriately. In practice these callers are
43 /// ClangdServer, TUScheduler, and BackgroundQueue.
44 struct Config {
45 /// Returns the Config of the current Context, or an empty configuration.
46 static const Config &current();
47 /// Context key which can be used to set the current Config.
48 static clangd::Key<Config> Key;
49
50 Config() = default;
51 Config(const Config &) = delete;
52 Config &operator=(const Config &) = delete;
53 Config(Config &&) = default;
54 Config &operator=(Config &&) = default;
55
56 struct CDBSearchSpec {
57 enum { Ancestors, FixedDir, NoCDBSearch } Policy = Ancestors;
58 // Absolute, native slashes, no trailing slash.
59 std::optional<std::string> FixedCDBPath;
60 };
61
62 /// Controls how the compile command for the current file is determined.
63 struct {
64 /// Edits to apply to the compile command, in sequence.
65 std::vector<llvm::unique_function<void(std::vector<std::string> &) const>>
66 Edits;
67 /// Where to search for compilation databases for this file's flags.
68 CDBSearchSpec CDBSearch = {CDBSearchSpec::Ancestors, std::nullopt};
69 } CompileFlags;
70
71 enum class BackgroundPolicy { Build, Skip };
72 /// Describes an external index configuration.
73 struct ExternalIndexSpec {
74 enum { None, File, Server } Kind = None;
75 /// This is one of:
76 /// - Address of a clangd-index-server, in the form of "ip:port".
77 /// - Absolute path to an index produced by clangd-indexer.
78 std::string Location;
79 /// Absolute path to source root this index is associated with, uses
80 /// forward-slashes.
81 std::string MountPoint;
82 };
83 /// Controls index behavior.
84 struct {
85 /// Whether this TU should be background-indexed.
86 BackgroundPolicy Background = BackgroundPolicy::Build;
87 ExternalIndexSpec External;
88 bool StandardLibrary = true;
89 } Index;
90
91 enum UnusedIncludesPolicy {
92 /// Diagnose unused includes.
93 Strict,
94 None,
95 /// The same as Strict, but using the include-cleaner library.
96 Experiment,
97 };
98 /// Controls warnings and errors when parsing code.
99 struct {
100 bool SuppressAll = false;
101 llvm::StringSet<> Suppress;
102
103 /// Configures what clang-tidy checks to run and options to use with them.
104 struct {
105 // A comma-seperated list of globs specify which clang-tidy checks to run.
106 std::string Checks;
107 llvm::StringMap<std::string> CheckOptions;
108 } ClangTidy;
109
110 UnusedIncludesPolicy UnusedIncludes = None;
111
112 /// IncludeCleaner will not diagnose usages of these headers matched by
113 /// these regexes.
114 struct {
115 std::vector<std::function<bool(llvm::StringRef)>> IgnoreHeader;
116 } Includes;
117 } Diagnostics;
118
119 /// Style of the codebase.
120 struct {
121 // Namespaces that should always be fully qualified, meaning no "using"
122 // declarations, always spell out the whole name (with or without leading
123 // ::). All nested namespaces are affected as well.
124 std::vector<std::string> FullyQualifiedNamespaces;
125 } Style;
126
127 /// Configures code completion feature.
128 struct {
129 /// Whether code completion includes results that are not visible in current
130 /// scopes.
131 bool AllScopes = true;
132 } Completion;
133
134 /// Configures hover feature.
135 struct {
136 /// Whether hover show a.k.a type.
137 bool ShowAKA = true;
138 } Hover;
139
140 struct {
141 /// If false, inlay hints are completely disabled.
142 bool Enabled = true;
143
144 // Whether specific categories of hints are enabled.
145 bool Parameters = true;
146 bool DeducedTypes = true;
147 bool Designators = true;
148 } InlayHints;
149 };
150
151 } // namespace clangd
152 } // namespace clang
153
154 namespace llvm {
155 template <> struct DenseMapInfo<clang::clangd::Config::ExternalIndexSpec> {
156 using ExternalIndexSpec = clang::clangd::Config::ExternalIndexSpec;
157 static inline ExternalIndexSpec getEmptyKey() {
158 return {ExternalIndexSpec::File, "", ""};
159 }
160 static inline ExternalIndexSpec getTombstoneKey() {
161 return {ExternalIndexSpec::File, "TOMB", "STONE"};
162 }
163 static unsigned getHashValue(const ExternalIndexSpec &Val) {
164 return llvm::hash_combine(Val.Kind, Val.Location, Val.MountPoint);
165 }
166 static bool isEqual(const ExternalIndexSpec &LHS,
167 const ExternalIndexSpec &RHS) {
168 return std::tie(LHS.Kind, LHS.Location, LHS.MountPoint) ==
169 std::tie(RHS.Kind, RHS.Location, RHS.MountPoint);
170 }
171 };
172 } // namespace llvm
173
174 #endif