Skip to content
/ devana Public

Python package to parse and generate C/C++ code as context aware preprocessor.

License

Notifications You must be signed in to change notification settings

JhnW/devana

Repository files navigation

Devana

License: LGPL v2.1 PyPI - Python Version PyPI - Status PyPI - Format PyPI - Implementation
Tests Release
PyPI GitHub issues Website PyPI - Downloads

Devana is a python tool that make it easy to parsing, format, transform and generate C++ (or C) code. This tool uses libclang to parse the code. Fundamental problems, bugs and missing features of libclang are fixed in Devann's internal code.
Please note that Devana focuses on the header-level code e.g. class and functions definitions, templates resolving, typedefs and includes. Control statements, arithmetics operations etc. (pure body of functions) are supported as access to raw string field "body". It is planned to introduce more control over this type of code in future versions.
Important: Devana is still under development. At the moment, parsing and basic code generation is available (almost full coverage of development plans). Please check roadmap.

Installation

Devana is published on PyPI and can be installed from there:

pip install -U devana

If you wish to install Devana for development purposes, refer to the contributors guide.

How to start

You can find the complete guide in this section of the documentation.
Demo applications are located in project repository inside demo folder.

Documentation

Documentation is available from GitHub Pages.

Contributing

Please check contributing guide for take more details about contributing this project.
For now, the most wanted help is bugreports, bugfix, writing test and parser features completion. You can write e-mail to me directly with question about help.

Testing

Continuous testing is GitHub Actions. For information on running tests locally, refer to the contributors guide.

Roadmap

A detailed list of missing functionalities and planned features can be found in the documentation.

Acknowledgments

JetBrains Black Box Logo logo For providing a very good development environment within Free License Programs for Open Source.