CMake相关知识介绍

cmake 是一个跨平台的安装编译工具，可以用简单的语言来描述所有平台的安装编译过程。

语法特性介绍：

		基本语法格式： 指令（参数1  参数2......）
			参数使用括弧阔起
			参数之间使用空格或者分号分开
		指令是大小写无关的，参数和变量是大小写相关的
		变量使用${} 方式进行取值，但是IF控制语句是直接使用变量名。

重要指令：

cmake_minimum_required - 指定CMake的最小版本要求

• 1# CMake最小版本要求为2.8.3
• 2cmake_minimum_required(VERSION 2.8.3)
• 语法：cmake_minimum_required(VERSION versionNumber [FATAL_ERROR])

project - 定义工程名称，并可指定工程支持的语言

• 1# 指定工程名为HELLOWORLD
• 2project(HELLOWORLD)
• 语法：project(projectname [CXX] [C] [Java])

set - 显式的定义变量

• 1# 定义SRC变量，其值为main.cpp hello.cpp
• 2set(SRC sayhello.cpp hello.cpp)
• 语法：set(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])

include_directories - 向工程添加多个特定的头文件搜索路径 —>相当于指定g++编译器的-I参数

• 1# 将/usr/include/myincludefolder 和 ./include 添加到头文件搜索路径
• 2include_directories(/usr/include/myincludefolder ./include)
• 语法：include_directories([AFTER|BEFORE] [SYSTEM] dir1 dir2 …)

link_directories - 向工程添加多个特定的库文件搜索路径 —>相当于指定g++编译器的-L参数

• 1# 将/usr/lib/mylibfolder 和 ./lib 添加到库文件搜索路径
• 2link_directories(/usr/lib/mylibfolder ./lib)
• 语法：link_directories(dir1 dir2 …)

add_library - 生成库文件

• 1# 通过变量 SRC 生成 libhello.so 共享库
• 2add_library(hello SHARED ${SRC})
• 语法：add_library(libname [SHARED|STATIC|MODULE] [EXCLUDE_FROM_ALL]
  source1 source2 … sourceN)

add_compile_options - 添加编译参数

• 1# 添加编译参数 -Wall -std=c++11
• 2add_compile_options(-Wall -std=c++11 -O2)

add_executable - 生成可执行文件

• 1# 编译main.cpp生成可执行文件main
• 2add_executable(main main.cpp)
• 语法：add_library(exename source1 source2 … sourceN)

target_link_libraries - 为 target 添加需要链接的共享库 —>相同于指定g++编译器-l参数

• 1# 将hello动态库文件链接到可执行文件main
• 2target_link_libraries(main hello)
• 语法：target_link_libraries(target library1library2…)

add_subdirectory - 向当前工程添加存放源文件的子目录，并可以指定中间二进制和目标二进制存放的位置

• 1# 添加src子目录，src中需有一个CMakeLists.txt
• 2add_subdirectory(src)
• 语法：add_subdirectory(source_dir [binary_dir] [EXCLUDE_FROM_ALL])

aux_source_directory - 发现一个目录下所有的源代码文件并将列表存储在一个变量中，这个指令临时被用来自动构建源文件列表

• 1# 定义SRC变量，其值为当前目录下所有的源代码文件
• 2aux_source_directory(. SRC)
• 3# 编译SRC变量所代表的源代码文件，生成main可执行文件
• 4add_executable(main ${SRC})
• 语法：aux_source_directory(dir VARIABLE)

message(“this is not good”), 可以利用该语句进行输出打印消息
find_packet : (为我们寻找外部依赖的包)

• 通过Cmake内置模块引入依赖包
  为了方便我们在项目中引入外部依赖包，cmake官方为我们预定义了许多寻找依赖包的Module，他们存储在path_to_your_cmake/share/cmake-/Modules目录下。每个以Find.cmake命名的文件都可以帮我们找到一个包。我们也可以在官方文档中查看到哪些库官方已经为我们定义好了，我们可以直接使用find_package函数进行引用官方文档：Find
  Modules。
  我们以curl库为例，假设我们项目需要引入这个库，从网站中请求网页到本地，我们看到官方已经定义好了FindCURL.cmake。所以我们在CMakeLists.txt中可以直接用find_pakcage进行引用。

find_package(CURL)
add_executable(curltest curltest.cc)
if(CURL_FOUND)
    target_include_directories(clib PRIVATE ${CURL_INCLUDE_DIR})
    target_link_libraries(curltest ${CURL_LIBRARY})
else(CURL_FOUND)
    message(FATAL_ERROR ”CURL library not found”)
endif(CURL_FOUND)

• 对于系统预定义的 Find.cmake 模块，使用方法一般如上例所示。 每一个模块都会定义以下几个变量 -

   <LibaryName>_FOUND or <LibaryName>_INCLUDE_DIR or <LibaryName>_INCLUDES
   <LibaryName>_LIBRARY or <LibaryName>_LIBRARIES

你可以通过_FOUND 来判断模块是否被找到，如果没有找到，按照工程的需要关闭
某些特性、给出提醒或者中止编译，上面的例子就是报出致命错误并终止构建。 如果_FOUND
为真，则将_INCLUDE_DIR 加入 INCLUDE_DIRECTORIES，

CMAKE常用变量

• CMAKE_C_FLAGS gcc编译选项
• CMAKE_CXX_FLAGS g++编译选项
  1# 在CMAKE_CXX_FLAGS编译选项后追加-std=c++11
  2set( CMAKE_CXX_FLAGS “${CMAKE_CXX_FLAGS} -std=c++11”)
• CMAKE_BUILD_TYPE 编译类型(Debug, Release)
  1# 设定编译类型为debug，调试时需要选择debug
  2set(CMAKE_BUILD_TYPE Debug)
  3# 设定编译类型为release，发布时需要选择release
  4set(CMAKE_BUILD_TYPE Release)
• CMAKE_BINARY_DIR or PROJECT_BINARY_DIR or projectname’__BINARY_DIR
  这三个变量指代的内容是一致的。
  如果是 in source build，指的就是工程顶层目录。
  如果是 out-of-source 编译,指的是工程编译发生的目录。
  PROJECT_BINARY_DIR 跟其他指令稍有区别，不过现在，你可以理解为他们是一致的。
• CMAKE_SOURCE_DIR or PROJECT_SOURCE_DIR or ‘projectname’__SOURCE_DIR
  这三个变量指代的内容是一致的,不论采用何种编译方式,都是工程顶层目录。 也就是在 in source build时,他跟
  CMAKE_BINARY_DIR 等变量一致。 PROJECT_SOURCE_DIR 跟其他指令稍有区别,现在,你可以理解为他们是一致的。
• CMAKE_C_COMPILER：指定C编译器
• CMAKE_CXX_COMPILER：指定C++编译器
• EXECUTABLE_OUTPUT_PATH：可执行文件输出的存放路径
• LIBRARY_OUTPUT_PATH：库文件输出的存放路径
• CMAKE_CXX_STANDARD 指定使用的C++版本
• CMAKE_CURRENT_SOURCE_DIR :This the full path to the source directory
  that is currently being processed by cmake

Cmake编译工程

• CMAKE的目录结构：
  项目主目录存在一个cmakeList.txt文件

  包含源文件的子文件包含cmakeList.txt文件，主目录的cmakeList 通过add_subdirectory添加子目录即可；
  包含源文件的子文件夹未包含cmakeList.txt文件，子目录编译规则体现在主目录的cmakeList.txt；

• 编译流程：
  -手动编写cmakeList.txt
  -执行命令cmake path 生成Makefile(PATH是顶层目录)
  -执行命令make进行编译。
  -我们可以创建一个目录，将编译之后的文件放置在这个文件夹下。