CMake 基本使用方法--写CMakeList.txt
来源：互联网 发布：办公软件的优缺点 编辑：程序博客网 时间：2024/06/14 08:19
这一章将从软件开发者的角度来描述如何实用CMake。也就是说，如果你的目标是用CMake来管理你的生成过程，请阅读这一章。
CMake的输入
COMMAND(args)
这里的 COMMAND是命令行的名称，args是用空格分割的参数列表。典型的，对与每一个项目的目录存在一个CMakeLists.txt。下面我们将从一个简单的Hello world例子开始介绍, 它的源代码树形文件包含这些文件：
Hello.c CMakeLists.txt
CMakeLists.txt将包含下面两行：
PROJECT（Hello)
ADD_EXECUTABLE(HelloHello.c）
为了生成Hello的可执行程序，你只需依照上面CMake运行的过程描述来生成makefiles文件。 PROJECT命令表明了产生的工作空间的名称。ADD_EXECUTABLE命令添加可执行的目标到生成程序。这个简单的程序就只需要这些设置。如果你的项目需要一些文件才能编译也很容易，只想修改ADD_EXECUTABLE命令行如下：
ADD_EXECUTABLE（Hello Hello.c File2.c File3.c File4.c)
ADD_EXECUTABLE只是很多CMake命令中的一种。比如更复杂的如下：
PROJECT(HELLO)
SET(HELLO_SRCS Hell.c File2.c File3.c)
IF(WIN32)
SET(HELLO_SRCS ${HELLO_SRCS} WinSupport.c)
ELSE (WIN32)
SET(HELLO_SRCS ${HELLO_SRCS}UnixSupport.c)
ENDIF (WIN32)
ADD_EXECUTABLE (Hello ${HELLO_SRCS})
#look for the Tcl library
FIND_LIBRARY(TCL_LIBRARY NAMES tcl tc184 tc183 tc 182 tc 180
PATHS /usr/lib /usr/local/lib)
IF (TCL_LIBRARY)
TARGET_ADD_LIBRARY (Hello TCL_LIBRARY)
ENDIF(TCL_LIBRARY)
在这个例子中 SET 命令用于将源文件组成一个列表。 IF命令用于增加WinSupport.c或者UnixSupport.c到列表中。 最后 ADD_EXECUTABLE 命令用于采用源文件列表HELLO_SRCS中列出的文件生成可执行文件。FIND_LIBRARY命令用于寻找在一些指定目录下的特定的Tcl库文件。如果找到了，就将他们添加到Hello可执行程序的链接命令。#行为注释行。
CMake 是会定义一些使用的变量在CMakeList文件中。比如，WIN32总是会在windows系统中被定义，而UNIX
总是在UNIX系统中被定义。
生成目标：（Build Targets)
SET()
SUBDIRS()
ADD_LIBRARY()
这里生成静态链接文件，例如ADD_LIBRARY(Whole${HELLO_SRC}),就会生成一个libWhole.a可供链接
ADD_EXECUTABLE()
AUX_SOURCE_DIRECTORY()
PROJECT()
CMake会循环的查找从当前目录到SUBDIRS列出的任何子目录的文件。SET命令用于设定一个变量。ADD_LIBRARY将添加一个库到目标之中。ADD_EXECUTABLE添加一个可执行程序到目标列表中。（Note:编译器执行的顺序是先编译源文件，然后生成库文件，最后生成可执行文件）。AUX_SOURCE_DIRECTORY表示一个不在当前目录的包含源文件的目录。这些源代码将插入当前的库（LIBRARY）中。所有在AUX_SOURCE_DIRECTORY的文件将被编译（如，*.c,*.cxx,*.cpp等等）。PROJECT（ProjectName）是一个用在MSVC中的特殊变量，用于为编译器生成项目。他也为CMAKE定义两个有用的变量:ProjectName_SOURCE_DIR和ProjectName_BINARY_DIR.
编译的标示和选项。除了上面列出的命令外，CMakeLists.txt还包含如下的命令：
INCLUDE_DIRECTORIES()
LINK_DIRECTORIES()
LINK_LIBRARIES()
TARGET_LINK_LIBRARIES()
这些命令定义了用于编译源代码和生成可执行程序的目录和库。上面列出的目录的一个很重要的特性是它们会被任何子目录继承。也就是说，CMake依照目录的分层结构来承袭这些命令。在每次遇到对这些命令的描述的时候都会被展开一次。比如说，如果在顶层的CMakeLists文件中有定义INCLUDE_DIRECTORIES(/usr/include)和SUBDIRS（./subdir1),并且在./subdir1/CMakeLists.txt有INCLUDE_DIRECTORIES(/tmp/foobar),于是最后网状的结果是
INCLUDE_DIRECTORIES(/usr/include /tmp/foobar)
CMake会定义许多的模块来查找通常会用到的包，比如OpenGL或Java。这些模块为你节省了很多的时间来编写这些查找包。这些模块可以像这样加到你的CMakeList文件中，如下：
INCLUDE(${CMAKE_ROOT}/Modules/FindTCL.cmake)
CMAKE_ROOT总是定义在CMake中，用于指向CMake安装的路径。查看Modules子目录下的一些文件可以给你提供一些很好的idea关于怎样用这些CMake命令。
给项目文件添加一个新的目录
一个通用的方法来扩展一个项目文件是给他添加一个新的文件夹。这将包含三个步骤：
1.创建一个新的目录在你的源代码的分层目录中
2.将这个新的目录添加到SUBDIRS命令中
3.在这个新创建的目录中用适当的命令建立一个CMakeLists.txt文件
This section describes how to use CMake from the softwaredeveloper's point of view. That is, if your aim is to use CMake tomanage your build process, read this section first.
Input to CMake
COMMAND(args)
Where COMMAND is the name of the command, and args is a white-spaceseparated list of arguments to the command. (Arguments withembedded white-space should be quoted.) Typically there will be aCMakeLists.txt file for each directory of the project. Let's startwith a simple example. Consider building hello world. You wouldhave a source tree with the following files:
Hello.c CMakeLists.txt
The CMakeLists.txt file would contain two lines:
PROJECT (Hello)
ADD_EXECUTABLE(Hello Hello.c)
To build the Hello executable you just follow the process describedin Running CMake above to generate the makefiles or Microsoftproject files. The PROJECT command indicates what the name of theresulting workspace should be and the ADD_EXECUTABLE command addsan executable target to the build process. That's all there is toit for this simple example. If your project requires a few files itis also quite easy, just modify the ADD_EXECUTABLE line as shownbelow.
ADD_EXECUTABLE(Hello Hello.c File2.c File3.c File4.c)
ADD_EXECUTABLE is just one of many commands available in CMake.Consider the more complicated example below.
PROJECT (HELLO)
SET(HELLO_SRCS Hello.c File2.c File3.c)
IF (WIN32)
SET(HELLO_SRCS ${HELLO_SRCS} WinSupport.c)
ELSE (WIN32)
SET(HELLO_SRCS ${HELLO_SRCS}UnixSupport.c)
ENDIF (WIN32)
ADD_EXECUTABLE (Hello ${HELLO_SRCS})
# look for the Tcl library
FIND_LIBRARY(TCL_LIBRARY NAMES tcl tcl84 tcl83 tcl82 tcl80
PATHS /usr/lib/usr/local/lib)
IF (TCL_LIBRARY)
TARGET_ADD_LIBRARY (Hello TCL_LIBRARY)
ENDIF (TCL_LIBRARY)
In this example the SET command is used to group together sourcefiles into a list. The IF command is used to add eitherWinSupport.c or UnixSupport.c to this list. And finally theADD_EXECUTABLE command is used to build the executable with thefiles listed in the source list HELLO_SRCS. The FIND_LIBRARYcommand looks for the Tcl library under a few different names andin a few different paths, and if it is found adds it to the linkline for the Hello executable target. Note the use of the #character to denote a comment line.
CMake always defines some variables for use within CMakeList files.For example, WIN32 is always defined on windows systems and UNIX isalways defined for UNIX systems. CMake defines a number ofcommands. A brief summary of the most commonly used commandsfollows here. Later in the document an exhaustive list of allpre-defined commands is presented. (You may also add your owncommands, see the Extension Guide for more information.)
Build Targets:
SET()
SUBDIRS()
ADD_LIBRARY()
这里生成静态链接文件，例如ADD_LIBRARY(Whole${HELLO_SRC})，就会生成一个libWhole.a，可供链接。
ADD_EXECUTABLE()
AUX_SOURCE_DIRECTORY()
PROJECT()
CMake works recursively, descending from the current directory intoany subdirectories listed in the SUBDIRS command. The command SETis used for setting a variable, in this case to a list of sourcefiles. (Note: currently only C and C++ code can be compiled.)ADD_LIBRARY adds a library to the list of targets this makefilewill produce. ADD_EXECUTABLE adds an executable to the list oftargets this makefile will produce. (Note: source code is compiledfirst, then libraries are built, and then executables are created.)The AUX_SOURCE_DIRECTORY is a directory where other source code,not in this directory, whose object code is to be inserted into thecurrent LIBRARY. All source files in the AUX_SOURCE_DIRECTORY arecompiled (e.g. *.c, *.cxx, *.cpp, etc.). PROJECT (PojectName) is aspecial variable used in the MSVC to create the project for thecompiler, it also defines two useful variables for CMAKE:ProjectName_SOURCE_DIR and ProjectName_BINARY_DIR.
Build flags and options. In addition to the commands listed above,CMakeLists.txt often contain the following commands:
INCLUDE_DIRECTORIES()
LINK_DIRECTORIES()
LINK_LIBRARIES()
TARGET_LINK_LIBRARIES()
These commands define directories and libraries used to compilesource code and build executables. An important feature of thecommands listed above is that are inherited by any subdirectories.That is, as CMake descends through a directory hierarchy (definedby SUBDIRS()) these commands are expanded each time a definitionfor a command is encountered. For example, if in the top-levelCMakeLists file has INCLUDE_DIRECTORIES(/usr/include), withSUBDIRS(./subdir1), and the file ./subdir1/CMakeLists.txt hasINCLUDE_DIRECTORIES(/tmp/foobar), then the net result is
INCLUDE_DIRECTORIES(/usr/include /tmp/foobar)
CMake comes with a number of modules that look for commonly usedpackages such as OpenGL or Java. These modules save you from havingto write all the CMake code to find these packages yourself.Modules can be used by including them into your CMakeList file asshown below.
INCLUDE(${CMAKE_ROOT}/Modules/FindTCL.cmake)
CMAKE_ROOT is always defined in CMake and can be used to point towhere CMake was installed. Looking through some of the files in theModules subdirectory can provide good ideas on how to use some ofthe CMake commands.
Adding A New Directory to a project
A common way to extend a project is to add a new directory. Thisinvolves three steps:
Create the new directory somewhere in your sourcedirectory hierarchy.
Add the new directory to the SUBDIRS command inthe parent directories CMakeLists.txt
ARGS -n${basename} -o${outfile}${pathname}
CMake的输入
COMMAND(args)
这里的 COMMAND是命令行的名称，args是用空格分割的参数列表。典型的，对与每一个项目的目录存在一个CMakeLists.txt。下面我们将从一个简单的Hello world例子开始介绍, 它的源代码树形文件包含这些文件：
Hello.c CMakeLists.txt
CMakeLists.txt将包含下面两行：
PROJECT（Hello)
ADD_EXECUTABLE(HelloHello.c）
为了生成Hello的可执行程序，你只需依照上面CMake运行的过程描述来生成makefiles文件。 PROJECT命令表明了产生的工作空间的名称。ADD_EXECUTABLE命令添加可执行的目标到生成程序。这个简单的程序就只需要这些设置。如果你的项目需要一些文件才能编译也很容易，只想修改ADD_EXECUTABLE命令行如下：
ADD_EXECUTABLE（Hello Hello.c File2.c File3.c File4.c)
ADD_EXECUTABLE只是很多CMake命令中的一种。比如更复杂的如下：
PROJECT(HELLO)
SET(HELLO_SRCS Hell.c File2.c File3.c)
IF(WIN32)
ELSE (WIN32)
ENDIF (WIN32)
ADD_EXECUTABLE (Hello ${HELLO_SRCS})
#look for the Tcl library
FIND_LIBRARY(TCL_LIBRARY NAMES tcl tc184 tc183 tc 182 tc 180
IF (TCL_LIBRARY)
ENDIF(TCL_LIBRARY)
在这个例子中 SET 命令用于将源文件组成一个列表。 IF命令用于增加WinSupport.c或者UnixSupport.c到列表中。 最后 ADD_EXECUTABLE 命令用于采用源文件列表HELLO_SRCS中列出的文件生成可执行文件。FIND_LIBRARY命令用于寻找在一些指定目录下的特定的Tcl库文件。如果找到了，就将他们添加到Hello可执行程序的链接命令。#行为注释行。
CMake 是会定义一些使用的变量在CMakeList文件中。比如，WIN32总是会在windows系统中被定义，而UNIX
总是在UNIX系统中被定义。
生成目标：（Build Targets)
SET()
SUBDIRS()
ADD_LIBRARY()
ADD_EXECUTABLE()
AUX_SOURCE_DIRECTORY()
PROJECT()
CMake会循环的查找从当前目录到SUBDIRS列出的任何子目录的文件。SET命令用于设定一个变量。ADD_LIBRARY将添加一个库到目标之中。ADD_EXECUTABLE添加一个可执行程序到目标列表中。（Note:编译器执行的顺序是先编译源文件，然后生成库文件，最后生成可执行文件）。AUX_SOURCE_DIRECTORY表示一个不在当前目录的包含源文件的目录。这些源代码将插入当前的库（LIBRARY）中。所有在AUX_SOURCE_DIRECTORY的文件将被编译（如，*.c,*.cxx,*.cpp等等）。PROJECT（ProjectName）是一个用在MSVC中的特殊变量，用于为编译器生成项目。他也为CMAKE定义两个有用的变量:ProjectName_SOURCE_DIR和ProjectName_BINARY_DIR.
编译的标示和选项。除了上面列出的命令外，CMakeLists.txt还包含如下的命令：
INCLUDE_DIRECTORIES()
LINK_DIRECTORIES()
LINK_LIBRARIES()
TARGET_LINK_LIBRARIES()
这些命令定义了用于编译源代码和生成可执行程序的目录和库。上面列出的目录的一个很重要的特性是它们会被任何子目录继承。也就是说，CMake依照目录的分层结构来承袭这些命令。在每次遇到对这些命令的描述的时候都会被展开一次。比如说，如果在顶层的CMakeLists文件中有定义INCLUDE_DIRECTORIES(/usr/include)和SUBDIRS（./subdir1),并且在./subdir1/CMakeLists.txt有INCLUDE_DIRECTORIES(/tmp/foobar),于是最后网状的结果是
INCLUDE_DIRECTORIES(/usr/include /tmp/foobar)
CMake会定义许多的模块来查找通常会用到的包，比如OpenGL或Java。这些模块为你节省了很多的时间来编写这些查找包。这些模块可以像这样加到你的CMakeList文件中，如下：
INCLUDE(${CMAKE_ROOT}/Modules/FindTCL.cmake)
CMAKE_ROOT总是定义在CMake中，用于指向CMake安装的路径。查看Modules子目录下的一些文件可以给你提供一些很好的idea关于怎样用这些CMake命令。
给项目文件添加一个新的目录
一个通用的方法来扩展一个项目文件是给他添加一个新的文件夹。这将包含三个步骤：
1.创建一个新的目录在你的源代码的分层目录中
2.将这个新的目录添加到SUBDIRS命令中
3.在这个新创建的目录中用适当的命令建立一个CMakeLists.txt文件
This section describes how to use CMake from the softwaredeveloper's point of view. That is, if your aim is to use CMake tomanage your build process, read this section first.
Input to CMake
COMMAND(args)
Where COMMAND is the name of the command, and args is a white-spaceseparated list of arguments to the command. (Arguments withembedded white-space should be quoted.) Typically there will be aCMakeLists.txt file for each directory of the project. Let's startwith a simple example. Consider building hello world. You wouldhave a source tree with the following files:
Hello.c
The CMakeLists.txt file would contain two lines:
PROJECT (Hello)
ADD_EXECUTABLE(Hello Hello.c)
To build the Hello executable you just follow the process describedin Running CMake above to generate the makefiles or Microsoftproject files. The PROJECT command indicates what the name of theresulting workspace should be and the ADD_EXECUTABLE command addsan executable target to the build process. That's all there is toit for this simple example. If your project requires a few files itis also quite easy, just modify the ADD_EXECUTABLE line as shownbelow.
ADD_EXECUTABLE(Hello Hello.c File2.c File3.c File4.c)
ADD_EXECUTABLE is just one of many commands available in CMake.Consider the more complicated example below.
PROJECT (HELLO)
SET(HELLO_SRCS Hello.c File2.c File3.c)
IF (WIN32)
ELSE (WIN32)
ENDIF (WIN32)
ADD_EXECUTABLE (Hello ${HELLO_SRCS})
# look for the Tcl library
FIND_LIBRARY(TCL_LIBRARY NAMES tcl tcl84 tcl83 tcl82 tcl80
IF (TCL_LIBRARY)
ENDIF (TCL_LIBRARY)
In this example the SET command is used to group together sourcefiles into a list. The IF command is used to add eitherWinSupport.c or UnixSupport.c to this list. And finally theADD_EXECUTABLE command is used to build the executable with thefiles listed in the source list HELLO_SRCS. The FIND_LIBRARYcommand looks for the Tcl library under a few different names andin a few different paths, and if it is found adds it to the linkline for the Hello executable target. Note the use of the #character to denote a comment line.
CMake always defines some variables for use within CMakeList files.For example, WIN32 is always defined on windows systems and UNIX isalways defined for UNIX systems. CMake defines a number ofcommands. A brief summary of the most commonly used commandsfollows here. Later in the document an exhaustive list of allpre-defined commands is presented. (You may also add your owncommands, see the Extension Guide for more information.)
Build Targets:
SET()
SUBDIRS()
ADD_LIBRARY()
ADD_EXECUTABLE()
AUX_SOURCE_DIRECTORY()
PROJECT()
CMake works recursively, descending from the current directory intoany subdirectories listed in the SUBDIRS command. The command SETis used for setting a variable, in this case to a list of sourcefiles. (Note: currently only C and C++ code can be compiled.)ADD_LIBRARY adds a library to the list of targets this makefilewill produce. ADD_EXECUTABLE adds an executable to the list oftargets this makefile will produce. (Note: source code is compiledfirst, then libraries are built, and then executables are created.)The AUX_SOURCE_DIRECTORY is a directory where other source code,not in this directory, whose object code is to be inserted into thecurrent LIBRARY. All source files in the AUX_SOURCE_DIRECTORY arecompiled (e.g. *.c, *.cxx, *.cpp, etc.). PROJECT (PojectName) is aspecial variable used in the MSVC to create the project for thecompiler, it also defines two useful variables for CMAKE:ProjectName_SOURCE_DIR and ProjectName_BINARY_DIR.
Build flags and options. In addition to the commands listed above,CMakeLists.txt often contain the following commands:
INCLUDE_DIRECTORIES()
LINK_DIRECTORIES()
LINK_LIBRARIES()
TARGET_LINK_LIBRARIES()
These commands define directories and libraries used to compilesource code and build executables. An important feature of thecommands listed above is that are inherited by any subdirectories.That is, as CMake descends through a directory hierarchy (definedby SUBDIRS()) these commands are expanded each time a definitionfor a command is encountered. For example, if in the top-levelCMakeLists file has INCLUDE_DIRECTORIES(/usr/include), withSUBDIRS(./subdir1), and the file ./subdir1/CMakeLists.txt hasINCLUDE_DIRECTORIES(/tmp/foobar), then the net result is
INCLUDE_DIRECTORIES(/usr/include /tmp/foobar)
CMake comes with a number of modules that look for commonly usedpackages such as OpenGL or Java. These modules save you from havingto write all the CMake code to find these packages yourself.Modules can be used by including them into your CMakeList file asshown below.
CMAKE_ROOT is always defined in CMake and can be used to point towhere CMake was installed. Looking through some of the files in theModules subdirectory can provide good ideas on how to use some ofthe CMake commands.
Adding A New Directory to a project
A common way to extend a project is to add a new directory. Thisinvolves three steps:
1. 手工设置编译选项(VC)
# Debug: /MDset(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} /MD /Zi /Od /Ob0 /RTC1")
set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} /MD /Zi /Od /Ob0 /RTC1")
# Release: /MT set(CMAKE_C_FLAGS_RELEASE " /MT /O2 /Ob2 /DNDEBUG")
set(CMAKE_CXX_FLAGS_RELEASE " /MT /O2 /Ob2 /DNDEBUG")
# 链接选项 set(CMAKE_EXE_LINKER_FLAGS "/MANIFEST:NO")
编译类型可以查看:
CMAKE_CONFIGURATION_TYPES
CMAKE_BUILD_TYPE
其中CMAKE_BUILD_TYPE, nmake编译时默认为debug.
可以手工设置为Release.
2. 添加新的编译规则
假设要将tolua的生成规则自己加到编译规则中, 定义宏:
project(TRY_CMAKE)
# tolua.exe set(TOLUA tolua.exe)
# tolua 转换 #
tolua_wrap(outfiles inputfile ... )macro(tolua_wrap outfiles )
# 解析inputfile列表(可变参数) foreach(arg ${ARGN})
# 基本名/绝对路径/目录 get_filename_component(basename ${arg} NAME_WE)
get_filename_component(pathname ${arg} ABSOLUTE)
get_filename_component(src_dir ${pathname} PATH)
# 目标名 SET(outfile ${src_dir}/${basename}_luabind.c)
# 生成规则 add_custom_command(
OUTPUT ${outfile}COMMAND${TOLUA}
ARGS -n${basename} -o${outfile}${pathname}
MAIN_DEPENDENCY${pathname}
) # 目标文件添加到列表 SET(${outfiles} ${${outfiles}} ${outfile})
endforeach(arg)
endmacro(tolua_wrap)
# lua绑定文件 tolua_wrap(LUA_BIND_SRC src/blas.pkg )
add_executable(hello main.c ${LUA_BIND_SRC} )
主要涉及以下几点:
a. macro 宏定义用法
b. foreach(arg ${ARGN}) 解析宏的可变参数
c. get_filename_component 获取文件名/目录等信息
d. add_custom_command 添加生成规则和依赖关系
e. SET(${outfiles} ${${outfiles}} ${outfile}) 宏参数类似一个二级指针, 通过${outfiles}设置
更多学习请查看以下网站:
http://www.cmake.org/Wiki/CMake
0 0
- CMake 基本使用方法--写CMakeList.txt
- CMake 基本使用方法--写CMakeList.txt
- CMake 基本使用方法--写CMakeList.txt
- [转载]CMake 基本使用方法--写CMakeList.txt
- CMake 基本使用方法--写CMakeList.txt
- CMake 基本使用方法--写CMakeList.txt
- CMake 基本使用方法--写CMakeList.txt
- CMake 基本使用方法--写CMakeList.txt
- CMake 基本使用方法--写CMakeList.txt
- CMake 基本使用方法--写CMakeList.txt,Compile ROS package
- CMake 使用方法 & CMakeList.txt
- CMake 使用方法 & CMakeList.txt
- cmake笔记(CMakeList.txt)
- CMake 介绍 & CMakeList.txt
- 怎样编写Cmake的配置文件Cmakelist.txt
- CMakeList.txt脚本文件及Cmake常用命令
- 如何写cmake使其包含c++11特性 （-std=c++11如何写进cmakeList.txt）
- Qt Creator 根据已有的CMakeList.txt创建CMake工程
- c#多态|抽象类|访问修饰符
- 从零开始打造一个新闻订阅APP之Android篇（三、关于图片加载、展示的那些事）
- android 编译内核步骤
- 三齿轮问题（最大公约数）
- ios CoreData框架的使用，对上下文数据的增删改查，表与表之间的关联，1对多，1对1，谓词查询，多表连接
- CMake 基本使用方法--写CMakeList.txt
- tomcat启动时报：java.lang.IllegalArgumentException: Document base D:\apache-tomcat-6.0.20\webapps
- Java 字符终端上获取输入三种方式
- Qt下Link2019，Link2001错误的解决
- Java通过锁的顺序避免死锁
- 【知识点】Linux下tar.xz结尾的文件的解压方法
- c#的FileStream文件流
- java 简单网络爬虫
- java命令行运行小记
