Class CMaker

constructor

• new CMaker(name?: string, disableWeaving?: boolean): 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: string[]): CMaker

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

  Parameters

  • ...args: string[]

  Returns CMaker

addCurrentAst

• addCurrentAst(): CMaker

  Returns CMaker

addCxxFlags

• addCxxFlags(...args: string[]): CMaker

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

  Parameters

  • ...args: string[]

  Returns CMaker

addFlags

• addFlags(...args: string[]): CMaker

  Parameters

  • ...args: string[]

  Returns CMaker

addIncludeFolder

• addIncludeFolder(includeFolder: string | File): CMaker

  Parameters

  • includeFolder: string | File

    String representing an include folder

  Returns CMaker

addLibs

• addLibs(...args: string[]): CMaker

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

  Parameters

  • ...args: string[]

  Returns CMaker

build

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

  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 File | undefined

  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(): string | undefined

  Returns string | undefined

getSources

• getSources(): CMakerSources

  Returns CMakerSources

  Object that can be used to specify the sources.

setCompiler

• setCompiler(compiler: CMakeCompiler | "gcc" | "clang" | "icc"): CMaker

  Parameters

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

  Returns CMaker

setCustomCMakeCode

• setCustomCMakeCode(customCMakeCode: string): 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: string): CMaker

  Parameters

  • generator: string

  Returns CMaker

setMakeCommand

• setMakeCommand(makeCommand: string): CMaker

  Parameters

  • makeCommand: string

  Returns CMaker

setMinimumVersion

• setMinimumVersion(version: string): CMaker

  Sets the minimum version of the CMake file.

  Parameters

  • version: string

    String with minimum CMake version

  Returns CMaker

setName

• setName(name: string): CMaker

  Sets the name of the executable.

  Parameters

  • name: string

    String with the name of the executable.

  Returns CMaker

setPrintToolsOutput

• setPrintToolsOutput(printToolsOutput?: boolean): 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