cmake使用方法（详细）

最新推荐文章于 2024-03-11 23:51:03 发布
最新推荐文章于 2024-03-11 23:51:03 发布
阅读量2.4k 收藏 10
点赞数 2
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/zxpoiu/article/details/103270957
版权

cmake使用方法（详细）

帮助文档

  1. cmake官方新手tutorial
  2. cmake 添加头文件目录，链接动态、静态库
  3. 官方文档
  4. cmake 语法

技巧

  1. cmake命令是不区分大小写的，但是变量区分。

  2. 判断编译器类型

     if ("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang")
 MESSAGE("Clang")
 elseif ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")
 MESSAGE("GNU")
 elseif ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Intel")
 MESSAGE("Intel")
 elseif ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "MSVC")
 MESSAGE("MSVC")
 endif()

命令行选项

-D

  1. -D 相当于就是定义, -D 可以理解为告诉cmake 后边我要定义一些参数了, 你每定义一个就在前边加上-D就是了
  2. CMAKE_BUILD_TYPE 这种东西往往是在CMakeList.txt 中定义的, 这个是你要编译的类型, 一般的选择有debug,release, 但是不确定
  3. CMAKE_INSTALL_PREFIX 这个是安装路径.

例子

cmake -DCMAKE_BUILD_TYPE=Debug

编译选项

在cmake脚本中，设置编译选项可以通过add_compile_options命令，也可以通过set命令修改CMAKE_CXX_FLAGS或CMAKE_C_FLAGS。 使用这两种方式在有的情况下效果是一样的，但请注意它们还是有区别的：

  1. add_compile_options命令添加的编译选项是针对所有编译器的(包括c和c++编译器)，
  2. 而set命令设置CMAKE_C_FLAGS或CMAKE_CXX_FLAGS变量则是分别只针对c和c++编译器的。

例子

#判断编译器类型,如果是gcc编译器,则在编译选项中加入c++11支持
if(CMAKE_COMPILER_IS_GNUCXX)
    set(CMAKE_CXX_FLAGS "-std=c++11 ${CMAKE_CXX_FLAGS}")
    message(STATUS "optional:-std=c++11")
endif(CMAKE_COMPILER_IS_GNUCXX)

add_compile_options

语法

add_compile_options(<option> ...)

# 例子

add_compile_options(-Wall -Wextra -pedantic -Werror -g)

add_compile_definition

待补充

option & add_definition

语法

# Provides an option for the user to select as ON or OFF. If no initial <value> is provided, OFF is used. If <variable> is already set as a normal variable then the command does nothing
option(<variable> "<help_text>" [value])

# Add -D define flags to the compilation of source files.
add_definitions(-DFOO -DBAR ...)
使用方法

  1. 首先在CMakeList.txt中增加选项

    option(TEST_DEBUG "option for debug" OFF)
if (TEST_DEBUG)
add_definitions(-DTEST_DEBUG)
endif()

  2. 在cmake构造makefile的时候输入想要的参数

    cmake -DTEST_DEBUG=ON ..

  3. 源码中使用该定义

    // test.cpp
#include "test.h"

#ifdef TEST_DEBUG
...
#endif

语法说明

列表和字符串

在CMake中基础的数据形式是字符串。CMake也支持字符串列表。

列表通过分号分隔。譬如两个声明给变量VAR设同样的值：

set(VAR a;b;c)
set(VAR a b c)

字符串列表可以通过foreach命令迭代或直接操控列表命令。

变量

CMake 支持简单的变量可以是字符串也可以是字符串列表。变量参考使用${VAR}语法。多参数可以使用set命令组合到一个列表中。所有其他的命令

通过空白分隔符传递命令来扩展列表，例如

set(Foo a b c)
# 将 变量 Foo 设为 a b c, 并且如果Foo 传递给另一个命令
command(${Foo})
# 等同于
command(a b c)

# 如果要把参数列表传递给一个命令，且它是一个简单的参数只要加一个双引号就可以。例如
command("${Foo}")
# 等价于
command("a b c")

控制流

像大多数语言一样,Cmake 提供了控制流结构。Cmake提供了三中控制流：

  1. 条件控制流 if

    # some_command will be called if the variable's value is not:
# empty, 0, N, NO, OFF, FALSE, NOTFOUND, or -NOTFOUND.
if(var)
some_command(...)
endif(var)

  2. 循环结构： foreach 和 while

    set(VAR a b c)
# loop over a, b,c with the variable f
foreach(f ${VAR})
    message(${f})
endforeach(f)

  3. 过程定义 宏和函数（函数在2.6及更高的版本中有效）。函数对变量局部有效，宏是全局有效。

    # define a macro hello
macro(hello MESSAGE)
    message(${MESSAGE})
endmacro(hello)
# call the macro with the string "hello world"
hello("hello world")
# define a function hello
function(hello MESSAGE)
    message(${MESSAGE})
endfunction(hello)

更多控制流信息参见命令 if,while,foreach,macro,function文档。

引号，字符串和转义

在CMake中原义字符串用双引号括起来。字符串可以是多行字符串，并在其中嵌入新的行。例如

set(MY_STRING "this is a string with a

 newline in

it")

也可以在一个字符串中转义字符和使用变量

set(VAR "

  hello

  world

")

message("\${VAR}= ${VAR}")

# prints out

${VAR}=

hello

world

同样支持标准C中的转义

message("\n\thello world")

#prints out

hello world

如果字符在引号之前是空格则原义字符串只是原义字符串。但是引号必须成对，例如

message(hell"o") -> prints hell"o"
message(hell\"o\") -> prints hello"o"

正则表达式

cmake可以使用正则表达式

常用命令

cmake_minimum_required

cmake project 头文件必须存在这行命令， 例如cmake_minimum_required(VERSION 3.10)

project

设置项目名称project(Tutorial)

set

语法

# Set Normal Variable
set(<variable> <value>... [PARENT_SCOPE])

# Set Environment Variable
# 这个环境变量只对当前cmake工程有效，对外界是无效的。
set(ENV{<variable>} [<value>])

例子

set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -O3 -Wall -Wl,-rpath=/tools/lib64 -Wl,--dynamic-linker=/tools/lib/ld-2.17.so")

message

语法

message([<mode>] "message to display" ...)
mode关键字

The optional <mode> keyword determines the type of message:

modeexplaination
FATAL_ERRORCMake Error, stop processing and generation.
SEND_ERRORCMake Error, continue processing, but skip generation.
WARNINGCMake Warning, continue processing.
AUTHOR_WARNINGCMake Warning (dev), continue processing.
DEPRECATIONCMake Deprecation Error or Warning if variable CMAKE_ERROR_DEPRECATED or CMAKE_WARN_DEPRECATED is enabled, respectively, else no message.
(none) or NOTICEImportant message printed to stderr to attract user’s attention.
STATUS一般就用这个，Ideally these should be concise, no more than a single line, but still informative.
VERBOSEDetailed informational messages intended for project users. These messages should provide additional details that won’t be of interest in most cases, but which may be useful to those building the project when they want deeper insight into what’s happening.
DEBUGDetailed informational messages intended for developers working on the project itself as opposed to users who just want to build it. These messages will not typically be of interest to other users building the project and will often be closely related to internal implementation details.
TRACEFine-grained messages with very low-level implementation details. Messages using this log level would normally only be temporary and would expect to be removed before releasing the project, packaging up the files, etc.

aux_source_directory 查找源文件

# 找到所有dir目录下的源文件（不会递归遍历子文件夹），源文件是.c文件（也就是makefile中可以生成.o的文件）
aux_source_directory(<dir> <variable>)

add_library

将指定的源文件（CPP文件）生成链接文件，然后添加到工程中去。

语法

add_library(<name> [STATIC | SHARED | MODULE]
            [EXCLUDE_FROM_ALL]
            [source1] [source2 ...])

其中<name>表示库文件的名字，该库文件会根据命令里列出的源文件来创建。而STATIC、SHARED和MODULE的作用是指定生成的库文件的类型。

  1. STATIC库是目标文件的归档文件，在链接其它目标的时候使用。
  2. SHARED库会被动态链接（动态链接库），在运行时会被加载。
  3. MODULE库是一种不会被链接到其它目标中的插件，但是可能会在运行时使用dlopen-系列的函数。
  4. 默认状态下，库文件将会在于源文件目录树的构建目录树的位置被创建(默认static)，该命令也会在这里被调用。

例子

add_library(roland_pb CreateUDiskRequest.pb.cc)
add_executable(echo_client echo_client.cc)
target_link_libraries(echo_client uevent event uevent_base pthread roland_pb protobuf)

add_subdirectory

在子文件夹添加了library或者executable之后，在上层目录添加subdirectory, 也可以在同一个CMakeList.txt中使用

include_directories 添加头文件目录

它相当于g++选项中的-I参数的作用，也相当于环境变量中增加路径到CPLUS_INCLUDE_PATH变量的作用。

语法：

include_directories([AFTER|BEFORE] [SYSTEM] dir1 [dir2 ...])
# 例子
include_directories(../../../thirdparty/comm/include)

link_directories 添加需要链接的库文件目录

它相当于g++命令的-L选项的作用，也相当于环境变量中增加LD_LIBRARY_PATH的路径的作用。 语法：

`link_directories(directory1 directory2 ...)`
# 例子
`link_directories("/home/server/third/lib")`

find_library 查找库所在目录

语法：

# A short-hand signature is:
find_library (<VAR> name1 [path1 path2 ...])

# The general signature is:
find_library (
          <VAR>
          name | NAMES name1 [name2 ...] [NAMES_PER_DIR]
          [HINTS path1 [path2 ... ENV var]]
          [PATHS path1 [path2 ... ENV var]]
          [PATH_SUFFIXES suffix1 [suffix2 ...]]
          [DOC "cache documentation string"]
          [NO_DEFAULT_PATH]
          [NO_CMAKE_ENVIRONMENT_PATH]
          [NO_CMAKE_PATH]
          [NO_SYSTEM_ENVIRONMENT_PATH]
          [NO_CMAKE_SYSTEM_PATH]
          [CMAKE_FIND_ROOT_PATH_BOTH |
           ONLY_CMAKE_FIND_ROOT_PATH |
           NO_CMAKE_FIND_ROOT_PATH]
         )

# 例子如下
FIND_LIBRARY(RUNTIME_LIB rt /usr/lib  /usr/local/lib NO_DEFAULT_PATH)
cmake会在目录中查找，如果所有目录中都没有，值RUNTIME_LIB就会被赋为NO_DEFAULT_PATH

link_libraries 添加需要链接的库文件路径

该指令的作用主要是指定要链接的库文件的路径，该指令有时候不一定需要。因为find_package和find_library指令可以得到库文件的绝对路径。不过你自己写的动态库文件放在自己新建的目录下时，可以用该指令指定该目录的路径以便工程能够找到。

语法：

link_libraries(library1 <debug | optimized> library2 ...)

# 直接是全路径
link_libraries(“/home/server/third/lib/libcommon.a”)
# 下面的例子，只有库名，cmake会自动去所包含的目录搜索
link_libraries(iconv)

# 传入变量
link_libraries(${RUNTIME_LIB})
# 也可以链接多个
link_libraries("/opt/MATLAB/R2012a/bin/glnxa64/libeng.so"　"/opt/MATLAB/R2012a/bin/glnxa64/libmx.so")

可以链接一个，也可以多个，中间使用空格分隔.

target_link_libraries 设置要链接的库文件的名称

语法：

target_link_libraries(<target> [item1 [item2 [...]]]
                      [[debug|optimized|general] <item>] ...)

# 以下写法都可以：
target_link_libraries(myProject comm)       # 连接libhello.so库，默认优先链接动态库
target_link_libraries(myProject libcomm.a)  # 显示指定链接静态库
target_link_libraries(myProject libcomm.so) # 显示指定链接动态库

# 再如：
target_link_libraries(myProject libcomm.so)　　#这些库名写法都可以。
target_link_libraries(myProject comm)
target_link_libraries(myProject -lcomm)

add_executable 为工程生成目标文件

语法：

add_executable(<name> [WIN32] [MACOSX_BUNDLE]
               [EXCLUDE_FROM_ALL]
               source1 [source2 ...])

简单的例子如下：

add_executable(demo main.cpp)
add_executable(echo_client echo_client.cc CreateUDiskRequest.pb.cc)


本篇文章由一文多发平台ArtiPub自动发布

杰特JET
关注
  • 2
    点赞
  • 踩
  • 10
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
cmake基本用法
yulesyu的博客
12-28 1万+
cmake基本用法
CMake用法详解 使用方法说明
08-13
CMake 用法详解，简单描述了CMake 的使用方法，通过简单的例子
cmake
最新发布
T20151470的博客
03-11 963
add_executable(可执行程序名 源文件名称)
CMake Introduction 1
comedate的专栏
11-23 1428
一、      基本使用 安装：下载二进制包后可直接解压使用 从源码安装则执行命令：./bootstrap; make; make install——尝试执行bootstrap失败 使用：cmake dir_path，生成工程文件或makefile文件 二、      概念 out-of-source build，与in-source build相对，即将编译输出文件与源文件放到不同目录
cmake使用方法详解
Coder_MrLee的博客
02-08 5270
cmake 简介 CMake是一个跨平台的安装(编译)工具,可以用简单的语句来描述所有平台的安装(编译过程)。他能够输出各种各样的makefile或者project文件,能测试编译器所支持的C++特性,类似UNIX下的automake。 CMake 使用方法 CMake的所有的语句都写在一个叫:CMakeLists.txt的文件中。当CMakeLists.txt文件确定后,可以用ccmake命令对相关 的变量值进行配置。这个命令必须指向CMakeLists.txt所在的目录。配置完成之后,应用cmake命令
cmake的使用
梦心之魂的博客
06-02 6806
一、基本使用 安装：下载二进制包后可直接解压使用。 从源码安装则执行命令： ./bootstrap; ——尝试执行bootstrap失败 make; make install 使用：cmake dir_path，生成工程文件或makefile文件 二、概念 out-of-sourcebuild，与in-source build...
cmake使用教程
阿东的学习记录
11-08 7809
可以用来指定工程的名字和支持的语言，默认支持所有语言PROJECT (HELLO) 指定了工程的名字，并且支持所有语言—建议PROJECT (HELLO CXX) 指定了工程的名字，并且支持语言是C++PROJECT (HELLO C CXX) 指定了工程的名字，并且支持语言是C和C++该指定隐式定义了两个CMAKE的变量_BINARY_DIR，本例中是 HELLO_BINARY_DIR_SOURCE_DIR，本例中是 HELLO_SOURCE_DIR。
VScode中使用Cmake遇到的问题及其解决方法(推荐)
08-19
主要介绍了VScode中使用Cmake遇到的问题及其解决方法,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
超详细的cmake教程(去糟粕-重实践-学以致用).pdf
02-17
以通俗化的语言，深入浅出的介绍了程序构建原理以及cmake的编写方法，使我们能知其然并知其所以然。摒弃长篇大论的一贯作风，去除糟粕，提炼精髓，学以致用是本门教程最大的特点。入门即上手，上手即封神
GMSSL windows编译方法，详细参加说明txt，压缩包内有x64的cmake
11-22
1、压缩包内有x64的cmake，win7 64 位操作系统安装，使用正常。 2、GMSSL是从gitHub上下载，有更新可以替换。 3、编译说明 用详细的编译过程，及我遇到的问题解决方式。
cmake工具使用教程
12-15
一本描述cmake工具的文档，里面详细介绍了cmake的使用方法，内容很详细，写的很言简意赅。
CMake编译RocketMQ With VS2010
11-23
编译rocketmq 工具：CMake 环境：vs2010 依赖：jsoncpp、boost、libevent、zlib，文档中有下载地址和详细的编译过程 描述：文档中记录自己使用过程中遇到的问题以及解决方法
cmake使用详细教程（日常使用这一篇就足够了）
iuu77的博客
02-27 2万+
此时可以使用cmake中的函数存储这些源文件。只需要在CMakeLists.txt中添加所依赖的.cpp文件，编译步骤和上面相同。有时编译程序时想添加一些编译选项，如-Wall，-std=c++11等，可以使用。此时在当前目录新增两个依赖，并mian函数的执行需要依赖这两个文件。1、在官网下载cmake的安装包，这里我下载的是v3.26。4、此时已经安装完成，可以在shell中使用cmake命令。2、找到下载的sh文件，并使用bash来执行sh脚本。对于集中的头文件，CMake提供了一个很方便的函数。
cmake使用教程（实操版）（一）
qq_34796146的博客
07-24 1万+
cmake使用教程 本文主要借鉴《CMake+Pratice》一文，如果造成版权问题请联系作者删除。作者在网络上发现关于cmake的中英文材料都比较少，所以有了整理cmake的入门教程的想法。如果需要深入了解cmake的各种命令，建议在已有的项目中学习。在介绍本文的cmake内容之前，本文将整个使用教程分成七篇文章。 一、初识cmake 官网：www.cmake.org 优点： 1、开源代码，使用类BSD许可发布。 2、跨平台，并可以生成native编译配置文件，在linux/Unix平台，生成makefi
cmake使用教程（实操版）
热门推荐
qq_34796146的博客
10-08 11万+
cmake使用教程 目录 一、初识cmake PS:绝大部分使用变量的情况要通过${}引用，而在IF语句中却必须直接使用变量名。 官网：www.cmake.org 优点： 1、开源代码，使用类BSD许可发布。 2、跨平台，并可以生成native编译配置文件，在linux/Unix平台，生成makefile,在苹果平台可以生成Xcode,在windows平台，可以生成MSVC的工程文件。 3、能够管理大型项目。 4、简化编译构建过程和编译过程。cmake的工具链：cmake+make。 5、高效率，因为cma
CMake详解
顺其自然~专栏
01-07 7025
CMake（cross platform make）是一个跨平台的安装（编译）工具，可以用简单的语句来描述所有平台的安装(编译过程)。他能够输出各种各样的makefile或者project文件，能测试编译器所支持的C++特性,类似UNIX下的automake。只是 CMake 的组态档取名为 CMakeLists.txt。Cmake 并不直接建构出最终的软件，而是产生标准的建构档（如 Unix 的 Makefile 或 Windows Visual C++ 的 projects/workspaces），然后
CMake详细教程
m0_43424329的博客
12-07 4868
CMake入门详细教程
07-cmake语法-MATCHES
04-18 3360
如果给定的字串或变量值域给定的正则表达式匹配的话，表达式返回真。 IF (CMAKE_SYSTEM_NAME MATCHES "Linux") MESSAGE(STATUS "current platform: Linux ") ELSEIF (CMAKE_SYSTEM_NAME MATCHES "Windows") MESSAGE(STATUS ...
cmake详细教程（经验版）
IT菜鸟
11-12 6027
Make 就是针对上面问题所设计的工具：它首先允许开发者编写一种平台无关的 CMakeList.txt 文件来定制整个编译流程，然后再根据目标用户的平台进一步生成所需的本地化 Makefile 和工程文件，如 Unix 的 Makefile 或 Windows 的 Visual Studio 工程。从而做到“Write once, run everywhere”。
cmake详细教程pdf
06-22
CMake详细教程PDF是一份非常有用的CMake教程资料，可以帮助初学者快速掌握CMake的使用方法。该PDF文件包含了CMake教程的各个方面，包括从CMake的基本使用到高级主题，以及如何使用CMake构建各种软件项目。 CMake...

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值