如何让C++流操纵器支持多字符分隔符且避免开头插入？

问题描述 #

我现在用下面这个自定义的delimiter流操纵器，在写入stringstream时插入逗号或空格来分隔条目，但它只支持单字符分隔符。我想让它支持多字符分隔符，比如", "（逗号加空格）。

我的使用场景是构建包含逗号分隔统计信息的字符串，部分信息（如PID、GID等）可能不可用。我希望避免流的开头出现分隔符，而且觉得boost::join(list, ", ")太繁琐，更倾向于直接输出到流而非先存临时列表再拼接。

原代码如下：

template <char C>
std::basic_ostream<char>& delimiter(std::basic_ostream<char>& os)                                                      
{
    if (os.tellp())
        os << C;
    return os;
}

std::stringstream ss;
if (pid) ss << delimiter<','> << "pid=" << pid;
if (gid) ss << delimiter<','> << "gid=" << gid;

解决方案 #

当然可以实现支持多字符分隔符的版本。核心思路是用一个可携带多字符分隔符的类替代原模板，同时利用ostream的pword机制存储是否已输出内容的状态（避免依赖tellp()，因为不是所有流都支持该操作）。

修改后的代码如下：

#include <ostream>
#include <string>

// 获取唯一索引，用于在流中存储分隔器状态
static const int delimiter_state_idx = std::ios_base::xalloc();

class Delimiter {
private:
    std::string sep;
public:
    explicit Delimiter(std::string s) : sep(std::move(s)) {}

    friend std::ostream& operator<<(std::ostream& os, const Delimiter& d) {
        // 取出流中存储的状态：是否已输出过内容
        auto& has_written = *static_cast<bool*>(os.pword(delimiter_state_idx));
        if (has_written) {
            os << d.sep;
        }
        // 更新状态：当前已输出内容
        has_written = true;
        return os;
    }
};

// 初始化流的分隔器状态，第一次使用前调用一次即可
std::ostream& init_delimiter_state(std::ostream& os) {
    if (!os.pword(delimiter_state_idx)) {
        os.pword(delimiter_state_idx) = new bool(false);
        // 注册回调，在流销毁时清理动态分配的状态变量
        os.register_callback([](std::ios_base::event ev, std::ios_base& stream, int idx) {
            if (ev == std::ios_base::erase_event) {
                delete static_cast<bool*>(stream.pword(idx));
                stream.pword(idx) = nullptr;
            }
        }, delimiter_state_idx);
    }
    return os;
}

使用示例 #

#include <sstream>
#include <iostream>

int main() {
    int pid = 1234;
    int gid = 5678;
    std::stringstream ss;

    // 初始化流的分隔器状态
    init_delimiter_state(ss);

    if (pid) ss << Delimiter(", ") << "pid=" << pid;
    if (gid) ss << Delimiter(", ") << "gid=" << gid;
    ss << Delimiter(", ") << "status=running";

    std::cout << ss.str() << std::endl;
    // 输出结果：pid=1234, gid=5678, status=running
    return 0;
}

关键说明 #

1. 状态存储：用std::ios_base::xalloc()获取唯一索引，通过pword()在流中存储bool状态，替代原代码中tellp()的判断（tellp()对非可查找流无效）。
2. 多字符支持：通过Delimiter类封装任意字符串作为分隔符，灵活适配不同需求。
3. 内存安全：注册erase_event回调，在流销毁时自动清理动态分配的状态变量，避免内存泄漏。
4. 使用便捷：第一次使用流前调用init_delimiter_state初始化状态，之后直接传入多字符分隔符即可。

内容的提问来源于stack exchange，提问作者patraulea