CMake-Maven-Project

Introduction

A Maven project for the CMake build system. It can be used by including it as a plugin within your Maven project's pom.xml file.

This repository originally lived on Google Code and was migrated to GitHub (and Git) after Google Code shut down.

Sample Usage

Generate Goal

<plugin>
  <groupId>com.googlecode.cmake-maven-project</groupId>
  <artifactId>cmake-maven-plugin</artifactId>
  <version>3.4.1-b1</version>
  <executions>
    <execution>
      <id>cmake-generate</id>
      <goals>
        <goal>generate</goal>
      </goals>
      <configuration>
        <sourcePath>
          <!-- The directory containing CMakeLists -->
        </sourcePath>
        <targetPath>
          <!-- The directory write the project files to -->
        </targetPath>
        <generator>
          <!-- One of the generators defined at http://www.cmake.org/cmake/help/v2.8.10/cmake.html#section_Generators -->
        </generator>
        <environmentVariables>
          <key>value</key>
        </environmentVariables>
        <options>
          <!--
            Optional: One or more options found at http://www.cmake.org/cmake/help/v2.8.10/cmake.html#section_Options
            For example:
          -->
          <option>-DBUILD_THIRDPARTY:bool=on</option> 
        </options>
      </configuration>
    </execution>
  </executions>
</plugin>

Compile Goal

<plugin>
  <groupId>com.googlecode.cmake-maven-project</groupId>
  <artifactId>cmake-maven-plugin</artifactId>
  <version>3.4.1-b1</version>
  <executions>
    <execution>
      <id>cmake-compile</id>
      <goals>
        <goal>compile</goal>
      </goals>
      <configuration>
        <config>
          <!-- Optional: the build configuration (e.g. "Release|x64") -->
        </config>
        <target>
          <!-- Optional: the build "target" -->
        </target>
        <projectDirectory>
          <!-- "targetPath" from the "generate" goal -->
        </projectDirectory>
        <environmentVariables>
          <key>value</key>
        </environmentVariables>
      </configuration>
    </execution>
  </executions>
</plugin>

Test Goal

<plugin>
  <groupId>com.googlecode.cmake-maven-project</groupId>
  <artifactId>cmake-maven-plugin</artifactId>
  <version>3.4.1-b1</version>
  <executions>
    <execution>
      <id>cmake-test</id>
      <goals>
        <goal>test</goal>
      </goals>
      <configuration>
        <!-- "buildDirectory" is "targetPath" from the "generate" goal --> 
        <buildDirectory>${project.build.directory}</buildDirectory>
        <!-- Optional way to not fail the build on test failures -->
        <!-- <testFailureIgnore>true</testFailureIgnore> -->
        <!-- Optional way to skip just the ctest tests -->
        <!-- <ctest.skip.tests>true</ctest.skip.tests> -->
        <!-- Optional/standard way to skip all Maven tests -->
        <!-- <maven.test.skip>true</maven.test.skip> -->
        <!-- Optional way to configure number of threads tests should use -->
        <!-- <threadCount>2</threadCount> -->
        <!-- Optional dashboard configuration; used with CTestConfig.cmake -->
        <!-- <dashboard>Experimental</dashboard> -->
      </configuration>
    </execution>
  </executions>
</plugin>

Configuring Platform-Specific Build Profiles

You can use Maven profiles (in your project's pom.xml file) to enable platform-specific configurations. For example, the below changes the generator based on OS:

<profiles>
  <profile>
    <id>linux64</id>
    <activation>
      <os>
        <name>Linux</name>
        <arch>!i386</arch>
      </os>
    </activation>
    <properties>
      <cmake.generator>Unix Makefiles</cmake.generator>
    </properties>
  </profile>
  <profile>
    <id>linux32</id>
    <activation>
      <os>
        <name>Linux</name>
        <arch>i386</arch>
      </os>
    </activation>
    <properties>
      <cmake.generator>Unix Makefiles</cmake.generator>
    </properties>
  </profile>
  <profile>
    <id>mac64</id>
    <activation>
      <os>
        <name>Mac OS X</name>
      </os>
    </activation>
    <properties>
      <cmake.generator>xcode</cmake.generator>
    </properties>
  </profile>
  <profile>
    <id>windows</id>
    <activation>
      <os>
        <family>windows</family>
      </os>
    </activation>
    <properties>
      <!-- with cygwin -->
      <cmake.generator>Unix Makefiles</cmake.generator>
      <!-- with MinGW -->
      <!-- <cmake.generator>MinGW Makefiles</cmake.generator> -->
      <!-- with MSYS -->
      <!-- <cmake.generator>MSYS Makefiles</cmake.generator> -->
    </properties>
  </profile>
</profiles>

Building Your Project Using Version 2.8.11-b4 and Later

Since version 2.8.11-b4, CMake-Maven-Project will use OS activation to determine which profile to use. If you're building on a Linux system, it will automatically select the 'linux' profile; if you're running on a Windows system, it will automatically select the 'windows' profile. You simply have to build your project in the standard Maven way:

mvn install

OS profile activation can be overridden (if you have a Windows cross-compiling setup on a 64 bit Linux machine, for instance). To select the Windows profile on a 64 bit Linux machine, use:

mvn -Pwindows,-linux64 install

This removes the 'linux64' profile and adds the 'windows' one.

Since version 3.4.1-b1, the following profiles are supported:

• windows
• linux64
• linux32
• mac64

Between versions 2.8.11-b4 and 3.4.1-b1, the supported build profiles were:

• windows
• linux
• mac

To clean an old build, run:

mvn -P<profile> clean

Building Your Project Using Version 2.8.11-b3 and Earlier

To build your project using an earlier version of CMake-Maven-Project, you will need to supply the OS profile you want to use. It will not be auto-detected.

mvn -P<profile> install

So, for example, to build on 64 bit Linux:

mvn -Plinux install

The following profiles are supported:

• windows
• linux
• mac

That's it! To learn more about CMake itself, consult the CMake.org website.

License

CMake-Maven-Project is released under an Apache License 2.0