CMake第一课--Hello_World
CMake 第一课 Hello_World
一.完整过程
这篇博文主要是教你怎么写一个最简单程序,编写CMakeLists.txt 文件,并进行外部编译。
—————————————————————————————————————————————————
#先建一个空文件夹“1” 它的路径是/home/guo/cmake_practice/1 标红的那部分改成自己的用户名
绝对路径:/home/guo/cmake_practice/1
—————————————————————————————————————————————————
建立一个 main.cpp 和 一个CMakeLists.txt (注意文件名大小写)
main.cpp 文件内容:
#include <iostream> using namespace std; int main( int argc, char** argv ) { cout<<"Hello World!"<<endl; return 0; }
CmakeLists.txt 文件内容:
CMAKE_MINIMUM_REQUIRED( VERSION 2.8 ) # 声明要求的 cmake 最低版本 PROJECT (HELLO) # 声明一个 cmake 工程 SET(SRC_LIST main.cpp) #SET 指令可以用来显式的定义变量
#向终端输出用户定义的信息,打印信息 MESSAGE(STATUS "This is BINARY dir " ${PROJECT_BINARY_DIR}) MESSAGE(STATUS "This is SOURCE dir " ${PROJECT_SOURCE_DIR}) # 添加一个可执行程序 语法:ADD_EXECUTABLE( 生成的可执行文件名 源代码文件 ) ADD_EXECUTABLE(hello ${SRC_LIST})
—————————————————————————————————————————————————
外部编译
开终端
cd /home/guo/cmake_practice/1
mkdir build 新建build文件夹
cd build 进入build文件夹
cmake .. ".." 代表父目录(“1”文件夹),因为父目录存在我们需要的CMakeLists.txt;
"." 代表本目录(build文件夹)
make
通过外部编译进行工程构建,
PROJECT_SOURCE_DIR 仍然指代工程路径,即/home/guo/cmake_practice/1
PROJECT_BINARY_DIR则指代编译路径,即/home/guo/cmake_practice/1/build
(都是绝对路径)
执行二进制可执行文件
cd /home/guo/cmake_practice/1
cd build 进入build文件夹
./hello
—————————————————————————————————————————————————
二.详细解释
1. PROJECT 指令的语法是: PROJECT(projectname [CXX] [C] [Java])
- 你可以用这个指令定义工程名称,并可指定工程支持的语言,支持的语言列表是可以忽略的,默认情况表示支持所有语言。
- 这个指令隐式的定义了两个 cmake 变量: <projectname>_BINARY_DIR 以及 <projectname>_SOURCE_DIR。
- 建议以后直接使用PROJECT_BINARY_DIR和PROJECT_SOURCE_DIR,这样即使修改了工程名称,也不会影响这两个变量。如果使用了<projectname>_SOURCE_DIR ,修改工程名称后,需要同时修改这些变量。
2. SET 指令的语法是: SET(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])
- 现阶段,你只需要了解 SET 指令可以用来显式的定义变量即可。比如我们用到的是SET(SRC_LIST main.cpp)。
- 如果有多个源文件,也可以定义成:SET(SRC_LIST main.cpp t1.cpp t2.cpp)。
3. MESSAGE 指令的语法是:MESSAGE([SEND_ERROR | STATUS | FATAL_ERROR] "message to display"...)
- 这个指令用于向终端输出用户定义的信息,包含了三种类型:
- SEND_ERROR 产生错误,生成过程被跳过
- STATUS 输出前缀为‘-’的信息
- FATAL_ERROR 立即终止所有 cmake 过程
4. ADD_EXECUTABLE(hello ${SRC_LIST})
- 定义了这个工程会生成一个文件名为 hello 的可执行文件,相关的源文件是SRC_LIST 中定义的源文件列表,本例中你也可以直接写:ADD_EXECUTABLE(hello main.cpp)。
5. 将本例可改写成一个最简化的 CMakeLists.txt:
PROJECT(HELLO)
ADD_EXECUTABLE(hello main.cpp)
三.基本语法规则及其他注意事项
1. 在本例我们使用了${ }来引用变量的值,这是 cmake 的变量应用方式。变量使用${ }方式取值,但是在 IF 控制语句中是直接使用变量名;如果使用了${ }去应用变量,其实 IF 会去判断名为${ }所代表的值的变量,那当然是不存在的了。
2. 指令(参数 1 参数 2...)参数使用括弧括起,参数之间使用空格或分号分开。
以上面的 ADD_EXECUTABLE 指令为例,如果存在另外一个 func.cpp 源文件,就要写成:
ADD_EXECUTABLE(hello main.cpp func.cpp) 或者
ADD_EXECUTABLE(hello main.cpp;func.cpp)
3. 指令是大小写无关的,参数和变量是大小写相关的。但,推荐你全部使用大写指令。
4. 这里需要特别解释的是作为工程名的 HELLO 和生成的可执行文件 hello 是没有任何关系的!
hello 定义了可执行文件的文件名,你完全可以写成:
ADD_EXECUTABLE(t1 main.cpp)编译后会生成一个 t1 可执行文件。
5. SET(SRC_LIST main.cpp)也可以写成 SET(SRC_LIST “main.cpp” )是没有区别的;
但是假设一个源文件的文件名是 fu nc.cpp(文件名中间包含了空格)。这时候就必须使用双引号,如果写成了 SET(SRC_LIST fu nc.cpp),就会出现错误,提示你找不到fu文件和nc.cpp文件。这种情况,就必须写成:SET(SRC_LIST “fu nc.cpp”)
6. 终端命令 make clean 即可清理可执行程序。
7. 发布代码时,一定要清理掉所有的中间文件。