/dstep

A tool for converting C and Objective-C headers to D modules

Primary LanguageD

DStep

DStep is a tool for translating C and Objective-C headers to D modules.

Download

For the latest release see: releases/latest.

Pre-compiled binaries are available for Mac OS X, Linux and FreeBSD. As 32 and 64bit. See the releases section.

Arch packages are available in [community] repository (thanks to Михаил Страшун):

https://www.archlinux.org/packages/?q=dstep

Alternatively install via Dub

License

The source code is available under the Boost Software License 1.0

Building

Requirements

Building

  1. Install all requirements, see below

  2. Clone the repository by running:

     $ git clone --recursive git://github.com/jacob-carlborg/dstep.git

  3. run dub build

Usage

$ dstep Foo.h -o Foo.d

For translating Objective-C headers add the -ObjC flag.

$ dstep Foo.h -o Foo.d -ObjC

Use -h for usage information. Any flags recognized by Clang can be used.

Requirements

libclang

This tool requires libclang. Any version that is 3.1 or later and binary compatible with 3.1 should work. Either download the pre-compatible libraries from the LLVM site or use libclang shipping with your system or available from the system package manager.

Some header files will require "stdarg.h" and/or "stddef.h". These are so called builtin includes and are shipped with Clang. They need to be placed in the standard header locations or explicitly referenced with the -I flag. For more information see the Clang FAQ.

Download the pre-compiled libraries here:

http://llvm.org/releases/download.html#3.1

Alternatively compile libclang yourself:

$ git clone http://llvm.org/git/llvm.git
$ cd llvm
$ git checkout release_31
$ cd tools
$ git clone http://llvm.org/git/clang.git
$ cd clang
$ git checkout release_31
$ cd ../..
$ ./configure --enable-optimized
$ cp Release+Asserts/lib/libclang.<dylib|so> <path/to/dstep>

Dub

Limitations/Known issues

  • Doesn't translate preprocessor macros of any kind

  • Doesn't translate #include to import. A few standard C headers are translated

  • Doesn't translate C++ at all

  • Umbrella headers. Some headers just serve to include other headers. If these other headers contain some form of protection, like #error, to be included directly this can cause problems for DStep

  • Some headers are designed to always be included together with other header files. These headers may very well use symbols from other header files without including them itself. Since DStep is designed to convert header files one-by-one this doesn't work. There are two workarounds for this:

    1. Add #include-directives for the header files the header file is actually using
    2. Use the -include <file> flag available in Clang to indicate the given <file> should be processed before the file that should be translated. DStep accepts all flags Clang accepts