CMake使用特点

已于 2023-02-26 10:15:21 修改
阅读量1.7k 收藏 8
点赞数
分类专栏： 工具 文章标签： cmake
于 2019-07-09 19:09:36 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/dadan1314/article/details/92799013
版权

帮助

cmake --help-command-list
cmake --help-command <--->
cmake -E
cmake -G <generator-name>
cmake -D <var>:<type>=<value> -D <var>=<value>

常用方法

string相关方法

# 正则匹配 ${variable} 按^(.*)_OUTPUT_(.*)$匹配到 output_variable 变量
string(REGEX MATCH "^(.*)_OUTPUT_(.*)$" output_variable "${variable}")
# 将文件名转成全路径，从输入中匹配出字符串，并放入取代表达式中，最后放入变量中
# string(REGEX REPLACE <regular_expression> <replace_expression> 
# <output variable> <input> [<input>...])
string(REGEX REPLACE "([^;]+)" "${PROJECT_SOURCE_DIR}/src/\\1" SRC_LIST "${SRC_LIST}")

list相关方法

# 向变量最后添加一项
list(APPEND argument_list "-D${output_variable}=${${output_variable}}")

file相关方法 

# 查找src目录下所有头文件并保存到SRC_FILES变量里,通常与install一起用
file(GLOB HEADER_FILES "src/*.h")
# 递归查找
file(GLOB_RECURSE SRC_FILES "src/hello*")
# 写文件
file(WRITE "version.h" "#define VERSION \"version: ${PROJECT_VERSION}\"\n"）
# 创建目录
file(MAKE_DIRECTORY ${xmlDir})

常用命令

add_compile_definitions   VS   add_definitions

if(BUILD_SHARED_LIBS)
    if(CMAKE_VERSION VERSION_GREATER_EQUAL 3.12.0)
        add_compile_definitions(JSON_DLL_BUILD)
    else()
        add_definitions(-DJSON_DLL_BUILD)
    endif()
endif()

add_compile_options   VS   CMAKE_<LANG>_FLAGS

if(CMAKE_VERSION VERSION_GREATER_EQUAL 3.12.0)
    add_compile_options($<$<CONFIG:Debug>:/WX>)
else()
    set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} /WX ")
endif()

install

# 安装目标
install(TARGETS ${TARGET_NAME}
       RUNTIME DESTINATION bin
       LIBRARY DESTINATION lib
       ARCHIVE DESTINATION lib)
# 安装目录
install(DIRECTORY ${SRC_DIR}
        DESTINATION ${DST_DIR})
# 安装文件
install(FILES ${FILES_LIST}
        DESTINATION ${DST_DIR})

find_package

Find<LibName>.cmake或<LibName>Config.cmake或<小写package-name>-config.cmake
<LibName>_FOUND、<LibName>_INCLUDE_DIR、<LibName>_LIBRARY

LIST(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/modules)
find_package(<LibName> REQUIRED)

常用模板

  添加外部工程

set(PACKAGE dtype)

set(argument_list)

get_cmake_property(variables VARIABLES)
foreach(variable ${variables})
  string(REGEX MATCH "^(.*)_OUTPUT_(.*)$" output_variable "${variable}")
  if(output_variable)
    list(APPEND argument_list "-D${output_variable}=${${output_variable}}")
    unset(output_variable)
    unset(${variable})
  endif()
endforeach()

# print argument_list
foreach(arg ${argument_list})
    message("${arg} - ${${arg}}")
endforeach()

ExternalProject_Add(${PACKAGE}
  SOURCE_DIR ${PROJECT_SOURCE_DIR}/package/${PACKAGE}
  CMAKE_ARGS "${argument_list}"
)

工程和目标属性

 设置和获取属性

# 设置全局和工程属性 
# eg: set_property(GLOBAL PROPERTY USE_FOLDERS ON)
# eg: set_property(TARGET ${TARGET_NAME} PROPERTY FOLDER "test")
set_property
# 获取工程属性
# eg: get_property
get_property
# 设置目标属性
set_target_properties(<目标> PROPERTIES <属性名> <属性值>)
# 获取目标属性
get_target_properties(<属性值> <目标> <属性名>)

 属性盘点

DEFINE_SYMBOL
# 属性设置了编译一个共享库中的源文件时才会被定义的预处理器符号名。
# 如果这个值没有被设置的话，那么它会被设置为默认值target_EXPORTS
VERSION
# 设置库的版本，linux下生成的库版本在文件名后面
# windows下无效果
SOVERSION
# 设置库的版本，linux下生成的库的soname版本在文件名后面
# windows下无效果
OUTPUT_NAME
OUTPUT_NAME_<CONFIG>
# 设置库和执行体的输出名称，若若没指定就是target的名称
# OUTPUT_NAME_<CONFIG>可以是OUTPUT_NAME_DEBUG
COMPILE_DEFINITIONS
# 设置宏定义，如：值为"GTEST_LINKED_AS_SHARED_LIBRARY=1"
DEBUG_POSTFIX
# 设置debug配置下目标名后缀，如“d”
FRAMEWORK
# 生成framework,如TRUE
IMPORTED_LOCATION
# 设置本地导入库的全路径，常用于安卓，如../libswscale-3.so

外部工程

 外部工程和设置目标目录

# ExternalProject_Add必须先include(ExternalProject)
include(ExternalProject)
ExternalProject_Add

# 为目标设置目录时必须先打开用户目录属性
SET_PROPERTY(GLOBAL PROPERTY USE_FOLDERS ON)
SET_PROPERTY(TARGET ${MODULE} PROPERTY FOLDER "modules")

ExternalProject_Add

 常用

# 指定相关文件生成存放文件目录前缀
PREFIX
# 指定源码目录，必须存在CMakeLists.txt
SOURCE_DIR
# 新的cmake工程参数
CMAKE_ARGS
# 待说明
INSTALL_DIR

 下载

# 下载命令，比如git clone <git-url> -b <分支>
DOWNLOAD_COMMAND 
# 指定目录
DOWNLOAD_DIR
# 如果是下载文件，指定文件名
DOWNLOAD_NAME
# 是否报告进度，1
DOWNLOAD_NO_PROGRESS

git

# git url
GIT_REPOSITORY
# git tag
GIT_TAG

ExternalProject_Get_Property
形式：ExternalProject_Get_Property(<name> [prop1 [prop2 [...]]])

# 获取外部工程gtest的source_dir和binary_dir属性，并将结果存放在这两个变量中
ExternalProject_Get_Property(gtest source_dir binary_dir)

内部模块

CMakeDependentOption.cmake 

# 包含模块
include(CMakeDependentOption)
# 根据BUILD_GMOCK判断，给INSTALL_GMOCK赋值，若为真，为前面的值，否则为后面的值
option(BUILD_GMOCK "Builds the googlemock subproject" ON)
cmake_dependent_option(INSTALL_GMOCK "Enable installation of googlemock." ON "BUILD_GMOCK" OFF)

GNUInstallDirs.cmake

# 包含模块
include(GNUInstallDirs)

注意点

 列表变量和列表变量字符串

# 正则匹配的时候要注意
set(CPP_LIST
	InitLib.cpp
	print.cpp
	StringUtil.h
	StringUtil.cpp
	DllibUtil.h
	DllibUtil.cpp
)
message(${CPP_LIST})
message("${CPP_LIST}")

# 结果：
# InitLib.cppprint.cppStringUtil.hStringUtil.cppDllibUtil.hDllibUtil.cpp
# InitLib.cpp;print.cpp;StringUtil.h;StringUtil.cpp;DllibUtil.h;DllibUtil.cpp

 关于rpath目录

  • CMAKE_INSTALL_RPATH             指定rpath目录
  • CMAKE_BUILD_WITH_INSTALL_RPATH 启动指定rpath目录
  • CMAKE_SKIP_RPATH                   构建和安装的时候是否加自认为的rpath
  • CMAKE_SKIP_BUILD_RAPTH      构建时候是否加自认为的rpath
  • CMAKE_SKIP_INSTALL_RPATH   安装时候是否加自认为的rpath
  • CMAKE_INSTALL_RPATH_USE_LINK_PATH
  • CMAKE_MACOSX_RPATH
if(NOT CMAKE_HOST_WIN32)
  set(CMAKE_BUILD_WITH_INSTALL_RPATH TRUE)
  if(CMAKE_HOST_APPLE)
    cmake_policy(SET CMP0068 OLD)
    set(CMAKE_INSTALL_RPATH "@executable_path")
  elseif(CMAKE_HOST_UNIX)
    set(CMAKE_INSTALL_RPATH "$ORIGIN")
  else() 
    message("rpath not support")
  endif()
endif()
多个rpath用;隔开：如set(CMAKE_INSTALL_RPATH "@executable_path;/usr/local/lib")

/*
其他参考
if(UNIX)
  set(CMAKE_INSTALL_RPATH_USE_LINK_PATH FALSE)
  set(CMAKE_BUILD_WITH_INSTALL_RPATH TRUE)
  if(NOT APPLE)
    set(CMAKE_INSTALL_RPATH "$ORIGIN")
  else()
    cmake_policy(SET CMP0068 OLD)
    set(CMAKE_MACOSX_RPATH ON)
    set(CMAKE_INSTALL_RPATH "@executable_path")
  endif()
endif()
*/

关于常用编译参数

# 设置 警告 - 异常 - 运行类型信息（dynamic_cast）
if(MSVC)
  add_definitions(/W4 /EHsc /GR)
else()
  add_definitions(/Wall -fexceptions -frtti)
endif()

 关于sysroot

set(SYSROOT_PATH  /home/admin/tx2-rootfs)
set(CMAKE_SYSROOT "${SYSROOT_PATH}")

 关于调试

if(CMAKE_HOST_APPLE)
  set(CMAKE_XCODE_ATTRIBUTE_DEBUG_INFORMATION_FORMAT "dwarf-with-dsym")
elseif(CMAKE_HOST_UNIX AND CMAKE_BUILD_TYPE STREQUAL Debug)
  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g")
endif()

关于验证编译器编译标志

# 验证c编译器flag
# -std=c90 -std=c90 -std=c11 -std=gnu90 -std=gnu99 -std=gnu11
include(CheckCCompilerFlag)
CHECK_C_COMPILER_FLAG("-std=gnu99" B1)
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=gnu99")
# 验证c++编译器flag
include(CheckCXXCompilerFlag)
CHECK_CXX_COMPILER_FLAG("-std=c++11" B1)
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")

检查头文件是否包含

# include的作用是将cmake的Modules下的CheckIncludeFil.cmake包含进来
# CMAKE_REQUIRED_INCLUDES 指定包含路径
include(CheckIncludeFile)
set (CMAKE_REQUIRED_INCLUDES ${PROJECT_SOURCE_DIR}/include)
CHECK_INCLUDE_FILE(InitLib/InitLib.h INITLIB_H_FOUND)
IF(INITLIB_H_FOUND)
   MESSAGE("found InitLib.h")
ENDIF(INITLIB_H_FOUND)

自动添加源文件

# 从当前CMakeLists.txt中遍历源文件
aux_source_directory(${CMAKE_CURRENT_SOURCE_DIR} DIR_SRCS)
foreach(DIR_SRC ${DIR_SRCS})
  message("${DIR_SRC}")
endforeach()
add_library(<库名> SHARED ${DIR_SRCS})

关于将源文件分组到工程

set(INC_LIST
	InitLib.h
)

set(CPP_LIST
	InitLib.cpp
	print.cpp
	StringUtil.h
	StringUtil.cpp
	DllibUtil.h
	DllibUtil.cpp
)

string(REGEX REPLACE "([^;]+)" "${PROJECT_SOURCE_DIR}/include/${LIBRARY}/\\1" INC_LIST "${INC_LIST}")
string(REGEX REPLACE "([^;]+)" "${PROJECT_SOURCE_DIR}/code/${LIBRARY}/\\1" CPP_LIST "${CPP_LIST}")

foreach(file ${INC_LIST} ${CPP_LIST})
  string(REGEX REPLACE "^${PROJECT_SOURCE_DIR}/(.*)/.*$" "\\1" groupname ${file})
  if(WIN32)
    string(REGEX REPLACE "/" "\\\\" groupname ${groupname})
  endif()
  source_group(${groupname} FILES ${file})
  unset(groupname)
endforeach()

  自定义命令

# ---> post script
#add_custom_command(TARGET ${TARGET_NAME}_lib POST_BUILD
#    COMMAND ${CMAKE_COMMAND} -E make_directory ${PROJECT_OUTPUT_INCLUDE_DIR}/${TARGET_NAME}
#    COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_LIST_DIR}/inc/FreeImage.h ${PROJECT_OUTPUT_INCLUDE_DIR}/${TARGET_NAME})

日志

macro(logmessage msg)
message("[${CMAKE_CURRENT_LIST_FILE}-${CMAKE_CURRENT_LIST_LINE}] ${msg}")
endmacro()

不同配置链接不同库和链接框架

# windows下debug配置链接baseutild.lib库，release配置链接baseutil.lib库
target_link_libraries(<目标名> debug baseutild optimized baseutil)
# 默认参数不是debug和optimized，而是general 
# debug是针对debug配置或者DEBUG_CONFIGURATIONS属性加入的配置
# optimized是针对debug参数对应的其他所有配置
# general是针对所有配置生效

# 比如多配置有如下Debug;Release;MinSizeRel;RelWithDebInfo
# 其中Debug和MinSizeRel设置为DEBUG_CONFIGURATIONS
set_property(GLOBAL PROPERTY DEBUG_CONFIGURATIONS "Debug;MinSizeRel")
target_link_libraries(<目标名> debug baseutild optimized baseutil)
# 那么只有debug和MinSizeRel是链接baseutild.lib，其他链接baseutil.lib

# 链接framework
target_link_libraries(<目标名> "-framework frame1" "-framework frame2")

 参考：[CMake] TARGET_LINK_LIBRARIES debug optimized visual studio 2010

安卓下本地导入库

add_library(swscale SHARED IMPORTED)
set_target_properties(swscale PROPERTIES IMPORTED_LOCATION ../libswscale-3.so)

问题

VERSION not allowed unless CMP0048 is set to NEW ，cmake最小版本太多，比如最小2.8

使用参数

# 指定生成工具
cmake -G "Visual Studio 12 2013 Win64" ..
cmake -DCMAKE_BUILD_TYPE=Debug -G "Unix Makefiles" ..
cmake -G "Xcode" ..
# 列出缓存的变量中的非高级的变量。
cmake -LAH
-L[A][H]: 列出缓存的变量中的非高级的变量。
# 关闭警告输出，cmake输出更清爽
cmake -Wno-dev

不同系统

CMAKE_OSX_DEPLOYMENT_TARGET  10.9

CMAKE_XCODE_ATTRIBUTE_DEBUG_INFORMATION_FORMAT dwarf-with-dsym

配套工具

cpack

# 设置打包名称，输出目录，会产生一个PACKAGE目标，通过make package生成目标，vs增加一个package项目
set(CPACK_PACKAGE_FILE_NAME ${PROJECT_NAME}_${PROJECT_VERSION})
set(CPACK_GENERATOR "TGZ")
set(CPACK_OUTPUT_FILE_PREFIX ${PROJECT_SOURCE_DIR})
include(CPack)

ctest

参考

cmake档案

cmake3.3

CMake中文文档 - 幕布

cmake 常用变量、常用环境变量、常用语法总结

主要变量

CMAKE_ARGC3cmake解释*.cmake脚本文件传入参数的个数
CMAKE_ARGV0 CMAKE_ARGV1cmake各个参数值
CMAKE_AR/usr/bin/arlinux下
CMAKE_MAKE_PROGRAM

C:/Program Files (x86)/MSBuild/12.0/bin/MSBuild.exe

/usr/bin/make

CMAKE_BUILD_TOOL
CMAKE_COMMAND

C:/Program Files/CMake/bin/cmake.exe

/usr/bin/cmake

cmake程序完整路径
CMAKE_CTEST_COMMAND

C:/Program Files/CMake/bin/ctest.exe

/usr/bin/ctest

师从小白
关注
  • 0
    点赞
  • 踩
  • 8
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
CMake的使用
qq_36458461的博客
08-15 230
1. cmake介绍 cmake是kitware公司以及一些开源开发者在开发几个工具套件(VTK)的过程中所产生的衍生品。后来经过发展，最终形成体系，在2001年成为一个独立的开放源代码项目。其官方网站是www.cmake.org，可以通过访问官方网站来获得更多关于cmake的信息，而且目前官方的英文文档比以前有了很大的改进，可以作为实践中的参考手册。 cmake是一个项目构建工具，它能够帮我们在不同平台上更好地组织和管理我们的代码及其编译过程。 cmake的一些主要特点： 1.开放源代码,使用类 BSD
CMake使用注意事项
king_weng的博客
09-21 1485
1、找不到lib等库 当使用CMake编译项目有时回出现找不到lib等库的情况，此种情况可能是由于CMake没有使用正确的库路径，此时需要自行选择库路径，然后再重新编译即可。 2、CMakeSettings.json和launch.vs.json （1）CMakeSettings.json存储环境变量或 Cmake.exe 的命令行选项。还可以定义和存储多个 CMa...
cmake version not allowed unless cmp0048 is set to new
登山
06-13 1603
cmake 阿里云oss sdk构建出错
CMake Error：No targets specified and no makefile found
weixin_50749380的博客
11-26 674
CMake Error：No targets specified and no makefile found
Cmake 交叉编译
qq_38446366的博客
10-30 4415
交叉编译 最近由Kitware Robot编辑6个月前 页面历史记录 从版本2.6.0开始，CMake支持交叉编译。 交叉编译意味着该软件是为不同于构建的系统构建的。 这意味着      CMake无法自动检测目标系统      通常，可执行文件不在构建主机上运行      构建过程必须使用一组不同的包含文件和库来构建，即不是本机的 设置系统和工具链 交叉编译时，CMake无法猜测目标系...
【cmake】利用ExternalProject_Add解决第三方库target命名冲突问题
beidou111的博客
01-01 1656
我们这时候编译External_B_name_I_set，
cmake: CHECK_INCLUDE_FILE_CXX 检查是否存在 codecvt 头文件
10km的专栏
06-01 3484
今天第一次使用cmake的CHECK_INCLUDE_FILE_CXX 函数检查是否存在 codecvt include文件，然而出错了(编译器使用gcc 5.4.0)。 cmake脚本如下： include(CheckIncludeFileCXX) # 检查是否存在 codecvt header file CHECK_INCLUDE_FILE_CXX(codecvt HAS_CODECVT ) # 检查是否存在 algorithm header file CHECK_INCLUDE_FILE_CXX(al
CMake使用文档
10-31
CMake 特点 1. 在每个源码目录下都有一个 CMakeLists.txt. 2. CMake 语句不区分大小写。一句一行，无行结束符号，注释用# 3. CMake 实际也是一种编程语言。CMake 根据 CMakeLists.txt 自动生成 Makefile. 4. CMake ...
CMake实战.pdf
09-09
CMake的特点包括： 1. 开源：CMake遵循类BSD许可，允许自由使用和分发。 2. 跨平台：它能生成适用于Linux、Unix、Apple macOS、Windows等不同系统的本地构建文件。 3. 适合大型项目：CMake的设计能够处理复杂的多...
CMake实战-20200708.pdf
03-31
CMake的特点主要有： 1. 开放源代码，使⽤类BSD 许可发布。 2. 跨平台，并可⽣成native 编译配置⽂件，在Linux/Unix 平台，⽣成 makefile，在苹果平台，可以⽣成xcode，在 Windows 平台，可以⽣成 MSVC 的⼯程⽂件...
cmake-3.29.2-windows-x86-64
最新发布
04-25
CMake的主要特点包括： 1. **跨平台**：CMake支持多种操作系统，如Windows、Linux、macOS等，使得项目可以在这些平台之间轻松迁移。 2. **简洁的配置语言**：CMakeLists.txt文件使用简单的命令行语法，允许用户...
cmake-3.18.6.zip
03-22
CMake的主要特点包括： 1. **平台无关性**：CMake使用简单的文本文件（`CMakeLists.txt`）来描述构建过程，这些文件可以在任何平台上读取和处理。 2. **可扩展性**：CMake支持通过宏、函数和模块来扩展，这使得...
CMake中INSTALL_RPATH与BUILD_RPATH问题
喜欢打篮球的普通人
08-08 3796
CMake为了方便用户的安装，默认在make install之后会自动remove删除掉相关的RPATH，这个时候你再去查看exe的RPATH，已经发现没有这个字段了。如何让CMake能够在install的过程中写入相关RPATH，并且该RPATH不能使当初build的时候的RPATH呢？设置linker的rpath选项：$ gcc -Wl,-rpath,/your/rpath/ test.cpp。如果需要设置$ORIGIN：$ gcc -Wl,-rpath,‘$ORIGIN/lib’ test.cpp。.
cmake rpath的一些总结
hellolixq的博客
04-28 2187
cmak rpath相关设置
CMAKE cmake_policy命令
TyearLin的专栏
06-06 455
当我们使用 CMake 工具编译项目的 CMakeLists.txt 存在两个问题。的话，可能 CMakeLists.txt 使用了，就会；的话，也会出现问题，因为 CMake 新版本在更新时 不一定向后兼容，。为了解决这些差异，保证我们的cmake代码始终可用，cmake 从版本2.0开始提出了policy这个概念。
cmake属性 INSTALL_RPATH
flying_ant2018的博客
09-02 5480
cmake属性INSTALL_RPATH
1.0 CMakeLists.txt注解
zhang45596961的专栏
11-21 1264
cmake是什么 cmake是一个生成工程文件的工具，生成的工程文件可以在各个平台上用开发工具来第二次编译。也就是说cmake并不是直接的编译工具，它只能生成对应平台的工程文件，比如：Windows上的Visual studio的sln，Linux上的makefile等。作为一个中间层的工具，cmake集成了很多内置的命令和变量，这也是我们在阅读cmake源码时候应该注意的。 cmake的源码文件是CMakeLists.txt文件，在下级目录中也有需要生成成makefile的情况下，需要在每个目录中添加CM
解决ROS Noetic没有serial包的问题
weixin_42937217的博客
10-05 2555
1、安装Serial包 ros-noetic没有serial包，所以需要自行下载安装。步骤如下 首先进入Downloads目录 cd ~/Downloads 然后下载serial源码 git clone https://github.com/wjwwood/serial.git 进入serial目录，安装编译 cd serial ccmake . 按c键，将CMAKE_INSTALL_PREFIX 变量值改为/opt/ros/noetic，再按c键 如果提示一长串以下开头 CMake Warning
Visual Studio基本使用
热门推荐
师从小白
04-28 3万+
安装 软件下载关联地址（老版本要求登录，新版本是在线安装） https://docs.microsoft.com/zh-cn/visualstudio/releasenotes/ 配置安装选项 VS2008按下选项 > X64编译器和工具 - VS2008配置x64平台，即64位编译器，如下： 默认安装根目录： VS2013：C:\Program Files (x86)\Mi...
20191117-CMake的应用与实践.pdf
06-27
CMake的应用与实践

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值