Difference between revisions of "Eclipse CDT4 Generator"

From KitwarePublic
Jump to navigationJump to search
(Replace content with link to new CMake community wiki)
 
(20 intermediate revisions by 11 users not shown)
Line 1: Line 1:
==Overview==
+
{{CMake/Template/Moved}}
  
<!-- [[Image:CMakeEclipseCDT4_TSPBuild.png|thumb|right|350px|CMake generated Eclipse Project for TSP]] -->
+
This page has moved [https://gitlab.kitware.com/cmake/community/wikis/doc/editors/Eclipse-CDT4-Generator here].
 
 
[[Image:CMakeEclipseCDT4GeneratorScreendump.png|thumb|right|350px|Eclipse opens CMake project file]]
 
 
 
Starting with version 2.6.0 CMake includes an Eclipse CDT 4.0 generator. It works together with the Makefile generators (i.e. "Unix Makefiles", "MinGW Makefiles", "MSYS Makefiles", and maybe "NMake Makefiles").
 
This generator creates a set of .project/.cproject files that can be imported in Eclipse as an "Existing Eclipse project".
 
 
 
Note that CMake 2.4.x users may follow instructions provided here [[CMake:Eclipse]] in order to setup an Eclipse+CMake usage ''manually''.
 
 
 
 
 
==Using Eclipse CDT4 Generator==
 
 
 
Using the Eclipse CDT4 generator is not different as using another CMake generator, it works for in-source and out-of-source builds.
 
In this example I assume the source tree of my project
 
is ''/home/eric/certi_src''
 
 
 
<ol>
 
<li> Create a build directory, go there and run CMake:
 
<pre>mkdir /home/eric/certi_build
 
cd /home/eric/certi_build
 
cmake -G"Eclipse CDT4 - Unix Makefiles" ../certi_src</pre>
 
After that you will find two Eclipse files in your build tree:
 
    <ol>
 
    <li> <tt>certi_build/.project</tt></li>
 
    <li> <tt>certi_build/.cproject</tt></li>
 
    </ol>
 
</li>
 
</li>
 
<li> Import the created project file into Eclipse:
 
    <ol>
 
    <li> Launch eclipse</li>
 
    <li> Import project using Menu ''File->Import''
 
          [[Image:Capture-EclipseMenuFileImport.jpg|thumb|center|200px|Eclipse Menu->File->Import]]</li>
 
 
 
    <li> Select ''General->Existing projects into workspace'':
 
          [[Image:Capture-EclipseProjectsIntoWorkspace.jpg|thumb|center|200px|Existing Projects into Workspace]]</li>
 
 
 
    <li> Browse where your build tree is and select the root build tree directory. Keep "Copy projects into workspace" unchecked.
 
          [[Image:Capture-Import.jpg|thumb|center|200px|Eclipse Import after build tree selection]]</li>
 
 
 
    <li> You get a fully functional eclipse project
 
          [[Image:Capture-certi_build-Eclipse.jpg|thumb|center|200px|Eclipse Imported CERTI project]]</li>
 
    </ol>
 
</li>
 
</ol>
 
 
 
==In-Source Builds==
 
 
 
In-Source builds are fully supported by the Eclipse
 
project generator.
 
 
 
==Out-Of-Source Builds==
 
 
 
Eclipse has two issues with out-of-source builds, the project generator tries to work around them as good as possible. The details are described below.
 
 
 
===Version Control Integration in Eclipse===
 
 
 
Eclipse supports version control systems, e.g. cvs and svn, but for them to work the project files must be at the root of the source tree. This is not the case with out-of-source builds.
 
The only way to get version control for your project in Eclipse is to have a separate project in the source tree for this purpose. You can create this project either manually (screen cast showing how to do this: [[Image:CMakeEclipseCDT4andCVS-2.ogg]]), or you can tell CMake to do it for when creating your project files:
 
<pre>
 
cmake -G"Eclipse CDT4 - Unix Makefiles" -DECLIPSE_CDT4_GENERATE_SOURCE_PROJECT ../certi_src
 
</pre>
 
 
 
This will create your normal project in the build tree and additionally an extra project in the source tree, we call it the "source-project". In Eclipse you can then import this source-project the same way as you import the normal project. This way you'll have two (or more) projects, one for browsing the sources and doing version control, the other for building your project.
 
 
 
===Accessing the Source and Advanced Editing Features===
 
 
 
Eclipse has advanced support for editing C/C++ sources, including code navigation, autocompletion etc.
 
For that to work the sources must be inside the project (the additional source-project from above is not inside the project).
 
The Eclipse project generator therefor creates a linked resource to the source tree in the Eclipse project. This makes the C/C++ features work.
 
 
 
This linked resource isn't created if the build directory is a subdirectory of the source directory, because Eclipse doesn't allow to load projects which have linked resources pointing to a parent directory.
 
So we recommend to create your build directories not as children, but e.g. as siblings to the source directory.
 
 
 
==Discussion about Eclipse CDT4 Generator limitations==
 
 
 
If you would like to monitor the changes to the EclipseCDT4 support, you can view the following links which contain the cvs history log for changes to the two main files:
 
* [http://www.cmake.org/cgi-bin/viewcvs.cgi/Source/cmExtraEclipseCDT4Generator.h?root=CMake&view=log cmExtraEclipseCDT4Generator.h]
 
 
 
* [http://www.cmake.org/cgi-bin/viewcvs.cgi/Source/cmExtraEclipseCDT4Generator.cxx?root=CMake&view=log cmExtraEclipseCDT4Generator.cxx]
 
 
 
 
 
Eclipse assumes project files (i.e. .project and .cproject) ''must
 
be at the root of the project tree'' '''and''' a project
 
may be handled by a versioning system (CVS, SVN, ...) iff
 
''the root project tree is''.
 
 
 
This assumption clashes with the fact that CMake generated files
 
should ''stay in the build tree'' whereas source files (which are usually those handled
 
by a versioning system) reside ''in the source tree''.
 
 
 
There has been a fair amount of discussion regarding this problem
 
of the Eclipse CDT4 Generator:
 
<ol>
 
<li>[http://www.cmake.org/pipermail/cmake/2007-October/016956.html Trouble with CMake + Eclipse + SVN/CVS]
 
<li>[http://www.cmake.org/pipermail/cmake/2007-August/015504.html *Updated* Eclipse CDT4 CMake Generator - Pre-Alpha version]
 
<li>[http://dev.eclipse.org/mhonarc/lists/platform-cvs-dev/msg00462.html Partially Shared project using Eclipse CDT (cdt-dev ML)]
 
</ol>
 
{{CMake/Template/Footer}}
 

Latest revision as of 11:41, 30 April 2018


The CMake community Wiki has moved to the Kitware GitLab Instance.

This page has moved here.