Target

The core of reggae's D-based DSL for describing build systems. Targets contain outputs, a command to generate those outputs, explicit dependencies and implicit dependencies. All dependencies are themselves Target structs.

The command is given as a string. In this string, certain words have special meaning: $in, $out, $project and builddir.

$in gets expanded to all explicit dependencies. $out gets expanded to all outputs. $project gets expanded to the project directory (i.e. the directory including the source files to build that was given as a command-line argument). This can be useful when build outputs are to be placed in the source directory, such as automatically generated source files. $builddir expands to the build directory (i.e. where reggae was run from).

struct Target {

this(string output);

this(string output, C command, Target dependency, Target[] implicits);

this(string output, C command, Target[] dependencies, Target[] implicits);

this(string[] outputs, C command, Target[] dependencies, Target[] implicits);

string rawOutputs [@property setter];

string dependencies [@property setter];

string implicits [@property setter];

string dependenciesInProjectPath [@property setter];

string implicitsInProjectPath [@property setter];

bool isLeaf();

string[] outputsInProjectPath(string projectPath);

Language getLanguage();

auto expandOutputs(string projectPath);

string rawCmdString(string projectPath);

string shellCommand(Options options, Flag!"dependencies" deps);

string[] execute(Options options);

bool hasDefaultCommand();

CommandType getCommandType();

string[] getCommandParams(string projectPath, string key, string[] ifNotFound);

const(string)[] commandParamNames();

static Target phony(string output, string shellCommand, Target[] dependencies, Target[] implicits);

string toString(Options options);

ubyte[] toBytes(Options options);

static Target fromBytes(ubyte[] bytes);

}

Constructors

this this(string output): Undocumented in source.
this this(string output, C command, Target dependency, Target[] implicits): Undocumented in source.
this this(string output, C command, Target[] dependencies, Target[] implicits): Undocumented in source.
this this(string[] outputs, C command, Target[] dependencies, Target[] implicits): Undocumented in source.

Members

Functions

commandParamNames const(string)[] commandParamNames(): Undocumented in source. Be warned that the author may not have intended to support it.
execute string[] execute(Options options): Undocumented in source. Be warned that the author may not have intended to support it.
expandOutputs auto expandOutputs(string projectPath): Replace special variables and return a list of outputs thus modified
getCommandParams string[] getCommandParams(string projectPath, string key, string[] ifNotFound): Undocumented in source. Be warned that the author may not have intended to support it.
getCommandType CommandType getCommandType(): Undocumented in source. Be warned that the author may not have intended to support it.
getLanguage Language getLanguage(): Undocumented in source. Be warned that the author may not have intended to support it.
hasDefaultCommand bool hasDefaultCommand(): Undocumented in source. Be warned that the author may not have intended to support it.
isLeaf bool isLeaf(): Undocumented in source. Be warned that the author may not have intended to support it.
outputsInProjectPath string[] outputsInProjectPath(string projectPath): Undocumented in source. Be warned that the author may not have intended to support it.
rawCmdString string rawCmdString(string projectPath): Undocumented in source. Be warned that the author may not have intended to support it.
shellCommand string shellCommand(Options options, Flag!"dependencies" deps): returns a command string to be run by the shell
toBytes ubyte[] toBytes(Options options): Undocumented in source. Be warned that the author may not have intended to support it.
toString string toString(Options options): Undocumented in source. Be warned that the author may not have intended to support it.

Properties

dependencies string dependencies [@property setter]: Undocumented in source. Be warned that the author may not have intended to support it.
dependenciesInProjectPath string dependenciesInProjectPath [@property setter]: Undocumented in source. Be warned that the author may not have intended to support it.
implicits string implicits [@property setter]: Undocumented in source. Be warned that the author may not have intended to support it.
implicitsInProjectPath string implicitsInProjectPath [@property setter]: Undocumented in source. Be warned that the author may not have intended to support it.
rawOutputs string rawOutputs [@property setter]: Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

fromBytes Target fromBytes(ubyte[] bytes): Undocumented in source. Be warned that the author may not have intended to support it.
phony Target phony(string output, string shellCommand, Target[] dependencies, Target[] implicits): Undocumented in source. Be warned that the author may not have intended to support it.