PlatformIO 自定义脚本选择编译库源文件 - 设置只用于C++ 的编译选项

PlatformIO 只支持以文件夹为单位选择要编译的源文件，不像Keil 或者CMake，可以手动控制每一个源文件。而且默认只会将库的src 文件夹下的源文件全部加入编译。比如，某个库的文件结构如下：

+ libx+ src+ include+ mem|  a.c|  b.c|  c.c

PlaformIO 默认会将src 文件夹下的所有源文件加入编译，并且将include 文件夹加入包含路径，但是没有简单的方法把mem 文件夹加入编译；要只选择mem 里面的某一个文件编译，其他的排除，这就更复杂了。而FreeRTOS 就恰好是这样的结构，需要在五个heap_x.c 文件里选择一个。一般有两种常规的方法：

1. 直接修改库文件，把不想要的源文件删掉，剩下的源文件放在库的src 文件夹里；
2. 创建或编辑库的配置文件library.json，想办法用文件过滤器把要包含的源文件过滤出来；

这两种方法的操作和原理可以参考：

1. library.json
2. How to add source directories and include directories for libraries?

但是修改库文件的话，就等于要自己维护一个库的版本，以后如果原来的库升级了，还得费劲把升级的内容合并到自己修改后的库里。而且如果以后有别的需求，想更改成其他源文件，那就又得从头改个新版本。所以最好还是折腾一下PlatformIO 的脚本吧，或者别用PlaformIO 了。脚本的基本功能参考官方文档：Adavanced Scripting，用的是python。下面把脚本功能分成三个难度等级。

一、用脚本添加C++ 编译选项

某些C++ 的编译选项和C 不兼容，如果直接在platformio.ini 的build_flags 里添加，选项也会应用在C 文件上，编译时就会冒出大片的警告，说这个选项不能用于C，挺烦的。比如，喜欢追求流行的大伙们或许会发现，如果指定了C++20 标准，本来正常的寄存器操作代码突然会报大量编译警告。这是C++20 关于volatile 关键字的新规定，而寄存器都是定义成volatile 的，写嵌入式的又不配用C++ 了……解决方法是添加个编译选项，关掉和volatile 有关的警告。

build_flags = -Wno-volatile

但是这个选项不能用于C 文件。解决方法就是用脚本，只给C++ 文件添加这个选项。

要使用脚本，先要在platformio.ini 添加一行：

extra_scripts = pre:extra_flags.py

意思是要在编译时先执行一个python 脚本，脚本文件名extra_flags.py，和platformio.ini 一样放在项目根目录。pre: 表示脚本是在编译前执行的。脚本的内容是：

Import("env")  # type: ignore
env = env  # type: ignore
# 别管上面这行，留着就行print(" ========== Script Start ======== ")# 只用于C++ 的参数
env.Append(CXXFLAGS=["-Wno-volatile",]
)print(" ========== Script Ended ======== ")

CXXFLAGS 就是类似makefile 的编译器选项，PlatformIO 把这些底层的东西都隐藏了，只能靠脚本打洞。详细的API 文档是没有的，好像是和scons 编译系统有关，这东西应该和cmake 类似，懒得去深究，参考示例，连蒙带猜吧。

二、选择任意文件夹加入编译

这个可以参考官方文档：Build external sources。假如要将之前那个libx 库里的mem 文件夹里的所有源文件加入编译，脚本里可以这么写：

from pathlib import PathImport("env")  # type: ignore
env = env  # type: ignore
# 别管上面这行，留着就行build_dir = Path('$BUILD_DIR')
project_dir = Path('$PROJECT_DIR')# 把mem 文件夹整体加入编译
env.BuildSources(str(build_dir / 'libx' / 'mem'),str(project_dir / 'lib' / 'libx' / 'mem')  # 假设libx 是放在项目的lib 目录下
)

就不详细解释了，毕竟我也是靠猜的，理解的不一定准确。

三、选择单个文件加入编译

终于到重头戏了。假如我希望只把mem 下面的a.c 和 b.c 加入编译，没有直接能用的API，只能自己在PlatformIO 编译系统上打洞实现。

为了方便易用，不要每次加入个文件都得修改脚本，可以利用自定义选项，在platformio.ini 里添加：

; 将任意库中的任意源文件导入build，库可以在lib 或libdeps 文件夹下
custom_lib_src =libx/mem/a.clibx/mem/b.c

这就跟写makefile 一样了。custom 开头的选项就是自定义选项，可以传递给脚本。这个地方不需要写出库文件的绝对路径，之后会在脚本里查找libx 库到底在哪个位置，然后补全路径。PlatformIO 默认会把自动下载的库放在libdeps 文件夹下；如果自己添加库，则要放在lib 文件夹下；所以脚本之后在这两个位置找就行。

脚本文件还是之前的extra_flags.py，想试用的话直接复制粘贴过去就行。全部内容如下：

import sys
import fnmatch
from pathlib import PathImport("env")  # type: ignore
env = env  # type: ignore
# 别管上面这行，留着就行print(" ========== Script Start ======== ")# 只用于C++ 编译器的参数
env.Append(CXXFLAGS=["-Wno-volatile",]
)# #################### 查找并添加自定义库源文件
# 自定义源文件的定义是相对库文件夹得路径，比如ioxx/ioxx.c
# ioxx 是库文件夹名，ioxx.c 是要包含得源文件。
# 脚本将自动从几个库文件夹可能的位置中查找到具体的路径。
# 比如，ioxx 库可能位于lib 文件夹里，也可能在libdeps 里，
# 如果脚本在lib 中找到了库，就会把相对路径变成绝对路径 $PROJECT_DIR/lib/ioxx/ioxx.c,
# 然后将该源文件加入构建extra_src = env.GetProjectOption("custom_lib_src")
extra_src = env.Split(extra_src)lib_parent = env.subst('$LIBSOURCE_DIRS')
lib_parent = list(map(lambda x: Path(x), env.Split(lib_parent)))if len(extra_src) > 0:print("Extra Sources Added From Lib:")for f in extra_src:print(f'\t{f}')fp = Path(f)lib_name = fp.parts[0]# 查找子文件夹src_path = Nonelib_path = Nonefor l_p in lib_parent:if (l_p / lib_name).exists():lib_path = l_p / lib_namesrc_path = l_p / fpbreakassert (src_path is not None) and (lib_path is not None)# print('!> Lib: {lib_name}, not found, skip.')src_path = src_path.absolute()lib_path = lib_path.absolute()assert src_path.exists()# print('!> Lib src: {src_path.basename}, not found, skip.')variant = Path(f'$BUILD_DIR/extra/{lib_name}')if src_path != lib_path:rel_path = src_path.relative_to(lib_path)variant = variant / rel_pathif src_path.is_dir():# 将文件夹加入构建env.BuildSources(str(variant), str(src_path))else:# 将单个文件加入构建，这部分用了没有文档的接口，# 功能是连蒙带猜的build_file = env.File(str(variant))middlewares = env.get("__PIO_BUILD_MIDDLEWARES")if middlewares:node = build_filenew_node = build_filefor callback, pattern in middlewares:if pattern and not fnmatch.fnmatch(node.srcnode().get_path(), pattern):continueif callback.__code__.co_argcount == 2:new_node = callback(env, new_node)else:new_node = callback(new_node)if not new_node:breakif new_node:build_file = new_nodeenv.Append(PIOBUILDFILES=[env.Object(build_file)])env.VariantDir(str(variant.parent), str(src_path.parent))print(" ========== Script Ended ======== ")

开头几行就是获取自定义选项extra_src，然后获取当前项目的几个库路径lib_parent。

extra_src = env.GetProjectOption("custom_lib_src")
extra_src = env.Split(extra_src)lib_parent = env.subst('$LIBSOURCE_DIRS')
lib_parent = list(map(lambda x: Path(x), env.Split(lib_parent)))

循环里先要根据库的名字查找它的位置，比如根据libx 找到lib 下的libx 文件夹。

        print(f'\t{f}')fp = Path(f)lib_name = fp.parts[0]# 查找子文件夹src_path = Nonelib_path = Nonefor l_p in lib_parent:if (l_p / lib_name).exists():lib_path = l_p / lib_namesrc_path = l_p / fpbreak

找到路径以后，如果是要添加文件夹，就调用BuildSources 接口；如果是单个源文件，则只能打洞。

        if src_path.is_dir():# 将文件夹加入构建env.BuildSources(str(variant), str(src_path))else:# 将单个文件加入构建，这部分用了没有文档的接口，# 功能是连蒙带猜的build_file = env.File(str(variant))

下面这一大块代码是从PlatformIO 内部代码里复制出来的，不确定有什么用，但是似乎有用。

            middlewares = env.get("__PIO_BUILD_MIDDLEWARES")if middlewares:node = build_filenew_node = build_filefor callback, pattern in middlewares:if pattern and not fnmatch.fnmatch(node.srcnode().get_path(), pattern):continueif callback.__code__.co_argcount == 2:new_node = callback(env, new_node)else:new_node = callback(new_node)if not new_node:breakif new_node:build_file = new_node

总之就这样，我简单试了一下，貌似没问题，不知道有没有什么隐藏BUG。大伙可以拿去试试看，反正就算有BUG 也不会让电脑爆炸。