CmakeLists.txt和makefiles的关系及原理解析

cmakelists.txt和makefiles的关系及原理

1.cmake编译原理

cmake是一种跨平台编译工具，比make更为高级，使用起来要方便得多。cmake主要是编写cmakelists.txt文件，然后用cmake命令将cmakelists.txt文件转化为make所需要的makefile文件，最后用make命令编译生成可执行程序或共享库（so(shared object)）。因此cmake的编译基本就两个步骤：

1. cmake
2. make

cmake 指向cmakelists.txt所在的目录，例如cmake .. 表示cmakelists.txt在当前目录的上一级目录。cmake后会生成很多编译的中间文件以及makefile文件，所以一般建议新建一个新的目录，专门用来编译，例如

mkdir build
cd build
cmake ..
make

make根据生成makefile文件，编译程序。

2.使用cmake编译程序

我们编写一个关于开平方的c/c++程序项目，即b= sqrt(a)，以此理解整个cmake编译的过程。

a.准备程序文件

文件目录结构如下：

.
├── build
├── cmakelists.txt
├── include
│ └── b.h
└── src
    ├── b.c
    └── main.c

头文件b.h，如下所示：

#ifndef b_file_header_inc 

#define b_fiel_header_inc

#include double cal_sqrt(double value); #endif

头文件b.c，如下所示：

#include "../include/b.h"

double cal_sqrt(double value)
{
    return sqrt(value);
}

main.c主函数，如下所示：

#include "../include/b.h"

#include int main(int argc, char** argv) { double a = 49.0; double b = 0.0; printf("input a:%f\n",a); b = cal_sqrt(a); printf("sqrt result:%f\n",b); return 0; }

b.编写cmakelists.txt

接下来编写cmakelists.txt文件，该文件放在和src，include的同级目录，实际方哪里都可以，只要里面编写的路径能够正确指向就好了。cmakelists.txt文件，如下所示：

 1 #1.cmake verson，指定cmake版本 
 2 cmake_minimum_required(version 3.2)
 3 
 4 #2.project name，指定项目的名称，一般和项目的文件夹名称对应
 5 project(test_sqrt)
 6 
 7 #3.head file path，头文件目录
 8 include_directories(
 9 include
10 )
11 
12 #4.source directory，源文件目录
13 aux_source_directory(src dir_srcs)
14 
15 #5.set environment variable，设置环境变量，编译用到的源文件全部都要放到这里，否则编译能够通过，但是执行的时候会出现各种问题，比如"symbol lookup error xxxxx , undefined symbol"
16 set(test_math
17 ${dir_srcs}
18 )
19 
20 #6.add executable file，添加要编译的可执行文件
21 add_executable(${project_name} ${test_math})
22 
23 #7.add link library，添加可执行文件所需要的库，比如我们用到了libm.so（命名规则：lib+name+.so），就添加该库的名称
24 target_link_libraries(${project_name} m)

cmakelists.txt主要包含以上的7个步骤，具体的意义，请相应的注释。

c.编译和运行程序

准备好了以上的所有材料，接下来，就可以编译了，由于编译中出现许多中间的文件，因此最好新建一个独立的目录build，在该目录下进行编译，编译步骤如下所示：

mkdir build
cd build
cmake ..
make

操作后，在build下生成的目录结构如下：

├── build
│ ├── cmakecache.txt
│ ├── cmakefiles
│ │ ├── 3.2.2
│ │ │ ├── cmakeccompiler.cmake
│ │ │ ├── cmakecxxcompiler.cmake
│ │ │ ├── cmakedeterminecompilerabi_c.bin
│ │ │ ├── cmakedeterminecompilerabi_cxx.bin
│ │ │ ├── cmakesystem.cmake
│ │ │ ├── compileridc
│ │ │ │ ├── a.out
│ │ │ │ └── cmakeccompilerid.c
│ │ │ └── compileridcxx
│ │ │     ├── a.out
│ │ │     └── cmakecxxcompilerid.cpp
│ │ ├── cmake.check_cache
│ │ ├── cmakedirectoryinformation.cmake
│ │ ├── cmakeoutput.log
│ │ ├── cmaketmp
│ │ ├── feature_tests.bin
│ │ ├── feature_tests.c
│ │ ├── feature_tests.cxx
│ │ ├── makefile2
│ │ ├── makefile.cmake
│ │ ├── progress.marks
│ │ ├── targetdirectories.txt
│ │ └── test_sqrt.dir
│ │     ├── build.make
│ │     ├── c.includecache
│ │     ├── cmake_clean.cmake
│ │     ├── dependinfo.cmake
│ │     ├── depend.internal
│ │     ├── depend.make
│ │     ├── flags.make
│ │     ├── link.txt
│ │     ├── progress.make
│ │     └── src
│ │         ├── b.c.o
│ │         └── main.c.o
│ ├── cmake_install.cmake
│ ├── makefile
│ └── test_sqrt
├── cmakelists.txt
├── include
│ └── b.h
└── src
    ├── b.c
    └── main.c

注意在build的目录下生成了一个可执行的文件test_sqrt,运行获取结果如下：

命令：
./test_sqrt 
结果：
input a:49.000000
sqrt result:7.000000

d.源码

地址：test_sqrt.tar.gz

3.参考资料

[1].cmake 使用方法 & cmakelist.txt