A build system in D
To use this package, put the following dependency into your project's dependencies section:
A (meta) build system written in the D programming language. This is alpha software, only tested on Linux and likely to have breaking changes made.
- Low-level DAG build descriptions + high-level convenience rules to build C, C++ and D
- Automatic header/module dependency detection for C, C++ and D
- Automatically runs itself if the build description changes
- Out-of-tree builds
- Backends for GNU make, ninja, tup and a custom binary executable.
- User-defined variables like CMake in order to choose features before compile-time
- Rules for using dub build targets in your own build decription - use dub with ninja, add to the dub description, ...
Not all features are available on all backends. Executable D code commands (as opposed to shell commands) are only supported by the binary backend, and due to tup's nature dub support and a few other features are not available. When using the tup backend, simple is better.
The recommended backends are ninja and binary.
From a build directory (usually not the same as the source one), type
reggae -b <ninja|make|tup|binary> </path/to/project>. This will create
the actual build system depending on the backend chosen, for
tup, or a runnable
executable, respectively. The project path passed must either:
- Contain a a file named
reggaefile.dwith the build configuration
- Be a dub project
Dub projects with no
reggaefile.d will have one generated for them in the build directory.
How to write build configurations
The best examples can be found in the features directory.
reggaefile.d must contain one and only one function with a return value of type
Build. This function can be generated automatically with the
build template mixin. The
Build struct is a container for
Target structs, which themselves may depend on other targets.
Arbritrary build rules can be used. Here is an example of a simple D build
import reggae; const mainObj = Target("main.o", "dmd -I$project/src -c $in -of$out", Target("src/main.d")); const mathsObj = Target("maths.o", "dmd -c $in -of$out", Target("src/maths.d")); const app = Target("myapp", "dmd -of$out $in", [mainObj, mathsObj]); mixin build!(app);
That was just an example to illustrate the low-level primitives. To build D apps with no external dependencies, this will suffice and is similar to using rdmd:
import reggae; alias app = scriptlike!(App(SourceFileName("src/main.d"), BinaryFileName("myapp")), Flags("-g -debug"), ImportPaths(["/path/to/imports"]) ); mixin build!(app);
There are also other functions and pre-built rules for C and C++ objects. There is no HTML documentation yet but the package file contains the relevant DDoc with details. Other subpackages might contain DDoc of their own. There is also detailed documentation in markdown format.
For C and C++, the main high-level rules to use are
link, but of course they can also be hand-assembled from
Target structs. Here is an
example C++ build:
import reggae; alias objs = objectFiles!(Sources!(["."]), // a list of directories Flags("-g -O0"), IncludePaths(["inc1", "inc2"])); alias app = link!(ExeName("app"), objs);
Sources can also be used like so:
Sources!(Dirs([/*directories to look for sources*/], Files([/*list of extra files to add*/]), Filter!(a => a != "foo.d"))); //get rid of unwanted files
objectFiles isn't specific to C++, it'll create object file targets
for all supported languages (currently C, C++ and D).
The easiest dub integration is to run reggae with a directory containing a dub project as
parameter. That will create a build system that would do the same as "dub build" but probably
faster. In all likelihood a user needing reggae will need more than that, and reggae provides
an API to use dub build information in a
reggaefile.d build description file. A simple
example for building production and unittest binaries concurrently is this:
import reggae; alias main = dubDefaultTarget!("-g -debug"); alias ut = dubConfigurationTarget!(ExeName("ut"), Configuration("unittest")); mixin build!(main, ut);
Depending on whether or not the dub project in questions uses configurations, reggae's dub support might not work before this pull request is merged.
Scripting language limitations
Build written in one of the scripting languages currently:
- Can only detect changes to the main build description file (e.g. reggaefile.py), but not any other files that were imported/required
- Cannot use the binary backend
- Do not have access to the dub high-level rules
These limitations are solely due to the features not having been implemented yet.
Reggae can build itself. To bootstrap, either use dub or the included bootstrap script.
Call it without arguments for
make or with one to choose another backend, such as
will create a
reggae binary in a
bin directory then call itself to generate the "real" build
system with the requested backend. The reggae-enabled build includes a unit test binary.
- No external dependencies, including on dub
- Minimal boilerplate for writing build configurations
- Flexibility for low-level tasks with built-in common tasks
- Registered by Atila Neves
- 0.5.2 released 4 years ago
- BSD 3-clause
- Copyright © 2015, Atila Neves