ccls/README.md
2018-01-18 15:39:04 -08:00

2.1 KiB

cquery

Join the chat at https://gitter.im/cquery-project/Lobby

cquery is a highly-scalable, low-latency language server for C/C++/Objective-C. It is tested and designed for large code bases like Chromium. cquery provides accurate and fast semantic analysis without interrupting workflow.

Demo

cquery implements almost the entire language server protocol and provides some extra features to boot:

  • code completion (with both signature help and snippets)
  • finding definition/references
  • type hierarchy (parent type, derived types, expandable tree view)
  • finding base/derived methods/classes, call tree
  • symbol rename
  • document and global symbol search
  • hover tooltips showing symbol type
  • diagnostics
  • code actions (clang FixIts)
  • darken/fade code disabled by preprocessor
  • #include auto-complete, undefined type include insertion, include quick-jump (goto definition, document links)
  • auto-implement functions without a definition
  • semantic highlighting, including support for rainbow semantic highlighting

Setup - build cquery, install extension, setup project

There are three steps to get cquery up and running. Eventually, cquery will be published in the vscode extension marketplace which will reduce these three steps to only project setup.

Getting started

And wiki/Build.

Limitations

cquery is able to respond to queries quickly because it caches a huge amount of information. When a request comes in, cquery just looks it up in the cache without running many computations. As a result, there's a large memory overhead. For example, a full index of Chrome will take about 10gb of memory. If you exclude v8, webkit, and third_party, it goes down to about 6.5gb.

License

MIT