reggae.rules.common

Undocumented in source.

Members

Enums

Language
enum Language
Undocumented in source.

Functions

compileCommand
Command compileCommand(string srcFileName, string[] flags, string[] includePaths, string[] stringImportPaths, string projDir, Flag!"justCompile" justCompile)
Undocumented in source. Be warned that the author may not have intended to support it.
executable
Target executable()

A binary executable. The same as calling objectFiles and link with these parameters.

executable
Target executable(string projectPath, string name, string[] srcDirs, string[] excDirs, string[] srcFiles, string[] excFiles, string[] compilerFlags, string[] linkerFlags, string[] includes, string[] stringImports)
Undocumented in source. Be warned that the author may not have intended to support it.
extFileName
string extFileName(string srcFileName, string extension)
Undocumented in source. Be warned that the author may not have intended to support it.
getLanguage
Language getLanguage(string srcFileName)
Undocumented in source. Be warned that the author may not have intended to support it.
libFileName
string libFileName(string srcFileName)
Undocumented in source. Be warned that the author may not have intended to support it.
link
Target link()

"Compile-time" link function. Its parameters are compile-time so that it can be aliased and used at global scope in a reggafile. Links an executable from the given dependency targets. The linker used depends on the file extension of the leaf nodes of the passed-in targets. If any D files are found, the linker is the D compiler, and so on with C++ and C. If none of those apply, the D compiler is used.

link
Target link(ExeName exeName, Target[] dependencies, Flags flags)

Regular run-time link function. Links an executable from the given dependency targets. The linker used depends on the file extension of the leaf nodes of the passed-in targets. If any D files are found, the linker is the D compiler, and so on with C++ and C. If none of those apply, the D compiler is used.

objFileName
string objFileName(string srcFileName)
Undocumented in source. Be warned that the author may not have intended to support it.
objectFile
Target objectFile(SourceFile srcFile, Flags flags, ImportPaths includePaths, StringImportPaths stringImportPaths, Target[] implicits, string projDir)

An object file, typically from one source file in a certain language (although for D the default is a whole package). The language is determined by the file extension of the file passed in. The projDir variable is best left alone; right now only the dub targets make use of it (since dub packages are by definition outside of the project source tree).

objectFiles
Target[] objectFiles()

This template function exists so as to be referenced in a reggaefile.d at top-level without being called via alias. That way it can be named and used in a further Target definition without the need to define a function returning Build. This function gets the source files to be compiled at runtime by searching for source files in the given directories, adding files and filtering as appropriate by the parameters given in sources, its first compile-time parameter. The other parameters are self-explanatory.

objectFiles
Target[] objectFiles(string projectPath, string[] srcDirs, string[] excDirs, string[] srcFiles, string[] excFiles, string[] flags, string[] includes, string[] stringImports)
Undocumented in source. Be warned that the author may not have intended to support it.
phony
Target phony()

Compile-time version of Target.phony

removeProjectPath
string removeProjectPath(string path)
Undocumented in source. Be warned that the author may not have intended to support it.
removeProjectPath
string removeProjectPath(string projectPath, string path)
Undocumented in source. Be warned that the author may not have intended to support it.
sourcesToFileNames
string[] sourcesToFileNames()
Undocumented in source. Be warned that the author may not have intended to support it.
sourcesToFileNames
string[] sourcesToFileNames(string projectPath, string[] srcDirs, const(string)[] excDirs, string[] srcFiles, string[] excFiles)
Undocumented in source. Be warned that the author may not have intended to support it.
sourcesToTargets
auto sourcesToTargets()
Undocumented in source. Be warned that the author may not have intended to support it.
staticLibrary
Target staticLibrary()

Convenience rule for creating static libraries

staticLibrary
Target staticLibrary(string projectPath, string name, string[] srcDirs, string[] excDirs, string[] srcFiles, string[] excFiles, string[] flags, string[] includes, string[] stringImports)
Undocumented in source. Be warned that the author may not have intended to support it.
staticLibraryTarget
Target staticLibraryTarget(string name, Target[] objects)
Undocumented in source. Be warned that the author may not have intended to support it.
target
Target target()

"Compile-time" target creation. Its parameters are compile-time so that it can be aliased and used at global scope in a reggaefile

targetConcat
Target[] targetConcat()

Convenience alias for appending targets without calling any runtime function. This replaces the need to manually define a function to return a Build struct just to concatenate targets

Variables

exeExt
auto exeExt;
Undocumented in source.
exeExt
auto exeExt;
Undocumented in source.
libExt
auto libExt;
Undocumented in source.
libExt
auto libExt;
Undocumented in source.
objExt
auto objExt;
Undocumented in source.
objExt
auto objExt;
Undocumented in source.

Meta