手动学习Cmake

转载已于 2024-02-06 09:55:37 修改 · 210 阅读

0 ·

CC 4.0 BY-SA版权

原文链接：https://blog.youkuaiyun.com/iuu77/article/details/129229361

文章标签：

#学习

于 2024-02-05 09:50:02 首次发布

1.官网地址：

CMake - Upgrade Your Software Build System

2.基础指令

声明要求的最低Cmake版本

        CMAKE_MINIMUM_REQUIRED(VERSIN 2.8)

Cmake工程名

        PROJECT (HELLO)

        这个指令隐式的定义了两个 cmake变量: PROJECT_BINARY_DIR和PROJECT_SOURCE_DIR，分别指向项目的编译路径和工程路径。

生成可执行文件，${}来引用变量。

        ADD_EXECUTABLE(Executable program name ${ Source files })

3.主要变量

Cmake版本：

        CMAKE_SYSTEM_VERSION

可执行文件的输出路径

        EXECUTABLE_OUTPUT_PATH

库文件输出路径

        LIBRARY_OUTPUT_PATH

安装路径

        CMAKE_INSTALL_PREFIX

Note：

该变量可以在Cmakelist中显式地定义，即：SET(CMAKE_INSTALL_PREFIX < install_path >)；
也可以作为命令行参数传递：cmake -DCMAKE_INSTALL_PREFIX=< install_path > ；
还可以在cmake完成后使用make install DESTDIR=< install_path >指定安装路径。

工程编译时存放二进制文件的目录

        CMAKE_BINARY_DIR

将添加的头文件搜索路径放在已有路径的前面。

        CMAKE_INCLUDE_DIRECTORIES_BEFORE

将添加的头文件搜索路径放在已有路径的后面。

        CMAKE_INCLUDE_DIRECTORIES_ AFTER

工程顶层目录

        CMAKE_SOURCE_DIR

定义自己的 cmake模块所在的路径

        CMAKE_MODULE_PATH

控制库的默认编译方式

        BUILD_SHARED_LIBS

设置 C++/C的编译选项，也可以通过指令 ADD_DEFINITIONS()添加

        CMAKE_CXX_FLAGS/ CMAKE_CXX_FLAGS

Note：该指令非常重要，因为它能选择C++/C工程的编译器行为。有时候我们依赖的第三方库的编译方式与自己项目的编译方式不一致时，编译会通过，但是运行时出现非常隐蔽的bug。此时就需要检查，项目中各种库的编译行为是否一致。

设置构建类型，类型选项有Debug/Release。

        CMAKE_BUILD_TYPE

        当使用GDB调试工程时要使用Debug选项。该变量可以通过命令行：cmake DCMAKE_BUILD_TYPE=Release或指令SET(CMAKE_BUILD_TYPE [type])设置。

4.重要的指令和语句

#查看Cmake生成的详细编译信息，相当于执行make VERBOSE=1。当构建失败并且需要找出原因时使用该条指令非常有帮助。

SET(CMAKE_VERBOSE_MAKEFILE on )

#显式的为变量赋值，非常重要

SET(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])

#用来寻找第三方库的Find<name>.cmake模块，该模块里提供了库的头文件路径和库文件路径。如果找不到，通过设置 CMAKE_MODULE_PATH 变量来告诉 Cmake 在哪里找到它。

FIND_PACKAGE(<name> [major.minor] [QUIET] [NO_MODULE] [[REQUIRED|COMPONENTS] [componets...]])

Note：编译一个链接第三方库的软件时，我们需要知道该库的头文件路径、库文件路径、要链接的库的文件名。使用第三方库时必须在Cmakelist中提供这些信息。

#向终端输出用户定义的信息，显示状态信息、警告或错误。包含了三种类型:SEND_ERRO、SATUS、FATAL_ERROR。

MESSAGE([SEND_ERROR | STATUS | FATAL_ERROR] "message to display"...)

例：MESSAGE(STATUS "This is SOURCE dir "${HELLO_SOURCE_DIR})

#添加可执行文件

ADD_EXECUTABLE(<name> IMPORTED [GLOBAL])

#向当前工程添加存放源文件的子目录，并指定中间二进制和目标二进制存放的位置。

ADD_SUBDIRECTORY(source_dir [binary_dir] )

#生成库。生成的库的类型有三种:SHARED，动态库；STATIC，静态库；MODULE，在使用 dyld的系统有效。

ADD_LIBRARY(libname [SHARED|STATIC|MODULE] [EXCLUDE_FROM_ALL] source1 source2 ... sourceN)

#设置输出目标的属性

SET_TARGET_PROPERTIES(target1 target2 ...PROPERTIES prop1 value1 prop2 value2 ...)

例：设置目标库的名称：SET_TARGET_PROPERTIES(taget_name PROPERTIES OUTPUT_NAME "hello")

#设置动态库的版本号，VERSION指代动态库版本，SOVERSION指代 API版本。

SET_TARGET_PROPERTIES(hello PROPERTIES VERSION 1.2 SOVERSION 1)

#向工程添加多个特定的头文件搜索路径。系统默认的头文件路径是/usr/include和/usr/local/include，如果不是，需要在Cmakelist中显式的定义。

INCLUDE_DIRECTORIES([AFTER|BEFORE] [SYSTEM] dir1 dir2 ...)

#将目标文件链接到第三方库，非常重要的语句

TARGET_LINK_LIBRARIES(target library1<debug | optimized> library2...)

#在指定路径中搜索文件名,指定路径指的是环境变量CMAKE_INCLUDE_PATH中包含的所有路径。

FIND_PATH(filename)

#向 C/C++编译器添加-D定义。修改预处理器设置

ADD_DEFINITIONS()

#定义 target依赖的其他 target，确保在编译本 target之前，其他的 target已经被构建

ADD_DEPENDENCIES()

#搜索一个目录下所有的源代码文件并将列表存储在一个变量，可以与ADD_EXECUTABLE连用。

AUX_SOURCE_DIRECTORY(. SRC_LIST)

ADD_EXECUTABLE(main ${SRC_LIST})

#if语句, 如果表达式内容不是：空，0，N, NO, OFF, FALSE, NOTFOUND或<var>_NOTFOUND时，表达式为真。

IF(expression)

…..

ELSE(expression)

…..

ENDIF(expression)

#列表变量遍历语句

FOREACH(loop_var)

...

ENDFOREACH(loop_var)

#while语句

WHILE(condition)

...

ENDWHILE(condition)