Clang.jl provides a Julia language wrapper for libclang: the stable, C-exported interface to (a subset of) the LLVM Clang compiler. The libclang API documentation provides background on the functionality available through libclang, and thus through the Julia wrapper. The Clang.jl repository also hosts related tools built on top of libclang functionality.
If you are unfamiliar with the Clang AST and plan to access the internals of this library (as opposed to accessing the 'wrap-c' bindings), a good starting point is the Introduction to the Clang AST.
Installation requirements are listed down page.
Clang.jl includes a generator to create Julia wrappers for C libraries from a collection of header files. The following declarations are currently supported:
enum: translated to const value symbol
struct: partial struct support may be enabled by setting WrapContext.options.wrap_structs = true
Clang.jl tends to be used on large codebases, often with multiple API versions to support. Building a generator requires some customization effort, so for small libraries the initial investment may not pay off.
libclang and libclang-dev (versions >= 3.1) are required. libclang may
optionally be built by the Julia build system by setting
You might also install clang manually, e.g. via
sudo apt-get install clang-3.7.
When using a distribution packaged version, note the latest version may only be available from an optional pre-release archive (e.g. Ubuntu PPA).
To install using the Julia package manager, use: Pkg.add("Clang"). Note that you first need to make sure, that the following are in your
clang. If not present in a default Julia location,
libclang needs to be in
PATH (on Windows), or
LD_LIBRARY_PATH (Linux), or
DYLD_LIBRARY_PATH (OS X).
The cindex.jl libclang wrapper encompasses most CXType, CXCursor, and C++ related functions. A small convenience API is provided for basic tasks related to index generation, and retrieval of cursor kind and type information.
All testing and development so far has been on Ubuntu 12.04.1 (64-bit)
using Clang.cindex julia> topcu = cindex.parse_header("Index.h") # Parse Index.h, returning the root cursor julia> children(topcu).size 2148 julia> cu = cindex.search(top, "clang_parseTranslationUnit") julia> cu_kind(cu) == CIndex.CurKind.FUNCTIONDECL true julia> name(cu) "clang_parseTranslationUnit(CXIndex, const char *, const char *const *, int, struct CXUnsavedFile *, unsigned int, unsigned int)" julia> tkl = tokenize(cu) julia> for tk in tkl println(tk) # use tk.text to get underlying string end Identifier("CXTranslationUnit") Identifier("clang_parseTranslationUnit") Punctuation("(") Identifier("CXIndex") Identifier("CIdx") Punctuation(",") Keyword("const") Keyword("char") Punctuation("*") Identifier("source_filename")
See the examples/ and util/ folders for further usage scenarios. Clang.jl is partially self-generating, including parsing of the enums (util/genCIndex_h.jl)
There is a small convenience API exported by CIndex:
tu_init # init and parse file to TranslationUnit tu_cursor # get top cursor from TranslationUnit children # gets CXCursor children; accessed by ref. cu_kind # CIndex.CurKind enum ty_kind # CIndex.TypKind enum name # get the DisplayName of a CXCursor spelling # get spelling of a CXCursor or CXType cu_file # file in which cursor was declared is_function # CXCursor or CXType is_null # CXCursor tokenize # get tokens underlying given cursor
For documentation of wrapped CIndex functions, see:
For a nice introduction to some capabilities and limitations (fewer now) of the libclang API, see this post:
Most libclang functions accept and return small structs by value. As Julia does not (yet) have full struct support, the current Clang.jl implementation includes a C++ wrapper. clang functions are wrapped by a C++ function that memcpys data to/from a Julia-owned memory array (passed by pointer)
see src/cindex_base.jl and deps/src/wrapclang.h for generated wrappers.
Some functions are manually wrapped for convenience and ease of implementation, or to provide a more Julia-friendly API.
see src/Clang.jl and deps/src/wrapclang.cpp
Clang.jl is licensed under the MIT license.
6 days ago