compile_commands.json generation for SCons build system
SCons Compilation DB support
scons-compiledb adds a support for generating JSON formatted compilation database defined by Clang.
- Multiple construction environments support.
- compile_commands.json merge across SCons invocations
- Customisation for DB entry generation.
- Build with command line option, --compiledb
- Simpler installation with PyPI
At the moment, SCons mainline does not have compilation DB generation functionality and it is likely to have it in the near feature. However, this module can still provide some advantages such as supporting old version of SCons and other useful features.
The module was tested with Python 2.x/3.x along with SCons 2.x/3.x.
Install and update using
pip install scons-compiledb
Enable and use CompileDb builder
import scons_compiledb env = DefaultEnvironment() # Or with any other way scons_compiledb.enable(env) # # ... use env normally ... # env.CompileDb()
enable(env) adds a new builder,
CompileDb to the specified environment,
env. In order to build the
be called. It can also specify the DB file name as an optional argument.
enable(env) should be called before the
env is used to compile any
Simpler usage with command line option --compiledb
enable_with_cmdline() can be used to add a command line
--compiledb, which, when specified, generates 'compile_commands.json'
as default target.
import scons_compiledb env = DefaultEnvironment() # Or with any other way scons_compiledb.enable_with_cmdline(env) # # ... Use env normnally ... #
With the above build script,
compile_commands.json file will be generated when
SCons is invoked with
--compiledb command line option as follows:
$ scons --compiledb=
Note that the command line option requires an option string as argument and the trailing
= means empty.
The comma-separated option string can specify the bool type config options(see below) as follows:
$ scons --compiledb=reset,multi
In order to build DB while building other target,
compiledb can be used as an
alias as follows:
$ scons --compiledb= compiledb other_targets
While enabling, a
Config object can be passed. For example:
config = scons_compiledb.Config(db='foo.json') scons_compiledb.enable(env, config)
|db||filename of compilation DB.||'#/compile_commands.json'|
|entry_func||function to determine the entry dict for each source file.||entry_func_default|
|cxx_suffixes||Suffixes for C++ files.||('.cpp', '.cc')|
|cc_suffixes||Suffixes for C files.||('.c',)|
|reset||Whether to remove existing entries||False|
|multi||Whether to allow multiple entries with the same 'file'.||False|
entry_func is the main logic to convert source file node in SCons to a dict
command as keys. There are predefined
entry functions as follows:
This is default and it should work for the most of cases.
CPPDEFINES only and clang/clang++ as compiler tool name.
This will be useful to use clangd with compilers, which use command line
arguments clangd cannot understand.
entry_func can be easily customised. Please refer to the source code of the
compile_commands.json file is merged across the multiple
invocations of SCons so that one DB file can be used. This is usually good
thing. However, if it is not desirable for any reasons,
reset config can be
used to remove any existing entries before generating new ones.
compile_commands.json file keeps only one entry with the same
file as the key. However, some tools can handle multiple entries with the same
multi is set, multiple entries are stored as long as they generate the
different target(output) files.
enable(env) modifies the builders related to the compilations, such as
StaticObject, to add an additional Scanner, which make sure that the compilation
commands are captured.
enable(env) also adds a new builder
compile_commands.json from the captured commands.
scons_compiledb maintains an internal dot file
default, to merge compile commands across the multiple SCons invocations. The
compile_commands.json is touched only when the internal dot file
When the compile commands are merged, it is based on source/output file name. It means that the entry with the same pair will be overwritten.
enabled(env) can be called to check whether it is enabled before or not.
Please check SConscript files in test folder
The core functionality of scons-compiledb is based on MongoDB source code.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for scons_compiledb-0.7.4-py3-none-any.whl
Hashes for scons_compiledb-0.7.4-py2-none-any.whl