15knots/cmake4eclipse

Abstract

This Eclipse plug-in automatically generates build-scripts for the Eclipse CDT managed build system from CMake scripts. Its Primary claim is: Co-workers should be able to just check out the source and build the project.

Design goals

Automatic generation of build scripts. See Primary claim: No need to manually invoke cmake: Cmake options are persisted in the Eclipse project settings files.
Cmake is a cross-platform build tool. So Eclipse projects should be cross-platform as feasible; without the need for co-workers to adjust Eclipse project settings just to build on their platform.
Take the CMakeLists.txt as the source of truth.
- Auto-detect the actual build tool to invoke: make, ninja, nmake, MinGW make, MSYS make, ...
- Easy project configuration regarding code completion, symbol-declaration lookup and macro-value tool-tips in the source editor.
  - Feed include paths and pre-processor symbols from cmake to the CDT-Indexer (CMAKE_EXPORT_COMPILE_COMMANDS Parser).
  - Retrieve compiler-built-in pre-processor symbols and include paths by interrogating the actual compiler and feed these to the CDT-Indexer (CMAKE_EXPORT_COMPILE_COMMANDS Compiler Built-ins). Well, at least as the compiler supports that (GNU C and nvcc CUDA compilers do so).
    Screenshots
    
    Screenshots can be found at the Eclipse Marketplace.

Quick start

If you do not have any existing code, check out the Sample Projects, chose one and fill in your code.
If you have an existing C/C++ project code, inside Eclipse, goto Help:Help Contents, then read the Cmake4eclipse User Guide:Getting Started node to adjust your project settings.

License

The plugin is licensed under the Eclipse Public License Version 1.0 ("EPL").

System Requirements

CDT v 8.7 or newer and Eclipse v 4.5 (Mars) or newer

Java 8 or newer

Installation

The easiest way is to drag this: to your running Eclipse workbench.

Alternatively, cmake4eclipse can be installed into Eclipse using the "Install New Software..." dialog and entering the update site URL listed below.

Update Site

This composite update site is for use in a Eclipse workbench and contains the latest release as well as selected older releases: https://raw.githubusercontent.com/15knots/cmake4eclipse/master/releng/comp-update/.

p2 Repositories

Tool integrators will find each release at bintray. Each release is provided as a stand-alone zipped p2 repository and can be consumed in a PDE target platform. To add one of these repositories to your target platform, add a Software Site and enter a URL for the location as jar:https://dl.bintray.com/15knots/p2-zip/cmake4eclipse-2.0.1.zip!/ (note the leading jar: and the trailing !/).

If you work at a company that wants to ship cmake4eclipse with your product, please consider to mirror the zip file internally and reference the company-internal location in your target definition. This will help to reduce the traffic on bintray and make your product builds immune to downtimes on bintray.

Debug and Build

This project uses Apache maven as its build system. To build from a command-line, run mvn -f ./parent/pom.xml package in the root directory of the project source files.

There is also a run configuration for eclipse to invoke the maven build: build cmake4eclipse.

To debug the plug-in from Eclipse, first set the Plug-in Development Target platform of your workbench to cdt/8.7-eclipse/4.5.2, then run the Eclipse Application launch configuration named cmake4eclipse.

References

Projects that recommend to use this plugin to develop it using Eclipse.

IDEs with cmake4eclipse

Nsight Eclipse https://devblogs.nvidia.com/drivepx-application-development-using-nsight-eclipse-edition#attachment_10114

Books

Advanced C++ https://books.google.de/books?id=YVG7DwAAQBAJ&pg=PA9&lpg=PA9&dq=cmake4eclipse&source=bl&ots=qgHjAfjlcA&sig=ACfU3U21IppdYpImjXxBfWD69-2NYeHB4w&hl=de&sa=X&ved=2ahUKEwimtrONqJjnAhVKK1AKHVIEC2k4ChDoATAIegQIChAB#v=onepage&q=cmake4eclipse&f=false