CMakeList知识点梳理

最新推荐文章于 2024-06-04 21:49:19 发布

相偎

最新推荐文章于 2024-06-04 21:49:19 发布

阅读量1k

点赞数 1

分类专栏：编程文章标签： c++

本文链接：https://blog.csdn.net/u013932564/article/details/127106846

版权

编程专栏收录该内容

15 篇文章 0 订阅

订阅专栏

CMakeList文件相关知识点梳理

设置输出后缀
set(CMAKE_DEBUG_POSTFIX “d”)
设置输出目录
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
set(CMAKE_ARCHIVE_OUT_PUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
设置文件虚拟目录
SOURCE_GROUP(AppCore FILES ${AppCore_H_CPP})
设置工程虚拟目录
add_subdirectory(子工程文件夹)
add_dependencies(子工程名依赖其他的工程名)

SET_PROPERTY(GLOBAL PROPERTY USE_FOLDERS ON)
SET_PROPERTY(TARGET 子工程名 PROPERTY FOLDER “虚拟目录名”)
如下：

	set_property(GLOBAL PROPERTY USE_FOLDERS ON)
	set_property(GLOBAL PROPERTY PREDEFINED_TARGETS_FOLDER "CMakePredefinedTargets")

设置生成动态库，静态库选项
set(BUILD_SHARED_LIBS “On”)
#set(BUILD_SHARED_LIBS “Off”)
从环境变量里查找库
find_path(3rdparty_INCLUDE_DIR zlib.h ENV 3rdparty_INCLUDE_DIR)
find_path(3rdparty_LIB_DIR zlib.lib ENV 3rdparty_LIB_DIR)
Boost在CMake中的使用
设置环境变量Boost_DIR
set(Boost_USE_STATIC_LIBS ON)
set(Boost_USE_MULTITHREADED ON)
find_package(Boost 1.49 REQUIRED system thread regex date_time)
target_link_libraries(${PROJECT_NAME} ${Boost_LIBRARRIES})
调试库和非调试库连接
target_link_libraries(debug ${} optimized ${})
输出动态库和静态库
if( ${BUILD_SHARED_LIBS} STREQUIL "On") add_library($ {OUT_NAME} SHARED ${SRC} ${HEADER} ${SOUECE}) ADD_DEFINITIONS(-DXXX_LIBRARY) else() add_library($ {OUT_NAME} STATIC ${SRC} ${HEADER})
ADD_DEFINITIONS(-DXXX_LIBRARY_STATIC)
endif()

#if defined(_MSC_VER) || defined(__CYGWIN__) || defined(__MINGW32__) || defined( __BCPLUSPLUS__)  || defined( __MWERKS__)
    #  if defined( XXX_LIBRARY_STATIC )
    #    define XXX_EXPORT
    #  elif defined( XXX_LIBRARY )
    #    define XXX_EXPORT   __declspec(dllexport)
    #  else
    #    define XXX_EXPORT   __declspec(dllimport)
    #  endif
#else
    #  define XXX_EXPORT
#endif

##################################################################################

设置编译类型

add_executable(demo demo.cpp)		# 生成可执行文件
add_library(common STATIC util.cpp)	# 生成静态库
add_library(common SHARED util.cpp)	# 生成动态库或共享库

指定编译包含的源文件
11.1 明确指定包含哪些文件

add_library(demo demo.cpp test.cpp util.cpp)

11.2 搜索所有的cpp文件
aux_source_directory(dir VAR) 发现一个目录下所有的源代码文件并将列表存储在一个变量中

aux_source_directory(. SRC_LIST) # 搜索当前目录下的所有.cpp文件
add_library(demo ${SRC_LIST})

11.3 自定义搜索规则

file(GLOB SRC_LIST "*.cpp" "protocol/*.cpp")
add_library(demo ${SRC_LIST})
# 或者
file(GLOB SRC_LIST "*.cpp")
file(GLOB SRC_PROTOCOL_LIST "protocol/*.cpp")
add_library(demo ${SRC_LIST} ${SRC_PROTOCOL_LIST})
# 或者
file(GLOB_RECURSE SRC_LIST "*.cpp") # 递归搜索
file(GLOB SRC_PROTOCOL RELATIVE "protocol" "*.cpp")	# 相对protocol目录下搜索
add_library(demo ${SRC_LIST} ${SRC_PROTOCOL})
# 或者
aux_source_directory(. SRC_LIST)
aux_source_directory(protocol SRC_PROTOCOL_LIST)
aux_library(demo ${SRC_LIST} ${SRC_PROTOCOL_LIST})

查找指定的库文件
find_library(VAR name path) 查找到指定的预编译库，并将它的路径存储在变量中。
默认的搜索路径为cmake包含的系统库，因此如果是NDK的公共库只需要指定库的name即可。

find_library(#Sets the name of the path variable.
			log-lib
			
			# Specifies the name of the NDK library that you want CMake to locate.
			log)

类似的命令还有find_file()、find_path()、find_program()、find_package()

include_directories(
	${CMAKE_CURRENT_SOURCE_DIR}
	${CMAKE_CURRENT_BINARY_DIR}
	${CMAKE_CURRENT_SOURCE_DIR}/include
)

Linux下还可以通过如下方式设置包含的目录

set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -I${CMAKE_CURRENT_SOURCE_DIR}")

link_directories(
	${CMAKE_CURRENT_SOURCE_DIR}/libs
)

Linux下还可以通过如下方式设置引用的目录

set(CMAKE_CXX_FLAGS "${CMAKE_CXX+FLAGS} -L${CMAKE_CURRENT_SOURCE_DIR}/libs")

设置target需要连接的库

target_link_libraries(	# 目录库
	demo
	
	# 目标库需要连接的库
	# log-lib 是上面find_library指定的变量名
	${log-lib})

15.1 指定连接动态库或静态库

target_link_libraries(demo libface.a)	# 链接libface.a
target_link_libraries(demo libface.so)	# 链接libface.so

15.2 指定全路径

target_link_libraries(demo ${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.a)
target_link_libraries(demo ${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.so)

15.3 指定链接多个库

target_link_libraries(demo
	${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.a
	boost_system.a
	boost_thread
	pthread)

设置变量
16.1 set直接设置变量的值

set(SRC_LIST main.cpp test.cpp)
add_executable(demo ${SRC_LIST})

16.2 set 追加设置变量的值

set(SRC_LIST main.cpp)
set(SRC_LIST ${SRC_LIST} test.cpp)
add_executable(demo ${SRC_LIST})

16.3 list追加或者删除变量的值

set(SRC_LIST main.cpp)
list(APPEND SRC_LIST test.cpp)
list(REMOVE_ITEM SRC_LIST main.cpp)
add_executable(demo ${SRC_LIST})

##############################################################################################################################

条件控制
17.1 if…elseif…else…endif
逻辑判断和比较
if(expression): expression 不为空(0, N, NO, OFF, FALSE, NOTFOUND)时为真
if(not exp): 与上面相反
if(var1 AND var2)
if(var1 OR var2)
if(COMMAND cmd): 如果cmd确实是命令并且调用为真
if(EXISTS dir) if(EXISTS file): 如果目录或文件存在为真
if(file1 IS_NEWER_THAN file2): 当file1比file2新，或file1/file2中有一个不存时为真，文件名需要使用全路径
if(IS_DIRECTORY dir): 当dir是目录时为真
if(DEFINED var): 如果变量被定义为真
if(var MATCHES regex): 给定的变量或者字符串能够匹配正则表达式regex时为真，此处var可以用var名，也可以用${var}
if(string MATCHES regex)

数字比较
if(variable LESS number): LESS小于
if(string LESS number)
if(variable GREATER number): GREATER大于
if(string GREATER number)
if(variable EQUAL number): EQUAL等于
if(string EQUAL number)

字母表顺序比较
if(variable STRLESS string)
if(string STRLESS string)
if(variable STRGREATER string)
if(string STRGREATER string)
if(variable STREQUAL string)
if(string STREQUAL string)
示例：

if(MSVC)
	set(LINK_LIBS common)
else()
	set(boost_thread boost_log.a boost_system.a)
endif()

target_link_libraries(demo ${LINK_LIBS})

#或者
if(UNIX)
	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -fpermissive -g")
else()
	add_definitions(-D_SCL_SECURE_WARNINGS
	-D_CRT_SECURE_NO_WARNINGS
	-D_WIN32_WINNT=0x601
	-D_WINSOCK_DEPECATED_NO_WARNINGS)
endif()

if(${CMAKE_BUILD_TYPE} MATCHES "debug")
	...
else()
	...
endif()

17.2 while…endwhile

while(condition)
	...
endwhile()

17.3 foreach…endforeach

foreach(loop_var RANGE start stop [step]
	...
endforeach(loop_var)

start表示起始数，stop表示终止数，step表示步长，示例：

foreach(i RANGE 1 9 2)
	message(${i})
endforeach(i)
# 输出1 3 5 7 9

打印信息

message(${PROJECT_SOURCE_DIR})
message("build with debug mode")
message(WARNING "this is warning message")
message(FATAL_ERROR "this build has many error") # FATAL_ERROR 会导致编译失败

包含其它cmake文件

include(./common.cmake) # 指定包含文件的全路径
include(def) #在搜索路径中搜索def.cmake文件
set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake) # 设置include的搜索路径

######################################################################################

常用变量
20.1 预定义变量
PROJECT_SOURCE_DIR: 工程的根目录
PROJECT_BINARY_DIR: 运行cmake命令的目录，通常是${PROJECT_SOURCE_DIR}/build
PROJECT_NAME: 返回通过project命令定义的项目名称
CMAKE_CURRENT_SOURCE_DIR: 当前处理的CMakeLists.txt所在的路径
CMAKE_CURRENT_BINARY_DIR: target编译目录
CMAKE_CURRENT_LIST_DIR: CMakeLists.txt的完整路径
CMAKE_CURRENT_LIST_LINE: 当前所在的行
CMAKE_MODULE_PATH: 定义自己的cmake模块所在的路径，SET(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)，然后可以用INCLUDE命令来调用自己的模块
EXECUTABLE_OUTPUT_PATH: 重新定义目标二进制可执行文件的存放位置
LIBRARY_OUTPUT_PATH: 重新定义目标连接库文件的存储位置

20.2 环境变量

使用环境变量

$ENV{Name}

写入环境变量

set(ENV{Name} value) # 这里没有"$"符号

20.3 系统信息

CMAKE_MAJOR_VERSION: cmake 主版本号，比如3.4.1中的3
CMAKE_MINOR_VERSION: cmake次版本号，比如3.4.1中的4
CMAKE_PATCH_VERSION: cmake补丁等级，比如3.4.1中的1
CMAKE_SYSTEM: 系统名称，比如Linux-2.6.22
CMAKE_SYSTEM_NAME: 不包含版本的系统名称，比如Linux
CMAKE_SYSTEM_VERSION: 系统版本，比如2.6.22
CMAKE_SYSTEM_PROCESSOR: 处理器名称，比如i686
UNIX: 在所有的类UNIX平台下该值为TRUE，包括OS X和cygwin
WIN32: 在所有的win32平台下该值为TRUE，包括cygwin

20.4 自定义编译选项

cmake允许为项目增加编译选项，从而可以根据用户的环境和需求选择最合适的编译方案。
例如，可以将MathFunctions库设为一个可选的库，如果该选项为ON，就使用该库定义的数学函数来进行运算，否则就调用标准库中的数学函数库。

修改根根目录下的CMakeLists.txt文件如

# CMake 最低版本号要求
cmake_minimum_required(VERSION 2.8)
# 项目信息
project(Demo)
# 加入一个配置头文件，用于处理CMake对源码的设置
configure_file(
	"${PROJECT_SOURCE_DIR}/config.h.in"
	"${PROJECT_SOURCE_DIR}/config.h"
)
# 是否使用自己的MathFunctions库
option(USE_MYMATH
	"Use provided math implementation" ON)
# 是否加入MathFunctions库
if(USE_MYMATH)
	include_directories("${PROJECT_SOURCE_DIR}/math")
	add_subdiretory(math)
	set(EXTRA_LIBS ${EXTRA_LIBS} MathFunctions)
endif(USE_MYMATH)
# 查找当前目录下的所有源文件
# 并将名称保存到DIR_SRCS变量
aux_source_directory(. DIR_SRCS)
# 指定生成目录
add_executable(Demo ${DIR_SRCS})
target_link_libraries(Demo ${EXTRA_LIBS})

configure_file 命令用于加入一个配置头文件config.h，这个文件由cmake从config.in生成，通过这样的机制，将可以通过预定义一些参数和变量来控制diam的生成。
option命令添加了一个USE_MYMATH选项，并且默认值为ON。根据USER_MYMATH变量的值来决定是否使用我们自己编写的MathFunctions库。

修改main.cc文件，让其根据USE_MYMATH的预定义值来决定是否调用标注库还是MathFunctions库

#include "config.h"
#ifdef USE_MYMATH
    #include "math/MathFunctions.h"
#else
    #include <math.h>
#endif
 
int main(int argc, char *argv[])
{
    if (argc < 3){
        printf("Usage: %s base exponent \n", argv[0]);
        return 1;
    }
    double base = atof(argv[1]);
    int exponent = atoi(argv[2]);
 
#ifdef USE_MYMATH
    printf("Now we use our own Math library. \n");
    double result = power(base, exponent);
#else
    printf("Now we use the standard library. \n");
    double result = pow(base, exponent);
#endif
    printf("%g ^ %d is %g\n", base, exponent, result);
    return 0;
}

编写config.h.in文件
注意main.cc的第一行，这里引用了一个config.h文件，这个文件预定义了USE_MYMATH的值。但我们并不直接编写这个文件，为了方便从CMakeLists.txt中导入配置，我们编写一个config.h.in文件，内容如下：