cmake基础入门

3 篇文章 0 订阅

cmake入门

单个源文件

  1. 我们编写如下文件
#include <stdio.h>
#include <stdlib.h>

int main(int argc, char *argv[])
{
   printf("hello world\n");
   return 0;
}
  1. 我们编写如下CMakeLists.txt
# CMake 指定运行此配置文件所需的 CMake 的最低版本
cmake_minimum_required (VERSION 2.8)
# 该命令表示项目的名称是singleFile
project (singleFile)
# 将名为 main.cc 的源文件编译成一个名称为 Demo 的可执行文件
add_executable(singleFile main.cpp)
  1. 使用cmake命令进行配置编译并编译
  • mkdir debug
  • cd debug
  • cmake …/
  • make

多个源文件

同级目录

  1. 我们在同一文件夹下创建如下文件
    ./sameDirMultSrc
    		|
    		+---------tool.h
    		|
    		+---------tool.cpp
    		|
    		+---------main.cpp
    
  2. 我们在同级目录下编写如下CMakeLists.txt
    # CMake 最低版本号要求
    cmake_minimum_required (VERSION 2.8)
    # 项目信息
    project (sameDirMultSrc)
    # 指定生成目标
    add_executable(sameDirMultSrc main.cpp tool.cpp)
    
  • 与上面的CMakeLists.txt比较,我们只是在add_executable命令中多添加了一个源文件
  • 当源文件很多是这样写不利于管理,cmake中有如下命令来简化这种写法
    aux_source_directory
    该命令会查找指定目录下的所有源文件,然后将结果存进指定变量名。其语法如下:
    aux_source_directory(<dir> <variable>)
  1. 最终形式的CMakeLists.txt为:
    # CMake 最低版本号要求
    cmake_minimum_required (VERSION 2.8)
    
    # 项目信息
    project (sameDirMultSrc)
    
    # 查找当前目录下的所有源文件
    # 并将名称保存到 SRC 变量
    aux_source_directory(. SRC)
    
    # 指定生成目标
    #add_executable(sameDirMultSrc main.cpp tool.cpp)
    
    add_executable(sameDirMultSrc ${SRC})
    

多级目录

  1. 我们创建如下目录结构,并在各目录下创建对应文件

    ./sameDir
    	|
    	+-----main.cpp
    	|
    	+-----./tool
    			|
    			+-----tool.h
    			|
    			+-----tool.cpp
    
  2. 为了方便,我们将tool目录里的文件编译为动态库,并在main中调用

    # CMake 最低版本号要求
    cmake_minimum_required (VERSION 2.8)
    
    # 项目信息
    project (sameDir)
    
    #导入头文件所在路径
    #PROJECT_SOURCE_DIR为cmake宏
    include_directories("${PROJECT_SOURCE_DIR}/tool")
    
    # 查找当前目录下的所有源文件
    # 并将名称保存到 SRC 变量
    aux_source_directory(. SRC)
    
    # 指定生成目标
    add_executable(sameDir ${SRC})
    
    # 添加 math 子目录
    add_subdirectory(tool)
    
    # 添加链接库 
    #该命令要在add_executable命令下方,否则报错
    target_link_libraries(sameDir Tool)
    
  • add_subdirectory 指明本项目包含一个子目录 tool,这样 tool 目录下的 CMakeLists.txt 文件和源代码也会被处理
  • 使用命令 target_link_libraries 指明可执行文件 main 需要连接一个名为 Tool 的链接库
  1. 子目录中的CMakeLists.txt文件为
    # 查找当前目录下的所有源文件
    # 并将名称保存到 LIB_SRC 变量
    aux_source_directory(. LIB_SRC)
    
    #生成链接库
    add_library(Tool ${LIB_SRC})
    

自定义编译选项

  当我们需要在代码中做预编译处理时,我们如何通过cmake来指定相关的预处理宏呢?
  现在我们将tool库设为一个可选库,如果该选项是ON,我们就使用其中的Message函数,否则我们使用系统printf函数。

  1. 为了实现这个功能我们需要在CMakeLists.txt文件中这样写
    # CMake 最低版本号要求
    cmake_minimum_required (VERSION 2.8)
    
    
    # 项目信息
    project (compileOption)
    
    
    #通过cmake处理预定义头文件
    configure_file (
    	"${PROJECT_SOURCE_DIR}/config.h.in"
    	"${PROJECT_BINARY_DIR}/config.h"
    	)
    
    # 是否使用自己的 Tool 库
    option (USE_TOOL "Use tool" on)
    
    if(USE_TOOL)
    	#导入头文件所在路径
    	#PROJECT_SOURCE_DIR为cmake宏
    	include_directories(
    		${PROJECT_SOURCE_DIR}/tool
    		${PROJECT_BINARY_DIR}
    	)
    	# 添加 math 子目录
    	add_subdirectory(tool)
    	set (EXTRA_LIBS Tool)
    endif(USE_TOOL)
    
    
    # 查找当前目录下的所有源文件
    # 并将名称保存到 SRC 变量
    aux_source_directory(. SRC)
    
    
    # 指定生成目标
    add_executable(compileOption ${SRC})
    
    # 添加链接库 
    #该命令要在add_executable命令下方,否则报错
    target_link_libraries(compileOption ${EXTRA_LIBS})
    
  • configure_file 命令用于加入一个配置头文件 config.h ,这个文件由 CMake 从 config.h.in 生成,通过这样的机制,将可以通过预定义一些参数和变量来控制代码的生成
  • option 命令添加了一个 USE_TOOL 选项,并且默认值为 ON,该选项可以在cmake时指定为OFF
  • if(USE_TOOL)可以根据变量的值来确定是否使用TOOL库
  • PROJECT_SOURCE_DIR为cmake预先定义好的变量,可以参考cmake文档
  • EXTRA_LIBS 为自定义变量,用于保存静态库名称方便可执行文件链接链接
  • set的用法请查看该链接
  1. 我们编写一个config.h.in文件放在工程目录下
    //config.h.in

    #cmakedefine USE_MYMATH
    
  2. 我们的源文件这样写
    //main.cpp

    #include "config.h"
    
    #include <stdio.h>
    #include <stdlib.h>
    
    #ifdef USE_TOOL
    #include "tool.h"
    #endif //USE_TOOL
    
    int main(int argc, char *argv[])
    {
    #ifdef USE_TOOL
    	Message(string("hello world!"));
    #else
    	printf("%s %d %s",__FILE__, __LINE__, "hello world!\n");
    #endif //USE_TOOL
    
    	return 0;
    }
    
    
  3. 运行cmake

    1. mkdir build
    2. cd build
    3. cmake … (等价与cmake … -DUSE_TOOL=1) 或者 cmake … -DUSE_TOOL=0
    4. make
    5. ./compileOption

编译不同版本

#编译Debug
set(CMAKE_BUILD_TYPE "Debug")
#编译Release
set(CMAKE_BUILD_TYPE "Release")
#支持gdb
set(CMAKE_CXX_FLAGS_DEBUG "$ENV{CXXFLAGS} -O0 -Wall -g -ggdb")=
set(CMAKE_CXX_FLAGS_RELEASE "$ENV{CXXFLAGS} -O3 -Wall")

添加版本号

我们为项目添加版本号,并在源码中使用它

  1. 在CMakeLists.txt文件中project命令后添加如下命令
    # CMake 指定运行此配置文件所需的 CMake 的最低版本
    cmake_minimum_required (VERSION 2.8)
    # 该命令表示项目的名称是singleFile
    project (version)
    
    set(VERSION_MAJOR 1)
    set(VERSION_MINOR 0)
    
    configure_file (
    	"${PROJECT_SOURCE_DIR}/config.h.in"
    	"${PROJECT_BINARY_DIR}/config.h"
    )
    
    include_directories(
    	${PROJECT_BINARY_DIR}
    )
    # 将名为 main.cc 的源文件编译成一个名称为 Demo 的可执行文件
    add_executable(version main.cpp)
    
  2. 在config.h.in文件中写如下语句
    #define VERSION_MAJOR @VERSION_MAJOR@
    #define VERSION_MINOR @VERSION_MINOR@
    
  3. 我们在代码中这样使有它
    #include <stdio.h>
    #include <stdlib.h>
    
    #include "config.h"
    
    int main(int argc, char *argv[])
    {
    	
    	printf("%s Version %d.%d\n", argv[0], VERSION_MAJOR, VERSION_MINOR);
    	return 0;
    }
    

源码

本文中所有源码下载路径

  • 2
    点赞
  • 10
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值