CMakeList文件编写

在linux 下进行开发很多人选择编写makefile文件进行项目环境搭建,而makefile 文件依赖关系复杂,工作量很大,搞的人头很大。采用自动化的项目构建工具cmake可以将程序员从复杂的makefile 文件中解脱出来。cmake 根据内置的规则和语法来自动生成相关的makefile文件进行编译,同时还支持静态库和动态库的构建,我把工作中用到的东东总结在此,方便忘记时随时查看,具体cmake的介绍和详细语法还是参考官方文档(http://www.cmake.org/),有一篇中文的 cmake实践 写的不错,可以google一下。

使用cmake很简单,只需要执行cmake, make 两个命令即可,用我工作中的一个工程举例说明。

假设当前的项目代码在src 目录。 src下有子目录:server, utility, lib, bin, build

server -----存放项目的主功能类文件

utility----- 存放项目要用到相关库文件,便已成为库文件存放到子目录lib 中

lib -----存放utility 生成的库

bin -----存放association 生成的二进制文件

build -----编译目录,存放编译生成的中间文件

cmake要求工程主目录和所有存放源代码子目录下都要编写CMakeLists.txt 文件,注意大小写(cm 大写,list中l大写且落下s).

src/CMakeLists.txt文件如下:

-------------------------------------------------------------------------------------------------------------

#cmake file for project association #表示注释
#author:>---double__song
#created:>--2011/03/01

CMAKE_MINIMUM_REQUIRED(VERSION 2.8) #cmake 最低版本要求,低于2.6 构建过程会被终止。

PROJECT(server_project) #定义工程名称

MESSAGE(STATUS "Project: SERVER") #打印相关消息消息
MESSAGE(STATUS "Project Directory: ${PROJECT_SOURCE_DIR}")

SET(CMAKE_BUILE_TYPE DEBUG) #指定编译类型


SET(CMAKE_C_FLAGS_DEBUG "-g -Wall") #指定编译器

ADD_SUBDIRECTORY(utility) #添加子目录
ADD_SUBDIRECTORY(server)
-------------------------------------------------------------------------------------------------------------

相关解释:

1. CMakeLists.txt 文件中不区分大小写

2. PROJECT(project_name) 定义工程名称

语法:project(projectname [cxx] [c] [java])

可以指定工程采用的语言,选项分别表示:C++, C, java, 如不指定默认支持所有语言

3. MESSAGE(STATUS, "Content") 打印相关消息

输出消息,供调试CMakeLists.txt 文件使用。

4. SET(CMAKE_BUILE_TYPE DEBUG) 设置编译类型debug 或者release。 debug版会生成相关调试信息,可以使用GDB 进行

调试;release不会生成调试信息。当无法进行调试时查看此处是否设置为debug.

5. SET(CMAKE_C_FLAGS_DEBUG "-g -Wall") 设置编译器的类型

CMAKE_C_FLAGS_DEBUG ---- C 编译器

CMAKE_CXX_FLAGS_DEBUG ---- C++ 编译器

6. ADD_SUBDIRECTORY(utility) 添加要编译的子目录

为工程主目录下的存放源代码的子目录使用该命令,各子目录出现的顺序随意。

如上便是工程server_project 主目录src 下的CMakeLists.txt文件,下一篇我们解释子目录utiltiy中的CMakeLists.txt 文件。

子目录utility下的CMakeLists.txt 文件如下:

--------------------------------------------------------------------------------------------------------------------
#Cmake file for library utility.a
#Author: double__song
#Created: 2011/3/3


SET(SOURCE_FILES #设置变量,表示所有的源文件
ConfigParser.cpp
StrUtility.cpp
)


INCLUDE_DIRECTORIES( #相关头文件的目录
/usr/local/include
${PROJET_SOURCE_DIR}/utility
)


LINK_DIRECTORIES( #相关库文件的目录
/usr/local/lib

)


ADD_LIBRARY(association ${SOURCE_FILES})#生成静态链接库libassociation.a

TARGET_LINK_LIBRARY(associationcore) #依赖的库文件


SET_TARGET_PROPERTIES(utility PROPERTIES #表示生成的执行文件所在路径
RUNTIME_OUTPUT_DIRECTORY>"${PROJECT_SOURCE_DIR}/lib")


--------------------------------------------------------------------------------------------------------------------
相关解释:

1.SET(SOURCE_FILES .....)

表示要编译的源文件,所有的源文件都要罗列到此处。set设置变量,变量名SOURCE_FILES自定义。

2.INCLUDE_DIRECTORY(...)

include头文件时搜索的所有目录

变量PROJECT_SOURCE_DIR表示工程所在的路径,系统默认的变量

3.LINK_DIRECTORIES(...)

库文件存放的目录,在程序连接库文件的时候要再这些目录下寻找对应的库文件

4.ADD_LIBRARY(...)

表示生成静态链接库libassociaiton.a,由${PROJECT_SOURCE_DIR}代表的文件生成。

语法:ADD_LIBRARY(libname[SHARED|STATIC]

SHARED表示生成动态库, STATIC表示生成静态库。

5.TARGET_LINK_LIBRARY(association core)

表示库association依赖core库文件

6.SET_TARGET_PROPERTIES

设置编译的库文件存放的目录,还可用于其他属性的设置。如不指定,

生成的执行文件在当前编译目录下的各子目录下的build目录下,好拗口!简单一点:

如指定在:./src/lib 下

不指定在:./src/build/utility/build 目录下

生成的中间文件在./src/build/utilty/build目录下,不受该命令额影响


子目录server下的CMakeLists.txt 文件:

--------------------------------------------------------------------------------------------
SET(SOURCE_FILES
Gassociation.cpp
ConfigurationHandler.cpp
)

INCLUDE_DIRECTORIES(

/usr/local/include
${PROJECT_SOURCE_DIR}/utility
${PROJECT_SOURCE_DIR}/association
)

LINK_LIBRARIES(
/usr/local/lib
${PROJECT_SOURCE_DIR}/lib
)

ADD_EXECUTABLE(server ${SOURCE_FILES})

TARGET_LINK_LIBRARIES(server
utility

SET_TARGET_PROPERTIES(serverPROPERTIES #表示生成的执行文件所在路径
RUNTIME_OUTPUT_DIRECTORY "${PROJECT_SOURCE_DIR}/bin")

-------------------------------------------------------------------------------------------------------

相关解释:

1.ADD_EXECUTABLE() #指定要生成的执行文件的名称server

其他用法同utilty/CMakeLists.txt

2.SET_TARGET_PROPERTIES

设置生成的执行文件存放的路径,

注意:

执行文件server依赖的子目录utility 子目录生成的静态库libutility.a,在指定的时候要写成:
TARGET_LINK_LIBRARIES(server utility)

而不能写成:

TARGET_LINK_LIBRARIES(serverlibutility.a)

否则编译总会提示找不到libutility库文件。

但使用第三方的库却要指定成具体的库名,如:libACE-6.0.0.so

这一点很诡异,暂时还没找到原因。


完成对应的CMakeLists.txt文件编写后,便可以进行编译了。

编译:

进入./src/build

执行cmake..

make


cmake的使用很简单,更高级的应用好比版本信息,打包,安装等相关基本的应用后面会一一介绍,

复杂的语法使用要参考官方文档。


CMakeLists.txt文件是用于配置CMake构建系统的文件,可以用来指定项目的编译选项、依赖库、生成的可执行文件或动态库等信息。在CMakeLists.txt文件中,可以使用一系列的CMake命令来描述项目的构建过程。常见的CMake命令包括add_executable、add_library、target_link_libraries等,这些命令可以用来添加可执行文件或库,并指定它们的源文件、依赖库等信息。通过配置CMakeLists.txt文件后,我们可以使用cmake命令生成Makefile文件,然后使用make命令进行编译工作,最终得到可执行文件或动态库。 CMakeLists.txt文件编写可以根据具体项目的需求进行灵活配置,但通常包括以下几个常见的部分: 1. 使用cmake_minimum_required命令指定CMake的最低版本要求。 2. 使用project命令指定项目名称。 3. 使用add_executable或add_library命令添加可执行文件或库,并指定源文件。 4. 使用target_link_libraries命令添加依赖库。 5. 使用set命令设置编译选项或定义变量。 6. 使用include_directories或target_include_directories命令指定头文件路径。 7. 使用link_directories或target_link_directories命令指定库文件路径。 8. 使用install命令指定安装规则。 以上是CMakeLists.txt文件的一般编写方式和常见命令用法,具体的编写方式和命令使用取决于项目的需求。 在CMakeLists.txt文件中,可以使用add_definitions命令定义预处理宏。add_definitions的功能和C/C++中的#define是类似的,可以用来定义一些编译时的宏,从而在源代码中使用#ifdef和#ifndef等条件编译语句进行条件判断。例如,在CMakeLists.txt中使用add_definitions命令定义了TEST_IT_CMAKE宏后,源文件中可以通过#ifdef TEST_IT_CMAKE来判断是否定义了该宏,并执行相应的代码。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* *2* [Cmakelist知识总结](https://blog.csdn.net/niewei120/article/details/127209564)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] - *3* [CMakeLists入门](https://blog.csdn.net/weixin_45626706/article/details/121191635)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值