Development/Tutorials/CMake - Revision history

AnneW at 15:22, 13 July 2012

2012-07-13T15:22:35Z

Icwiener: /* Using CMake for a KDE Project */ Fix syntax highlighting.

2011-06-30T11:49:42Z

‎Using CMake for a KDE Project: Fix syntax highlighting.

Icwiener: /* Using CMake for a Simple Application */ Fix syntax highlighting.

2011-06-30T11:49:12Z

‎Using CMake for a Simple Application: Fix syntax highlighting.

Icwiener: /* Going Further */ Fix syntax highlighting.

2011-06-30T11:48:19Z

‎Going Further: Fix syntax highlighting.

Icwiener: Fix syntax highlighting.

2011-06-27T13:00:11Z

Fix syntax highlighting.

Mpyne: Slight case correction for CMake build types.

2011-02-20T22:25:36Z

Slight case correction for CMake build types.

Krop: /* Using CMake for a KDE Project */

2010-10-16T16:53:10Z

‎Using CMake for a KDE Project

Iwesp: Change section on environment variables. It recommends setting CMAKE_PREFIX_PATH now.

2010-10-09T10:57:00Z

Change section on environment variables. It recommends setting CMAKE_PREFIX_PATH now.

JLP: /* Command Line Variables */ fixed link ro build types

2010-04-29T19:25:32Z

‎Command Line Variables: fixed link ro build types

Waldir: fix

2010-04-20T08:33:35Z

fix

← Older revision		Revision as of 15:22, 13 July 2012
Line 1:		Line 1:
−	~~{{Template:I18n/Language Navigation Bar\|Development/Tutorials/CMake}}~~

	== Introduction ==		== Introduction ==

@@ Line 173: / Line 173: @@
 Here's a basic CMakeList file that builds a small KDE 4 project:
-<pre>
+<syntaxhighlight lang="cmake">
 project( kde4project )
 find_package( KDE4 REQUIRED )
@@ Line 187: / Line 187: @@
 install( TARGETS kde4project  ${INSTALL_TARGETS_DEFAULT_ARGS} )
-</pre>
+</syntaxhighlight>
 ''target_link_libraries'' contains the development libraries that are linked to your program. E.g. if you want to link to libtidy-devel, your library file name may be called /usr/local/lib/libtidy.a. You would then add -ltidy to a gcc call. Here, you add ''tidy'' to your target_link_libraries. If possible, use pre-defined variables or macros like ${KDE4_KDEUI_LIBS}.

@@ Line 139: / Line 139: @@
 Here's the most simple CMakeLists.txt:
-<pre>
+<syntaxhighlight lang="cmake">
 add_executable(hello main.cpp)
-</pre>
+</syntaxhighlight>
 This will create an executable named "hello" (or "hello.exe" under Windows) from the source file main.cpp. You can mix C and C++ files as you want.  You can have multiple executables and libraries in one CMakeLists.txt.  The same source file can be used in multiple targets, it will be compiled for each target independently from the other targets.  Probably the most important part of the cmake language are the variables:
-<pre>
+<syntaxhighlight lang="cmake">
 set( MY_SOURCES main.cpp widget.cpp)
 message(STATUS "my sources: ${MY_SOURCES}")
-</pre>
+</syntaxhighlight>
 So, use the SET() command to set the value of a variable. If you list more than one string, the variable will be a list.   A list is a list of strings separated by semicolons. If you set it to only one item, it will have just that value. To get the value of a variable, use ${VAR}.
 You can iterate over a list using FOREACH():
-<pre>
+<syntaxhighlight lang="cmake">
 foreach(next_ITEM ${MY_SOURCES})
     message(STATUS "next item: ${next_ITEM}")
 endforeach(next_ITEM ${MY_SOURCES})
-</pre>
+</syntaxhighlight>
 The commands in CMake are case-insensitive.  Names of variables and names of parameter are case-sensitive.
 You can also test for various things:
-<pre>
+<syntaxhighlight lang="cmake">
 if (UNIX)
     message(STATUS "This is UNIX (including OS X and CygWin)")
@@ Line 165: / Line 165: @@
     set(MY_SRCS ${MY_SRCS} winextra.cpp)
 endif (MSVC)
-</pre>
+</syntaxhighlight>
 In this second example  you can see also how to append items to a list.

@@ Line 131: / Line 131: @@
 out which library, search in the cmake/modules directory for
 the variable that cmake can't find. In the example above, it is
-<pre>
+<syntaxhighlight lang="cmake">
 find_library(X11_XTest_LIB Xtst ${X11_LIB_SEARCH_PATH})
-</pre>
+</syntaxhighlight>
 So the missing library is Xtst. You then need to find it (perhaps installing a libXtst-devel library) and re-run cmake.

@@ Line 21: / Line 21: @@
 Once downloaded, unpack and compile it:
-<code>
+<syntaxhighlight lang="bash">
 $ mkdir cmake-build
 $ cd cmake-build
@@ Line 27: / Line 27: @@
 $ make
 $ make install
-</code>
+</syntaxhighlight>
 By default, this will install CMake in /usr/local, so make sure to have /usr/local/bin in your execute path.   To change the installation prefix (e.g. to /usr in debian), add the '--prefix=PATH' option to the bootstrap command.
@@ Line 48: / Line 48: @@
 So, let's say you have kdelibs/ in ~/src/kdelibs/, then do the following:
-<code>
+<syntaxhighlight lang="bash">
 $ ls
 kdelibs/
@@ Line 54: / Line 54: @@
 $ cd kdelibs-build
 $ cmake ../kdelibs
-</code>
+</syntaxhighlight>
 This will generate the Makefiles for building kdelibs/ in kdelibs-build/.
@@ Line 61: / Line 61: @@
 So, let's say you have kdelibs\ in c:\daten\kde4, then do the following:
-<code>
+<syntaxhighlight lang="dos">
 c:\daten\kde4> cd kdelibs\win
 c:\daten\kde4> cmake
@@ Line 70: / Line 70: @@
 c:\daten\kde4> cd kdelibs-build
 c:\daten\kde4\kdelibs-build> cmake ..\kdelibs
-</code>
+</syntaxhighlight>
 This will generate the Makefiles for building kdelibs\ in kdelibs-build\. See [[Projects/KDE_on_Windows|KDE on Windows]] for more informations about compiling KDE on Windows.
@@ Line 76: / Line 76: @@
 ==== KDevelop 3 Project Files ====
 If you prefer project files for KDevelop 3 (which will basically be Makefiles accompanied by some extra files for KDevelop), run it like this:
-<code>
+<syntaxhighlight lang="bash">
 $ cmake ../kdelibs -GKDevelop3
-</code>
+</syntaxhighlight>
 Use 'cmake -h' to find out which generators CMake supports and the other options.
@@ Line 122: / Line 122: @@
 If you got a failure that says something like
-<code>
+<pre>
 CMake Error: This project requires some variables to be set,
 and cmake can not find them.
 Please set the following variables:
 X11_XTest_LIB (ADVANCED)
-</code>
+</pre>
 then you may have a missing library (or other dependency). To find
 out which library, search in the cmake/modules directory for
 the variable that cmake can't find. In the example above, it is
-<code>
+<pre>
 find_library(X11_XTest_LIB Xtst ${X11_LIB_SEARCH_PATH})
-</code>
+</pre>
 So the missing library is Xtst. You then need to find it (perhaps installing a libXtst-devel library) and re-run cmake.
@@ Line 139: / Line 139: @@
 Here's the most simple CMakeLists.txt:
-<code>
+<pre>
 add_executable(hello main.cpp)
-</code>
+</pre>
 This will create an executable named "hello" (or "hello.exe" under Windows) from the source file main.cpp. You can mix C and C++ files as you want.  You can have multiple executables and libraries in one CMakeLists.txt.  The same source file can be used in multiple targets, it will be compiled for each target independently from the other targets.  Probably the most important part of the cmake language are the variables:
-<code>
+<pre>
 set( MY_SOURCES main.cpp widget.cpp)
 message(STATUS "my sources: ${MY_SOURCES}")
-</code>
+</pre>
 So, use the SET() command to set the value of a variable. If you list more than one string, the variable will be a list.   A list is a list of strings separated by semicolons. If you set it to only one item, it will have just that value. To get the value of a variable, use ${VAR}.
 You can iterate over a list using FOREACH():
-<code>
+<pre>
 foreach(next_ITEM ${MY_SOURCES})
     message(STATUS "next item: ${next_ITEM}")
 endforeach(next_ITEM ${MY_SOURCES})
-</code>
+</pre>
 The commands in CMake are case-insensitive.  Names of variables and names of parameter are case-sensitive.
 You can also test for various things:
-<code>
+<pre>
 if (UNIX)
     message(STATUS "This is UNIX (including OS X and CygWin)")
@@ Line 165: / Line 165: @@
     set(MY_SRCS ${MY_SRCS} winextra.cpp)
 endif (MSVC)
-</code>
+</pre>
 In this second example  you can see also how to append items to a list.
@@ Line 173: / Line 173: @@
 Here's a basic CMakeList file that builds a small KDE 4 project:
-<code>
+<pre>
 project( kde4project )
 find_package( KDE4 REQUIRED )
@@ Line 187: / Line 187: @@
 install( TARGETS kde4project  ${INSTALL_TARGETS_DEFAULT_ARGS} )
-</code>
+</pre>
 ''target_link_libraries'' contains the development libraries that are linked to your program. E.g. if you want to link to libtidy-devel, your library file name may be called /usr/local/lib/libtidy.a. You would then add -ltidy to a gcc call. Here, you add ''tidy'' to your target_link_libraries. If possible, use pre-defined variables or macros like ${KDE4_KDEUI_LIBS}.
@@ Line 202: / Line 202: @@
 == Converting autotools-based KDE software to CMake ==
 In kdesdk/cmake/ you can find a script am2cmake . This is a ruby script, so you need to have ruby installed. Run am2cmake in the toplevel directory of your sources:
-<code>
+<syntaxhighlight lang="bash">
 $ cd src/mykooltool/
 $ am2cmake --kde4
-</code>
+</syntaxhighlight>
-Don't forget the switch "--kde4", otherwise it won't generate files suitable for KDE 4 software. The converted files 'may' work as they are, but complicated projects will require some additional editing.
+Don't forget the switch <tt>--kde4</tt>, otherwise it won't generate files suitable for KDE 4 software. The converted files 'may' work as they are, but complicated projects will require some additional editing.
 You may have to:

@@ Line 98: / Line 98: @@
 Some cmake command line variables you may want to set:
 * '''CMAKE_INSTALL_PREFIX''': cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4 is the equivalent to ./configure --prefix=/opt/kde4
-* '''[[Development/CMake/Addons_for_KDE#Buildtypes|CMAKE_BUILD_TYPE]]''': decide which type of build you want. You can choose between "debugfull", "Debug", "Profile", "RelWithDebInfo" and "Release". The default is "RelWithDebInfo". Please refer to page [[Development/CMake/Addons_for_KDE#Buildtypes|CMake Build Types]] for a more detailed explanation.
+* '''[[Development/CMake/Addons_for_KDE#Buildtypes|CMAKE_BUILD_TYPE]]''': decide which type of build you want. You can choose between "DebugFull", "Debug", "Profile", "RelWithDebInfo" and "Release". The default is "RelWithDebInfo". Please refer to page [[Development/CMake/Addons_for_KDE#Buildtypes|CMake Build Types]] for a more detailed explanation.
 * '''KDE4_BUILD_TESTS=ON''': creates Makefiles with build test programs and also provides 'test' targets
 * '''KDE4_TEST_OUTPUT=xml''': Unit tests using the QTestLib framework will create xml formatted logfiles.

@@ Line 106: / Line 106: @@
 === Environment Variables ===
-If you have headers and libraries installed in non-standard locations that cmake cannot find (e.g., fink on Mac OSX installs to /sw), then set the following as environment variables.  This can be also very
+If you have headers and libraries installed in non-standard locations that cmake cannot find (e.g., fink on Mac OSX installs to /sw), then populate the environment variable CMAKE_PREFIX_PATH with a list of paths to these locations.  When searching for headers, libraries and binaries, CMake will search all the paths in CMAKE_PREFIX_PATH as well as their standard subdirectories ("lib" for libraries, "include" for headers and "bin" for binaries). This can be also very useful e.g. if you install kdesupport to ~/install/kdesupport.
-useful e.g. if you install kdesupport to ~/install/kdesupport .
+* '''CMAKE_PREFIX_PATH''', eg. export CMAKE_PREFIX_PATH=/sw
-Despite the similar naming convention, these will not work as arguments on the cmake command line:
-* '''CMAKE_INCLUDE_PATH''', eg. export CMAKE_INCLUDE_PATH=/sw/include
+If you need to further tweak the search behavior, you can additionally set the
 * '''CMAKE_LIBRARY_PATH''', eg. export CMAKE_LIBRARY_PATH=/sw/lib
 * '''CMAKE_PROGRAM_PATH''', eg. export CMAKE_PROGRAM_PATH=/sw/bin
 For more information on variables, see [http://www.cmake.org/Wiki/CMake_Useful_Variables this cmake.org wiki page]