ANTAREX API

Clava API

LARA API

LARA Common Language API

CMaker

Constructor

CMaker

new CMaker()

(Extends Tool)
Builds CMake configurations.


Instance Members

_addExtraIncludes

_addExtraIncludes(includes)

Parameters

includes: unknown

_getCFlagsCode

_getCFlagsCode()

_getCxxFlagsCode

_getCxxFlagsCode()

_getExecutableName

_getExecutableName()

Returns

any - the name of the executable that will be generated

_getIncludeFoldersCode

_getIncludeFoldersCode()

_getProjectDirectoriesCode

_getProjectDirectoriesCode()

addCFlags

addCFlags()

Adds a variable number of Strings, one for each flag.


addCurrentAst

addCurrentAst()

addCxxFlags

addCxxFlags()

Adds a variable number of Strings, one for each flag.


addFlags

addFlags()

addIncludeFolder

addIncludeFolder(includeFolder)

param includeFolder String representing an include folder

Parameters

includeFolder: unknown

addLibs

addLibs(arguments)

Adds link-time libraries (e.g., m for math.h).

Parameters

arguments: String...|String[] - a sequence of String with the name of the link-time libraries, as CMake would accept (e.g., "m").

build

build([cmakelistsFolder = ], [builderFolder = /build], cmakeFlags)

Builds the program currently defined in the CMaker object.

Parameters

cmakelistsFolder: String|J#java.io.File - The folder where the CMakeList files will be written (optional)
builderFolder: String|J#java.io.File - The folder where the program will be built (optional)
cmakeFlags: String - Additional flags that will be passed to CMake execution

Returns

J#java.io.File - file to the executable compiled by the build.

constructor

constructor(name, disableWeaving)

Parameters

name: unknown
disableWeaving: unknown

copy

copy()

getCode

getCode()

Returns

any - the CMake corresponding to the current configuration

getMakeOutput

getMakeOutput()

getSources

getSources()

Returns

lara.cmake.CMakerSources - Object that can be used to specify the sources.

setCompiler

setCompiler([missing param name])

Parameters

[missing param name]: string|lara.cmake.compilers.CMakeCompiler

setCustomCMakeCode

setCustomCMakeCode(customCMakeCode)

Custom CMake code that will be appended to the end of the CMake file.

Parameters

customCMakeCode: string - The code to append at the end of the CMake file.

setGenerator

setGenerator(generator)

Parameters

generator: String

setMakeCommand

setMakeCommand(makeCommand)

Parameters

makeCommand: unknown

setMinimumVersion

setMinimumVersion(version)

Sets the minimum version of the CMake file.

Parameters

version: any - String with minimum CMake version

setName

setName(name)

Sets the name of the executable.

Parameters

name: any - String with the name of the executable.

setPrintToolsOutput

setPrintToolsOutput(printToolsOutput)

Sets if output of external tools (e.g., cmake, make) should appear in the console. By default it is off.

Parameters

printToolsOutput: unknown