CMake重要指令
1 语法特性介绍
- 基本语法格式——指令(参数1 参数2)
-
- 参数使用括弧括起来;
-
- 参数之间使用空格或者分号隔开;
set(HELLO hello.cpp)
add_executable(hello main.cpp hello.cpp)
ADD_EXECUTABLE(hello main.cpp ${HELLO})
- 变量使用${}方式取值,但是在IF控制语句中是直接使用变量名
2 重要指令和CMake常用变量
2.1 重要指令
- cmake_minimum_required——指定CMake的最小版本要求
-
- 语法:cmake_minimum_required(VERSION versionNumber [FATAL_ERROR])
# CMake最小版本要求为2.8.3
cmake_minimum_required(VERSION 2.8.3)
- project——定义工程名称,并可指定工程支持的语言
-
- 语法:project(project name[CXX] [C] [Java])
# 指定工程名为HELLOWORLD
project(HELLOWORLD)
- set——显示的定义变量
-
- 语法:set(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])
# 定义SRC变量,其值为main.cpp和hello.cpp
set(SRC main.cpp hello.cpp)
- include_directories——向工程添加多个特定的头文件搜索路径----->相当于指定g++编译器参数-I
-
- 语法:include_directories([AFTER|BEFORE][SYSTEM]dir1 dir2...)
# 将/usr/include/myinclude和./include添加到头文件搜索路径
include_directories(/usr/include/myinclude ./include)
- add_library——生成库文件
-
- 语法:add_library(libname[SHARED|STATIC|MODULE][EXCLUDE_FROM_ALL] source1 source2 ... sourceN)
# 通过变量SRC生成libhello.so共享库
add_library(hello SHARED ${SRC})
- add_compile_options——添加编译参数
-
- 语法:add_compile_options(
# 添加编译参数 -wall -std=c++1 -o2
add_compile_options(-wall -std=c++1 -o2)
- add_executable——生成可执行文件
-
- 语法:add_executable(exename source1 source2 ... sourceN)
# 编译main.cpp为可执行程序main
add_executable(main main.cpp)
- 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})
- aux_source_directory——发现一个目录下所有的源代码文件并将列表存储在一个变量中,这个指令临时被用来自动构建源文件列表
-
- 语法:set(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)
# 设置可执行文件到bin目录下,其中PROJECT_SOURCE_DIR
# 为cmake中定义好的常用变量,它代表当前工程路径
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)
3 CMake常用变量
- CMAKE_C_FLAGS gcc编译选项
- CMAKE_CXX_FLAGS g++编译选项
# 在CMAKE_CXX_FLAGS编译选项后追加-std=c++11
set(CMAKE_CXX_FLAGES "${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)
- CMAEK_BINARY_DIR
PROJECT_BINARY_DIR
<projectname>_BINARY_DIR
1.这三个变量指代的内容是一致的。
2.如果是 in source build,指的就是工程顶层目录。
3. 如果是 out-of-source 编译,指的是工程编译发生的目录。
4. PROJECT_BINARY_DIR 跟其他指令稍有区别。
CMAKE_SOURCE_DIR
PROJECT_SOURCE_DIR
<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:库文件输出的存放路径