大连网站建设 选领超科技,h5制作开发在哪儿,怎么搭建小程序平台,传统文化网站建设方案文章目录 引言一 环境搭建二 简单入门2.1 项目结构2.2 示例源码2.3 运行查看 三 编译多个源文件3.1 在同一个目录下有多个源文件3.1.1 简单版本3.1.1.1 项目结构3.1.1.2 示例代码3.1.1.3 运行查看 3.1.2 进阶版本3.1.2.1 项目结构3.1.2.2 示例源码3.1.2.3 运行查看 3.2 在不同目… 文章目录 引言一 环境搭建二 简单入门2.1 项目结构2.2 示例源码2.3 运行查看 三 编译多个源文件3.1 在同一个目录下有多个源文件3.1.1 简单版本3.1.1.1 项目结构3.1.1.2 示例代码3.1.1.3 运行查看 3.1.2 进阶版本3.1.2.1 项目结构3.1.2.2 示例源码3.1.2.3 运行查看 3.2 在不同目录下有多个源文件3.2.1 项目结构3.2.2 示例源码3.2.2 运行查看 四 项目级的组织结构4.1 项目结构4.2 示例源码4.3 运行查看 五 动态库和静态库的编译控制5.1 生成库文件5.1.1 项目结构5.1.2 示例源码5.1.3 运行查看 5.2 链接库文件5.2.1 项目结构5.2.2 示例源码5.2.3 运行查看 六 条件编译6.1 简单程序6.1.1 项目结构6.1.2 示例代码6.1.3 运行查看 6.2 添加编译选项6.2.1 生成部分指定bin或库文件6.2.1.1 项目结构6.2.1.2 示例源码6.2.1.3 运行查看 6.2.2 编译部分代码 总结 引言 CMake是开源、跨平台的构建工具可以让我们通过编写简单的配置文件去生成本地的Makefile这个配置文件是独立于运行平台和编译器的这样就不用亲自去编写Makefile了而且配置文件可以直接拿到其它平台上使用无需修改非常方便。
本文主要讲述在Linux下如何使用CMake来编译我们的程序。
一 环境搭建
我使用的是ubuntu18.04安装cmake使用如下命令
sudo apt install cmake安装完成后在终端下输入:
cmake -version查看cmake版本 这样cmake就安装好了。
二 简单入门
首先让我们从最简单的代码入手先来体验下cmake是如何操作的。
2.1 项目结构 2.2 示例源码
打开终端输入
touch main.c CMakeLists.txt编写main.c如下
main.c
#include stdio.hint main(void)
{printf(Hello World\n);return 0;
}然后在main.c同级目录下编写CMakeLists.txt内容如下
CMakeLists.txt
cmake_minimum_required (VERSION 2.8)project (demo)add_executable(main main.c)2.3 运行查看
在终端下切到main.c所在的目录下然后输入以下命令运行cmake
cmake .输出结果如下 ps:此时建议留意一下这个文件夹下多生成的文件都有哪些。 可以看到成功生成了Makefile还有一些cmake运行时自动生成的文件。 然后在终端下输入make 可以看到执行cmake生成的Makefile可以显示进度并带颜色。再看下目录下的文件 可以看到我们需要的可执行文件main也成功生成了 然后运行main 运行成功
PS如果想重新生成main输入make clean就可以删除main这个文件。然后重新make就行。 需要注意的是我希望你着重看一下这时候这个文件夹下都有哪些文件。
三 编译多个源文件
3.1 在同一个目录下有多个源文件
3.1.1 简单版本
接下来进入稍微复杂的例子在同一个目录下有多个源文件。
3.1.1.1 项目结构 3.1.1.2 示例代码
首先删除之前的文件
rm -rf CMakeFiles CMakeCache.txt cmake_install.cmake Makefile main在之前的目录下添加2个文件testFunc.c和testFunc.h:
touch testFunc.c testFunc.h添加完后整体文件结构如下 testFunc.c
/*
** testFunc.c
*/#include stdio.h
#include testFunc.hvoid func(int data)
{printf(data is %d\n, data);
}testFunc.h
/*
** testFunc.h
*/#ifndef _TEST_FUNC_H_
#define _TEST_FUNC_H_void func(int data);#endif修改main.c调用testFunc.h里声明的函数func()
main.c
#include stdio.h#include testFunc.hint main(void)
{func(100);return 0;
}修改CMakeLists.txt在add_executable的参数里把testFunc.c加进来:
CMakeLists.txt
cmake_minimum_required (VERSION 2.8)project (demo)add_executable(main main.c testFunc.c)3.1.1.3 运行查看
cmake .
make然后运行查看 运行成功
可以类推如果在同一目录下有多个源文件那么只要在add_executable里把所有源文件都添加进去就可以了。
但是如果有一百个源文件再这样做就有点坑了无法体现cmake的优越性。 因此cmake提供了一个命令可以把指定目录下所有的源文件存储在一个变量中这个命令就是
aux_source_directory(dir var)第一个参数dir是指定目录第二个参数var是用于存放源文件列表的变量。
接下来写个进阶版的demo使用一下这个变量。
3.1.2 进阶版本
3.1.2.1 项目结构 3.1.2.2 示例源码
删除无关文件
rm -rf CMakeFiles CMakeCache.txt cmake_install.cmake main Makefile 创建文件
touch testFunc1.c testFunc1.htestFunc1.c
/*
** testFunc1.c
*/#include stdio.h
#include testFunc1.hvoid func1(int data)
{printf(data is %d\n, data);
}testFunc1.h
/*
** testFunc1.h
*/#ifndef _TEST_FUNC1_H_
#define _TEST_FUNC1_H_void func1(int data);#endif再修改main.c调用testFunc1.h里声明的函数func1()
main.c
#include stdio.h#include testFunc.h
#include testFunc1.hint main(void)
{func(100);func1(200);return 0;
}修改CMakeLists.txt
CMakeLists.txt
cmake_minimum_required (VERSION 2.8)project (demo)aux_source_directory(. SRC_LIST)add_executable(main ${SRC_LIST})使用aux_source_directory把当前目录下的源文件存列表存放到变量SRC_LIST里;
然后在add_executable里调用SRC_LIST注意调用变量时的写法。
3.1.2.3 运行查看
再次执行cmake和make并运行main: 可以看到运行成功了。
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})3.2 在不同目录下有多个源文件
一般来说当程序文件比较多时我们会进行分类管理把代码根据功能放在不同的目录下这样方便查找。那么这种情况下如何编写CMakeLists.txt呢
3.2.1 项目结构
我们把之前的源文件整理一下新建2个目录test_func和test_func1
rm -rf CMakeFiles CMakeCache.txt cmake_install.cmake main Makefile
整理好后整体文件结构如下 把之前的testFunc.c和testFunc.h放到test_func目录下testFunc1.c和testFunc1.h则放到test_func1目录下。
3.2.2 示例源码
其中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_directories。
该命令是用来向工程添加多个指定头文件的搜索路径路径之间用空格分隔。
因为main.c里include了testFunc.h和testFunc1.h如果没有这个命令来指定头文件所在位置就会无法编译。当然也可以在main.c里使用include来指定路径如下
#include test_func/testFunc.h
#include test_func1/testFunc1.h只是这种写法不好看。 另外我们使用了2次aux_source_directory因为源文件分布在2个目录下所以添加2次。
3.2.2 运行查看 四 项目级的组织结构
正规一点来说一般会把源文件放到src目录下把头文件放入到include文件下生成的对象文件放入到build目录下最终输出的可执行程序文件会放到bin目录下这样整个结构更加清晰。
4.1 项目结构
让我们把前面的文件再次重新组织下
4.2 示例源码
修改CMakeLists.txt
CMakeLists.txt
cmake_minimum_required (VERSION 2.8)project (demo)add_subdirectory (src)add_subdirectory这个语句的作用是增加编译子目录。其基本语法格式是
add_subdirectory(source_dir [binary_dir] [EXCLUDE_FROM_ALL])一共有三个参数后两个是可选参数.
source_dir 源代码目录
指定一个包含CMakeLists.txt和代码文件所在的目录该目录可以是绝对路径也可以是相对路径对于后者相对路径的起点是CMAKE_CURRENT_SOURCE_DIR。此外如果子目录再次包含的CMakeLists.txt则将继续处理里层的CMakeLists.txt而不是继续处理当前源代码。
binary_dir 二进制代码目录
这个目录是可选的如果指定cmake命令执行后的输出文件将会存放在此处若没有指定默认情况等于source_dir没有进行相对路径计算前的路径也就是CMAKE_BINARY_DIR。
EXCLUDE_FROM_ALL标记
这个标志是可选的如果传递了该参数表示新增加的子目录将会排除在ALL目录之外可能是make系统中的make all表示这个目录将从IDE的工程中排除。用户必须显式在子文件这个编译目标手动cmake之类的。指定了这个文件夹表示这个文件夹是独立于源工程的这些函数是有用但是不是必要的比如说我们一系列的例子。
add_subdirectory 这个命令用于添加源文件子目录同时还可以指定中间二进制和目标二进制的生成路径。EXCLUDE_FROM_ALL将会将这个目录从编译中排除如工程的例子需要等待其他编译完成后再进行单独的编译。通常子目录应该包含自己的project()命令这样以来整个编译命令将会产生各自的目标文件。如果把CMakeLists.txt与VS IDE比较总的CMakeLists.txt就相当于解决方案子CMakeLists.txt就相当于在解决方案下的工程文件。还有一个需要注意的是如果编译父CMakeLists时依赖了子CMakeLists.txt中的源文件那么该标志将会被覆盖也就是也会处理以满足编译任务。
这里指定src目录下存放了源文件当执行cmake时就会进入src目录下去找src目录下的CMakeLists.txt所以在src目录下也建立一个CMakeLists.txt内容如下:
src/CMakeLists.txt
aux_source_directory (. SRC_LIST)include_directories (../include)add_executable (main ${SRC_LIST})set (EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)这里的set其实是和前面的一样只是EXECUTABLE_OUTPUT_PATH是个系统自带的预定义变量其意义如下
EXECUTABLE_OUTPUT_PATH 目标二进制可执行文件的存放位置PROJECT_SOURCE_DIR工程的根目录
所以这里set的意思是把存放elf文件的位置设置为工程根目录下的bin目录。cmake有很多预定义变量详细的可以网上搜索一下
添加好以上这2个CMakeLists.txt后整体文件结构如下
4.3 运行查看
下面来运行cmake不过这次先让我们切到build目录下:
cd build
cmake ..
make这样Makefile会在build目录下生成二进制程序会在bin目录下生成然后运行可执行程序
cd ../bin
./main 这里解释一下为什么在build目录下运行cmake 还记得在第一个例子里我让你着重看一下cmake和make之后会生成什么文件吗这个过程中会生成很多文件但是可惜的是跟我们的运行并没有什么关系因此如果能把编译隔离在某个文件夹这样cmake的时候所有的中间文件都将在这个目录下生成删除的时候也很好删除非常方便。如果不这样做cmake运行时生成的附带文件就会跟源码文件混在一起这样会对程序的目录结构造成污染。 另外一种写法 前面的工程使用了2个CMakeLists.txt最外层的CMakeLists.txt用于掌控全局使用add_subdirectory来控制其它目录下的CMakeLists.txt的运行。 上面的例子也可以只使用一个CMakeLists.txt把最外层的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。 关于什么是静态库和动态库以及如何使用它们请参见我的另一篇博客【C】静态库与动态库的生成与使用介绍 5.1 生成库文件
5.1.1 项目结构
首先按照如下重新组织文件只留下testFunc.h和TestFunc.c 我们会在build目录下运行cmake并把生成的库文件存放到lib目录下。
5.1.2 示例源码
CMakeLists.txt
cmake_minimum_required (VERSION 3.5)project (demo)set (SRC_LIST ${PROJECT_SOURCE_DIR}/testFunc/testFunc.c)add_library (testFunc_shared SHARED ${SRC_LIST})
add_library (testFunc_static STATIC ${SRC_LIST})set_target_properties (testFunc_shared PROPERTIES OUTPUT_NAME testFunc)
set_target_properties (testFunc_static PROPERTIES OUTPUT_NAME testFunc)set (LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/lib)这里又出现了新的命令和预定义变量:
add_library: 生成动态库或静态库(第1个参数指定库的名字第2个参数决定是动态还是静态如果没有就默认静态第3个参数指定生成库的源文件)set_target_properties: 设置最终生成的库的名称还有其它功能如设置库的版本号等LIBRARY_OUTPUT_PATH: 库文件的默认输出路径这里设置为工程目录下的lib目录 PS前面使用set_target_properties重新定义了库的输出名称如果不使用set_target_properties也可以那么库的名称就是add_library里定义的名称只是连续2次使用add_library指定库名称时第一个参数这个名称不能相同而set_target_properties可以把名称设置为相同只是最终生成的库文件后缀不同一个是.so一个是.a这样相对来说会好看点。 5.1.3 运行查看
cd build/
cmake ..
make
cd ../lib/
ls5.2 链接库文件
既然我们已经生成了库那么就进行链接测试下。
5.2.1 项目结构
重新建一个工程目录然后把上节生成的库拷贝过来然后在在工程目录下新建src目录和bin目录在src目录下添加一个main.c整体结构如下
5.2.2 示例源码
main.c
#include stdio.h#include testFunc.hint main(void)
{func(100);return 0;
}CMakeLists.txt
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})这里出现2个新的命令
find_library: 在指定目录下查找指定库并把库的绝对路径存放到变量里其第一个参数是变量名称第二个参数是库名称第三个参数是HINTS第4个参数是路径其它用法可以参考cmake文档target_link_libraries: 把目标文件与库文件进行链接
使用find_library的好处是在执行cmake …时就会去查找库是否存在这样可以提前发现错误不用等到链接时。
5.2.3 运行查看
cd到build目录下然后运行cmake … make最后进入到bin目录下查看发现main已经生成运行之
cd build/
cmake ..
make
cd ../bin/
./mainps在lib目录下有testFunc的静态库和动态库find_library(TESTFUNC_LIB testFunc …默认是查找动态库如果想直接指定使用动态库还是静态库可以写成find_library(TESTFUNC_LIB libtestFunc.so …或者find_library(TESTFUNC_LIB libtestFunc.a … ps 查看elf文件使用了哪些库可以使用readelf -d ./xx来查看 例readelf -d ./main 六 条件编译
有时编译程序时想添加一些编译选项如-Wall-stdc11等就可以使用add_compile_options来进行操作。 这里以一个简单程序来做演示。
6.1 简单程序
6.1.1 项目结构 6.1.2 示例代码
main.cpp
#include iostreamint main(void)
{auto data 100;std::cout data: data \n;return 0;
}CMakeLists.txt
cmake_minimum_required (VERSION 2.8)project (demo)set (EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)add_compile_options(-stdc11 -Wall) add_executable(main main.cpp)6.1.3 运行查看
然后cd到build目录下执行cmake … make命令就可以在bin目录下得到main的可执行文件
6.2 添加编译选项
有时希望在编译代码时只编译一些指定的源码可以使用cmake的option命令主要遇到的情况分为2种
本来要生成多个bin或库文件现在只想生成部分指定的bin或库文件对于同一个bin文件只想编译其中部分代码使用宏来控制
6.2.1 生成部分指定bin或库文件
6.2.1.1 项目结构
假设我们现在的工程会生成2个bin文件main1和main2项目结构如下
6.2.1.2 示例源码
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如下
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
// main1.c
#include stdio.hint main(void)
{printf(hello, this main1\n);return 0;
}main1.c
// main2.c
#include stdio.hint main(void)
{printf(hello, this main2\n);return 0;
}6.2.1.3 运行查看
然后cd到build目录下输入cmake … make就可以只编译出main1如果想编译出main2就把MYDEBUG设置为ON再次输入cmake … make重新编译。
每次想改变MYDEBUG时都需要去修改CMakeLists.txt有点麻烦其实可以通过cmake的命令行去操作例如我们想把MYDEBUG设置为OFF先cd到build目录然后输入cmake … -DMYDEBUGON这样就可以编译出main1和main2 在bin目录下
6.2.2 编译部分代码
假设我们有个main.c其内容如下
main.c
#include stdio.hint 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文件的打印输出了。
整体工程结构如下
cd到build目录下执行cmake … make然后到bin目录下执行./main可以看到打印为空 接着分别按照下面指令去执行然后查看打印效果
cmake … -DWWW1ON -DWWW2OFF makecmake … -DWWW1OFF -DWWW2ON makecmake … -DWWW1ON -DWWW2ON make
这里有个小坑要注意下假设有2个options叫A和B先调用cmake设置了A下次再调用cmake去设置B如果没有删除上次执行cmake时产生的缓存文件那么这次虽然没设置A也会默认使用A上次的option值。
所以如果option有变化要么删除上次执行cmake时产生的缓存文件要么把所有的option都显式的指定其值。
总结
以上是自己学习CMake的一点学习记录通过简单的例子让大家入门CMake学习的同时也阅读了很多网友的博客。CMake的知识点还有很多具体详情可以在网上搜索。总之CMake可以让我们不用去编写复杂的Makefile并且跨平台是个非常强大并值得一学的工具。
如果有写的不对的地方希望能留言指正谢谢阅读。
