cquery

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

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

code completion (with both signature help and snippets)
references
type hierarchy (parent type, derived types, expandable tree view)
calls to functions, calls to base and derived functions, call tree
symbol rename
goto definition, goto base method
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

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.

Build cquery

Building cquery is simple. The external dependencies are few:

relatively modern c++11 compiler (ie, clang 3.4 or greater)
python
git

$ clang --version  # if missing, sudo apt-get install clang
$ git clone https://github.com/jacobdufault/cquery --recursive
$ cd cquery
$ ./waf configure
$ ./waf build

Install extension

cquery includes a vscode extension; it is part of the repository. Launch vscode and install the vscode-extension.tsix extension. To do this:

Hit F1; execute the command Install from VSIX.
Select vscode-extension.vsix in the file chooser.

IMPORTANT: Please reinstall the extension when you sync the code base - it is still being developed.

If you run into issues, you can view debug output by running the (F1) View: Toggle Output command and opening the cquery output section.

Project setup

compile_commands.json (Best)

To get the most accurate index possible, you can give cquery a compilation database emitted from your build system of choice. For example, here's how to generate one in ninja. When you sync your code you should regenerate this file.

$ ninja -C out/Release -t compdb cxx cc > compile_commands.json

The compile_commands.json file should be in the top-level workspace directory.

cquery.index.extraClangArguments

If for whatever reason you cannot generate a compile_commands.json file, you can add the flags to the cquery.index.extraClangArguments configuration option.

clang_args

If for whatever reason you cannot generate a compile_commands.json file, you can add the flags to a file called clang_args located in the top-level workspace directory.

Each argument in that file is separated by a newline. Lines starting with # are skipped. Here's an example:

# Language
-xc++
-std=c++11

# Includes
-I/work/cquery/third_party

Building extension

If you wish to modify the vscode extension, you will need to build it locally. Luckily, it is pretty easy - the only dependency is npm.

# Build extension
$ cd vscode-client
$ npm install
$ code .

When VSCode is running, you can hit F5 to build and launch the extension locally.

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.

Chromium tips

Chromium is a very large codebase, so cquery benefits from a bit of tuning. Optionally add these to your settings:

  // Set slightly lower than your CPU core count to keep other tools responsive.
  "cquery.misc.indexerCount": 50,
  // Remove uncommonly used directories with large numbers of files.
  "cquery.index.blacklist": [
   ".*/src/base/third_party/.*",
   ".*/src/native_client/.*",
   ".*/src/native_client_sdk/.*",
   ".*/src/third_party/.*",
   ".*/src/v8/.*",
   ".*/src/webkit/.*"
  ]

License

MIT

4.5 KiB Raw Blame History