linux系统编程学习笔记——CMake

一、概述

二、重要指令

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

• cmake_minimum_required - 指定CMake的最小版本要求
  语法： cmake_minimum_required(VERSION versionNumber [FATAL_ERROR])
  cmake_minimum_required(VERSION 2.8.3) # CMake最小版本要求为2.8.3

• project - 定义工程名称，并可指定工程支持的语言
  语法： project(projectname [CXX] [C] [Java])
  project(HELLOWORLD) # 指定工程名为HELLOWORLD

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

• include_directories - 向工程添加多个特定的头文件搜索路径 —>相当于指定g++编译器的-I参数
  语法： include_directories([AFTER|BEFORE] [SYSTEM] dir1 dir2 …)
  include_directories(/usr/include/myincludefolder ./include)
  # 将/usr/include/myincludefolder 和 ./include 添加到头文件搜索路径

• link_directories- 向工程添加多个特定的库文件搜索路径 —>相当于指定g++编译器的-L参数
  语法： link_directories(dir1 dir2 …)
  link_directories(/usr/lib/mylibfolder ./lib) # 将/usr/lib/mylibfolder 和 ./lib 添加到库文件搜索路径

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

• add_compile_options- 添加编译参数
  语法：add_compile_options()
  add_compile_options(-Wall -std=c++11 -O2) # 添加编译参数 -Wall -std=c++11 -O2

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

• target_link_libraries - 为 target 添加需要链接的共享库 —>相同于指定g++编译器-l参数
  语法： target_link_libraries(target library1<debug | optimized> library2…)
  # 将hello动态库文件链接到可执行文件main
  target_link_libraries(main hello)

• add_subdirectory

• 向当前工程添加存放源文件的子目录，并可以指定中间二进制和目标二进制
  存放的位置
  语法： add_subdirectory(source_dir [binary_dir] [EXCLUDE_FROM_ALL])
  # 添加src子目录，src中需有一个CMakeLists.txt
  add_subdirectory(src)

• aux_source_directory - 发现一个目录下所有的源代码文件并将列表存储在一个变量中，这个指令临时被用来自动构建源文件列表
  语法： aux_source_directory(dir VARIABLE)
  # 定义SRC变量，其值为当前目录下所有的源代码文件
  aux_source_directory(. SRC)
  # 编译SRC变量所代表的源代码文件，生成main可执行文件
  add_executable(main ${SRC})

三、常用变量

• CMAKE_C_FLAGS gcc编译选项

• CMAKE_CXX_FLAGS g++编译选项
  # 在CMAKE_CXX_FLAGS编译选项后追加-std=c++11
  set( CMAKE_CXX_FLAGS “${CMAKE_CXX_FLAGS} -std=c++11”)

• CMAKE_BUILD_TYPE 编译类型(Debug, Release)
  # 设定编译类型为debug，调试时需要选择debug
  set(CMAKE_BUILD_TYPE Debug)
  # 设定编译类型为release，发布时需要选择release
  set(CMAKE_BUILD_TYPE Release)

• CMAKE_BINARY_DIR

• PROJECT_BINARY_DIR

• _BINARY_DIR
  1. 这三个变量指代的内容是一致的。
  2. 如果是 in source build，指的就是工程顶层目录。
  3. 如果是 out-of-source 编译,指的是工程编译发生的目录
  4. PROJECT_BINARY_DIR 跟其他指令稍有区别，不过现在，你可以理解为他们是一致的

• CMAKE_SOURCE_DIR

• PROJECT_SOURCE_DIR

• _SOURCE_DIR
  1. 这三个变量指代的内容是一致的,不论采用何种编译方式,都是工程顶层目录。
  2. 也就是在 in source build时,他跟 CMAKE_BINARY_DIR 等变量一致。
  3. PROJECT_SOURCE_DIR 跟其他指令稍有区别,现在,你可以理解为他们是一致的

• CMAKE_C_COMPILER：指定C编译器

• CMAKE_CXX_COMPILER：指定C++编译器

• EXECUTABLE_OUTPUT_PATH：可执行文件输出的存放路径

• LIBRARY_OUTPUT_PATH：库文件输出的存放路径

四、编译

CMake目录结构：项目主目录存在一个CMakeLists.txt文件
两种方式设置编译规则：通常采用方式1

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

五、实例

多目录工程 - 生成库编译

# Set the minimum version of CMake that can be used
cmake_minimum_required(VERSION 3.0)
#project name
project(SWAP_LIBRARY)
#add compile options
add_compile_options("-Wall -std=c++11")
#set CMAKE_BUILD_TYPE
set( CMAKE_BUILD_TYPE Debug )
# set output binary path
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)
############################################################
# Create a library
############################################################
#Generate the static library from the library sources
add_library( swap_library STATIC src/Swap.cpp )
target_include_directories( swap_lib PUBLIC ${PROJECT_SOURCE_DIR}/include )
############################################################
# Create an executable
############################################################
# Add an executable with the above sources
add_executable( swap_01 main.cpp )
# link the new swap_01 target with the swap_lib target
target_link_libraries( swap_01 swap_liby )