阅读 CMakeLists

Posted 2020-10-04 小菜的爱

新手，入门阅读 CMakeLists，希望读者能给点建议

发现两篇文章，我感觉很好~

《阅读 CMakeLists》（下面只copy此篇）文章来源：http://blog.sina.com.cn/s/blog_8380edd00100wyei.html 

《CMake 入门实战》 文章地址：http://www.hahack.com/codes/cmake/

 

 

楼主最近几天被Orz和PageGeometry弄得有点头大，需要通过源码 + CMakeLists 来建立工程和sln，但是到底CMakeLists.txt 里写的是些什么东西呢。

 

【语法】

 

注释  # :   
    #我是注释

 

命令语法 COMMAND：
    COMMAND(参数1 参数2 ...)

 

字符串列

    A;B;C           //分号分割或空格分隔的值

 

变量
    set(Foo a b c)             // 设置变量 Foo
    command(${Foo})     //等价于 command(a b c)
    command("${Foo}")  // 等价于 command("a b c")
    command("/${Foo}") // 转义，和 a b c无关联

流控制结构
    IF()...ELSE()  /ELSEIF()...ENDIF()
    WHILE()...ENDWHILE()
    FOREACH()...ENDFOREACH()

 

【常用命令】

（按A~Z排列）

 

ADD_EXECUTABLE
add_exectuable  : 工程生成一个可执行文件。
add_executable(hello ${SRC_LIST})  //生成一个名为hello.exe的可执行文件

 

ADD_LIBRARY
add_library :  生成一个库文件。
add_library(libhello ${LIB_SRC})                  //生成libhello.lib文件
add_library(libhello SHARED ${LIB_SRC})  //生成动态库文件

 

ADD_CUSTOM_TARGET
自定义目标，生成一个自定义文件类型

 

add_subdirectory ：增加子文件夹，2个参数的话就是 源→目标 文件夹生成对应 
add_subdirectory(src) ：建立src子文件夹
add_subdirectory(src bin)  ：在cmake目标文件夹中与源文件夹对应 src→bin文件夹

 

ADD_DEPENDENCIES( target1 t2 t3 )
目标target1依赖于t2 t3

 

ADD_DEFINITIONS( "-Wall -ansi")
本意是供设置 -D... /D... 等编译预处理需要的宏定义参数，对比 REMOVE_DEFINITIONS()

 

AUX_SOURCE_DIRECTORY ( “sourcedir” variable)
收集目录中的文件名并赋值给变量

 

EXEC_PROGRAM ( bin [work_dir] ARGS <..> [OUTPUT_VARIABLE var] [RETURN_VALUE var] )
 执行外部程序

 

FILE ( WRITE|READ|APPEND|GLOB| GLOB_RECURSE|REMOVE|MAKE_DIRECTORY ...)
文件操作

 

FIND_FILE
FIND_PATH
FIND_LIBRARY
FIND_PACKAGE    上述4个注意 CMAKE_LIBRARY_PATH

 

FIND_PROGRAM

 

INCLUDE_DIRECTORIES ( "dir1" "dir2" ... )
include_directories  : 包含指定目录下的指定文件夹
include_directories(${PROJECT_SOURCE_DIR}/libhello)  //包含当前目录下的libhello文件夹

 

INSTALL ( FILES “f1” “f2”DESTINATION . )
DESTINATION （目标文件夹）相对于 ${CMAKE_INSTALL_PREFIX}
 
LINK_DIRECTORIES ("dir1" "dir2")
 库文件路径。注意：由于历史原因，相对路径会原样传递给链接器。尽量使用FIND_LIBRARY而避免使用这个。
 
LINK_LIBRARIES ( lib1 lib2 ...)
设置所有目标需要链接的库

 

LIST ( APPEND|INSERT|LENGTH|GET| REMOVE_ITEM|REMOVE_AT|SORT ...)
列表操作

 

MESSAGE (...)  输出信息，方便检查调试

message(${PROJECT_SOURCE_DIR})

 

project

建立一个工程
project   不是强制性的，但最好始终都加上。这一行会引入两个变量
?HELLO_BINARY_DIR 和 HELLO_SOURCE_DIR
同时，cmake自动定义了两个等价的变量
?PROJECT_BINARY_DIR   和  PROJECT_SOURCE_DIR
如果是out-of-source方式构建（源代码和生成的中间产物分离），所以要时刻区分这两个变量对应的目录

 

SET
set (SRC_LIST hello.cpp)  //源文件列表 hello.cpp
set (APP_SRC main.c)       //语义基本同上，具体不太了解
set (EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)  //指定生成hello.exe到目标文件夹

 

SET_TARGET_PROPERTIES ( ... )： 设置目标的属性 OUTPUT_NAME, VERSION, ....
set_target_properties(libhello PROPERTIES OUTPUT_NAME "hello")  //使libhello.lib输出文件名为hello.exe

 

SEPARATE_ARGUMENTS ( VAR )
转换空格分隔的字符串到列表

 

STRING ( TOUPPER|TOLOWER|LENGTH| SUBSTRING|REPLACE|REGEX ...)
字符串操作

 

TARGET_LINK_LIBRARIES ( target-name lib1 lib2 ...)
target_link_libraries  :  将指定库文件链接到某个执行文件
target_link_libraries(hello libhello)   //将libhello.lib文件链接到hello.exe

 

 

【常见变量】

----工程路径------

?CMAKE_SOURCE_DIR
?PROJECT_SOURCE_DIR
?<projectname>_SOURCE_DIR
这三个变量指代的内容是一致的，是工程顶层目录

 

?CMAKE_BINARY_DIR
?PROJECT_BINARY_DIR
?<projectname>_BINARY_DIR
这三个变量指代的内容是一致的，如果是in source编译，指得就是工程顶层目录，如果  是out-of-source编译，指的是工程编译发生的目录

 

?CMAKE_CURRENT_SOURCE_DIR
指的是当前处理的CMakeLists.txt所在的路径。

 

?CMAKE_CURRRENT_BINARY_DIR
如果是in-source编译，它跟CMAKE_CURRENT_SOURCE_DIR一致，如果是out-ofsource  编译，他指的是target编

译目录。

?CMAKE_CURRENT_LIST_FILE
输出调用这个变量的CMakeLists.txt的完整路径

 

----CMAKE_BUILD_TYPE-----

 

控制 Debug 和 Release 模式的构建

?CMakeList.txt文件
SET(CMAKE_BUILD_TYPE Debug)?命令行参数
cmake DCMAKE_BUILD_TYPE=Relea

 

-----编译器参数-----

?CMAKE_C_FLAGS
?CMAKE_CXX_FLAGS
也可以通过指令ADD_DEFINITIONS()添加

 

CMAKE_INCLUDE_PATH
配合 FIND_FILE() 以及 FIND_PATH() 使用。如果头文件没有存放在常规路径/usr/include, /usr/local/include等)，
则可以通过这些变量就行弥补。如果不使用 FIND_FILE 和 FIND_PATH的话，CMAKE_INCLUDE_PATH，没有任何作

用。

 

?CMAKE_LIBRARY_PATH

配合 FIND_LIBRARY() 使用。否则没有任何作用

 

?CMAKE_MODULE_PATH

cmake 为上百个软件包提供了查找器(finder):FindXXXX.cmake

当使用非cmake自带的finder时，需要指定finder的路径，这就是CMAKE_MODULE_PATH，配合 FIND_PACKAGE

()使用

 

CMAKE_INSTALL_PREFIX
控制make install是文件会安装到什么地方。默认定义是/usr/local 或 %PROGRAMFILES%

 

BUILD_SHARED_LIBS
如果不进行设置，使用ADD_LIBRARY且没有指定库类型，默认编译生成的库是静态库。

 

UNIX 与 WIN32
?UNIX，在所有的类UNIX平台为TRUE，包括OS X和cygwin
?WIN32，在所有的win32平台为TRUE，包括cygwin

 

更多CMake信息参考

• http://www.cmake.org/cmake/help/cmake-2-8-docs.html

学习如何写CMakeLists参考如下网址，写的不错

• http://blog.csdn.net/dbzhang800/article/details/6314073