Class cMaker

constructor

• new cMaker(name?, disableWeaving?): cMaker

• Parameters

  • name: string = "cmaker-project"
  • disableWeaving: boolean = false

  Returns cMaker

cFlags

compiler

customCMakeCode

cxxFlags

generator

includeFolders

lastMakeOutput

libs

makeCommand

minimumVersion

printToConsole

sources

addCFlags

• addCFlags(...args): cMaker

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

  Parameters

  • Rest...args: string[]

  Returns cMaker

addCurrentAst

• addCurrentAst(): cMaker

• Returns cMaker

addCxxFlags

• addCxxFlags(...args): cMaker

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

  Parameters

  • Rest...args: string[]

  Returns cMaker

addFlags

• addFlags(...args): cMaker

• Parameters

  • Rest...args: string[]

  Returns cMaker

addIncludeFolder

• addIncludeFolder(includeFolder): cMaker

• Parameters

  • includeFolder: string | File

    String representing an include folder

  Returns cMaker

addLibs

• addLibs(...args): cMaker

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

  Parameters

  • Rest...args: string[]

  Returns cMaker

build

• build(cmakelistsFolder?, builderFolder?, cmakeFlags?): undefined | File

• Builds the program currently defined in the CMaker object.

  Parameters

  • cmakelistsFolder: string | File = ...

    The folder where the CMakeList files will be written
  • builderFolder: string | File = ...

    The folder where the program will be built
  • OptionalcmakeFlags: string

    Additional flags that will be passed to CMake execution

  Returns undefined | File

  File to the executable compiled by the build.

copy

• copy(): cMaker

• Returns cMaker

getCode

• getCode(): string

• Returns string

  The CMake corresponding to the current configuration

getMakeOutput

• getMakeOutput(): undefined | string

• Returns undefined | string

getSources

• getSources(): cMakerSources

• Returns cMakerSources

  Object that can be used to specify the sources.

setCompiler

• setCompiler(compiler): cMaker

• Parameters

  • compiler:
        | cMakeCompiler
        | "gcc"
        | "clang"
        | "icc"

  Returns cMaker

setCustomCMakeCode

• setCustomCMakeCode(customCMakeCode): cMaker

• 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.

  Returns cMaker

setGenerator

• setGenerator(generator): cMaker

• Parameters

  • generator: string

  Returns cMaker

setMakeCommand

• setMakeCommand(makeCommand): cMaker

• Parameters

  • makeCommand: string

  Returns cMaker

setMinimumVersion

• setMinimumVersion(version): cMaker

• Sets the minimum version of the CMake file.

  Parameters

  • version: string

    String with minimum CMake version

  Returns cMaker

setName

• setName(name): cMaker

• Sets the name of the executable.

  Parameters

  • name: string

    String with the name of the executable.

  Returns cMaker

setPrintToolsOutput

• setPrintToolsOutput(printToolsOutput?): cMaker

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

  Parameters

  • printToolsOutput: boolean = false

  Returns cMaker