clangd Directory Reference

Directory dependency graph for clangd:

Directories
	benchmarks
	fuzzer
	index
	indexer
	quality
	refactor
	support
	test
	tool
	unittests
	xpc

Files
	AST.cpp
	AST.h
	ASTSignals.cpp
	ASTSignals.h
	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
	DecisionForest.cpp
	Diagnostics.cpp
	Diagnostics.h
	DraftStore.cpp
	DraftStore.h
	DumpAST.cpp
	DumpAST.h
	ExpectedTypes.cpp
	ExpectedTypes.h
	Feature.cpp
	Feature.h
	FeatureModule.cpp
	FeatureModule.h
	FileDistance.cpp
	FileDistance.h
	FindSymbols.cpp
	FindSymbols.h
	FindTarget.cpp
	FindTarget.h
	Format.cpp
	Format.h
	FS.cpp
	FS.h
	FuzzyMatch.cpp
	FuzzyMatch.h
	GlobalCompilationDatabase.cpp
	GlobalCompilationDatabase.h
	Headers.cpp
	Headers.h
	HeaderSourceSwitch.cpp
	HeaderSourceSwitch.h
	Hover.cpp
	Hover.h
	IncludeCleaner.cpp
	IncludeCleaner.h
	Include Cleaner is clangd functionality for providing diagnostics for misuse of transitive headers and unused includes.
	IncludeFixer.cpp
	IncludeFixer.h
	InlayHints.cpp
	InlayHints.h
	JSONTransport.cpp
	LSPBinder.h
	ModulesBuilder.cpp
	ModulesBuilder.h
	ParsedAST.cpp
	ParsedAST.h
	PathMapping.cpp
	PathMapping.h
	Preamble.cpp
	Preamble.h
	ProjectModules.h
	Protocol.cpp
	Protocol.h
	Quality.cpp
	Quality.h
	RIFF.cpp
	RIFF.h
	ScanningProjectModules.cpp
	ScanningProjectModules.h
	Selection.cpp
	Selection.h
	SemanticHighlighting.cpp
	SemanticHighlighting.h
	SemanticSelection.cpp
	SemanticSelection.h
	SourceCode.cpp
	SourceCode.h
	SymbolDocumentation.cpp
	SymbolDocumentation.h
	SystemIncludeExtractor.cpp
	TidyFastChecks.inc
	TidyFastChecks.py
	TidyProvider.cpp
	TidyProvider.h
	Transport.h
	TUScheduler.cpp
	TUScheduler.h
	URI.cpp
	URI.h
	XRefs.cpp
	XRefs.h

Detailed Description

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 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.