CMake---基础练习1

Posted 2021-03-25 carle-09

 

因为卡在一个问题上，几经排除应该可能是CMakeLists.txt写的不正确，但是又生成了可执行文件，运行可执行文件报错。多方排除，应该是CMakeLists.txt加载动态库的时候，函数加载的不全。

猜测可能是CMakeLists.txt写的不正确，因为在CSDN上都是照猫画虎，知其然不知其所以然，几经折腾耗费了时间也没解决问题。索性，系统的学学“Cmake的语法和规则”。

为什么学习“Cmake的语法和规则”？
工程中，只有简单的几个文件（如.cpp），那么首选编写一个Makefile，当然编写一个CMakeLists.txt也很简单。但是，当工程中有很多.cpp .h  .c  .hpp等文件并且还嵌套使用，还有静态库/动态库的时候，这时候选择编写一个CMakeLists.txt就很方便了。实际项目中，不能单是几个简单的.cpp .h，所以学习“Cmake的语法和规则”对我个人来说是必要的。

基础第一个例子：

//main.c

#include <stdio.h>
int main()
{
    printf("Hello World from t1 Main!
 ");
    
    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(HELLO)
ADD_EXECUTABLE(hello main.c)

 

方式1，新建一个build文件夹

方式二，直接在源文件夹下

 

 

 

说明：
（0）CMakeLists.txt的使用命令：cmake + make 。
（1）CMakeLists.txt：注意文件名大小写、文件名正确性。cmakeLists.txt/CmakeLists.txt/CMakeList.txt
（2）cmake .       ：注意命令后面的点号,代表本目录。
（3）cmake ..      ：注意命令后面的点号,代表本目录的上一级目录。
（4）执行【cmake .】之后，系统自动生成了:CMakeFiles, CMakeCache.txt, cmake_install.cmake 等文件,并且生成了
Makefile。不用太关注这些文件的意义，重点是它自动生成了Makefile。
（5）执行【make】之后，系统自动生成了：一个可执行文件。
                                    这个可执行文件名字在ADD_EXECUTABLE(可执行文件名字 ${SRC_LIST})中体现。
（6）CMakeLists.txt：这个文件是 cmake 的构建定义文件。如果工程存在多个目录,需要确保每个要管理的目录都存在一个CMakeLists.txt。【多目录构建,后面在学】
（7）PROJECT 指令的语法是:
    PROJECT(projectname [CXX] [C] [Java])
    你可以用这个指令定义工程名称,并可指定工程支持的语言,支持的语言列表是可以忽略的,默认情况表示支持所有语言。
        这个指令隐式的定义了两个 cmake 变量:<projectname>_BINARY_DIR 以及<projectname>_SOURCE_DIR,这里就是HELLO_BINARY_DIR 和 HELLO_SOURCE_DIR(所以 CMakeLists.txt 中两个 MESSAGE指令可以直接使用了这两个变量),因为采用的是内部编译,两个变量目前指的都是工程所在路径/backup/cmake/t1,后面我们会讲到外部编译,两者所指代的内容会有所不同。同时 cmake 系统也帮助我们预定义了 PROJECT_BINARY_DIR 和 PROJECT_SOURCE_DIR变量,他们的值分别跟 HELLO_BINARY_DIR 与 HELLO_SOURCE_DIR 一致。为了统一起见,建议以后直接使用 PROJECT_BINARY_DIR,PROJECT_SOURCE_DIR,即使修改了工程名称,也不会影响这两个变量。如果使用了<projectname>_SOURCE_DIR ,修改工程名称后,需要同时修改这些变量。

（8）SET 指令的语法是:
SET(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])
现阶段,你只需要了解 SET 指令可以用来显式的定义变量即可。比如我们用到的是 SET(SRC_LIST main.c),如果有多个源文件,也可以定义成：SET(SRC_LIST main.c t1.c t2.c)。

（9）MESSAGE 指令的语法是:MESSAGE([SEND_ERROR | STATUS | FATAL_ERROR] "message to display" ...)
这个指令用于向终端输出用户定义的信息,包含了三种类型:SEND_ERROR,产生错误,生成过程被跳过。SATUS ,输出前缀为 — 的信息。FATAL_ERROR,立即终止所有 cmake 过程.
我们在这里使用的是 STATUS 信息输出,演示了由 PROJECT 指令定义的两个隐式变量HELLO_BINARY_DIR 和 HELLO_SOURCE_DIR。

（10）ADD_EXECUTABLE(hello ${SRC_LIST})定义了这个工程会生成一个文件名为 hello 的可执行文件,相关的源文件是 SRC_LIST 中定义的源文件列表, 本例中你也可以直接写成 ADD_EXECUTABLE(hello main.c)。

（11）1,变量使用${}方式取值,但是在 IF 控制语句中是直接使用变量名
      2,指令(参数 1 参数 2...)
参数使用括弧括起,参数之间使用空格或分号分开。
以上面的 ADD_EXECUTABLE 指令为例,如果存在另外一个 func.c 源文件,就要写成:
    ADD_EXECUTABLE(hello main.c func.c)或者
    ADD_EXECUTABLE(hello main.c;func.c)
     3,指令是大小写无关的,参数和变量是大小写相关的。但,推荐你全部使用大写指令。

上面的 MESSAGE 指令我们已经用到了这条规则:
MESSAGE(STATUS “This is BINARY dir” ${HELLO_BINARY_DIR})
也可以写成:
MESSAGE(STATUS “This is BINARY dir ${HELLO_BINARY_DIR}”)
这里需要特别解释的是作为工程名的 HELLO 和生成的可执行文件 hello 是没有任何关系的。
hello 定义了可执行文件的文件名,你完全可以写成:ADD_EXECUTABLE(t1 main.c)
编译后会生成一个 t1 可执行文件。


cmake 的语法还是比较灵活而且考虑到各种情况,比如
SET(SRC_LIST main.c)也可以写成 SET(SRC_LIST “main.c”)
是没有区别的,但是假设一个源文件的文件名是 fu nc.c(文件名中间包含了空格)。
这时候就必须使用双引号,如果写成了 SET(SRC_LIST fu nc.c),就会出现错误,提示找不到 fu 文件和 nc.c 文件。这种情况,就必须写成:
SET(SRC_LIST “fu nc.c”)
此外,你可以可以忽略掉 source 列表中的源文件后缀,比如可以写成
ADD_EXECUTABLE(t1 main),cmake 会自动的在本目录查找 main.c 或者 main.cpp等,当然,最好不要偷这个懒,以免这个目录确实存在一个 main.c 一个 main.
同时参数也可以使用分号来进行分割。
下面的例子也是合法的:
ADD_EXECUTABLE(t1 main.c t1.c)可以写成 ADD_EXECUTABLE(t1 main.c;t1.c).
我们只需要在编写 CMakeLists.txt 时注意形成统一的风格即可。

（12）清理工程:
   运行:make clean  即可对构建结果进行清理。


   还有另外一个非常重要的提示,就是:刚才例子中进行的是内部构建(in-source build),而 cmake 强烈推荐的是外部构建(out-of-source build)。
（13）内部构建与外部构建:
上面的例子展示的是 “ 内部构建 ” ,相信看到生成的临时文件比您的代码文件还要多的时候,估计这辈子你都不希望再使用内部构建:-D

举个简单的例子来说明外部构建,以编译 wxGTK 动态库和静态库为例,在 Everest 中打包方式是这样的:解开 wxGTK 后。
在其中建立 static 和 shared 目录。
进入 static 目录,运行../configure –enable-static;make 会在 static 目录生成 wxGTK 的静态库。
进入 shared 目录,运行../configure –enable-shared;make 就会在 shared 目录生成动态库。
这就是外部编译的一个简单例子。

对于 cmake,内部编译上面已经演示过了,它生成了一些无法自动删除的中间文件,所以,引出了我们对外部编译的探讨,外部编译的过程如下:
1,首先,请清除 t1 目录中除 main.c CmakeLists.txt 之外的所有中间文件,最关键的是 CMakeCache.txt。
2,在 t1 目录中建立 build 目录,当然你也可以在任何地方建立 build 目录,不一定必须在工程目录中。
3,进入 build 目录,运行 cmake ..(注意,..代表父目录,因为父目录存在我们需要的CMakeLists.txt,如果你在其他地方建立了 build 目录,需要运行 cmake <工程的全路径>),查看一下 build 目录,就会发现了生成了编译需要的 Makefile 以及其他的中间文件。
4,运行 make 构建工程,就会在当前目录(build 目录)中获得目标文件 hello。
上述过程就是所谓的 out-of-source 外部编译,一个最大的好处是,对于原有的工程没有任何影响,所有动作全部发生在编译目录。通过这一点,也足以说服我们全部采用外部编译方式构建工程。这里需要特别注意的是:通过外部编译进行工程构建,HELLO_SOURCE_DIR 仍然指代工程路径,即/learn_Cmake/cmake/t1
而 HELLO_BINARY_DIR 则指代编译路径,即/learn_Cmake/cmake/t1/build