Awesome

Clank :hammer_and_wrench:

Warning Clank is still in the alpha stages, and can't reliably parse any subset of C or C++ yet. Work is ongoing to change this as soon as possible, but for now your milage may very.

Clank is a fully stand-alone C++ front-end based on LLVM's clang compiler.

It has been heavily modified and de-coupled from LLVM to be a stand alone library with only the C++ standard libraries as dependencies.

Note Clank is ONLY a language front-end, it does not generate an IL or machine code

Compiler front end comparison

The following table

Front End	Open Source	Notes
libclang	:heavy_check_mark:	Tied to LLVM
EDG Front End	:x:	Proprietary and Non-free
clank	:heavy_check_mark:	Only builds w/ C++17 or newer

FAQ

The following are some questions that you may possible have regarding this project.

Why not just use libclang?

Mainly for personal reasons, I was never a fan of the API, nor how it dragged a large chunk of LLVM around.

Why not support building with C++14 and/or C++11

Mainly because a lot of nice things were added in C++17 an it makes de-coupling the code from LLVM easier.

Planned Support

The clang front-end can parse many languages, but clank is mainly focused on C and C++, however work is eventually planned to support most if not all of the languages that clang does as well. The table below shows the status of each language.

There is also the possibility of adding support for D lang and also possibly Fortran but those would be left until after the MVP of supporting C and C++ has been met.

<table> <thead> <tr> <th>Language</th> <th>Standard</th> <th>Status</th> <th>Extensions</th> </tr> </thead> <tbody> <tr> <td rowspan="6">C++</td> <td>99</td> <td>🚧 In Progress 🚧</td> <td>GNU</td> </tr> <tr> <td>11</td> <td>🚧 In Progress 🚧</td> <td>GNU</td> </tr> <tr> <td>14</td> <td>🚧 In Progress 🚧</td> <td>GNU</td> </tr> <tr> <td>17</td> <td>🚧 In Progress 🚧</td> <td>GNU</td> </tr> <tr> <td>20</td> <td>🚧 In Progress 🚧</td> <td>GNU</td> </tr> <tr> <td>2b</td> <td>🚧 In Progress 🚧</td> <td>GNU</td> </tr> <tr> <td rowspan="5">C</td> <td>99</td> <td>⏳ Planned ⏳</td> <td>GNU</td> </tr> <tr> <td>11</td> <td>⏳ Planned ⏳</td> <td>GNU</td> </tr> <tr> <td>14</td> <td>⏳ Planned ⏳</td> <td>GNU</td> </tr> <tr> <td>17</td> <td>⏳ Planned ⏳</td> <td>GNU</td> </tr> <tr> <td>2x</td> <td>⏳ Planned ⏳</td> <td>GNU</td> </tr> <tr> <td rowspan="1">ObjC</td> <td>❔</td> <td>⏳ Planned ⏳</td> <td>None</td> </tr> <tr> <td rowspan="1">ObjC++</td> <td>❔</td> <td>⏳ Planned ⏳</td> <td>None</td> </tr> <tr> <td rowspan="1">OpenCL</td> <td>❔</td> <td>⏳ Planned ⏳</td> <td>None</td> </tr> </tbody> </table>

Examples

A collection of examples will be put in the examples directory to show how to use Clank to consume C++ code once it is at a point where that is possible.

Documentation

For more comprehensive documentation, such as usage guides, as well as API documentation, see https://lethalbit.github.io/clank/.

Configuring and Building

The following steps describe how to build Clank, it should be consistent for Linux, macOS, and Windows, but macOS and Windows remain untested.

NOTE: The minimum C++ standard to build Clank is C++17.

Prerequisites

To build Clank, ensure you have the following build time dependencies:

git
meson
ninja
g++ >= 11 or clang++ >= 11

Optionally, when also building with binding support (which is the default) you also need:

python >= 3.9
pybind11 >= 2.7.0

Configuring

You can build Clank with the default options, all of which can be found in meson_options.txt. You can change these by specifying -D<OPTION_NAME>=<VALUE> at initial meson invocation time, or with meson configure in the build directory post initial configure.

To change the install prefix, which is /usr/local by default ensure to pass --prefix <PREFIX> when running meson for the first time.

In either case, simply running meson build from the root of the repository will be sufficient and place all of the build files in the build subdirectory.

Building

Once you have configured Clank appropriately, to simply build and install simply run the following:

$ ninja -C build
$ ninja -C build test # Optional: Run Tests
$ ninja -C build install

This will build and install Clank into the default prefix which is /usr/local, to change that see the configuration steps above.

Notes to Package Maintainers

If you are building Clank for inclusion in a distributions package system then ensure to set DESTDIR prior to running meson install.

There is also a bugreport_url configuration option that is set to this repositories issues tracker by default, it is recommended to change it to your distributions bug tracking page.

License

Clank is under the Apache 2.0 license with LLVM exceptions, just like the original clang. The full text of the license can be found in the LICENSE file.