ccls/README.md

# ccls

ccls is a rewrite of cquery (originally written by Jacob Dufault),
a C/C++/Objective-C language server.

  * code completion (with both signature help and snippets)
  * [definition](src/messages/text_document_definition.cc)/[references](src/messages/text_document_references.cc), and other cross references
  * [call (caller/callee) hierarchy](src/messages/ccls_call_hierarchy.cc), [inheritance (base/derived) hierarchy](src/messages/ccls_inheritance_hierarchy.cc), [member hierarchy](src/messages/ccls_member_hierarchy.cc)
  * [symbol rename](src/messages/text_document_rename.cc)
  * [document symbols](src/messages/text_document_document_symbol.cc) and approximate search of [workspace symbol](src/messages/workspace_symbol.cc)
  * [hover information](src/messages/text_document_hover.cc)
  * diagnostics
  * code actions (clang FixIts)
  * preprocessor skipped regions
  * semantic highlighting, including support for [rainbow semantic highlighting](https://medium.com/@evnbr/coding-in-color-3a6db2743a1e)

It makes use of C++17 features, has less third-party dependencies and slimmed-down code base. Cross reference features are strenghened, (see [wiki/FAQ](../../wiki/FAQ). It currently uses libclang to index C++ code but will switch to Clang C++ API. Refactoring and formatting are non-goals as they can be provided by clang-format, clang-include-fixer and other Clang based tools.

The comparison with cquery as noted on 2018-07-15:

|             | cquery                         | ccls                         |
|------------ |--------------------------------|------------------------------|
| third_party | more                           | fewer                        |
| C++         | C++14                          | C++17                        |
| clang API   | libclang (C)                   | clang/llvm C++               |
| Filesystem  | AbsolutePath + custom routines | llvm/Support                 |
| index       | libclang                       | clangIndex, some enhancement |
| pipeline    | index merge+id remapping       | simpler and more robust      |

cquery has system include path detection (through running the compiler driver) while ccls uses clangDriver.

# >>> [Getting started](../../wiki/Getting-started) (CLICK HERE) <<<

* [Build](../../wiki/Build)
* [Emacs](../../wiki/Emacs)
* [FAQ](../../wiki/FAQ)
Resurrection of ccls 2018-03-31 03:16:33 +00:00			`# ccls`
Add gitter badge to README 2017-04-26 01:47:10 +00:00
Cleanup 2018-07-10 06:40:26 +00:00			`ccls is a rewrite of cquery (originally written by Jacob Dufault),`
. 2018-03-31 05:05:21 +00:00			`a C/C++/Objective-C language server.`
Readme polish 2017-06-14 07:08:25 +00:00
Update README.md 2017-05-15 07:31:44 +00:00			`* code completion (with both signature help and snippets)`
README 2018-05-05 03:40:52 +00:00			`* [definition](src/messages/text_document_definition.cc)/[references](src/messages/text_document_references.cc), and other cross references`
Use clang_File_tryGetRealPathName 2018-04-07 17:43:56 +00:00			`* [call (caller/callee) hierarchy](src/messages/ccls_call_hierarchy.cc), [inheritance (base/derived) hierarchy](src/messages/ccls_inheritance_hierarchy.cc), [member hierarchy](src/messages/ccls_member_hierarchy.cc)`
Update tests and README 2018-03-17 17:10:26 +00:00			`* [symbol rename](src/messages/text_document_rename.cc)`
Fix skipped region in clang 6.0.0; add repology badge; remove -latomic 2018-03-17 17:04:12 +00:00			`* [document symbols](src/messages/text_document_document_symbol.cc) and approximate search of [workspace symbol](src/messages/workspace_symbol.cc)`
			`* [hover information](src/messages/text_document_hover.cc)`
Update README.md 2017-05-10 06:13:56 +00:00			`* diagnostics`
Implement code actions using clang FixIts - Also make server check client version and show an error message if they do not match. 2017-05-20 19:31:07 +00:00			`* code actions (clang FixIts)`
Fix skipped region in clang 6.0.0; add repology badge; remove -latomic 2018-03-17 17:04:12 +00:00			`* preprocessor skipped regions`
Mention semantic highlighting in the feature list (#282) Also mention the "rainbow" feature and link to an article explaining it. 2018-01-10 08:01:31 +00:00			`* semantic highlighting, including support for [rainbow semantic highlighting](https://medium.com/@evnbr/coding-in-color-3a6db2743a1e)`
Add README 2017-04-18 04:53:34 +00:00
textDocument/references: include base references by default 2018-05-17 06:49:21 +00:00			`It makes use of C++17 features, has less third-party dependencies and slimmed-down code base. Cross reference features are strenghened, (see [wiki/FAQ](../../wiki/FAQ). It currently uses libclang to index C++ code but will switch to Clang C++ API. Refactoring and formatting are non-goals as they can be provided by clang-format, clang-include-fixer and other Clang based tools.`

Enable clangDriver in project.cc https://bugs.llvm.org/show_bug.cgi?id=37695 is not fixed. But since we have eliminated libclang for indexing and completion the bug no longer bothers us. 2018-07-15 07:57:48 +00:00			`The comparison with cquery as noted on 2018-07-15:`
textDocument/references: include base references by default 2018-05-17 06:49:21 +00:00
Cleanup 2018-07-10 06:40:26 +00:00			`\| \| cquery \| ccls \|`
			`\|------------ \|--------------------------------\|------------------------------\|`
			`\| third_party \| more \| fewer \|`
			`\| C++ \| C++14 \| C++17 \|`
Enable clangDriver in project.cc https://bugs.llvm.org/show_bug.cgi?id=37695 is not fixed. But since we have eliminated libclang for indexing and completion the bug no longer bothers us. 2018-07-15 07:57:48 +00:00			`\| clang API \| libclang (C) \| clang/llvm C++ \|`
Cleanup 2018-07-10 06:40:26 +00:00			`\| Filesystem \| AbsolutePath + custom routines \| llvm/Support \|`
			`\| index \| libclang \| clangIndex, some enhancement \|`
			`\| pipeline \| index merge+id remapping \| simpler and more robust \|`
textDocument/references: include base references by default 2018-05-17 06:49:21 +00:00
Enable clangDriver in project.cc https://bugs.llvm.org/show_bug.cgi?id=37695 is not fixed. But since we have eliminated libclang for indexing and completion the bug no longer bothers us. 2018-07-15 07:57:48 +00:00			`cquery has system include path detection (through running the compiler driver) while ccls uses clangDriver.`
Add README 2017-04-18 04:53:34 +00:00
README 2018-05-05 03:40:52 +00:00			`# >>> [Getting started](../../wiki/Getting-started) (CLICK HERE) <<<`
Add README 2017-04-18 04:53:34 +00:00
README 2018-05-05 03:40:52 +00:00			`* [Build](../../wiki/Build)`
			`* [Emacs](../../wiki/Emacs)`
			`* [FAQ](../../wiki/FAQ)`