cmake 当前编译路径_CMake 使用总结
前言
我们使用 Make 工具构建项目时,需要编写 Makefile,但不同的平台 Make 工具是不一样的,比如 Linux 的 GNU Make ,Windows 的 nmake,它们对 Makefile 的规范也是不一样的,如果软件要跨平台,则需要针对每一种 Make 工具写一份 Makefile,非常浪费时间;而且当软件比较庞大时,Makefile 的编写也会变的复杂。
CMake 简介
CMake(Cross-Platform-Make)是一个开源、跨平台的软件构建工具,它使用与平台独立的配置文件来对软件编译过程进行控制,根据用户所需,生成 Makefile 或者 IDE的 project。
CMake 构建过程
- 编写 CMake 配置文件 CMakeLists.txt,一般放在项目的最顶层目录下。
- 运行 cmake 命令,参数为 CMakeLists.txt 所在根路径,执行完成后得到 Makefile 文件。
- 使用 make 命令进行编译。
$ mkdir -p build && cd build
$ cmake ..
$ make
基本语法
- 指定最小版本
如果使用的 CMake 版本低于该版本,则会发出致命错误。
cmake_minimum_required(VERSION 3.9)
- 设置工程名
可以同时指定工程版本和语言,CXX 代表 C++。
project(sunflower VERSION 0.0.1 LANGUAGES C CXX)
- 设置 c/c++版本
set(CMAKE_C_STANDARD 11)
set(CMAKE_CXX_STANDARD 11)
- 设置编译选项
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -g -w -O3")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g -w -O3")
- 添加宏定义
add_definitions(-DSPDLOG_ACTIVE_LEVEL=SPDLOG_LEVEL_INFO)
- 设置头文件搜索目录
实现编译时的 [-I] 选项,设置后引用头文件不需要使用相对路径,直接引用文件名。
include_directories(
"${PROJECT_SOURCE_DIR}/include"
"${PROJECT_SOURCE_DIR}/depends/json/"
"${PROJECT_SOURCE_DIR}/depends/leveldb/include"
)
- 设置库文件搜索目录
实现编译时的[-L]选项,项目内部明确路径的库文件,可以通过该命令指定。
link_directories(
"${PROJECT_SOURCE_DIR}/depends/json/lib"
"${PROJECT_SOURCE_DIR}/depends/leveldb"
)
- 查找指定库文件
查找到指定的预编译库,并将它的路径存储在变量中。
默认的搜索路径为 cmake 包含的系统库,因此如果是 NDK 的公共库只需要指定库的name 即可(不需path),类似的命令还有 find_file()、find_path()、find_program()、find_package()。
find_library(log-lib,log)
- 查找指定目录下源文件
获取指定目录下源文件列表,保存到 DIR_SRCS 变量中,后续编译构建目标可执行文件。
注意这里不能递归获取子目录下的源文件。
aux_source_directory(${PROJECT_SOURCE_DIR}/src DIR_SRCS)
- 添加子目录源文件
使用命令 add_subdirectory 指明本项目包含一个子目录,这样子目录下的 CMakeLists.txt 文件和源文件也会被处理。
项目包含多个子目录时,通常可以在子目录下也定义 CMakeLists.txt 文件,并通过 add_library 生成包含子目录源码的库文件,并最终链接到目标可执行文件。
add_subdirectory(utils)
add_subdirectory(config)
- 递归查找目录下的所有源文件
可以通过 file 命令递归获取指定目录下的所有源文件,这样可以不用为子目录专门定义CMakeLists.txt,也不需要通过链接的方式集成各个子目录,而是统一编译构建。
file(GLOB_RECURSE DIR_SRCS
${PROJECT_SOURCE_DIR}/src/*.c
${PROJECT_SOURCE_DIR}/src/*.cc
${PROJECT_SOURCE_DIR}/src/*.cpp
)
- 设置可执行文件输出路径
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)
- 生成可执行文件
add_executable(${PROJECT_NAME} ${DIR_SRCS})
- 生成库文件
add_library(${PROJECT_NAME} STATIC ${DIR_SRCS})
add_library(${PROJECT_NAME} SHARED ${DIR_SRCS})
- 链接库文件
set(EXTRA_LIBS
sasl2
libleveldb.a
)
target_link_libraries(${PROJECT_NAME}
${EXTRA_LIBS}
)
常用变量
PROJECT_SOURCE_DIR:工程的根目录
PROJECT_BINARY_DIR:运行cmake命令的目录,通常为${PROJECT_SOURCE_DIR}/build
PROJECT_NAME:返回通过 project 命令定义的项目名称
CMAKE_CURRENT_SOURCE_DIR:当前处理的 CMakeLists.txt 所在的路径
CMAKE_CURRENT_BINARY_DIR:target 编译目录
CMAKE_CURRENT_LIST_DIR:CMakeLists.txt 的完整路径
EXECUTABLE_OUTPUT_PATH:重新定义目标二进制可执行文件的存放位置
LIBRARY_OUTPUT_PATH:重新定义目标链接库文件的存放位置
支持 Debug 版本
- 设置不同版本的编译选项
set(CMAKE_CXX_FLAGS_DEBUG "$ENV{CXXFLAGS} -O0 -Wall -g -ggdb")
set(CMAKE_CXX_FLAGS_RELEASE "$ENV{CXXFLAGS} -O3 -Wall")
- cmake 时指定版本
cmake .. -DCMAKE_BUILD_TYPE=Debug
cmake .. -DCMAKE_BUILD_TYPE=Release
完整示例
工程结构
+-- CMakeTest
|
+-- CMakeList.txt
+-- src
|
+-- main.cc
+--- utils/
|
+--- utils.cc
+--- utils.h
+-- config/
|
+-- config.cc
+-- config.h
+-- libs
|
+-- libleveldb.a
CMakeList.txt
cmake_minimum_required(VERSION 3.7.1)
project(CMakeTest VERSION 0.0.1 LANGUAGES C CXX)
set(CMAKE_C_STANDARD 11)
set(CMAKE_CXX_STANDARD 11)
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -g -w -O3")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g -w -O3")
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)
include_directories(
"utils"
"config"
)
link_directories(
""${PROJECT_SOURCE_DIR}/libs""
)
# 子目录的CMakeList.txt也可以定义到主配置中
# 将utils和config两个子目录的源文件打包成库test_share
aux_source_directory(${PROJECT_SOURCE_DIR}/src/utils SHARE_SRC_FILES)
aux_source_directory(${PROJECT_SOURCE_DIR}/src/config SHARE_SRC_FILES)
add_library(test_share STATIC ${SHARE_SRC_FILES} )
aux_source_directory(${PROJECT_SOURCE_DIR}/src DIR_SRCS)
add_executable(${PROJECT_NAME} ${DIR_SRCS})
# 也可以使用file命令递归获取目录下所有源文件
file(GLOB_RECURSE DIR_SRCS
${PROJECT_SOURCE_DIR}/src/*.c
${PROJECT_SOURCE_DIR}/src/*.cc
${PROJECT_SOURCE_DIR}/src/*.cpp
)
add_executable(${PROJECT_NAME} ${DIR_SRCS})
set(EXTRA_LIBS
ldl
pthread
libleveldb.a
)
target_link_libraries(${PROJECT_NAME}
test_share
${EXTRA_LIBS}
)
更多推荐
所有评论(0)