Cmake知識----編寫CMakeLists.txt文件編譯C/C++程序

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<math.h>

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 <stdio.h>
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