CMakeLists相关语法说明(一)

1、cmake使用实例

1.1、构建目录t1

2.2、编写main.c，CmakeLists.txt文件

//main.c
#include  int main()
{
     printf(“Hello World from t1 Main!\n”);
     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)

1.3、在t1目录输入

cmake ..

1.4、屏幕结果

-- The C compiler identification is GNU 4.8.5
-- The CXX compiler identification is GNU 4.8.5
-- Check for working C compiler: /usr/bin/cc
-- Check for working C compiler: /usr/bin/cc -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Detecting C compile features
-- Detecting C compile features - done
-- Check for working CXX compiler: /usr/bin/c++
-- Check for working CXX compiler: /usr/bin/c++ -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- this is BINARY DIR/root/cpp_test/backup/cmake/t1
-- this is SOURCE dir/root/cpp_test/backup/cmake/t1
-- Configuring done
-- Generating done
-- Build files have been written to: /root/cpp_test/backup/cmake/t1

CMakeFiles, CMakeCache.txt, cmake_install.cmake等文件，并且生成了 Makefile

1.4、继续输入命令，会生成目标文件hello

make

[ 50%] Building C object CMakeFiles/hello.dir/main.c.o
[100%] Linking C executable hello
[100%] Built target hello

1.5、执行键入

./hello

输出：Hello World from t1 Main!

2、CMakeLists.txt简单语法

2.1、PROJECT 指令语法

​​​​​​​PROJECT(projectname [CXX] [C] [Java])

你可以用这个指令定义工程名称，并可指定工程支持的语言，支持的语言列表是可以忽略的， 默认情况表示支持所有语言。这个指令隐式的定义了两个 cmake 变量: _BINARY_DIR 以及_SOURCE_DIR，这里就是 HELLO_BINARY_DIR 和 HELLO_SOURCE_DIR(所以 CMakeLists.txt 中两个 MESSAGE 指令可以直接使用了这两个变量)，因为采用的是内部编译，两个变量目前指的都是工程所 在路径/root/cpp_test/backup/cmake/t1，后面我们会讲到外部编译，两者所指代的内容会有所不同。

同时 cmake 系统也帮助我们预定义了 PROJECT_BINARY_DIR 和 PROJECT_SOURCE_DIR 变量，他们的值分别跟 HELLO_BINARY_DIR 与 HELLO_SOURCE_DIR 一致。

为了统一起见，建议以后直接使用 PROJECT_BINARY_DIR，PROJECT_SOURCE_DIR，即 使修改了工程名称，也不会影响这两个变量。如果使用了 _SOURCE_DIR，修改工程名称后，需要同时修改这些变量。

2.2、SET 指令语法

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

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

2.3、MESSAGE 指令语法

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

这个指令用于向终端输出用户定义的信息，包含了三种类型: SEND_ERROR，产生错误，生成过程被跳过。 SATUS，输出前缀为—的信息。

FATAL_ERROR，立即终止所有 cmake 过程.
我们在这里使用的是 STATUS 信息输出，演示了由 PROJECT 指令定义的两个隐式变量

HELLO_BINARY_DIR 和 HELLO_SOURCE_DIR。

2.4、ADD_EXECUTABLE指令

ADD_EXECUTABLE(hello ${SRC_LIST})

定义了这个工程会生成一个文件名为 hello 的可执行文件，相关的源文件是 SRC_LIST 中

定义的源文件列表， 本例中你也可以直接写成ADD_EXECUTABLE(hello main.c)。

在本例我们使用了${}来引用变量，这是 cmake 的变量应用方式，但是，有一些例外，比 如在 IF 控制语句，变量是直接使用变量名引用，而不需要${}。如果使用了${}去应用变 量，其实 IF 会去判断名为${}所代表的值的变量，那当然是不存在的了。

将本例改写成一个最简化的 CMakeLists.txt:

PROJECT(HELLO)
ADD_EXECUTABLE(hello main.c)

2.5、基本语法规则

前面提到过，cmake 其实仍然要使用”cmake 语言和语法”去构建，上面的内容就是所谓的”cmake 语言和语法”，最简单的语法规则是:
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)

2.6、cmake注意事项

cmake 的语法还是比较灵活而且考虑到各种情况，比如SET(SRC_LIST main.c)也可以写成SET(SRC_LIST “main.c”)是没有区别的，但是假设一个源文件的文件名是func.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 时注意形成统一的风格即可。

2.7、清理工程

make clean

只是清除了可执行文件hello