Linux下CMake教程总结
CMake是开源、跨平台的构建工具,可以让我们通过编写简单的配置文件去生成本地的Makefile,这个配置文件是独立于运行平台和编译器的,这样就不用亲自去编写Makefile了,而且配置文件可以直接拿到其它平台上使用,无需修改,非常方便。
本文主要讲述在Linux下如何使用CMake来编译我们的程序。
一 安装CMake
二 简单样例
首先让我们从最简单的代码入手,先来体验下cmake是如何操作的。编写main.c,如下,
然后在main.c相同目录下编写CMakeLists.txt,内容如下,
#include <stdio.h>int main(void)
{printf("Hello World\n");return 0;
}
然后在main.c相同目录下编写CMakeLists.txt,内容如下,
cmake_minimum_required (VERSION 2.8)project (demo)add_executable(main main.c)
PS: 如果想重新生成main,输入make clean就可以删除main这个elf文件。
三 同一目录下多个源文件
接下来进入稍微复杂的例子:在同一个目录下有多个源文件。
在之前的目录下添加2个文件,testFunc.c和testFunc.h。添加完后整体文件结构如下,
testFunc.c内容如下,
/*
** testFunc.c
*/#include <stdio.h>
#include "testFunc.h"void func(int data)
{printf("data is %d\n", data);
}
/*
** testFunc.h
*/#ifndef _TEST_FUNC_H_
#define _TEST_FUNC_H_void func(int data);#endif
修改main.c,调用testFunc.h里声明的函数func(),
#include <stdio.h>#include "testFunc.h"int main(void)
{func(100);return 0;
}
修改CMakeLists.txt,在add_executable的参数里把testFunc.c加进来
cmake_minimum_required (VERSION 2.8)project (demo)add_executable(main main.c testFunc.c)
然后重新执行cmake生成Makefile并运行make,
然后运行重新生成的elf文件main,
运行成功!
我们在main.c所在目录下再添加2个文件,testFunc1.c和testFunc1.h。添加完后整体文件结构如下,
testFunc1.c如下,
/*
** testFunc1.c
*/#include <stdio.h>
#include "testFunc1.h"void func1(int data)
{printf("data is %d\n", data);
}
/*
** testFunc1.h
*/#ifndef _TEST_FUNC1_H_
#define _TEST_FUNC1_H_void func1(int data);#endif
再修改main.c,调用testFunc1.h里声明的函数func1(),
#include <stdio.h>#include "testFunc.h"
#include "testFunc1.h"int main(void)
{func(100);func1(200);return 0;
}
cmake_minimum_required (VERSION 2.8)project (demo)aux_source_directory(. SRC_LIST)add_executable(main ${SRC_LIST})
aux_source_directory()也存在弊端,它会把指定目录下的所有源文件都加进来,可能会加入一些我们不需要的文件,此时我们可以使用set命令去新建变量来存放需要的源文件,如下,
cmake_minimum_required (VERSION 2.8)project (demo)set( SRC_LIST./main.c./testFunc1.c./testFunc.c)add_executable(main ${SRC_LIST})
四 不同目录下多个源文件
其中,CMakeLists.txt和main.c在同一目录下,内容修改成如下所示,
cmake_minimum_required (VERSION 2.8)project (demo)include_directories (test_func test_func1)aux_source_directory (test_func SRC_LIST)
aux_source_directory (test_func1 SRC_LIST1)add_executable (main main.c ${SRC_LIST} ${SRC_LIST1})
#include "test_func/testFunc.h"
#include "test_func1/testFunc1.h"
只是这种写法不好看。
另外,我们使用了2次aux_source_directory,因为源文件分布在2个目录下,所以添加2次。
五 正规一点的组织结构
cmake_minimum_required (VERSION 2.8)project (demo)add_subdirectory (src)
aux_source_directory (. SRC_LIST)include_directories (../include)add_executable (main ${SRC_LIST})set (EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)
这里又出现一个新的命令set,是用于定义变量的,EXECUTABLE_OUT_PATH和PROJECT_SOURCE_DIR是CMake自带的预定义变量,其意义如下,
所以,这里set的意思是把存放elf文件的位置设置为工程根目录下的bin目录。(cmake有很多预定义变量,详细的可以网上搜索一下)
上面的例子也可以只使用一个CMakeLists.txt,把最外层的CMakeLists.txt内容改成如下,
cmake_minimum_required (VERSION 2.8)project (demo)set (EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)aux_source_directory (src SRC_LIST)include_directories (include)add_executable (main ${SRC_LIST})
同时,还要把src目录下的CMakeLists.txt删除。
六 动态库和静态库的编译控制
有时只需要编译出动态库和静态库,然后等着让其它程序去使用。让我们看下这种情况该如何使用cmake。首先按照如下重新组织文件,只留下testFunc.h和TestFunc.c,
我们会在build目录下运行cmake,并把生成的库文件存放到lib目录下。
CMakeLists.txt内容如下,
cmake_minimum_required (VERSION 3.5)project (demo)set (SRC_LIST ${PROJECT_SOURCE_DIR}/testFunc/testFunc.c)
set (LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/lib)set_target_properties (testFunc_shared PROPERTIES OUTPUT_NAME "testFunc")
set_target_properties (testFunc_static PROPERTIES OUTPUT_NAME "testFunc")add_library (testFunc_shared SHARED ${SRC_LIST})
add_library (testFunc_static STATIC ${SRC_LIST})
- add_library: 生成动态库或静态库(第1个参数指定库的名字;第2个参数决定是动态还是静态,如果没有就默认静态;第3个参数指定生成库的源文件)
- set_target_properties: 设置最终生成的库的名称,还有其它功能,如设置库的版本号等等
- LIBRARY_OUTPUT_PATH: 库文件的默认输出路径,这里设置为工程目录下的lib目录
好了,让我们进入build目录下运行cmake ..
,成功后再运行make,
cd到lib目录下进行查看,发现已经成功生成了动态库和静态库,
七 对库进行链接
既然我们已经生成了库,那么就进行链接测试下。重新建一个工程目录,然后把上节生成的库拷贝过来,然后在在工程目录下新建src目录和bin目录,在src目录下添加一个main.c,整体结构如下,
#include <stdio.h>#include "testFunc.h"int main(void)
{func(100);return 0;
}
cmake_minimum_required (VERSION 3.5)project (demo)set (EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)set (SRC_LIST ${PROJECT_SOURCE_DIR}/src/main.c)# find testFunc.h
include_directories (${PROJECT_SOURCE_DIR}/testFunc/inc)find_library(TESTFUNC_LIB testFunc HINTS ${PROJECT_SOURCE_DIR}/testFunc/lib)add_executable (main ${SRC_LIST})target_link_libraries (main ${TESTFUNC_LIB})
- find_library: 在指定目录下查找指定库,并把库的绝对路径存放到变量里,其第一个参数是变量名称,第二个参数是库名称,第三个参数是HINTS,第4个参数是路径,其它用法可以参考cmake文档
- target_link_libraries: 把目标文件与库文件进行链接
使用find_library的好处是在执行cmake ..
时就会去查找库是否存在,这样可以提前发现错误,不用等到链接时。
cd到build目录下,然后运行cmake .. && make
,最后进入到bin目录下查看,发现main已经生成,运行之,
ps: 查看elf文件使用了哪些库,可以使用readelf -d ./xx来查看
之前本节教程使用的是库查找方法是link_directories,但是很多读者反映运行时有问题,本人去官方文档上查了下,发现不建议使用了,推荐使用find_library或者find_package
八 添加编译选项
有时编译程序时想添加一些编译选项,如-Wall,-std=c++11等,就可以使用add_compile_options来进行操作。
这里以一个简单程序来做演示,main.cpp如下
#include <iostream>int main(void)
{auto data = 100;std::cout << "data: " << data << "\n";return 0;
}
cmake_minimum_required (VERSION 2.8)project (demo)set (EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)add_compile_options(-std=c++11 -Wall) add_executable(main main.cpp)
整体目录结构如下,
然后cd到build目录下,执行cmake .. && make
命令,就可以在bin目录下得到main的elf文件
九 添加控制选项
有时希望在编译代码时只编译一些指定的源码,可以使用cmake的option命令,主要遇到的情况分为2种:
第1种情况
假设我们现在的工程会生成2个bin文件,main1和main2,现在整体结构体如下,
外层的CMakeLists.txt内容如下,
cmake_minimum_required(VERSION 3.5)project(demo)option(MYDEBUG "enable debug compilation" OFF)set (EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)add_subdirectory(src)
这里使用了option命令,其第一个参数是这个option的名字,第二个参数是字符串,用来描述这个option是来干嘛的,第三个是option的值,ON或OFF,也可以不写,不写就是默认OFF。
然后编写src目录下的CMakeLists.txt,如下
cmake_minimum_required (VERSION 3.5)add_executable(main1 main1.c)if (MYDEBUG)add_executable(main2 main2.c)
else()message(STATUS "Currently is not in debug mode")
endif()
注意,这里使用了if-else来根据option来决定是否编译main2.c
其中main1.c和main2.c的内容如下,
// main1.c
#include <stdio.h>int main(void)
{printf("hello, this main1\n");return 0;
}
// main2.c
#include <stdio.h>int main(void)
{printf("hello, this main2\n");return 0;
}
然后cd到build目录下输入cmake .. && make
就可以只编译出main1,如果想编译出main2,就把MYDEBUG设置为ON,再次输入cmake .. && make
重新编译。
每次想改变MYDEBUG时都需要去修改CMakeLists.txt,有点麻烦,其实可以通过cmake的命令行去操作,例如我们想把MYDEBUG设置为OFF,先cd到build目录,然后输入cmake .. -DMYDEBUG=ON
,这样就可以编译出main1和main2 (在bin目录下)
第2种情况
假设我们有个main.c,其内容如下,
#include <stdio.h>int main(void)
{
#ifdef WWW1printf("hello world1\n");
#endif #ifdef WWW2 printf("hello world2\n");
#endifreturn 0;
}
可以通过定义宏来控制打印的信息,我们CMakeLists.txt内容如下,
cmake_minimum_required(VERSION 3.5)project(demo)set (EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)option(WWW1 "print one message" OFF)
option(WWW2 "print another message" OFF)if (WWW1)add_definitions(-DWWW1)
endif()if (WWW2)add_definitions(-DWWW2)
endif()add_executable(main main.c)
这里把option的名字保持和main.c里的宏名称一致,这样更加直观,也可以选择不同的名字。通过与add_definitions()的配合,就可以控制单个bin文件的打印输出了。
其中-D
后面的参数就是控制程序流向。
整体工程结构如下,
cd到build目录下执行cmake .. && make
,然后到bin目录下执行./main
,可以看到打印为空,
接着分别按照下面指令去执行,然后查看打印效果,
cmake .. -DWWW1=ON -DWWW2=OFF && make
cmake .. -DWWW1=OFF -DWWW2=ON && make
cmake .. -DWWW1=ON -DWWW2=ON && make
这里有个小坑要注意下:假设有2个options叫A和B,先调用cmake设置了A,下次再调用cmake去设置B,如果没有删除上次执行cmake时产生的缓存文件,那么这次虽然没设置A,也会默认使用A上次的option值。
所以如果option有变化,要么删除上次执行cmake时产生的缓存文件,要么把所有的option都显式的指定其值。
十 总结
Linux下CMake教程总结相关推荐
- ubuntu18.04下--CMake教程
CMake 教程 文章目录 CMake 教程 0. CMake安装及卸载 1. 创建简单的实例 2. CMake 重要参数 3. 构建项目结构 4. CMakeList.txt 模板 CMake是开源 ...
- 记:关于W806的Linux下基本教程(一)——环境建立与第一次烧写
0x00 前言 本文主要在Linux下实现了对于联盛德的W806芯片的SDK相关的操作,包括但不限于指定烧写.擦除.编译. 技能 熟练度 Linux 熟悉 make 熟悉 C语言 熟悉 0x10 准备 ...
- Linux下CMake工程中gtestgmock的安装与使用
Linux下CMake工程中gtest&gmock的安装与使用 gtest和gmock是什么和功能以及用法可参考以下两篇文章,都相当给力! gtest <玩转Google开源C++单元测 ...
- Linux下CMake简明教程(一)简单入门
代码链接 CMake是开源.跨平台的构建工具,可以让我们通过编写简单的配置文件去生成本地的Makefile,这个配置文件是独立于运行平台和编译器的,这样就不用亲自去编写Makefile了,而且配置文件 ...
- linux下cmake命令行,深入理解CMake(1): CMake命令行参数
初衷 CMake能用来编写跨平台(cross-platform)的构建规则,通过这些规则来调用各个平台的编译器.链接器,生成各个目标(静态库,静态库,或者可执行). 我第一个接触的大型C++项目是Op ...
- php linux下开发教程,linux下php环境搭建教程_后端开发
linux下php环境搭建要领:起首猎取PHP.Apache以及MySQL装置包:然后装置Apache,并修正设置文件httpd.conf:接着装置MySQL,并做基础设置:末了装置PHP,并设置ph ...
- Luminati LPM在Linux下安装教程
Luminati是我们做Facebook广告投放用的比较多的代理服务,质量很好,提供很多种的IP,今天来说下Luminati的管理软件LPM(Luminati Proxy Manager)在Linux ...
- Linux下makefile教程
概述 -- 什么是makefile?或许很多Winodws的程序员都不知道这个东西,因为那些Windows的IDE都 为你做了这个工作,但我觉得要作一个好的和 professional的程序员,mak ...
- Linux下CMake简明教程(七)对库进行链接
代码在git 既然我们已经生成了库,那么就进行链接测试下.重新建一个工程目录,然后把上节生成的库拷贝过来,然后在在工程目录下新建src目录和bin目录,在src目录下添加一个main.c,整体结构如下 ...
最新文章
- 【英语天天读】奥哈拉给女儿的信
- easyui框架前后端交互_Easyui Datagrid增删改及后台交互(java)
- Objective-C模版方法(TemplateMethod)
- kafka java消费者消息拉取
- nginx curl linux,linux nginx 下通过curl url方式,符以后的参数无效
- 计算机科学在各专业领域中的应用,计算机科学在各专业领域中的应用
- 大小仅17KB!这个微型风格迁移模型太好玩了 | 代码+教程
- Acwing第 38 场周赛
- 【学习笔记:计算几何基础3】 Convex Hull
- Quickadmin:基于ThinkPhp6+Vue+ElementUI后台管理框架
- bootmgr is missing
- HDU-6638 Snowy Smile 区间最大子段和
- 大疆网上测评题库_大疆校招笔试题及参考(一个小编程题)
- 5G通信下FBMC-OQAM的误码率仿真
- Golang Append()详解
- js小学生图区_js 图片区域可点击,适配移动端,图片大小随意改变
- 微信小程序之数独挑战九宫格
- 安卓设备门禁识别开发_基于Android和RFID的门禁管理系统
- Auto CAD:图纸幅面规格之图纸幅面、标题栏与会签栏、图签与布局空间之详细攻略
- 遇到Initialization failure:0x0000000C错误,其他解决办法