cmake基础知识

前言

Cmake是一个跨平台的编译自动配置工具，使用名为CMakeLists.txt的文件描述构建过程，可以产生标准的构建文件，可以用简单的语言来描述所有平台的安装、编译过程。能够输出各种各样的makefile或者project文件，能测试编译器所支持的c++特性。
Cmake的组态档取名为CMakeLists.txt。组态档是一种构建软件专用的特殊编程语言写的cmake脚本，文件CMakeLists.txt需要手工编写，也可以通过编写脚本进行半自动的生成。通过编写CMakeLists.txt，可以控制生成的makefile，从而控制编译过程。
查看系统是否安装cmake使用以下命令：
cmake –version
若没有安装，执行下面命令今进行安装：
sudo apt-get install cmake
cmake的语法比较简单，由命令、注视和空格组成，其中命令不区分大小写，参数和变量区分大小写，符号#后面的内容被认为是注视。命令由命令名称、小括号和参数组成，参数之间使用空格或分号隔离，变量使用${xxx}引用。

---

单个目录单个源文件

目录结构

.
├── build
├── CMakeLists.txt
└── main.c

其中main.c文件内容为

#include<stdio.h>
int main()
{
    printf("Hello World!\n");
    printf("This is a Cmake test programe!\n");
    printf("My name is shuxiangqian and i am your God!\n");
    return 0;
}

CMakeLists.txt文件内容为

project(HELLO)
set(SRC_LIST main.c)
add_executable(hello ${SRC_LIST})

其中project命令为设置项目名称，非强制性的，但是最好加上
set命令用来设置变量
add_executable命令告诉工程生成一个可执行文件，名为hello
至此文件内容编写完成，使用终端进入build目录，执行命令cmake path，其中path为主目录中CMakeLists.txt所在的目录，这样可以使编译生成的文件在build文件中，如果嫌麻烦，可以在终端中只进入CMakeLists.txt所在的目录，执行cmake .即可实现同样作用。之后执行make对程序进行编译，可生成hello可执行文件 使用./hello运行此文件查看结果。

---

单个目录多个源文件

目录结构

.
├── build
├── CMakeLists.txt
├── hello.c
├── hello.h
└── main.c

各个文件内容为
CMakeLists.txt

cmake_minimum_required(VERSION 2.8)
project(test)
aux_source_directory(. DIR_SRCS)
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/build)
add_executable(test ${DIR_SRCS})

hello.c

#include<stdio.h>
#include"hello.h"
void hello(const char* name)
{
    printf("Hello %s\n",name);
}

hello.h

#ifndef _HELLO_H
#define _HELLO_H
void hello(const char* name);
#endif

main.c

#include"hello.h"
int main()
{
    hello("Sir!");
    return 0;
}

aux_source_directory(. DIR_SRCS)命令可将当前目录下所有源文件赋值给 DIR_SRCS变量，用于后续生成可执行文件。也可以不使用此命令，使用add_executable(test main.c hello.c)命令生成可执行文件，但当源文件过多时则会很麻烦。
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/build)命令指定生成的可执行文件所在的目录为build文件。

---

多个文件多个目录

目录结构

.
├── CMakeLists.txt
├── main.c
└── Mymath
    ├── CMakeLists.txt
    ├── mymath.c
    └── mymath.h

各个文件内容如下
主目录中CMakeLists.txt

project(demo)
add_subdirectory(Mymath)
include_directories(${PROJECT_SOURCE_DIR}/Mymath)
set(SRC main.c)
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/exe)
add_executable(math_test ${SRC})
target_link_libraries(math_test mymath)

其中add_subdirectory(Mymath)添加头文件目录
include_directories(${PROJECT_SOURCE_DIR}/Mymath)包含源文件所在目录
target_link_libraries(math_test mymath)链接一个 mymath的库
main.c

#include<stdio.h>
#include"mymath.h"
int main()
{
    int temp;
    int a=5;
    int b=4;
    temp=power(a,b);
    printf("Using our own math lib!\n");
    printf("%d^%d=%d\n",a,b,temp);
    return 0;
}

子目录中CMakeLists.txt

cmake_minimum_required(VERSION 2.8)
set(LIB_SRC mymath.c)                       
add_library(mymath STATIC ${LIB_SRC})      
set(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib)

其中add_library(mymath STATIC ${LIB_SRC})命令生成名为 mymath的库

mymath.c

#include"mymath.h"
int power(int a,int b)
{
    int i=0;
    int result=a;
    if(b==0)
        return 1;
    for(;i<b-1;i++)
    {
        result*=a;
    }
    return result;
}

mymath.h

#ifndef _MYMATH_H
#define _MYMATH_H
int power(int,int);
#endif

执行cmake .命令和make命令编译，运行可执行文件得到输出结果为
Using our own math lib!
5^4=625

---

扩展：当主函数也在单独一个目录中时的情况

目录结构为

.
├── build
├── CMakeLists.txt
├── libhello
│   ├── CMakeLists.txt
│   ├── hello.c
│   └── hello.h
└── src
    ├── CMakeLists.txt
    └── main.c

各个文件内容如下
主目录中CMakeLists.txt

project(HELLO)
add_subdirectory(src)
add_subdirectory(libhello)

作用是添加两个源文件所在目录，此时程序进入src执行其中的CMakeLists.txt文件

src目中
CMakeLists.txt

cmake_minimum_required(VERSION 2.8)
include_directories(${PROJECT_SOURCE_DIR}/libhello)
set(APP_SRC main.c)
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)
add_executable(main ${APP_SRC})
target_link_libraries(main libhello)

包含了库源文件所在的目录，设置了生成的可执行文件的目录，设置了链接库

main.c

#include"hello.h"
int main()
{
    hello("Sir!");
    return 0;
}

libhello目录中
CmakeLists.txt

cmake_minimum_required(VERSION 2.8)
set(LIB_SRC hello.c)    
add_library(libhello STATIC ${LIB_SRC})
set(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib) 
set_target_properties(libhello PROPERTIES OUTPUT_NAME "hello")
install(TARGETS libhello
LIBRARY DESTINATION lib
ARCHIVE DESTINATION lib)
install(FILES hello.h DESTINATION include/hello)

主要是设置库文件生成的目录，生成库，设置库文件属性，其中set_target_properties命令和install命令可以不加。

hello.c

#include<stdio.h>
#include"hello.h"
void hello(const char* name)
{
    printf("Hello %s\n",name);
}

hello.h

#ifndef _HELLO_H
#define _HELLO_H
void hello(const char* name);
#endif

使用cmake .命令和make编译源程序并允许，可以看到程序正确执行。