forked from OSchip/llvm-project
33c3ef2fbe
Underscore-uglified identifiers are used in standard library implementations to guard against collisions with macros, and they hurt readability considerably. (Consider `push_back(Tp_ &&__value)` vs `push_back(Tp value)`. When we're describing an interface, the exact names of parameters are not critical so we can drop these prefixes. This patch adds a new PrintingPolicy flag that can applies this stripping when recursively printing pieces of AST. We set it in code completion/signature help, and in clangd's hover display. All three features also do a bit of manual poking at names, so fix up those too. Fixes https://github.com/clangd/clangd/issues/736 Differential Revision: https://reviews.llvm.org/D116387 |
||
|---|---|---|
| .. | ||
| benchmarks | ||
| fuzzer | ||
| include-mapping | ||
| index | ||
| indexer | ||
| quality | ||
| refactor | ||
| support | ||
| test | ||
| tool | ||
| unittests | ||
| xpc | ||
| AST.cpp | ||
| AST.h | ||
| ASTSignals.cpp | ||
| ASTSignals.h | ||
| CMakeLists.txt | ||
| CSymbolMap.inc | ||
| ClangdLSPServer.cpp | ||
| ClangdLSPServer.h | ||
| ClangdServer.cpp | ||
| ClangdServer.h | ||
| CodeComplete.cpp | ||
| CodeComplete.h | ||
| CodeCompletionStrings.cpp | ||
| CodeCompletionStrings.h | ||
| CollectMacros.cpp | ||
| CollectMacros.h | ||
| CompileCommands.cpp | ||
| CompileCommands.h | ||
| Compiler.cpp | ||
| Compiler.h | ||
| Config.cpp | ||
| Config.h | ||
| ConfigCompile.cpp | ||
| ConfigFragment.h | ||
| ConfigProvider.cpp | ||
| ConfigProvider.h | ||
| ConfigYAML.cpp | ||
| Diagnostics.cpp | ||
| Diagnostics.h | ||
| DraftStore.cpp | ||
| DraftStore.h | ||
| DumpAST.cpp | ||
| DumpAST.h | ||
| ExpectedTypes.cpp | ||
| ExpectedTypes.h | ||
| FS.cpp | ||
| FS.h | ||
| Feature.cpp | ||
| Feature.h | ||
| FeatureModule.cpp | ||
| FeatureModule.h | ||
| Features.inc.in | ||
| FileDistance.cpp | ||
| FileDistance.h | ||
| FindSymbols.cpp | ||
| FindSymbols.h | ||
| FindTarget.cpp | ||
| FindTarget.h | ||
| Format.cpp | ||
| Format.h | ||
| FuzzyMatch.cpp | ||
| FuzzyMatch.h | ||
| GlobalCompilationDatabase.cpp | ||
| GlobalCompilationDatabase.h | ||
| HeaderSourceSwitch.cpp | ||
| HeaderSourceSwitch.h | ||
| Headers.cpp | ||
| Headers.h | ||
| HeuristicResolver.cpp | ||
| HeuristicResolver.h | ||
| Hover.cpp | ||
| Hover.h | ||
| IncludeCleaner.cpp | ||
| IncludeCleaner.h | ||
| IncludeFixer.cpp | ||
| IncludeFixer.h | ||
| InlayHints.cpp | ||
| InlayHints.h | ||
| JSONTransport.cpp | ||
| LSPBinder.h | ||
| ParsedAST.cpp | ||
| ParsedAST.h | ||
| PathMapping.cpp | ||
| PathMapping.h | ||
| Preamble.cpp | ||
| Preamble.h | ||
| Protocol.cpp | ||
| Protocol.h | ||
| Quality.cpp | ||
| Quality.h | ||
| QueryDriverDatabase.cpp | ||
| README.md | ||
| RIFF.cpp | ||
| RIFF.h | ||
| Selection.cpp | ||
| Selection.h | ||
| SemanticHighlighting.cpp | ||
| SemanticHighlighting.h | ||
| SemanticSelection.cpp | ||
| SemanticSelection.h | ||
| SourceCode.cpp | ||
| SourceCode.h | ||
| StdSymbolMap.inc | ||
| TUScheduler.cpp | ||
| TUScheduler.h | ||
| TidyProvider.cpp | ||
| TidyProvider.h | ||
| Transport.h | ||
| URI.cpp | ||
| URI.h | ||
| XRefs.cpp | ||
| XRefs.h | ||
README.md
clangd
clangd is a language server, and provides C++ IDE features to editors. This is not its documentation.
- the website is https://clangd.llvm.org/.
- the bug tracker is https://github.com/clangd/clangd/issues
- the source code is hosted at https://github.com/llvm/llvm-project/tree/main/clang-tools-extra/clangd.
- the website source code is at https://github.com/llvm/clangd-www/
Communication channels
If you have any questions or feedback, you can reach community and developers through one of these channels:
- chat: #clangd room hosted on LLVM's Discord channel.
- user questions and feature requests can be asked in the clangd topic on LLVM Discussion Forums
Building and testing clangd
For a minimal setup on building clangd:
-
Clone the LLVM repo to
$LLVM_ROOT. -
Create a build directory, for example at
$LLVM_ROOT/build. -
Inside the build directory run:
cmake $LLVM_ROOT/llvm/ -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_PROJECTS="clang;clang-tools-extra".- We suggest building in
Releasemode as building DEBUG binaries requires considerably more resources. You can check Building LLVM with CMake documentation for more details about cmake flags. - In addition to that using
Ninjaas a generator rather than defaultmakeis preferred. To do that consider passing-G Ninjato cmake invocation. - Finally, you can turn on assertions via
-DLLVM_ENABLE_ASSERTS=On.
- We suggest building in
-
Afterwards you can build clangd with
cmake --build $LLVM_ROOT/build --target clangd, similarly run tests by changing target tocheck-clangd.