Skip to main content

Tool for generating Clang JSON Compilation Database files for make-based build systems.

Project description

Attention!

This repo is forked from the official repo. Since the official repo hasn't accepted new pull requests for a long time, DiodeIoT decided to improve this tool on its own forked repo.

All credits go to nickdiego

Compilation Database Generator

CircleCI branch PyPI PyPI - Python Version GitHub

Tool for generating Clang's JSON Compilation Database file for GNU make-based build systems.

It's aimed mainly at non-cmake (cmake already generates compilation database) large codebases. Inspired by projects like YCM-Generator and Bear, but faster (mainly with large projects), since in most cases it doesn't need a clean build (as the mentioned tools do) to generate the compilation database file, to achieve this it uses the make options such as -n/--dry-run and -k/--keep-going to extract the compile commands. Also, it's more cross-compiling friendly than YCM-generator's fake-toolchanin approach.

Installation

# pip install compiledbd
  • Supports Python 2.x and 3.x (for now, tested only with 2.7 and 3.6 versions)

Usage

compiledbd provides a make python wrapper script which, besides to execute the make build command, updates the JSON compilation database file corresponding to that build, resulting in a command-line interface similar to Bear.

To generate compile_commands.json file using compiledbd's "make wrapper" script, executing Makefile target all:

$ compiledbd make

compiledbd forwards all the options/arguments passed after make subcommand to GNU Make, so one can, for example, generate compile_commands.json using core/main.mk as main makefile (-f flag), starting the build from build directory (-C flag):

$ compiledbd make -f core/main.mk -C build

By default, compiledbd make generates the compilation database and runs the actual build command requested (acting as a make wrapper), the build step can be skipped using the -n or --no-build options.

$ compiledbd -n make

compiledbd base command has been designed so that it can be used to parse compile commands from arbitrary text files (or stdin), assuming it has a build log (ideally generated using make -Bnwk command), and generates the corresponding JSON Compilation database.

For example, to generate the compilation database from build-log.txt file, use the following command.

$ compiledbd --parse build-log.txt

or its equivalent:

$ compiledbd < build-log.txt

Or even, to pipe make's output and print the compilation database to the standard output:

$ make -Bnwk | compiledbd -o-

By default compiledbd generates a JSON compilation database in the "arguments" list format. The "command" string format is also supported through the use of the --command-style flag:

$ compiledbd --command-style make

Testing / Contributing

I've implemented this tool because I needed to index some AOSP's modules for navigating and studying purposes (after having no satisfatory results with current tools available by the time such as YCM-Generator and Bear). So I've reworked YCM-Generator, which resulted in the initial version of compiledbd/parser.py and used successfully to generate compile_commands.json for some AOSP modules in ~1min running in a Docker container and then could use it with some great tools, such as:

Notice:

  • Windows: tested on Windows 10 with cmd, wsl(Ubuntu), mingw32
  • Linux: tested only on Arch Linux and Ubuntu 18 so far
  • Mac: tested on macOS 10.13 and 10.14

Patches are always welcome :)

License

GNU GPLv3

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

compiledbd-0.9.1.tar.gz (28.4 kB view details)

Uploaded Source

Built Distribution

compiledbd-0.9.1-py3-none-any.whl (27.4 kB view details)

Uploaded Python 3

File details

Details for the file compiledbd-0.9.1.tar.gz.

File metadata

  • Download URL: compiledbd-0.9.1.tar.gz
  • Upload date:
  • Size: 28.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for compiledbd-0.9.1.tar.gz
Algorithm Hash digest
SHA256 c8336505cefd8d7f565cd2ed8c994bd586a0e3ffb2e353291c087feae9a6db43
MD5 d46febdb187ec841310c38643a33d83e
BLAKE2b-256 478a6fd2d3a859bde618afc809ddffe6d41064f4cf3c89c6520a482eb9ccac31

See more details on using hashes here.

File details

Details for the file compiledbd-0.9.1-py3-none-any.whl.

File metadata

  • Download URL: compiledbd-0.9.1-py3-none-any.whl
  • Upload date:
  • Size: 27.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for compiledbd-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7a83c2810aa2dd4ab0b900935444798964e537c734af6004cdc0e178b0e816ed
MD5 8f1c8c3684bca1461e8f55a9e6fd1bf2
BLAKE2b-256 ede0b7e56528d4c3771651d102b9e5aa204ab96ee0402ea017cd66cd0279d014

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page