Google Git
Sign in
llvm / llvm-project / 987c7f407d1414a023f03eb788bb97667b479f27 / . / clang-tools-extra / clangd
tree: c48618b605a30758d3f7224dbebfb901f2a17d3c [path history] [tgz]
  1. benchmarks/
  2. fuzzer/
  3. index/
  4. indexer/
  5. quality/
  6. refactor/
  7. support/
  8. test/
  9. tool/
  10. unittests/
  11. xpc/
  12. AST.cpp
  13. AST.h
  14. ASTSignals.cpp
  15. ASTSignals.h
  16. ClangdLSPServer.cpp
  17. ClangdLSPServer.h
  18. ClangdServer.cpp
  19. ClangdServer.h
  20. CMakeLists.txt
  21. CodeComplete.cpp
  22. CodeComplete.h
  23. CodeCompletionStrings.cpp
  24. CodeCompletionStrings.h
  25. CollectMacros.cpp
  26. CollectMacros.h
  27. CompileCommands.cpp
  28. CompileCommands.h
  29. Compiler.cpp
  30. Compiler.h
  31. Config.cpp
  32. Config.h
  33. ConfigCompile.cpp
  34. ConfigFragment.h
  35. ConfigProvider.cpp
  36. ConfigProvider.h
  37. ConfigYAML.cpp
  38. Diagnostics.cpp
  39. Diagnostics.h
  40. DraftStore.cpp
  41. DraftStore.h
  42. DumpAST.cpp
  43. DumpAST.h
  44. ExpectedTypes.cpp
  45. ExpectedTypes.h
  46. Feature.cpp
  47. Feature.h
  48. FeatureModule.cpp
  49. FeatureModule.h
  50. Features.inc.in
  51. FileDistance.cpp
  52. FileDistance.h
  53. FindSymbols.cpp
  54. FindSymbols.h
  55. FindTarget.cpp
  56. FindTarget.h
  57. Format.cpp
  58. Format.h
  59. FS.cpp
  60. FS.h
  61. FuzzyMatch.cpp
  62. FuzzyMatch.h
  63. GlobalCompilationDatabase.cpp
  64. GlobalCompilationDatabase.h
  65. Headers.cpp
  66. Headers.h
  67. HeaderSourceSwitch.cpp
  68. HeaderSourceSwitch.h
  69. HeuristicResolver.cpp
  70. HeuristicResolver.h
  71. Hover.cpp
  72. Hover.h
  73. IncludeCleaner.cpp
  74. IncludeCleaner.h
  75. IncludeFixer.cpp
  76. IncludeFixer.h
  77. InlayHints.cpp
  78. InlayHints.h
  79. JSONTransport.cpp
  80. LSPBinder.h
  81. ParsedAST.cpp
  82. ParsedAST.h
  83. PathMapping.cpp
  84. PathMapping.h
  85. Preamble.cpp
  86. Preamble.h
  87. Protocol.cpp
  88. Protocol.h
  89. Quality.cpp
  90. Quality.h
  91. QueryDriverDatabase.cpp
  92. README.md
  93. RIFF.cpp
  94. RIFF.h
  95. Selection.cpp
  96. Selection.h
  97. SemanticHighlighting.cpp
  98. SemanticHighlighting.h
  99. SemanticSelection.cpp
  100. SemanticSelection.h
  101. SourceCode.cpp
  102. SourceCode.h
  103. TidyProvider.cpp
  104. TidyProvider.h
  105. Transport.h
  106. TUScheduler.cpp
  107. TUScheduler.h
  108. URI.cpp
  109. URI.h
  110. XRefs.cpp
  111. XRefs.h
clang-tools-extra/clangd/README.md

clangd

clangd is a language server, and provides C++ IDE features to editors. This is not its documentation.

Communication channels

If you have any questions or feedback, you can reach community and developers through one of these channels:

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 Release mode 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 Ninja as a generator rather than default make is preferred. To do that consider passing -G Ninja to cmake invocation.
    • Finally, you can turn on assertions via -DLLVM_ENABLE_ASSERTS=On.

  • Afterwards you can build clangd with cmake --build $LLVM_ROOT/build --target clangd, similarly run tests by changing target to check-clangd.