省流版——直接拿来用
文件里已经通过注释写上了基本教程,既能直接用还能当文档,纯手打,AI仅供辅助
# CMake的命令支持大小写混合,都可以正常识别,但仅限于命令!变量别混合大小写
# 设置最低要求的Cmake版本,你可以把版本号改成你认为有意义的
cmake_minimum_required(VERSION 3.15)
# 设置项目基本属性:名称 [版本] [语言(可选,但强烈建议加上)]
set{YOUR_PROJECT_NAME <在这里填入你的工程名称>}
project(${YOUR_PROJECT_NAME} LANGUAGES CXX) #这里的编程语言默认给你写了个C++ ,下面都按C++配置
# 设置一些配置项目
# ———————————————————————————-设置构建模式,默认给你设置个Debug模式
set(CMAKE_BUILD_TYPE Debug)
# set(CMAKE_BUILD_TYPE Release)
# ————————————————————————————设置C++标准
set(CMAKE_CXX_STANDARD 20)
set(CMAKE_CXX_STANDARD_REQUIRED ON) #强行要求使用C++20标准,如果编译器报错请将此项改为OFF,允许Cmake自动降级
# 目前你不需要单独设置目标系统和架构,Cmake会自动识别的
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/build/app) #设置你的可运行文件放到 项目根文件夹/构建目录/app
# 这里给出例子
# .
# |---build
# | |---app
# | | |--- 你的可执行文件 <==============在这里找
# | |---其他构建文件
# |
# |---src
# | |--- *.cpp
# |---head
# | |--- *.hpp
# |
# |---CMakeLists.txt
# |---其他文件
#
# 上面给出的目录树也是我目前认为还算干净的工程结构
# 下面的选项如果你更改了目录请务必自行修改
#有两种实现方案,这里启用了第二种方案
# aux_source_directory(${PROJECT_SOURCE_DIR}/src SRC_FILE)
file(GLOB SRC_FILE src/*.cpp)
file(GLOB HEAD_FILE head/*.hpp)
# ^ ^不进行递归 ^ ^在什么目录搜索符合哪些条件的文件 (这两条指令分别搜索src目录里的cpp文件和head目录里的hpp文件)
# 寻找文件 将搜到的文件存储到变量
add_executable(${YOUR_PROJECT_NAME}> ${SRC_FILE}) #添加可执行文件 从 指定的源码里
target_include_directories(${YOUR_PROJECT_NAME} PRIVATE src head) #本项目包括的文件夹(已默认包含刚才的两个文件夹)
# 这一步如果不执行的话会导致编译的时候搜不到头文件而报错
install(TARGETS ${YOUR_PROJECT_NAME}RUNTIME DESTINATION bin)
# 别忘了在 build 目录下进行构建以保证构建文件不会污染到项目根目录CMake我自己就是在用这一套模板,按照文件中的目录树创建文件夹并排布文件,应该就能运行。
有时候你需要连接第三方库,比如Json、openAI(写Agent用),你就需要使用 find_package 和 target_link_libraries 抱歉由于系统特性此处内容我无法为大家提供一个可以直接拿来用的文件,所以辛苦自己,找一下适合自己系统的方法。
下面是我的连接配置
# 找第三方库
find_package(PkgConfig REQUIRED) # 使用PkgConfig文件
pkg_check_modules(NCURSESW REQUIRED IMPORTED_TARGET ncursesw)
pkg_check_modules(JSONCPP REQUIRED IMPORTED_TARGET jsoncpp)
# 连接库
target_link_libraries(Fnaf1InTreminal PRIVATE
PkgConfig::NCURSESW
PkgConfig::JSONCPP
)CMake或者如果你愿意付出一点时间理解一下,或者你本来就是大牛,你就随便改
参考文献
前言
不要羞耻于查资料,多
拷问一下AI,我不认为你能马上背完几百条指令。如无特别注明,本教程将会使用 ” <占位符描述> ” 来作为占位符
本教程基于我的实测经历撰写而成,其目的只有一个——通过Cmake让你的程序能够 更方便地 通过编译然后跑起来,仅此而已。所以我也只会提供最为基础的内容
所以,如果你需要更进阶的教程,请查阅参考文献。
我是Linux用户,所以本文内容可能并不是那么通用,烦请各位多有包涵。
你问我是怎么接触到Cmake的?因为我用的IDE是Kdevelop,他就内建了个Cmake模板,然后有多文件开发的需求就顺手学了 Cmake
介绍 Cmake
Cmake——一款跨平台的辅助构建器,主要是C和C++特化。但是官方也对常见主流语言有支持,下面是支持表
- C语言 —— 参数为 C
- C++ —— 参数为 CXX
- Fortran —— 参数为 Fortran
- Java —— 参数为 Java
请务必注意,上述参数必须完全对应!大小写都不能变
信息来源:维基百科 和 我自己试
而 CMakeLists.txt 无疑是很关键的文件之一(对于本教程,你只需要会配这个就够,因为我也是只配了这个)
嗯对,就是这样
开始使用-只讲基本指令
cmake_minimum_required
语法
cmake_minimum_required(VERSION <版本数字>)CMake作用
声明最低使用的Cmake版本
注意
本条指令必须放在最开头
project
语法
project(<工程名称> LANGUAGES <语言参数,不知道填什么回“介绍Cmake”查>)CMake作用
声明工程基本信息,语言选项是可选的,但是建议加上,别到时候本来是写一个C++结果给你自动认成Python了(笑话来源:C++23标准开始不使用 #include 包含 标准库 头文件 了,改用 import 来 导入各种标准库 了。当然 Cmake 不会这么傻的,玩笑罢了)
set
前置知识
在Cmake里,一切皆字符串,所有的判断全部基于字符串比较
而官方也预定义了大量变量,已经是一种标准了
语法
set(<变量名称> <变量值>)
#调用变量
${<你的变量>}CMake通常情况下,你只需要使用预定义的宏变量即可,下面列出了常用的预定义变量和对应的 set 指令:
set(CMAKE_BUILD_TYPE Debug) # 设置构建方式 是 调试
#支持的参数: Debug Release 等总计四个
set(CMAKE_CXX_STANDARD 20) #设置C++标准 为 20
set(CMAKE_CXX_STANDARD_REQUIRED TRUE) #设置 强制使用C++20 标准为 是,若编译器不支持将会直接报错
# 后面的布尔参数支持这些字符串 TRUE/FALSE ON/OFF YES/NO ,大小写不敏感。建议成对使用
set(EXECUTABLE_OUTPUT_PATH <指定路径>) # 设置构建完毕后的可执行文件放哪里CMake还有一些是预定义且预先赋值的,目前我只用到一个
- ${PROJECT_SOURCE_DIR} 项目根目录,如果不写的话所有目录默认认为是相对于当前CMakeLists.txt文件的相对路径
这种变量在很多编程语言都很常见,它们通常是用于“实现”,我理解为为特定功能而事先约定好的变量。
一般而言,这种变量有这些特征:
名称全部大写
以两个下划线打头,比如 PHP 中的 __GET 变量就是为接受GET请求参数而事先准备好的
file
不全面!!仅讲解文件搜索命令
语法
file(<搜索方法> <存储变量> <搜索规则>)
file(GLOB <新的变量> <文件路径>/*.<文件后缀>) #这是常见用法
# 比如
file(GLOB SRC_FILE ${PROJECT_SOURCE_DIR}/src/*.cpp)CMake参数解析
- <搜索方法> —— 支持 GLOB 和 GLOB_RECURSE 参数。后者是递归搜索,会把指定路径及其子文件夹中的所有符合条件的内容都收起来
- <存储变量> —— 将搜索到的所有文件以 “file1 file2 file3 …” 的形式存到这里
- <搜索规则> —— 按照正则匹配规则搜索文件
作用
寻找对应路径下满足一定条件的文件,并将搜索到的文件名称存到 <新的变量> 里,方便其它指令调用
例子
现在有这么一个文件结构(手敲目录结构)
.根目录
|---Namie!
| |---InMyHeart
| | |Goldenglow.pub
| | |Goldenglow.cpp
| |Pepe.csv
| |Mizuki.csv
|
|---Reunion
| |---RIP
| | |---FrostNova
| | | |RememberForever.ca
| | |Foster
| |Wis'del.csv
| |CrownSlayer.csv
| |Raid.hpp
|
|---LungmenOrgs
| |---PenguinLogistics
| | |Texas.csv
| | |Exusiai.csv
| | |Sora.csv
| | |Croissant.csv
|
|---Siracusa
| |//Texas -> LunmenOrgs/PenguinLogistics/Texas #本行文字的意思是“在此处的 Texas 文件是一个指向别处的快捷方式”
| |Lappland.csv
...Plaintext你要想用file 指令找 企鹅物流 下所有内容,就可以使用 GLOB 参数,因为这个文件夹下 没有其他文件夹
file(GLOB PENGLOGIS ${PROJECT_SOURCE_DIR}/LunmenOrgs/PenguinLogistics/*.csv)CMake但是如果你想找所有 整合运动 的…… 也可以! 使用 GLOB_RECURSE 参数,因为有嵌套文件夹,让系统自己一点点翻找
file(GLOB_RECURSE REUNIONS ${PROJECT_SOURCE_DIR}/Reunion/*)CMakeadd_executable
语法
add_executable(<可执行文件名称> <源代码文件>)CMake作用
将所有 <源代码文件> 编译成一个可执行文件
注意
上一步你 file 到的变量就可以在这里用了
target_include_directories
语法
target_include_directories(<工程名称> <访问权限> <文件夹1> <文件夹2> <...>)
#您也可以这么写
target_include_directories(<工程名称> <访问权限>
<文件夹1>
<文件夹2>
<...>
)CMake作用
让你的项目能认出来你的文件夹,不然你在 include 头文件的时候就会找不到(除非你输入全部路径)
比如
还是上面那个舟味很浓的文件结构,现在我正在编辑 Goldenglow.cpp 文件,但是我想 include 一个 Raid.hpp 文件。(文件名小巧思你就学吧)
默认情况下编译器只会在文件当前目录去找,甚至都不会递归。如果你没指明路径,编译器会直接报错,找不到!
一看,雷德(Raid.hpp) 是 整合运动 的,你根本不可能 在 Namie!/InMyHeart 里找到。那么……
target_include_directories(Link_GG_with_Raid PRIVATE ${PROJECT_SOURCE_DIR}/Reunion)CMake再Cmake一下,编译器就认 #include “Raid.hpp” 了
结尾
其实还有一个install指令没讲,因为我目前也对这个指令不是很了解
但是这些内容应该能够让大家有所了解了,不说了,我去写石山代码了