文档章节

【整理】CMake 介绍和 CMake 实践

摩云飞
 摩云飞
发布于 2012/11/16 13:15
字数 1594
阅读 1.2K
收藏 8

码上生花,ECharts 作品展示赛正式启动!>>>

【CMake 优点】:

  1. 开放源代码,使用 BSD 许可证发布。
  2. 跨平台,可以生成 native 编译配置文件。在 linux/unix 平台可以生成 makefile,在 mac 平台可以生成 xcode,在 windows 平台可以生成 msvc 工程的配置文件。
  3. 能够管理大型项目。
  4. 简化编译构建过程和编译过程,只需要 cmake + make 就可以。
  5. 高效率。
  6. 可扩展,可以为 cmake 编写特定功能的模块,扩充 cmake 功能。

【如何安装 CMake】:

1. CMake 的安装可以使用 autotools 进行安装,点击cmake-2.8.6.tar.gz链接,可以对软件进行下
2. 执行 ./configure; make; make install

CMake的原理】 

准备main.cpp文件

//main.cpp

#include<cstdio>

int main()
{
    printf("hello world from main\n");
    return 0;
}

a.创建 CMakeLists.txt(注意:此文件名大小写必须如此命名),向该文件中加入以下几行(内容中命令的大小写无所谓):

PROJECT (HELLO)
SET(SRC_LIST main.cpp)
MESSAGE(STATUS "This is BINARY dir " ${HELLO_BINARY_DIR})
MESSAGE(STATUS "This is SOURCE dir "${HELLO_SOURCE_DIR})
ADD_EXECUTABLE(hello ${SRC_LIST})

b.运行以下命令(linux下):

$ cmake .                (别忘记加上这个点,表示当前目录)

执行完该命令后执行ls可以看到:

生成了CMakeFiles(目录)、CMakeCache.txtcmake_install.cmake以及Makefile文件。
c.执行make。

这时当前目录下就会生成可执行文件:

【例子解释】:

上面CMakeLists.txt的内容重新列出如下: 

PROJECT (HELLO)
SET(SRC_LIST main.cpp)
MESSAGE(STATUS "This is BINARY dir " ${HELLO_BINARY_DIR})
MESSAGE(STATUS "This is SOURCE dir "${HELLO_SOURCE_DIR})
ADD_EXECUTABLE(hello ${SRC_LIST})

PROJECT指令的语法:
PROJECT(projectname [CXX] [C] [JAVA]) 

该指令用来定义工程名称和工程支持的语言。这个指令也同时隐式定义了两个cmake变量:<projectname>_BINARY_DIR以及<projectname>_SOURCE_DIR
在该例子中就是HELLO_BINARY_DIRHELLO_SOURCE_DIR,两个变量指的都是当前工程的路径。 
SET指令的语法:
SETVAR[VALUE] [CACHE TYPE DOCSTRING [FORCE]] 

Set指令是用来显式的定义变量的,我们之前用到的是SET(SRC_LIST main.cpp),如果有多个源文件,也可以定义成SET(SRC_LIST main.cpp t1.cpp t2.cpp) 
MESSAGE指令的语法是:
MESSAGE([SEND_ERROR | STATUS | FATAL_ERROR] "message to display" ...) 

这个指令用于向终端输出用户信息,包含三种类型:

  1. SEND_ERROR,产生错误,生成过程被跳过。
  2. SATUS,输出前缀为-的信息。
  3. FATAL_ERROR,立即终止所有cmake过程。 


上例使用的是STATUS类型进行信息输出,用于显示由PROJECT指令隐式定义的两个变量HELLO_BINARY_DIRHELLO_SOURCE_DIR的值。 

ADD_EXECUTABLE(hello ${SRC_LIST})

定义了这个,工程会生成一个文件名为hello的可执行文件,相关的源文件是SRC_LIST中定义的源文件列表,本例中你可以直接写成ADD_EXECUTABLE(hello main.c)
本例CMakeLists.txt的最简化形式:

PROJECT(HELLO)
ADD_EXECUTABLE(hello main.c)

=== 我是分割线 ===

下面我们介绍一个比较实用的例子,既包含生成静态库又包含引入外部头文件和链接库的cmake demo
先按照工程规范建立工程目录并编写代码,以下面的工程目录为例进行解释这个例子,工程的目录结构为:

 

编译工程要实现的目标:

  • 添加子目录doc,用以放置这个工程的文档hello.txt
  • 生成hello的静态库,并在main可执行程序链接hello静态库。
  • 在这个工程中添加COPYRIGHTREADME文件。
  • 在工程目录中添加一个run.sh的脚本,用以调用生成的二进制可执行文件。
  • 将生成的二进制文件生成到bin子目录中。
  • 编写安装程序。 

1. 编写CMakeLists.txt
      由于一个工程目录中包含多个项目,其中在此项目中包含util项目和main项目,其中util项目是用以生成main程序需要的静态库,main是用以生成可执行文件。
      在整个工程项目的根目录下的CMakeLists.txt是用来定义工程需要的CMake设置以及子目录src,用以递归调用src中的MakeLists.txt。该CMakeLists.txt的内容定义如下: 

PROJECT(HELLO)
ADD_SUBDIRECTORY(src)

      目录src中的CMakeLists.txt用以定义src目录下包含的两个工程(main和util)的依赖关系。
      目录util里面的CMakeLists.txt是用以定义生成util静态库的规则,其中内容如下:

SET(LIBRARY_OUTPUT_PATH ${HELLO_SOURCE_DIR}/lib)
SET(CMAKE_C_COMPILER g++)
SET(SRC_LIST hello.c) 

INCLUDE_DIRECTORIES(${HELLO_SOURCE_DIR}/include)
ADD_LIBRARY(util STATIC ${SRC_LIST})


SET(LIBRARY_OUTPUT_PATH ${HELLO_SOURCE_DIR}/lib) -- 定义了库生成的路径,内部变量LIBRARY_OUTPUT_PATH用于存放库的生成路径。 
SET(CMAKE_C_COMPILER g++) -- 定义C的编译器为g++,防止出现CC++代码在不指定C编译器的情况下默认使用gcc,导致系统编译混乱。 
SET(SRC_LIST hello.c) -- 定义库文件需要的源文件。
INCLUDE_DIRECTORIES(${HELLO_SOURCE_DIR}/include) -- 定义非标准库头文件要搜索的路径。 

其中INCLUDE_DIRECTORIES命令的格式为:
INCLUDE_DIRECTORIES([AFTER|BEFORE] [SYSTEM] dir1 dir2 ...)
ADD_LIBRARY(util STATIC ${SRC_LIST}) -- 定义生成库的名字、类型和库所需要的源文件,

其中ADD_LIBRARY命令格式为:
ADD_LIBRARY(libname [SHARED|STATIC|MODULE] [EXCLUDE_FROM_ALL]
source1 source2 ... sourceN)

      目录main里面的CMakeLists.txt是用来定义可执行程序编译和链接时所需要的一些命令或环境。内容如下: 

SET(EXECUTABLE_OUTPUT_PATH ${HELLO_SOURCE_DIR}/bin)
SET(SRC_LIST main.cpp) 

INCLUDE_DIRECTORIES(${HELLO_SOURCE_DIR}/include)
LINK_DIRECTORIES(${HELLO_SOURCE_DIR}/lib) 

ADD_EXECUTABLE(hello ${SRC_LIST})
TARGET_LINK_LIBRARIES(hello util)


INCLUDE_DIRECTORIES(${HELLO_SOURCE_DIR}/include) -- 定义工程引用的include文件夹位置,其中存放使用到的库的头文件。
LINK_DIRECTORIES(${HELLO_SOURCE_DIR}/lib) -- 定义工程引用的库文件位置,其中存放着库文件。
ADD_EXECUTABLE(hello ${SRC_LIST}) -- 定义生成的可执行文件。
TARGET_LINK_LIBRARIES(hello util) -- 用以定义链接时需要的库文件。 

2.在工程目录下创建build目录,并采用out-of-source方式编译项目。执行命令

$ cmake ..

执行结果如下

 

执行tree命令,这时在build目录下生成了中间编译文件:

$ tree .

执行make命令,结果如下:

可以看到工程创建和编译成功了。 

3. 安装

      在工程目录下添加COPYRIGHTREADMErun.sh,重新编辑工程目录下的CMakeLists.txt。在CMakeLists.txt中添加如下命令: 

INSTALL(FILES COPYRIGHT README DESTINATION share/doc/cmake_demo)
INSTALL(PROGRAMS run.sh DESTINATION bin)
INSTALL(PROGRAMS bin/hello DESTINATION bin)
INSTALL(DIRECTORY doc/ DESTINATION share/doc/cmake_demo)

      这些命令表示在执行make install命令时,安装程序会拷贝相应的文件、目录或程序到指定的前缀开始的目录中,cmake执行命令如下: 

cmake -DCMAKE_INSTALL_PREFIX=~/data/cmake_demo ..

      这时将工程目录安装到~/data/cmake_demo目录下。执行结果如下:

其中cmake编译cc++工程完毕。 

本文转载自:http://www.udpwork.com/item/6326.html

摩云飞
粉丝 377
博文 534
码字总数 952694
作品 0
徐汇
程序员
私信 提问
加载中
此博客有 2 条评论,请先登录后再查看。
《CMake实践》笔记一:PROJECT/MESSAGE/ADD_EXECUTABLE

《CMake实践》笔记一:PROJECT/MESSAGE/ADD_EXECUTABLE 《CMake实践》笔记二:INSTALL/CMAKEINSTALLPREFIX 《CMake实践》笔记三:构建静态库与动态库 及 如何使用外部共享库和头文件 前言: ...

shzwork
2019/03/31
68
1
CMake和Linux编程:find_package的使用

1.第一个CMake例子   在 t1 目录建立 main.c 和 CMakeLists.txt(注意文件名大小写):   main.c 文件内容: //main.c include <stdio.h> int main(){ }  CmakeLists.txt 文件内容: PROJ......

osc_5ncz8ucr
2018/07/11
1
0
CMake安装或CMake Error at CMakeLists

CMake安装或CMake Error at CMakeLists 发生情景: 使用cmake命令安装软件时,报如下错误: CMake Error at CMakeLists.txt:4 (CMAKEMINIMUMREQUIRED): CMake 3.0.2 or higher is required.......

osc_gay6i4ve
2019/03/05
4
0
CMake如何查找库路径(一)

CMake如何查找库路径(一) 如果你的代码使用了外部库(external libraries),并且你事先不知道这些库的头文件和库文件在当前平台的位置。那么适当的文件夹路径和库的搜索路径就应该被添加到...

shzwork
2019/03/30
2.2K
0
CMake结合PCL库学习(1)

经常会有有人问到CMake的学习的问题,而且网上也有很多博客是介绍学习CMake 的用法,但是我觉的学习不用这样死板,用到了就顺便学习一下,也就是边做边学,由浅入深,慢慢的就会熟悉了,这个...

osc_exuz1x7u
2018/05/15
5
0

没有更多内容

加载失败,请刷新页面

加载更多

Http和Nginx反代至Tomcat(LNMT、LAMT)

Http和Nginx反代至Tomcat(LNMT、LAMT) ================================================================================ 概述: 本章将主要介绍Http和Nginx反代至Tomcat,具体内容如下......

osc_facwbzof
今天
17
0
mysql备份之mysqldump工具

参考文档: 利用mysqldump+二进制日志实现备份恢复数据库:http://www.178linux.com/60616 mysql进阶篇(三种备份方法总结:lvm, mysqldump, xtrabackup):http://www.178linux.com/9781 注意...

osc_ur9mmbck
今天
25
0
实战nginx前端反代MogfileFS及负载均衡

实战nginx前端反代mogfilefs及负载均衡 =============================================================================== 实验描述: 使用Nginx代理请求至tackers,实现通过键就可以访问到...

osc_jvzgahav
今天
9
0
Xshell远程操作liunx图形化桌面(xmanager,远程桌面)

必要条件: 1、安装全套的xmanager程序 2、Linux系统安装了图像界面 ~]# yum grouplist    # 查看可安装的桌面组件~]# yum groupinstall "组件名" 3、在shell远程连接主机的属性里...

osc_a45vpoh4
今天
11
0
zabbix基础配置(二)

zabbix基础配置(二) ============================================================================= 概述: 本章我们将继续介绍zabbix的基础配置,具体内容如下: zabbix-agent的安装、...

osc_7bkuddw5
今天
9
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部