BambuStudio学习笔记：format格式化输出

# Slic3r::format 字符串格式化工具说明 ## 概述 本头文件提供了基于 `boost::format` 的 C++ 字符串格式化工具封装，旨在简化多参数格式化操作，支持类似 C++20 `std::format` 的调用语法。 ## 核心设计目标 - **简化调用语法**：替代 `boost::format` 的链式 `%` 操作符 - **参数扩展性**：支持任意数量参数的模板展开 - **类型转换控制**：通过 `cook` 函数实现自定义类型处理 - **兼容性准备**：为未来迁移到 C++20 标准库做接口适配 ## 实现解析 ### 1. 辅助函数 (internal::format) #### 1.1 cook 模板函数 ```cpp template<typename T> inline T&& cook(T&& arg) 作用：参数预处理入口默认行为：完美转发参数扩展方式：通过特例化或重载实现类型转换典型应用：在 GUI 模块中转换 wxString 到 UTF-8 1.2 format_recursive 递归函数 std::string format_recursive(boost::format& message, TValue&& arg, TArgs&&... args) 实现逻辑： 使用 operator% 逐个处理参数递归展开参数包最终返回 message.str() 2. 公开接口 2.1 格式化函数模板 template<typename... TArgs> std::string format(const char* fmt, TArgs&&... args) template<typename... TArgs> std::string format(const std::string& fmt, TArgs&&... args) 参数说明： fmt：符合 boost::format 规范的格式字符串args：可变参数包（支持任意数量参数） 返回值：格式化后的 std::string 使用示例 基础用法 std::string result = Slic3r::format( "Print %1% layers in %2%.2f seconds", 25, 12.3456 ); // 输出："Print 25 layers in 12.35 seconds" 自定义类型处理 // 在头文件中添加类型特化 namespace Slic3r::internal::format { inline std::string cook(const wxString& str) { return str.ToUTF8().data(); } } // 使用示例 wxString material = _L("PLA"); std::string msg = Slic3r::format("Material: %s", material); 关键特性对比 特性Boost 原生实现Slic3r 封装调用语法chain % op参数列表参数数量限制编译期固定任意数量类型转换控制依赖 boost 内部机制显式 cook 函数C++ 标准兼容性C++03C++11 或更高 注意事项

格式规范兼容性：

必须使用 %N% 位置标记（不同于 C++20 的 {}）示例："X=%1% Y=%2%" 而非 "X={} Y={}"

性能考量：

递归模板可能增加编译时间对性能敏感场景建议预编译格式对象

国际化支持：

建议配合 _L() 宏使用注意编码转换时的性能损耗

异常处理：

继承 boost::format 的异常机制格式错误会抛出 boost::io::format_error 扩展开发指南 自定义类型处理步骤 在目标类型的命名空间内特化 cook 函数确保返回类型与 boost::format 兼容处理特殊字符转义需求 // 示例：处理自定义 Vector 类型 namespace Slic3r::internal::format { template<> inline std::string cook(const Vec3d& vec) { return boost::str(boost::format("[%1%,%2%,%3%]") % vec.x() % vec.y() % vec.z()); } } 格式验证辅助工具

建议配合使用 boost::io::basic_format_parser 进行运行时格式验证，防止生产环境出现格式异常。

void validate_format(const std::string& fmt) { boost::io::basic_format_parser<char> parser(fmt); parser.parse(); } 未来演进路线

C++20 迁移计划：

逐步替换底层实现为 std::format保持现有接口兼容性添加编译开关支持双版本并存

性能优化方向：

实现编译期格式字符串解析采用 constexpr 字符串处理探索类型安全格式验证