Metadata-Version: 2.1
Name: compiledb-plus
Version: 1.0.0
Summary: Tool for generating Clang JSON Compilation Database files for make-based build systems. A fork of https://github.com/nickdiego/compiledb
Home-page: https://github.com/maxnilz/compiledb-plus
Author: maxnilz
Author-email: maxnilz@gmail.com
License: GPLv3
Project-URL: Issue Tracking, https://github.com/maxnilz/compiledb/issues
Keywords: compilation-database clang c cpp makefile rtags completion
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Operating System :: OS Independent
Requires-Python: >=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: test
License-File: LICENSE

# Compilation Database Generator

[![CircleCI branch](https://img.shields.io/circleci/project/github/nickdiego/compiledb/master.svg)](https://circleci.com/gh/nickdiego/compiledb)
[![PyPI](https://img.shields.io/pypi/v/compiledb.svg)](https://pypi.org/project/compiledb/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/compiledb.svg)](https://pypi.org/project/compiledb)
[![GitHub](https://img.shields.io/github/license/nickdiego/compiledb.svg)](https://github.com/nickdiego/compiledb/blob/master/LICENSE)

Tool for generating [Clang's JSON Compilation Database][compdb] 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][ycm-gen] and [Bear][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.

## Note

This project is a fork of [compiledb](https://github.com/nickdiego/compiledb) maintained
by [Nick Yamane](https://github.com/nickdiego). Since the PRs to the origin were pending and inactive for quite a long
time, here is an attempt to patch the origin project with this new package name called `compiledb-plus`.

We express our gratitude to the original author(s) for their valuable contribution which made this fork possible. Any
issues, questions, or contributions pertaining to the additions in this fork should be directed to this repository, not
to the original author(s).

## Changes from Original

- Support non-recursive make

## Installation

```
# pip install compiledb-plus
```

- Supports Python 2.x and 3.x (for now, tested only with 2.7 and 3.6 versions)

## Usage

`compiledb-plus` 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][bear].

To generate `compile_commands.json` file using compiledb-plus's "make wrapper" script,
executing Makefile target `all`:

```bash
$ compiledb-plus make
```

`compiledb-plus` 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):

```bash
$ compiledb-plus make -f core/main.mk -C build
```

By default, `compiledb-plus 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.

```bash
$ compiledb-plus -n make
```

`compiledb-plus` 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.

```bash
$ compiledb-plus --parse build-log.txt
```

or its equivalent:

```bash
$ compiledb-plus < build-log.txt
```

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

```bash
$ make -Bnwk | compiledb-plus -o-
```

By default `compiledb-plus` generates a JSON compilation database in the "arguments" list
[format](https://clang.llvm.org/docs/JSONCompilationDatabase.html). The "command" string
format is also supported through the use of the `--command-style` flag:

```bash
$ compiledb-plus --command-style make
```

## Testing / Contributing

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

- [Vim][vim] + [YouCompleteMe][ycm] + [rtags][rtags] + [chromatica.nvim][chrom]
- [Neovim][neovim] + [LanguageClient-neovim][lsp] + [cquery][cquery] + [deoplete][deoplete]
- [Neovim][neovim] + [ALE][ale] + [ccls][ccls]

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

[compdb]: https://clang.llvm.org/docs/JSONCompilationDatabase.html

[ycm]: https://github.com/Valloric/YouCompleteMe

[rtags]: https://github.com/Andersbakken/rtags

[chrom]: https://github.com/arakashic/chromatica.nvim

[ycm-gen]: https://github.com/rdnetto/YCM-Generator

[bear]: https://github.com/rizsotto/Bear

[aosp]: https://source.android.com/

[docker]: https://www.docker.com/

[vim]: https://www.vim.org/

[neovim]: https://neovim.io/

[lsp]: https://github.com/autozimu/LanguageClient-neovim

[cquery]: https://github.com/cquery-project/cquery

[deoplete]: https://github.com/Shougo/deoplete.nvim

[ccls]: https://github.com/MaskRay/ccls

[ale]: https://github.com/w0rp/ale
