https://github.com/personalrobotics/chimera
:snake: A CLI tool for generating Boost.Python/pybind11 bindings from C/C++
https://github.com/personalrobotics/chimera
boost-python chimera clang-toolchain cli cpp llvm mustache pybind11 python
Last synced: about 1 month ago
JSON representation
:snake: A CLI tool for generating Boost.Python/pybind11 bindings from C/C++
- Host: GitHub
- URL: https://github.com/personalrobotics/chimera
- Owner: personalrobotics
- License: bsd-3-clause
- Created: 2015-09-09T05:07:06.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2020-08-22T14:19:49.000Z (about 5 years ago)
- Last Synced: 2025-04-02T00:35:33.446Z (6 months ago)
- Topics: boost-python, chimera, clang-toolchain, cli, cpp, llvm, mustache, pybind11, python
- Language: C++
- Homepage:
- Size: 972 KB
- Stars: 14
- Watchers: 45
- Forks: 1
- Open Issues: 55
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# chimera
[](https://github.com/personalrobotics/chimera/actions)
[](https://travis-ci.org/personalrobotics/chimera)
[](https://dev.azure.com/personalrobotics/chimera/_build/latest?definitionId=2&branchName=master)
[](https://codecov.io/gh/personalrobotics/chimera)
> ##### chi·me·ra
>
> ##### /kīˈmirə,kəˈmirə/ [![speaker][2]][1]
>
> _*informal*, noun_
>
> 1. a thing that is hoped or wished for but in fact is illusory or impossible to achieve.
> 2. a utility to generate Boost.Python bindings for C++ code.
Chimera is a tool for generating Boost.Python/Pybind11 bindings from C/C++ header files.
It uses the Clang/LLVM toolchain, making it capable of automatically handling
fairly complex source files.
## Usage
```bash
$ ./chimera -c -o my_cpp_header1.h my_cpp_header2.h -- [compiler args]
```
## Installation
### On Ubuntu using `apt`
Chimera provides Ubuntu packages for Xenial (16.04 LTS), Bionic (18.04 LTS), Eoan (19.10), and Focal (20.04).
**Xenial and greater**
```shell
$ sudo add-apt-repository ppa:personalrobotics/ppa
$ sudo apt update
$ sudo apt install chimera
```
### On macOS using Homebrew
```shell
# Install the Homebrew package manager
$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
# Add Homebrew tap for Personal Robotics Lab software
$ brew tap personalrobotics/tap
# Install Chimera
$ brew install chimera
```
## Build from Source
### Requirements
* libclang 6.0, 7, 8, 9
* llvm 6.0, 7, 8, 9 (+ tools)
* libedit
* yaml-cpp
* boost
### On Ubuntu from Source
#### Install Dependencies
```bash
$ sudo apt-get install llvm-6.0-dev llvm-6.0-tools libclang-6.0-dev libedit-dev \
$ libyaml-cpp-dev libboost-dev lib32z1-dev
```
#### Build Chimera
```bash
$ git clone https://github.com/personalrobotics/chimera.git
$ cd chimera
$ mkdir build && cd build
$ cmake -DCMAKE_BUILD_TYPE=Release ..
$ make
$ sudo make install
```
### On macOS from Source
```bash
$ brew install boost llvm yaml-cpp
$ brew install eigen # for examples
$ git clone https://github.com/personalrobotics/chimera.git
$ cd chimera
$ mkdir build && cd build
$ PKG_CONFIG_PATH=$(brew --prefix yaml-cpp)/lib/pkgconfig cmake -DCMAKE_BUILD_TYPE=Release \
-DLLVM_DIR=$(brew --prefix llvm)/lib/cmake/llvm ..
$ make
$ sudo make install
```
## Example
Let's try running chimera on itself!
```bash
$ cd [PATH TO CHIMERA]
$ rm -rf build && mkdir -p build && cd build
$ cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_EXPORT_COMPILE_COMMANDS=ON ..
$ make
$ chimera -p . -o chimera_py_binding.cpp ../src/chimera.cpp
```
## Configuration
```yaml
# The C++ namespaces that will be extracted by Chimera
namespaces:
- dart::dynamics
- dart::math
# Selected types that should have special handling.
# (Not implemented yet.)
types:
'class BodyNode':
convert_to: 'class BodyNodePtr'
# Selected function and class declarations that need custom parameters.
functions:
'const Eigen::Vector4d & ::dart::dynamics::Shape::getRGBA() const':
return_value_policy: copy_const_reference
'bool ::dart::dynamics::Skeleton::isImpulseApplied() const':
source: 'test.cpp.in'
'const Eigen::Vector3d & ::dart::dynamics::Shape::getBoundingBoxDim() const':
content: '/* Instead of implementing this function, insert this comment! */'
'Eigen::VectorXd & ::dart::optimizer::GradientDescentSolver::getEqConstraintWeights()': null
# This declaration will be suppressed.
classes:
'::dart::dynamics::Shape':
name: Shape
bases: []
noncopyable: true
```
## Troubleshooting
### Is there a length limit for the keys in the configuration file of Chimera?
Yes. [`yaml-cpp` does not support more than 1024 characters for a single line
key](https://github.com/jbeder/yaml-cpp/blob/release-0.5.3/src/simplekey.cpp#L111).
If you want to use a longer key, then you should use [multi-line
key](http://stackoverflow.com/a/36295084).
## License
Chimera is released under the 3-clause BSD license. See [LICENSE](./LICENSE) for more
information.
## Authors
Chimera is developed by Michael Koval ([**@mkoval**](https://github.com/mkoval)) and
Pras Velagapudi ([**@psigen**](https://github.com/psigen)), and it has received major
contributions from Jeongseok Lee ([**@jslee02**](https://github.com/jslee02)).
[1]: http://audio.oxforddictionaries.com/en/mp3/chimera_gb_1.mp3
[2]: https://upload.wikimedia.org/wikipedia/commons/7/74/Speaker_icon.svg