Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/axw/cmonster
Python wrapper for the Clang C++ preprocessor and parser.
https://github.com/axw/cmonster
Last synced: 5 days ago
JSON representation
Python wrapper for the Clang C++ preprocessor and parser.
- Host: GitHub
- URL: https://github.com/axw/cmonster
- Owner: axw
- Created: 2011-06-11T08:30:49.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2014-06-02T00:50:08.000Z (over 10 years ago)
- Last Synced: 2024-07-31T22:53:15.840Z (3 months ago)
- Language: C++
- Homepage:
- Size: 276 KB
- Stars: 127
- Watchers: 8
- Forks: 54
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
*I am no longer developing cmonster; please see the fork at [github.com/sztomi/cmonster](https://github.com/sztomi/cmonster).*
# cmonster
cmonster is a Python wrapper for the [Clang](http://clang.llvm.org/) C++
parser.
As well as providing standard preprocessing/parsing capabilities, cmonster
adds support for:
* Inline Python macros;
* Programmatic #include handling; and
* (Currently rudimentary) source-to-source translation.
## Documentation
There's no proper documentation yet; I'll get to it eventually. In the mean
time...
### Inline Python macros
You can define inline Python macros like so:
```python
py_def(function_name(arg1, arg2, *args, **kwdargs))
return [list_of_tokens]
py_end
```
Python macros must return a string, which will be tokenized, or a sequence of
tokens (e.g. some combination of the input arguments). Python macros are used
exactly the same as ordinary macros. e.g.
```python
py_def(REVERSED(token))
return "".join(reversed(str(token)))
py_end
```
```cpp
int main() {
printf("%s\n", REVERSED("Hello, World!"));
return 0;
}
```
### Source-to-source translation
Source-to-source translation involves parsing a C++ file, generating an AST;
then traversing the AST, and making modifications in a _rewriter_. The rewriter
object maintains a history of changes, and can eventually be told to dump the
modified file to a stream.
For example, here's a snippet of Python code that shows how to make an insertion
at the top of each top-level function declaration's body:
```python
import cmonster
import cmonster.ast
import sys
# Create a parser, and a rewriter. Parse the code.
parser = cmonster.Parser(filename)
ast = parser.parse()
rewriter = cmonster.Rewriter(ast)
# For each top-level function declaration, insert a statement at the top of
# its body.
for decl in ast.translation_unit.declarations:
if decl.location.in_main_file and \
isinstance(decl, cmonster.ast.FunctionDecl):
insertion_loc = decl.body[0]
rewriter.insert(insertion_loc, 'printf("Tada!\\n");\n')
# Finally, dump the result.
rewriter.dump(sys.stdout)
```
## Installation
cmonster requires [Python 3.2](http://python.org/download/releases/3.2.2/),
[LLVM/Clang 3.0](http://llvm.org/releases/download.html#3.0), so first
ensure you have them installed. To build and install cmonster from source,
you will also need to install [Cython](http://cython.org/#download).
Now you can use
[easy\_install](http://packages.python.org/distribute/easy_install.html) to
install cmonster, like so: `easy_install cmonster`. This will download and
install a prebuilt binary distribution of cmonster.
If you wish to build cmonster yourself, either pull down the git repository, or
grab the source distribution from
[cmonster's PyPI page](http://pypi.python.org/pypi/cmonster/). When building,
make sure you have LLVM 3.0's llvm-config in your execution path. To verify
this, run `llvm-config --version`; you should expect to see `3.0` output. To
build from source, simply run `python3.2 setup.py install`.