团队项目·冰球模拟器——cmake 自动化构建系统的配置文件的编写
1 前言
考虑到命令行界面下编译程序并不如在 IDE 那么直观,再考虑到各位队友对 Linux 并不熟悉,如何大幅度地减轻整个项目的开发复杂度就是一个很重要的问题。
在 Linux 下有个很古老但很有用的自动化构建系统:make,它会读取当前目录下的Makefile
(或其它名字)作为配置文件,并依照规则全自动完成相应的构建命令。但是有个坏处是:它相对来说比较难编写,不那么容易上手。因此又产生了大量的构建出Makefile
的软件,如automake
、premake
、cmake
等等。
本人在 Linux 下使用的 IDE 是 Clion,它是基于 cmake 来管理整个工程的。而使用 cmake 并不需要安装 Clion,对于其他人来说有很大的自由度。因此,本人将花时间编写各个CMakeLists.txt
等配置文件,最终达到一个命令完成构建的效果。
2 需求分析
首先,根据本人对本项目的文件结构设计(见这篇博文),配置文件必须要能够让 cmake 生成各种模块以及可执行文件。
其次,为了减少重复编译,应当生成多个相对独立的库文件,然后在最后才链接成最终的可执行文件。
最后,由于有第三方库的存在,如 Xenomai 开发库、CppUnit 单元测试库等,且安装路径不一定是固定的,故需要 cmake 通过一定的规则确定库文件的具体位置,缩小 debug 过程中问题的查找范围。
3 CMakeLists.txt
文件编写
3.1 根目录的CMakeLists.txt
该文件(见源代码)主要用于设置输出文件位置、C++语言标准、预定义符号等全局性的设置。
在配置完相关内容后,使用 add_subdirectory(src)
进入到源代码目录进行编译。
3.2 src/CMakeLists.txt
该文件(见源代码)主要用于编译项目入口。流程如下:
- 首先使用
find_package()
来寻找必须的第三方库的位置,如 Xenomai 开发库等。然后引入相应的引用路径和链接库路径。这一步需要编写相应的Findxxxx.cmake
文件。 - 再进入
src/interpolation
等子模块目录中进行模块的编译。 - 最后将相应的文件用
add_executable()
命令生成主程序,并将子模块用target_link_libraries
链接上去,完成编译。 - 再对单元测试进行相似的处理。
3.3 src/<子模块>/CMakeLists.txt
子模块中的编译要求较为简单,只需要目录下所有源代码文件使用 add_library()
命令编译成相应的静态链接库文件即可。
3.4 modules/Findxxxx.cmake
这是供 cmake 专用的文件,本身不直接用于构建。在本项目中位于根目录的 modules
文件夹下,详见Github 仓库。工作流程如下:
- 使用
find_path()
命令确定模块里面某个特有的文件所在的路径,间接定位库所在的路径。需要提供可能出现的位置来辅助查找。 - 判断是否找到,若找到,定义相应的变量,如
xxxx_INCLUDE_DIRS
、xxxx_LIBRARIES_DIRS
等。
4 编译&运行
4.1 编译
由于配置文件已经做好了大部份工作,因此,我们只需要在项目的根目录(即有 README.md
的目录)下运行以下命令即可。
cmake . # 生成 Makefile 文件
make # 使用 make 进行构建
但是,cmake 本身会产生一些如 CMakeCache.txt
等临时文件,若不想污染整个目录,建议进行如下操作:
mkdir build # 创建 build 文件夹。build 目录已经被 git 忽略了,见 .gitignore
cd build # 进入工作文件夹
cmake .. # 注意,需要提供根目录的位置
make # 使用 make 进行构建
若无报错,则会在工作目录下的 ./build
文件夹中得到生成的二进制文件。文件结构示例如下:
build
| air_hockey # 主程序
| unit_test # 单元测试程序
| libinterpolation.a # 插值算法静态库
| libtasks.a # 任务实现静态库
...
4.2 运行
4.2.1 单元测试
单元测试程序运行如下
./build/unit_test <测试集名>
该程序有一可选参数<测试集名>,若不指定,则会运行未命名测试集(在本项目中则为所有测试);若指定,则只运行对应的测试集。
4.2.2 主项目
主项目运行如下
./build/air_hockey
在标准输入输出中可见日志信息。
团队项目·冰球模拟器——cmake 自动化构建系统的配置文件的编写的更多相关文章
- 开发效率优化之自动化构建系统Gradle(二)下篇
阿里P7移动互联网架构师进阶视频(每日更新中)免费学习请点击:https://space.bilibili.com/474380680本篇文章将继续从自定义 Gradle 插件开发来介绍自动化构建系统 ...
- 开发效率优化之自动化构建系统Gradle(二)上篇
阿里P7移动互联网架构师进阶视频(每日更新中)免费学习请点击:https://space.bilibili.com/474380680 本篇文章将以下两个内容来介绍自动化构建系统Gradle: gra ...
- Vue项目模板--和--webpack自动化构建工具的---项目打包压缩使用
[首先安装node.js]: 1. 从node.js官网下载并安装node,安装过程很简单. 2. npm 版本需要大于 3.0,如果低于此版本需要升级它: # 查看版本 npm -v2.3.0 #升 ...
- [Cake] 0.C# Make自动化构建-简介
0.Cake是什么? Cake是C# Make的缩写,是一个基于C# DSL的自动化构建系统.它可以用来编译代码,复制文件以及文件夹,运行单元测试,压缩文件以及构建Nuget包等等. 熟悉大名鼎鼎的M ...
- xmake v2.3.1 发布, 无缝对接其他构建系统
最近对xmake内部做了不少的重构来改进,并且新增了不少实用的新特性,欢迎来体验. 项目源码 官方文档 一些新特性: 一键编译其他构建系统维护的项目,实现无缝对接,并且支持交叉编译(比如autotoo ...
- 在Azure DevOps Server (TFS) 中修改团队项目名称
概述 [团队项目]: 在Azure DevOps Server (原名TFS)中,团队项目(Team Project)是一个最基本的数据组织容器,包含了一个团队或者信息系统中的所有信息,包括源代码.文 ...
- 201671010406-丁家辉-实验十四 团队项目评审&课程学习总结
实验十四 团队项目评审&课程学习总结 项目 内容 这个作业属于哪个课程 [教师博客主页链接] 这个作业的要求在哪里 [作业链接地址] 作业学习目标 (1)掌握软件项目评审会流程(2)反思总结课 ...
- 《hello--world团队》第六次作业:团队项目系统设计改进与详细设计
项目 内容 这个作业属于哪个课程 2016级计算机科学与工程学院软件工程(西北师范大学) 这个作业的要求在哪里 实验十 团队作业6:团队项目系统设计改进与详细设计 团队名称 <hello--wo ...
- 浅谈自动化构建之gulp
一.gulp的基本使用 gulp是目前最流行的前端自动化构建系统,核心特点高效易用.(这块不过多的废话了,直接上干货了,有兴趣的话,可以查下gulp简介) 步骤如下: yarn init -y yar ...
随机推荐
- win10应用安装位置修改方法
win10应用安装位置怎么改?很多用户升级win10的系统之后,对于win10应用装置的位置如何修改一直不知道如何解决,今天,小编就跟大家一起来看看如何修改win10应用装置的位置. win10应用安 ...
- jersey post提交到 ContainerRequestFilter 而HttpServletRequest获取不到数据(转)
jersey post提交到 ContainerRequestFilter 而HttpServletRequest获取不到数据 问题:在serverfilter request获取不到post提交的 ...
- c++ 内存泄露的检查
对于c++的内存泄露检测,除了我们自己手动检查以外,还可以使用c++中的函数来帮助我们检测, 如下代码: #include "stdafx.h" #include <stri ...
- GCC 警告提示的用法
转自GCC 警告提示的用法 本节主要讲解GCC的警告提示功能.GCC包含完整的出错检查和警告提示功能,它们可以帮助Linux程序员写出更加专业和优美的代码.我们千万不能小瞧这些警告信息,在很多情况下, ...
- Unity C#写的A*寻路
原地址:http://www.unity蛮牛.com/blog-13769-1078.html 首先看了这篇翻译外国人的文章http://www.raywenderlich.com/zh-hans/2 ...
- linux下core文件调试方法
http://www.cnblogs.com/li-hao/archive/2011/09/25/2190278.html 在程序不寻常退出时,内核会在当前工作目录下生成一个core文件(是一个内存映 ...
- SQLite入门与分析(八)---存储模型(2)
3.页面结构(page structure) 数据库文件分成固定大小的页面.SQLite通过B+tree模型来管理所有的页面.页面(page)分三种类型:要么是tree page,或者是overflo ...
- 一个CLI的 的例子
1)这是CLI 调用HTTPOST例子 #using <System.dll> using namespace System;using namespace System::Net;usi ...
- Altium Designer学习:PCB只看当前层
1 Shift+S 这个快捷键能高亮当前层,并且使其他层变成灰色,见下图: 2 隐藏指定层 在图中右下角的地方,右键,会弹出一个选项条,选择Hide Layers,可以选 ...
- VCL+FMX 双剑合壁编程
VCL 是经典,FMX 是新生,新生事物总会带来一些好玩新奇的东西.舍弃经典是浪费,不了解新生事物是等死,那么我们来一个二合一双剑合壁又如何呢? 要双剑合壁,就得投些机,取些巧.由于 Delphi / ...