cxx:cmake

Full name:

org.codehaus.mojo:cxx-maven-plugin:0.0.6-SNAPSHOT:cmake

Description:

Goal which cmakes workspace.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: generate-sources.

Required Parameters

Name Type Since Description
generator String 0.0.4 Generator name, arguments for cmake command
User property is: cmake.generator.

Optional Parameters

Name Type Since Description
additionalDependenciesRoots String[] 0.0.6 directories were additional bin dependencies are default dependencies location is : ${project.build.directory}/dependency/${targetClassifier}/${buildConfig} "${targetClassifier}/${buildConfig}" will be automaticaly added to provided path to search for additionnal dependencies
additionalIncludeRoots String[] 0.0.6 Directory where additional include dependencies are
buildConfig String 0.0.6 build configuration {debug, release, debcov, relcov, relinfo}
User property is: buildConfig.
cmakeDependenciesFile String 0.0.6 cmake dependency file name. If not full qualified name file location is ${basedir}
Default value is: CMakeDependencies.txt.
User property is: cmake.dependenciesFile.
cmakeMavenDependenciesFile String 0.0.6 cmake maven dependency file name. If not full qualified name file location is ${basedir}
Default value is: CMakeMavenDependencies.txt.
User property is: cmake.mavenDependenciesFile.
commandArgs String 0.0.4 Arguments for the executed program
User property is: cmake.args.
environmentVariables Map 0.0.4 Environment variables to pass to the cmake program.
executableSuffix String 0.0.6 executables suffix of current platform {".exe", etc.}
User property is: executableSuffix.
injectMavenDependencies boolean 0.0.6 generate a cmake maven dependency file according
Default value is: true.
User property is: cmake.injectMavenDependencies.
outsourceDir File 0.0.4 Out of source directory Defaut set to ${basedir}
User property is: cmake.outsourcedir.
projectDir String 0.0.4 Directory location of main CMakeList.txt, argument for cmake command Defaut set to ${basedir}
User property is: cmake.projectdir.
sharedLibraryPrefix String 0.0.6 libraries prefixe of current platform {"lib", etc.}
User property is: sharedLibraryPrefix.
sharedLibrarySuffix String 0.0.6 libraries suffixe of current platform {".so", ".dylib", etc.}
User property is: sharedLibrarySuffix.
sharedModulePrefix String 0.0.6 module prefixe of current platform {"lib", etc.}
User property is: sharedModulePrefix.
sharedModuleSuffix String 0.0.6 module suffixe of current platform {".so", ".dylib", etc.}
User property is: sharedModuleSuffix.
staticLibraryPrefix String 0.0.6 static libraries prefixe of current platform {"lib", etc.}
User property is: staticLibraryPrefix.
staticLibrarySuffix String 0.0.6 static libraries suffixe of current platform {".a", ".lib", etc.}
User property is: staticLibrarySuffix.
targetArchitecture String 0.0.6 build architecture {i386, x86_64, etc.}
User property is: targetArchitecture.
targetClassifier String 0.0.6 maven artifact sub-classifier {win32, win64, linux-x64_64, etc.}
User property is: targetClassifier.
targetPlatform String 0.0.6 build platform = "native API" {win32, linux, mac}
User property is: targetPlatform.

Parameter Details

additionalDependenciesRoots:

directories were additional bin dependencies are default dependencies location is : ${project.build.directory}/dependency/${targetClassifier}/${buildConfig} "${targetClassifier}/${buildConfig}" will be automaticaly added to provided path to search for additionnal dependencies
  • Type: java.lang.String[]
  • Since: 0.0.6
  • Required: No

additionalIncludeRoots:

Directory where additional include dependencies are
  • Type: java.lang.String[]
  • Since: 0.0.6
  • Required: No

buildConfig:

build configuration {debug, release, debcov, relcov, relinfo}
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: buildConfig

cmakeDependenciesFile:

cmake dependency file name. If not full qualified name file location is ${basedir}
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: cmake.dependenciesFile
  • Default: CMakeDependencies.txt

cmakeMavenDependenciesFile:

cmake maven dependency file name. If not full qualified name file location is ${basedir}
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: cmake.mavenDependenciesFile
  • Default: CMakeMavenDependencies.txt

commandArgs:

Arguments for the executed program
  • Type: java.lang.String
  • Since: 0.0.4
  • Required: No
  • User Property: cmake.args

environmentVariables:

Environment variables to pass to the cmake program.
  • Type: java.util.Map
  • Since: 0.0.4
  • Required: No

executableSuffix:

executables suffix of current platform {".exe", etc.}
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: executableSuffix

generator:

Generator name, arguments for cmake command
  • Type: java.lang.String
  • Since: 0.0.4
  • Required: Yes
  • User Property: cmake.generator

injectMavenDependencies:

generate a cmake maven dependency file according
  • Type: boolean
  • Since: 0.0.6
  • Required: No
  • User Property: cmake.injectMavenDependencies
  • Default: true

outsourceDir:

Out of source directory Defaut set to ${basedir}
  • Type: java.io.File
  • Since: 0.0.4
  • Required: No
  • User Property: cmake.outsourcedir

projectDir:

Directory location of main CMakeList.txt, argument for cmake command Defaut set to ${basedir}
  • Type: java.lang.String
  • Since: 0.0.4
  • Required: No
  • User Property: cmake.projectdir

sharedLibraryPrefix:

libraries prefixe of current platform {"lib", etc.}
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: sharedLibraryPrefix

sharedLibrarySuffix:

libraries suffixe of current platform {".so", ".dylib", etc.}
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: sharedLibrarySuffix

sharedModulePrefix:

module prefixe of current platform {"lib", etc.}
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: sharedModulePrefix

sharedModuleSuffix:

module suffixe of current platform {".so", ".dylib", etc.}
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: sharedModuleSuffix

staticLibraryPrefix:

static libraries prefixe of current platform {"lib", etc.}
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: staticLibraryPrefix

staticLibrarySuffix:

static libraries suffixe of current platform {".a", ".lib", etc.}
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: staticLibrarySuffix

targetArchitecture:

build architecture {i386, x86_64, etc.}
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: targetArchitecture

targetClassifier:

maven artifact sub-classifier {win32, win64, linux-x64_64, etc.}
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: targetClassifier

targetPlatform:

build platform = "native API" {win32, linux, mac}
  • Type: java.lang.String
  • Since: 0.0.6
  • Required: No
  • User Property: targetPlatform