Cmake 实例学习一

首页 > Cmake 实例学习一

Cmake 实例学习一

一. 第一个简单的例子

在一个目录下面实现一个简单的 hello world 程序

使用cmake进行构建的时候，每个目录下面都要有一个 CMakeLists.txt 的文件

如果是一个稍微大的工程，有多级目录，在上级目录中的 CMakeLists.txt 中会有定义要求编译子目录的逻辑

当前目录中定义了一个main.c 和 CMakeLists.txt 文件，两个文件的内容分别如下

main.c

#include 
int main()
{printf("hello world!
");return 0;
}

CMakeLists.txt

project (hello)
set(SRC_LIST main.c)
message(STATUS "this is binary dir" ${HELLO_BINARY_DIR})
message(STATUS "this is source dir" ${HELLO_SOURCE_DIR})
add_executable(hello ${SRC_LIST})

重点解释 CMakeLists.txt 中的内容

project 定义工程名成set 定义一个变量，把后面的 mian.c 赋值给了 SRC_LIST ，这样做的好处是，
如果需要编译多个文件构成同一个可执行程序的时候，
在后面用到的时候，不需要每次都写多个文件，只需要使用这个变量名就可以了message 打印一些信息，这里可以打印多种信息，上文中需要打印出来的信息就是一个状态信息
后面可能会用到的打印信息包括，
SEND_ERROR，产生错误，生成过程被跳过。FATAL_ERROR，立即终止所有 cmake 过程.等add_executable 添加可执行程序，hello 是生成的可执行程序名
后面的符号表示生成这个可执行程序需要依赖的源文件注意其中的变量，使用set定义了变量之后，后面在使用的时候一般是需要加上 ${} 符号的
但是在 IF 判断语句中，如果使用 ${} 判断指令的话，就是不正确的，
因为那个样子的话，IF 判断的就是变量本身的内容另外注意的是，工程名project中的hello和可执行程序名中 add_executable 
中的 hello 是没有直接关系的，即两处的名称可以不同

二. 第二个例子，使hello更像一个工程

本小结将完成如下工作

1，为工程添加一个子目录 src，用来放置工程源代码;
2，添加一个子目录 doc，用来放置这个工程的文档 hello.txt
3，在工程目录添加文本文件 COPYRIGHT, README；
4，在工程目录添加一个 runhello.sh 脚本，用来调用 hello 二进制
4，将构建后的目标文件放入构建目录的 bin 子目录；
5，最终安装这些文件：将 hello 二进制与 runhello.sh 安装至/usr/bin，将 doc 目录
的内容以及 COPYRIGHT/README 安装到/usr/share/doc/cmake/t2，将

我们需要在上一节的基础之上，将文件改一下

首先新建一个目录t2，将上一个工程中的所有文件添加到这个文件中

在当前目录下面新建目录src。这个src专门用于存放文件程序的源代码

把 main.c 移动到 src 目录下面

上文提到每个目录下面需要增加CMakeLists.txt文件

所以需要在src目录下面新建一个CMakeLists.txt 文件，文件中写入如下内容

add_executable(hello main.c)

因为在工程中增加了子目录，我们需要在相应的父目录中的CMakeLists.txt 中增加相关的配置

在父目录下面的CMakeLists.txt 中修改最后的add，改成

add_subdirectory(src bin)

父目录中 CMakeLists 全文如下

project (hello)
set(SRC_LIST main.c)
message(STATUS "this is binary dir" ${HELLO_BINARY_DIR})
message(STATUS "this is source dir" ${HELLO_SOURCE_DIR})
#add_executable(hello ${SRC_LIST})
add_subdirectory(src bin)

这里解释一下最后一句

因为增加了子目录，这里需要将子目录增加进来，并且将子目录编译的结果放到了 bin目录下面

这里的重点是，将整个子目录将入到工程中，从而这个父目录和这个子目录整体构成了一个工程

另外我们也可以通过修改内置的隐式变量来指定程序输出的位置，简要如下

SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)
SET(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib)

三 . 添加共享库

有了上面的基础，添加动态库也是如此的简单

创建一个新的目录，用于存放新的工程t3

将之前t2的内容拷贝到t3中

新建一个lib目录，在lib目录下面创建三个文件，分别是 hello.c 和 hello.h 和 CMakeLists.txt

hello.c

#include "hello.h"
void HelloFunc()
{printf("hello world
");
}

hello.h

#ifndef HELLO_H
#define HELLO_H#include 
void HelloFunc();#endif

CMakeLists

set(LIBHELLO_SRC hello.c)
add_library(hello SHARED ${LIBHELLO_SRC})

这里解释一下子目录中的定义，其实很简单，就是生成一个库文件，这里hello是库文件的名称，SHARED 表示生成的是动态库，如果要生成静态库，使用的是STATIC，后面表示生成库文件需要的源文件是什么

在父目录中，修改 CMakeLists如下

cmake_minimum_required(VERSION 2.6)
project (hellolib)
#add_executable(hello ${SRC_LIST})
#add_subdirectory(src bin)
add_subdirectory(lib)

父目录中的CMakeLists就是添加一个子目录，子目录执行的任务在子目录中会定义

四. 生成一个库文件，并链接他

在同一个一个工程中，我们既需要生成一个库文件，又需要链接这个库文件

在上面二和三的基础之上，即既保留了 src 目录，又保留了 lib 目录的基础之上，

保持 lib 中的CMakeLists不变，需要修改父目录中的 CMakeLists如下

cmake_minimum_required(VERSION 2.6)
project (hellolib)
#add_executable(hello ${SRC_LIST})
#add_subdirectory(src bin)
add_subdirectory(lib)
add_subdirectory(src bin)

父目录中实际只是在生成 lib 的基础之上，增加了而一个新的子目录 src

进入到 src 目录中，修改源代码，我们需要在 main.c 中增加头文件和修改函数，如下所示

#include 
#include "hello.h"
int main()
{HelloFunc();return 0;
}

重点在 src 中的 CMakeLists 的编写，这里因为需要链接到库文件，所以需要注意两个内容，

一个是头文件，一个是库文件

src 中 CMakeLists 的书写如下所示

include_directories("${PROJECT_SOURCE_DIR}/lib")
add_executable(main main.c)
target_link_libraries(main hello)

第一行，增加头文件的查找目录，这里使用了变量， PROJECT_SOURCE_DIR 是 cmake 的内置变量，表示工程的目录所在位置，加上这个头文件目录的选项之后，程序在编译的时候，就会到这个目录下面去寻找头文件

第二行不在赘述

第三行表示，编译源文件 main 的时候，需要链接的库文件，这个库文件就是之前在 lib 中生成的库文件 hello

综上，在一个程序编译的时候，需要使用库文件的时候，需要注意两个内容，一个是头文件，一个就是库文件

五. 使用 cmake 和程序代码，决定是否调用自制库文件

在四的基础之上，我们需要改变一些CMakeLists的配置，通过判断是否需要一些条件来执行一些函数

在顶层的CMakeLists中，修改如下

cmake_minimu_required(VERSION 2.6)
project (hellolib)
#add_executable(hello ${SRC_LIST})
#add_subdirectory(src bin)
option(USE_MYLIB "Use my lib" ON)
add_subdirectory(lib)
add_subdirectory(src bin)

此处在中间加了一个options的选项，定义了一个选项USE_MYLIB 并默认为打开的

如果需要不想要一些逻辑的话，我们直接可以通过修改这个 ON 为OFF就可以关掉一些功能了

在 src 的CMakeLists中需要修改如下

if (USE_MYLIB)add_definitions(-DUSE_MYLIB)include_directories("${PROJECT_SOURCE_DIR}/lib")set(EXTRA_LIBS ${EXTRA_LIBS} hello)
endif (USE_MYLIB)message(STATUS "extra libs: " ${EXTRA_LIBS})
add_executable(main main.c)
target_link_libraries(main ${EXTRA_LIBS})

这里开始就是一个判断，就是判断这个 USE_MYLIB 是否为真，注意这里的 USE_MYLIB 不需要加 ${} 如果加上的，就表示取他的值了

如果这个判断为真，就执行如下的操作，这个值在顶层的 CMakeLists 中，已经定义为 ON了，所以此处会判断为真

在这个 if 为真的判断中，需要加上一个宏定义，定义了一个东西，这个宏是可以传递到代码中的

此外，如果这个判断为真，还是加上需要链接的头文件，和需要链接的库文件，这里没有直接链接上库文件，而是通过将库文件赋值给了一个变量，这个变量是cmake内置的变量

最后，编译这个程序，如果上面的判断为真，就会链接到了这个库文件，如果为假，则这个内置变量就是空的，具体是不是cmake内置的变量还有待考证

修改了 CMakeLists之后，还需要在代码中进行修改，src 中修改之后的代码如下

#include 
#ifdef USE_MYLIB
#include "hello.h"
#endifint main()
{
#ifdef USE_MYLIBHelloFunc();
#elseprintf("AAA
");
#endifreturn 0;
}

前面已经说过，如果在src 中的CMakeLists中的判断为真，就会加上一个宏，这个宏可以传递到代码里面的，在代码中，我们就可以通过判断这个宏是否为真的方式，来决定是否使用自己定义的库文件了