Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
C Python CMake Shell C++ QMake Makefile
Branch: master

README.md

Build EAR

Bear is a tool that generates a compilation database for clang tooling.

The JSON compilation database is used in the clang project to provide information on how a single compilation unit is processed. With this, it is easy to re-run the compilation with alternate programs.

One way to get a compilation database is to use cmake as the build tool. Passing -DCMAKE_EXPORT_COMPILE_COMMANDS=ON to cmake generates the compile_commands.json file into the current directory.

For non-cmake projects, use Bear. Bear generates the json file during the build process.

The concept behind Bear is to execute the original build command and intercept the exec calls issued by the build tool. To achieve that, Bear uses the LD_PRELOAD or DYLD_INSERT_LIBRARIES mechanisms provided by the dynamic linker.

Bear has two components: the library and the binary. The library redefines the exec methods to be used by all child processes. The executable enables the use of the library for child processes and writes the output file.

How to build

Bear should be quite portable on UNIX operating systems. It has been tested on FreeBSD, GNU/Linux and OS X.

Prerequisites

  1. an ANSI C compiler, to compile the sources.
  2. cmake, to configure the build process.
  3. make, to run the build. The makefiles are generated by cmake.
  4. python is a runtime dependency. The bear command is written in Python. (version >= 2.7)

Build commands

Ideally, you should build Bear in a separate build directory.

cmake $BEAR_SOURCE_DIR
make all
make install # to install
make check   # to run tests
make package # to make packages

You can configure the build process with passing arguments to cmake.

How to use

After installation the usage is like this:

bear make

The output file called compile_commands.json found in current directory.

For more options you can check the man page or pass --help parameter.

Known issues

Because Bear uses LD_PRELOAD or DYLD_INSERT_LIBRARIES environment variables, it does not append to it, but overrides it. So builds which are using these variables might not work. (I don't know any build tool which does that, but please let me know if you do.)

Problem reports

If you find a bug in this documentation or elsewhere in the program or would like to propose an improvement, please use the project's github issue tracker. Please describing the bug and where you found it. If you have a suggestion how to fix it, include that as well. Patches are also welcome.

Something went wrong with that request. Please try again.