Step 1: A Basic Starting Point

2022.2.7 - 2022.2.9
官网
 参考1
参考2

1基本代码

在CMakeLists.txt中，填写如下代码：

	cmake_minimum_required(VERSION 3.10)
	
	# set the project name
	project(Tutorial)
	
	# add the executable
	add_executable(Tutorial tutorial.cxx)

指定cmake最低版本
设定工程的名字为Tutorial
指定可执行文件为Tutorial，源代码为tutorial.cxx
执行流程
在当前目录下执行cmake 给出CMakeLists.txt所在目录即可，生成Makefile文件，
然后执行make（前提是目录切换到在Makefile所在目录），就可生成可执行文件Tutorial。

基本代码演化

	cmake_minimum_required(VERSION 3.10)
	  
	project(Tutorial22 VERSION 1.0)
	
	configure_file(TutorialConfig.h.in TutorialConfig.h)
	
	# specify the C++ standard
	set(CMAKE_CXX_STANDARD 11)
	set(CMAKE_CXX_STANDARD_REQUIRED True)
	
	add_executable(main main.cpp)
	
	target_include_directories(main PUBLIC "${PROJECT_BINARY_DIR}")

问题和解决方案

存在的问题：中间文件和源文件在同一个目录中，目录结构混乱。

解决的方法：创建一个中间build文件夹，与源文件所在目录的src_dir处于等级目录，命名为src_dir_build，然后执行
src_build$ cmake ../src_dir，这样生成的中间文件就会在当前目录（src_build）下，并生成Makefile，然后执行make就会生成可执行文件。

  mkdir src_dir_build  
  cd src_dir_build   
  cmake ../src_dir # run CMake to configure the project and generate a native build system，即生成Makefile
  cmake --build . # Then call that build system to actually compile/link the project， 其功能等同于直接make  

  [实践结果]: 执行cmake ../src_dir之后，就会产生可执行文件，也可以使用cmake --build .产生可执行文件

2添加版本号和配置文件头文件

2.1命令解释

2.1.1 `configure_file`

2.1.1.1概述

语法

  		configure_file(<input> <output>
  	               [COPYONLY] [ESCAPE_QUOTES] [@ONLY]
  	               [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ])

将<input>文件里面的内容复制到<output>文件中；
根据参数规则，替换@VAR@或${VAR}变量；
参考

2.1.1.2 参数解析

COPYONLY：仅拷贝<input>文件里面的内容到 <output> 文件，不进行变量的替换；
ESCAPE_QUOTES：使用反斜杠（C语言风格）来进行转义；
@ONLY：限制替换，仅仅替换 @VAR@ 变量，不替换 ${VAR} 变量
NEWLINE_STYLE：指定输入文件的新行格式，例如：Unix 中使用的是 \n, windows 中使用的 \r\n
**注意: ** COPYONLY 和 NEWLINE_STYLE 是冲突的，不能同时使用；

2.1.1.3 代码展现

CMakeLists.txt 文件内容:

  cmake_minimum_required(VERSION 3.5)
  
  project(Tutorial VERSION 1.0) # 对应的宏为Tutorial_VERSION_MAJOR和Tutorial_VERSION_MINOR
  
  message(STATUS "PROJECT_SOURCE_DIR " ${PROJECT_SOURCE_DIR})
  message(STATUS "PROJECT_BINARY_DIR " ${PROJECT_BINARY_DIR})
  
  set(CMAKEDEFINE_VAR1 1)
  set(CMAKEDEFINE_VAR2 0)
  
  set(DEFINE_VAR1 1)
  set(DEFINE_VAR2 0)
  
  configure_file(TutorialConfig.h.in TutorialConfig.h) # 默认是将源文件所在的TutorialConfig.h.in copy 到可执行文件所在的目录，也可以向下面那样，显示指出。
  
  configure_file (
    "${PROJECT_SOURCE_DIR}/Config.h.in"
    "${PROJECT_BINARY_DIR}/Config.h"
    )
  
  include_directories("$PROJECT_SOURCE_DIR")
  
  add_executable(DEMO tutorial.cpp)

Config.h.in 文件内容

  /**
   * This is the configure demo  
   *    - CMAKEDEFINE_VAR1 = @CMAKEDEFINE_VAR1@
   *    - CMAKEDEFINE_VAR2 = @CMAKEDEFINE_VAR2@
   *    - DEFINE_VAR1      = @DEFINE_VAR1@
   *    - DEFINE_VAR2      = @DEFINE_VAR2@
   */
  
  /**
   *  cmakedefine 会根据变量的值是否为真（类似 if）来变换为 #define VAR ... 或  #undef VAR 
   */
  #cmakedefine CMAKEDEFINE_VAR1 @CMAKEDEFINE_VAR1@
  #cmakedefine CMAKEDEFINE_VAR2 @CMAKEDEFINE_VAR2@
  
  
  /**
   * define 会直接根据规则来替换
   */
  #define DEFINE_VAR1 @DEFINE_VAR1@
  #define DEFINE_VAR2 ${DEFINE_VAR2}$

  #define Tutorial_VERSION_MAJOR @Tutorial_VERSION_MAJOR@

  #define Tutorial_VERSION_MINOR @Tutorial_VERSION_MINOR@ # 此处定义了Tutorial_VERION_MINOR宏变量，在真实的代码中会使用@Tutorial_VERSION_MINOR@，而在cmake时，@Tutorial_VERSION_MINOR@会被替换掉0，对应第二条代码，之后，若是源代码中包含了这个头文件，就可以使用其中的宏变量了。注意，头文件最好和Makefile文件在同一个目录下。

**tutorial.cpp ** 文件内容

  // 计算平方根的简单程序。
  #include <stdio.h>
  #include <stdlib.h>
  #include <math.h>
  #include <iostream>
  #include "Config.h"
  
  using namespace std;

  int main (int argc, char *argv[]) {

  cout << "Project Version: " << Tutorial_VERSION_MAJOR << "." << Tutorial_VERSION_MINOR << endl;

  #ifdef CMAKEDEFINE_VAR1
     fprintf(stdout,"CMAKEDEFINE_VAR1 = %d\n", CMAKEDEFINE_VAR1);
  #endif 
  
  #ifdef CMAKEDEFINE_VAR2
     fprintf(stdout,"CMAKEDEFINE_VAR2 = %d\n", CMAKEDEFINE_VAR2);
  #endif 
  
  #ifdef DEFINE_VAR1
     fprintf(stdout,"DEFINE_VAR1 = %d\n", DEFINE_VAR1);
  #endif 
  
  #ifdef DEFINE_VAR2
     fprintf(stdout,"DEFINE_VAR2 = %d\n", DEFINE_VAR2);
  #endif 
   
    return 0;
  }

2.1.2 `target_include_directories`

2.1.2.1 语法

指定编译目标时要使用的包含目录或目标。目标必须由 add_executable() or add_library()创建。意味着在它们之后，创建该语句。

	target_include_directories(<target> [SYSTEM] [BEFORE]
	  <INTERFACE|PUBLIC|PRIVATE> [items1...]
	  [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...])


	PUBLIC关键字大致装置PRIVATE + INTERFACE.


	因此,假设您正在创建一个A使用某些Boost标头的库.你会这样做:
	
	target_include_directories(A PRIVATE ${Boost_INCLUDE_DIRS})如果你只在源文件(.cpp)或私有头文件(.h)中使用那些Boost头.
	target_include_directories(A INTERFACE ${Boost_INCLUDE_DIRS})如果您不在源文件中使用这些Boost标头(因此,不需要它们进行编译A).我实际上无法想到一个现实世界的例子.
	target_include_directories(A PUBLIC ${Boost_INCLUDE_DIRS})如果你在公共头文件中使用那些Boost头文件,这些头文件包含在某些A源文件中,并且也可能包含在A库的任何其他客户端中.

推荐用target_include_directories替代include_directories来配置头文件

参考1
参考2

2.1.2.2 代码示例

	add_executable(main main.cpp)
	
	target_include_directories(main PUBLIC "${PROJECT_BINARY_DIR}")

2.1.3 'set'

2.1.3.1 语法

参考

	set(<variable> <value>... [PARENT_SCOPE]) #设置普通变量
	set(<variable> <value>... CACHE <type> <docstring> [FORCE]) #设置缓存条目
	set(ENV{<variable>} [<value>]) #设置环境变量

	set命令可以设置普通变量、缓存条目、环境变量三种变量的值，分别对应上述三种命令格式。set的值<value>...表示可以给变量设置0个或者多个值，当设置多个值时（大于2个），多个值会通过分号连接符连接成一个真实的值赋值给变量，当设置0个值时，实际上是把变量变为未设置状态，相当于调用unset命令。

设置变量，获取该变量的值，使用@@或者$$

2.1.4 设置C++11和标准库头文件

	#specify the C++ standard
	set(CMAKE_CXX_STANDARD 11)
	set(CMAKE_CXX_STANDARD_REQUIRED True)

	We will need to explicitly state in the CMake code that it should use the correct flags. The easiest way to enable support for a specific C++ standard in CMake is by using the CMAKE_CXX_STANDARD variable. For this tutorial, set the CMAKE_CXX_STANDARD variable in the CMakeLists.txt file to 11 and CMAKE_CXX_STANDARD_REQUIRED to True. Make sure to add the CMAKE_CXX_STANDARD declarations above the call to add_executable.

2.1.5 系统宏

	"${PROJECT_BINARY_DIR}" # 表示可执行文件所在目录
	"${PROJECT_SOURCE_DIR}" # 表示源文件所在目录
	${CMAKE_CURRENT_SOURCE_DIR} # 表示当前CMakeLists.txt所在目录

2.1.6 `include_directories`

语法

  include_directories ([AFTER|BEFORE] [SYSTEM] dir1 [dir2 ...])

将指定目录添加到编译器的头文件搜索路径之下，指定的目录被解释成当前源码路径的相对路径。

大白话：就是添加头文件头目录，这样在源码代码中就可以直接使用头文件，而不用指定层次关系。

默认情况下，include_directories命令会将目录添加到列表最后，可以通过命令设置CMAKE_INCLUDE_DIRECTORIES_BEFORE变量为ON来改变它默认行为，将目录添加到列表前面。也可以在每次调用include_directories命令时使用AFTER或BEFORE选项来指定是添加到列表的前面或者后面。如果使用SYSTEM选项，会把指定目录当成系统的搜索目录。该命令作用范围只在当前的CMakeLists.txt。

	#CMakeLists.txt
	cmake_minimum_required(VERSION 3.18.2)
	project(include_directories_test)
	
	include_directories(sub) 
	include_directories(sub2) #默认将sub2添加到列表最后
	include_directories(BEFORE sub3) #可以临时改变行为，添加到列表最前面
	
	get_property(dirs DIRECTORY ${CMAKE_SOURCE_DIR} PROPERTY INCLUDE_DIRECTORIES)
	message(">>> include_dirs=${dirs}") #打印一下目录情况
	
	set(CMAKE_INCLUDE_DIRECTORIES_BEFORE ON) #改变默认行为，默认添加到列表前面
	include_directories(sub4)
	include_directories(AFTER sub5) #可以临时改变行为，添加到列表的最后
	get_property(dirs DIRECTORY ${CMAKE_SOURCE_DIR} PROPERTY INCLUDE_DIRECTORIES)
	message(">>> SET DEFAULT TO BEFORE, include_dirs=${dirs}")


	
	#输出
	>>> include_dirs=/XXX/XXX/sub3;/XXX/XXX/sub;/XXX/XXX/sub2
	>>> SET DEFAULT TO BEFORE, include_dirs=/XXX/XXX/sub4;/XXX/XXX/sub3;/XXX/XXX/sub;/XXX/XXX/sub2;/XXX/XXX/sub5

参考1

2.1.7 `target_link_libraries`

2.1.8 `add_library`

语法

  add_library(<name> [STATIC | SHARED | MODULE]
  		            [EXCLUDE_FROM_ALL]
  		            source1 [source2 ...])

说明：生成库文件

<name> ：库的名字，直接写名字即可，不要写lib，会自动加上前缀的哈。
[STATIC | SHARED | MODULE] ：类型有三种。

	SHARED,动态库
	STATIC,静态库
	MODULE,在使用 dyld 的系统有效,如果不支持 dyld,则被当作 SHARED 对待。

EXCLUDE_FROM_ALL：这个库不会被默认构建，除非有其他的组件依赖或者手工构建。

案例1

  # sub/CMakeLists.txt
  cmake_minimum_required(VERSION 3.10.2)
  project(sub)
  add_library(sub test.cpp)

  生成libsub.a库文件

案例2

  SET(LIBHELLO_SRC hello.c)
  ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})
  ADD_LIBRARY(hello_static STATIC ${LIBHELLO_SRC})


  注意，一般我们使用的静态库/动态库只是后缀名不同而已，上面构建的libhello.so与libhello_static.a，显然名字不同哦。这时你会有一个想法，那我把hello_static改成hello，结果是不可行的，静态库无法构建。重名会忽略第二条指令。

  解决方法：改libhello_static.a的属性–输出名字

  SET_TARGET_PROPERTIES(hello_static PROPERTIES OUTPUT_NAME "hello")

关于动态库版本

  #VERSION 指代动态库版本,SOVERSION 指代 API 版本。
  SET_TARGET_PROPERTIES(hello PROPERTIES VERSION 1.2 SOVERSION 1)

  [实践]不管你的动态库版本是什么，对外调用总是libxxx.so。

参考

2.3 CEF案例分析

add_subdirectory

语法：

  add_subdirectory (source_dir [binary_dir] [EXCLUDE_FROM_ALL])
  添加一个子目录并构建该子目录，一般为.a和.so库文件或独立的可执行文件

命令解析：

  source_dir
  必选参数。该参数指定一个子目录，子目录下应该包含CMakeLists.txt文件和代码文件。子目录可以是相对路径也可以是绝对路径，如果是相对路径，则是相对当前目录的一个相对路径。

  binary_dir
  可选参数。该参数指定一个目录，用于存放输出文件。可以是相对路径也可以是绝对路径，如果是相对路径，则是相对当前输出目录的一个相对路径。如果该参数没有指定，则默认的输出目录使用source_dir。

  EXCLUDE_FROM_ALL
  可选参数。当指定了该参数，则子目录下的目标不会被父目录下的目标文件包含进去，父目录的CMakeLists.txt不会构建子目录的目标文件，必须在子目录下显式去构建。例外情况：当父目录的目标依赖于子目录的目标，则子目录的目标仍然会被构建出来以满足依赖关系（例如使用了target_link_libraries）。
  (大白话)：添加该参数后，只能子目录自己显示构建。若是父目录依赖于子目录的目标话，仍然会构建。

  [参考](https://www.jianshu.com/p/07acea4e86a3)

案例：