Difference between revisions of "Development/Tutorials/CMake (ko)"

Revision as of 16:40, 5 January 2008

Development/Tutorials/CMake

소개

CMake는 스크립트 파일을 읽고, 그것이 실행되는 플랫폼의 native 빌드 시스템의 위해 input 파일들을 생성한다. 이것은 GNU Makefile, KDevelop 프로젝트파일, XCode 프로젝트 파일, 그리고 Visual Studio 프로젝트 파일을 생성할수 있다.

CMake reads script files and produces input files for the native buildsystem of the platform where it runs on. It can create GNU Makefiles, KDevelop project files, XCode project files, and Visual Studio project files.

CMake는 자유 소프트웨어이고, BSD-style 라이센스 한에서 릴리즈된다. 이것은 Kitware Inc.에 의해 개발되었다.

CMake is free software and released under a BSD-style license. It is developed by Kitware Inc.

아래의 링크들은 일반적으로 CMake에 대해 배울수 있는 몇몇 괜찮은 곳들이다.:

• CMake 메뉴얼
• CMake 위키
• CMake 시스템 검사
• 추가적인 패키지 찾기
• CMake 위키에서의 KDE 4 튜트리얼
• CMake FAQ
• kde-buildsystem 메일링 리스트 문서

Here are some good places to learn about CMake in general:

• CMake Manual
• CMake Wiki
• CMake System Checks
• Finding Optional Packages
• KDE 4 Tutorial at the CMake Wiki
• CMake FAQ
• The kde-buildsystem Mailing List Archive

또한 CMake 메일링 리스트에 가입하는 것을 고려해보라.

Also, consider joining the CMake mailing list.

왜 CMake를 사용하는가

CMake는 2006년 3월에 결정된 KDE 4 release의 공식적인 도구이다. 첫번째로 오래된 KDE 도구 automake와 unsermake와 비교하여 기술적인 장점때문이다.:

• CMake는 KDE와 독립적으로 개발되었다. 이것은 다른 프로젝트에서도 잘 사용되어질 수 있다.
• 컴파일 시간이 훨신 빠른데, 대개 더이상 libtool을 사용하지 않아도 되기 때문이다.
• 빌드 파일들을 작성하기 더 쉬워졌다.

CMake is the official tool of KDE 4 release, decided in March 2006, primarily due to technical merits as compared to the older KDE tools automake and unsermake:

• CMake is developed independently of KDE, it can be used by other projects as well
• Compilation time is much faster, mainly due to not using libtool anymore
• The build files are easier to write

CMake를 사용하여 KDE를 어떻게 컴파일하는가

CMake를 얻고 설치하기

Linux, BSD, and other Unix Systems

[1]에서 CMake의 마지막 버전을 검색한다.

Retrieve the latest stable version of CMake from [2].

다운로드 하여 압축을 풀고, 컴파일 한다.:

Once downloaded, unpack and compile it:

$ mkdir cmake-build $ cd cmake-build $ ../bootstrap $ make $ make install

기본적으로 이것은 CMake를 /user/local 안에 설치할 것이다. 그러므로 당신의 실행 경로 안에/user/local/bin을 가지고 있도록 해야한다. 만약 설치 prefix를 바꾸려면, (예를 들어 데비안에서는 /usr로), '--prefix=PATH' 옵션을 bootstrap 명령에 추가하라.

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.

만약 현재 개발버전을 사용하기를 원한다면, here에 위치한 설명에 따르라.

Please follow the instructions located here if you would like to use the current development version.

Windows

[3]에서 CMake의 가장 마지막 안정 버전을 검색하라.

Retrieve the latest stable version of CMake from [4].

다운로드받아서 cmake 인스톨러를 설치하라.

Once downloaded, run the cmake installer.

기본적으로 이것은 C:\Program Files\CMake 2.4에 설치될 것이다. 그러므로 당신의 실행 경로에 <installpath>\bin를 추가시켜야 한다.

By default, this will install CMake in C:\Program Files\CMake 2.4, so make sure to have <installpath>\bin in your execute path.

만약 현재 개발 버전을 사용하기를 원한다면, here의 설명에 따르라.

Please follow the instructions at here if you would like to use the current development version.

CMake 실행하기

Linux, BSD, and other Unix Systems

당신의 시스템을 위해 빌드 파일들을 생성하기 위해서는 CMake를 실행해야 한다. in-source(소스 안에서)와 out-of-source(소스 밖에서) 둘 다 CMake에 의해 지원된다. 그러나 현재 in-source(소스 안에서) 빌드는 KDE 구현에 의하여 막혀져 있다.

You have to run CMake so that it generates the build files for your system. Both in-source and out-of-source builds are supported by CMake, but currently in-source builds are prevented by the KDE implementation.

그러므로 ~/src/kdelibs/ 안에 kdelibs/를 가지고 있다고 한다면, 다음을 수행한다.

So, let's say you have kdelibs/ in ~/src/kdelibs/, then do the following:

$ ls kdelibs/ $ mkdir kdelibs-build $ cd kdelibs-build $ cmake ../kdelibs 이것은 kdelibs-build/ 안에 kdelibs의 빌드를 위해 Makefile을 생성할 것이다.

This will generate the Makefiles for building kdelibs/ in kdelibs-build/.

Windows

당신의 시스템을 위해 빌드 파일들을 생성하기 위해서는 CMake를 실행해야 한다. in-source(소스 안에서)와 out-of-source(소스 밖에서) 둘 다 CMake에 의해 지원된다. 그러나 현재 in-source(소스 안에서) 빌드는 KDE 구현에 의하여 막혀져 있다.

You have to run CMake so that it generates the build files for your system. Both in-source and out-of-source builds are supported by CMake, but currently in-source builds are prevented by the KDE implementation.

c:\daten\kde4 안에 kdelib\를 가지고 있다고 한다면, 다음을 수행한다.: c:\daten\kde4> cd kdelibs\win c:\daten\kde4> cmake c:\daten\kde4> make c:\daten\kde4> make install c:\daten\kde4> cd .. c:\daten\kde4> mkdir kdelibs-build c:\daten\kde4> cd kdelibs-build c:\daten\kde4\kdelibs-build> cmake ..\kdelibs

이것은 kdelibs-build/ 안에 kdelibs의 빌드를 위해 Makefile을 생성할 것이다. 윈도우에서 KDE 컴파일에 관한 정보를 얻고 싶다면, KDE on Windows를 참고하라.

See KDE on Windows for more informations about compiling KDE on Windows.

KDevelop 프로젝트 파일

만약 (기본적으로 KDevelop를 위한 몇몇 파일에 의해 Makefile이 동반되는)KDevelop를 위한 프로젝트 파일을 좋아한다면, 이것과 같이 실행하라.

If you prefer project files for KDevelop (which will basically be Makefiles accompanied by some extra files for KDevelop), run it like this:

$ cmake ../kdelibs -GKDevelop3 CMake가 지원하는 것과 다른 옵션을 찾기 위해 'cmake -h'를 사용하라.

Use 'cmake -h' to find out which generators CMake supports and the other options.

CMake와 Qt4

Qt 4에 위치한 곳을 찾아내기 위해, CMake는 당신의 실행 경로에서 qmake를 찾는다. CMake는 QTDIR 환경 변수를 사용하지 않는다. 그러므로, 실행 경로에서 찾은 처음 qmake가 사용하기 원하는 것인지 확인하라.

To locate Qt 4, CMake searches for qmake in your execute path. CMake does not use the QTDIR environment variable. So make sure that the first qmake found in the execution path is the one you like to use.

더 자세한 세부사항

CMake가 종료되었을 때, "CMakeCache.txt"라는 파일이 생성될 것이다. 이것은 당신의 시스템에서 CMake가 찾은 모든 설정을 포함한다. 만약 다른 생성 프로그램으로 CMake를 수행하기를 원하거나, CMake가 모든 것을 다시 찾기를 원한다면 이 파일을 지워라.

When CMake has finished, it will have created a file called "CMakeCache.txt". This file contains all the settings CMake has detected on your system. If you want to run CMake with another generator or you want CMake to detect everything again, delete this file.

만약 CMake가 무언가를 찾지 않았지만, 당신이 이것이 당신의 상자의 어딘가에 있다는 것을 안다면, 당신은 CMake에게 찾을 곳을 수동적으로 알려줄 수 있다. CMake는 이 정보를 저장하는 변수를 사용한다. 이 변수들은 이미 언급된 CMakeCache.txt 파일에 캐시된다. 이 변수들을 수동적으로 적용하기 위해 3가지 방법이 있다.

If CMake didn't find something, but you know it is somewere on your box, you can tell CMake manually where to find it. CMake uses variables to store this information. These variables are cached in the already mentioned file CMakeCache.txt. You have three options to adjust these variables manually:

• 커맨드 라인 하에서 올바른 값을 CMake에게 말하기 : cmake ../kdelibs -DNAME_OF_THE_VARIABLE=value
• CMake 변수를 정용하기 위해 GUI 기반의 커서를 제공하는 ccmake를 사용하기(실행: ccmake ../kdelibs)
• CMakeCache.txt를 직접 수정하기(추천하지 않는다.)

* tell CMake the correct value via the command line: cmake ../kdelibs -DNAME_OF_THE_VARIABLE=value

• use ccmake, which provides a curses based GUI to adjust the CMake variables (run: ccmake ../kdelibs)
• edit the file CMakeCache.txt directly (not recommended)

당신은 최소한 한번은 "ccmake ../kdelibs"를 실행해야 한다. 그래서 CMake가 사용하는 변수의 결과물을 얻는다. "T"를 누르고 "advanced" 변수를 보기 위해 "T"를 눌러라. 그래서 CMake가 아무것도 찾지 않았다면, ccmake를 시작하고, 수동적으로 그것을 적용하라.

You should run "ccmake ../kdelibs" at least once so that you get an impression which variables CMake uses. Press "T" to see also the "advanced" variables. So, if CMake didn't find something, start ccmake and adjust it manually.

커맨드 라인 변수들

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
• CMAKE_BUILD_TYPE: decide which type of build you want. You can chose between "debugfull", "debug", "profile", "relwithdebinfo" and "release". The default is "relwithdebinfo" (-O2 -g). See FindKDE4Internal.cmake for details.
• 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.
• KDE4_DISABLE_MULTIMEDIA=ON: Build KDE without any multimedia (audio and video) support.
• RPATH_STYLE: This is not available anymore. By default everything will be built with RPATH set correctly. If you don't want RPATH at all, set CMAKE_SKIP_RPATH to TRUE.
• BUILD_foo=OFF: disables the build for the project in subdirectory 'foo'.
• WITH_foo: there are several options, e.g. WITH_CUPS or WITH_Jasper. If you disable them, cmake will not even try to find this package. If it is enabled, cmake will try to find it. If it fails with this, you can still adjust it manually as described above.

환경 변수들

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. 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
• CMAKE_LIBRARY_PATH, eg. export CMAKE_LIBRARY_PATH=/sw/lib

For more information on variables, see this cmake.org wiki page

Going Further

If cmake finishes with "Generating done" then there was no errors, but if it finishes with "Configuring done" then there was errors that you have to fix. Once cmake finishes successfully, run your buildtool (i.e. make, KDevelop, XCode or MSVC) and build and wait until it has finished. Then "make install".

If you got a failure that says something like 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) 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 FIND_LIBRARY(X11_XTest_LIB Xtst ${X11_LIB_SEARCH_PATH}) So the missing library is Xtst. You then need to find it (perhaps installing a libXtst-devel library) and re-run cmake.

간단한 어플리케이션을 위한 CMake 사용하기

Here's the most simple CMakeLists.txt: add_executable(hello main.cpp) 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: SET( MY_SOURCES main.cpp widget.cpp) MESSAGE(STATUS "my sources: ${MY_SOURCES}") 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(): FOREACH(next_ITEM ${MY_SOURCES})

  MESSAGE(STATUS "next item: ${next_ITEM}")

ENDFOREACH(next_ITEM ${MY_SOURCES}) The commands in CMake are case-insensitive. Names of variables and names of parameter are case-sensitive.

You can also test for various things: IF (UNIX)

  MESSAGE(STATUS "This is UNIX (including OS X and CygWin)")

  SET(MY_SRCS ${MY_SRCS} winextra.cpp)

ENDIF (MSVC) In this second example you can see also how to append items to a list.

In the cmake Wiki there is also a tutorial on using cmake to build KDE 4 software. It is recommended reading.

KDE 프로젝트를 위한 CMake 사용하기

Here's a basic CMakeList file that builds a small KDE 4 project: PROJECT(kde4project) FIND_PACKAGE(KDE4 REQUIRED) INCLUDE_DIRECTORIES( ${KDE4_INCLUDES} )

SET(KDE4ProjectSources kde4mainapp.cpp someclass.cpp someotherclass.cpp)

KDE4_ADD_EXECUTABLE(kde4project ${KDE4ProjectSources} )

TARGET_LINK_LIBRARIES(kde4project ${KDE4_KDEUI_LIBS} ${KDE4_KPARTS_LIBS} )

Variables, macros and other useful information specific to KDE can be found at the Development/KDE and CMake Together page.

CMake 확장

CMake can be extended using cmake scripts. CMake comes with a number of scripts; under UNIX they are by default installed to /usr/local/share/CMake/Modules/. The KDE libraries install also a set of cmake modules into share/apps/cmake/modules/. The files located there will be preferred over the ones in the system global cmake module path. For detecting software packages there are FindFOO.cmake files, see here for more information. You can also write macros in CMake. They are powerful enough to do most things you will need to build software, but they are not intended to be used as a general purpose programming language.

CMake로 autotools 기반의 KDE 소프트웨어를 변환하기

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: $ cd src/mykooltool/ $ am2cmake --kde4 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.

You may have to:

• add more include direcories, using INCLUDE_DIRECTORIES()
• add more link libraries, using TARGET_LINK_LIBRARIES()
• add some compile switches, using ADD_DEFINITIONS()
• add some "configure" checks, see How To Do Platform Checks and How To Find Installed Software
• take special care of former libtool convenience libraries. They are not supported by cmake, instead there will be a file ConvenienceLibs.cmake created. In this file you will find for every convenience lib a variable, which contains all source files of this convenience lib. For the targets which linked to this convenience lib, just add the variable to the sources.
• a file AdditionalInfo.txt will be created. There you will see all *.in and *.in.in files of your project. The stuff done in these files will have to be converted manually to cmake.

자주묻는 질문들

CMake 문법과 들여쓰기에 대해 내가 좋아하는 에디터에 어떻게 설정할 수 있습니까?

CMake 위키의 CMake 에디터 지원 섹션을 읽어라. 이것은 Emacs(XEmacs도 동작한다.), VIM, Kate, KWrite, 그리고 KDevelop에서 어떻게 설정하는지에 대해 설명한다.

Read the CMake Wiki section CMake Editors Support. It describes how to setup Emacs (XEmacs works too), VIM, Kate, KWrite, and KDevelop.

나는 빌드 중에 몇몇 파일들을 생성하는 것이 필요합니다. 어떻게 해야 합니까?

ADD_CUSTOM_COMMAN()를 사용하라. 이것은 CMake 위키 안의빌드하는 동안 어떻게 소스파일을 생성할 수 있는 방법

섹션에서 설명되어진다.

Use ADD_CUSTOM_COMMAND(). It's explained here in the CMake wiki: How can I generate a source file during the build

I need to build an executable which is used later on during the build to generate files. How do I do this ?

Let's say the executable is called genembed. Then use KDE4_ADD_EXECUTABLE(foo RUN_UNINSTALLED ${fooSources})to create the executable. The RUN_UNINSTALLED option is important, because the executable has to run from the build dir and has to link to the libraries in the builddir. To achieve this, the executable is compiled with RPATH set accordingly and a wrapper shell script, named just like the executable but with the suffix ".sh" is created. This shell scripts sets up LD_LIBRARY_PATH and the calls the actual executable. Use this wrapper shell script in the ADD_CUSTOM_COMMAND() as described above. You can find out the name and exact location by querying the property WRAPPER_SCRIPT. Here's a full example taken from kdelibs/kstyles/keramik/ :

 COMMAND ${GENEMBED_EXECUTABLE} --file ${CMAKE_CURRENT_BINARY_DIR}/keramikPics.txt > \
 ${CMAKE_CURRENT_BINARY_DIR}/pixmaps.keramik
 DEPENDS genembed ${keramikPics}

)

As you can see genembed is also listed as a dependency, this means cmake knows that it has to build the executable genembed before executing this rule.

I don't want to set the -DCMAKE_INSTALL_PREFIX command line option. Does cmake support the KDEDIR environment variable?

No. $KDEDIR is deprecated in KDE 4.

Why do i get compile errors like /usr/lib/qt4/include/QtCore/qstring.h:536: undefined reference to `QString::fromLatin1_helper(char const*, int)'?

A: If you have an old Qt4 version in your qt/lib directory you must delete the old (4.0.1) files.

How do I tell cmake to create noisy makefiles? I want to see the exact commands that are run during the make process.

Pass the VERBOSE variable to make, i.e. % make VERBOSE=1 or % VERBOSE=1 make

For more details see the CMake wiki: Is there an option to produce more 'verbose' compiling?

There is no 'make distclean' target in the generated Makefiles. How do I clean up everything, including the cache files?

Simply remove the build directory, or just the contents of the build directory.