18

我正在使用一个用 C++ 实现的开源 UNIX 工具，我需要更改一些代码来让它做我想做的事情。我想做最小的改变，希望我的补丁在上游被接受。首选可在标准 C++ 中实现且不会创建更多外部依赖项的解决方案。

这是我的问题。我有一个 C++ 类——我们称之为“A”——它目前使用 fprintf() 将其高度格式化的数据结构打印到文件指针。在它的打印函数中，它还递归地调用了几个成员类的相同定义的打印函数（“B”就是一个例子）。还有另一个类 C 有一个成员 std::string "foo"，需要将其设置为 A 实例的 print() 结果。将其视为 A 的 to_str() 成员函数。

在伪代码中：

class A {
public:
  ...

  void print(FILE* f);
  B b;

  ...  
};

...

void A::print(FILE *f)
{
  std::string s = "stuff";
  fprintf(f, "some %s", s);
  b.print(f);
}

class C {
  ...
  std::string foo;
  bool set_foo(std::str);
  ...
}

...

A a = new A();
C c = new C();

...

// wish i knew how to write A's to_str()
c.set_foo(a.to_str());

我应该提到 C 相当稳定，但 A 和 B（以及 A 的其他依赖项）处于不断变化的状态，因此所需的代码更改越少越好。当前的 print(FILE* F) 接口也需要保留。我考虑了几种实现 A::to_str() 的方法，每种方法都有优点和缺点：

  1. 将对 fprintf() 的调用更改为 sprintf()

    • 我不必重写任何格式字符串
    • print() 可以重新实现为： fprint(f, this.to_str());
    • 但我需要手动分配 char[]s，合并很多 c 字符串，最后将字符数组转换为 std::string

  2. 尝试在字符串流中捕获 a.print() 的结果

    • 我必须将所有格式字符串转换为 << 输出格式。有数百个 fprintf() 可以转换：-{
    • print() 必须重写，因为我知道没有标准方法可以从 UNIX 文件句柄创建输出流（尽管这个人说这可能是可能的）。

  3. 使用 Boost 的字符串格式库

    • 更多的外部依赖。呸。
    • Format 的语法与 printf() 的不同之处足以令人讨厌：

    printf(format_str, args) -> cout << boost::format(format_str) % arg1 % arg2 % etc

  4. 使用 Qt 的QString::asprintf()

    • 不同的外部依赖。

那么，我是否已经用尽了所有可能的选择？如果是这样，你认为哪个是我最好的选择？如果没有，我忽略了什么？

谢谢。

4

7 回答 7

41

这是我喜欢使功能与 'sprintf' 相同但返回 std::string 并且不受缓冲区溢出问题影响的习语。这段代码是我正在编写的一个开源项目（BSD 许可证）的一部分，所以每个人都可以随意使用它。

#include <string>
#include <cstdarg>
#include <vector>
#include <string>

std::string
format (const char *fmt, ...)
{
    va_list ap;
    va_start (ap, fmt);
    std::string buf = vformat (fmt, ap);
    va_end (ap);
    return buf;
}



std::string
vformat (const char *fmt, va_list ap)
{
    // Allocate a buffer on the stack that's big enough for us almost
    // all the time.
    size_t size = 1024;
    char buf[size];

    // Try to vsnprintf into our buffer.
    va_list apcopy;
    va_copy (apcopy, ap);
    int needed = vsnprintf (&buf[0], size, fmt, ap);
    // NB. On Windows, vsnprintf returns -1 if the string didn't fit the
    // buffer.  On Linux & OSX, it returns the length it would have needed.

    if (needed <= size && needed >= 0) {
        // It fit fine the first time, we're done.
        return std::string (&buf[0]);
    } else {
        // vsnprintf reported that it wanted to write more characters
        // than we allotted.  So do a malloc of the right size and try again.
        // This doesn't happen very often if we chose our initial size
        // well.
        std::vector <char> buf;
        size = needed;
        buf.resize (size);
        needed = vsnprintf (&buf[0], size, fmt, apcopy);
        return std::string (&buf[0]);
    }
}

编辑：当我编写这段代码时，我不知道这需要符合 C99 并且 Windows（以及较旧的 glibc）具有不同的 vsnprintf 行为，其中它返回 -1 表示失败，而不是确定多少空间的度量是需要的。这是我修改后的代码，大家可以看一下，如果你认为没问题，我会再次编辑，以列出唯一的成本：

std::string
Strutil::vformat (const char *fmt, va_list ap)
{
    // Allocate a buffer on the stack that's big enough for us almost
    // all the time.  Be prepared to allocate dynamically if it doesn't fit.
    size_t size = 1024;
    char stackbuf[1024];
    std::vector<char> dynamicbuf;
    char *buf = &stackbuf[0];
    va_list ap_copy;

    while (1) {
        // Try to vsnprintf into our buffer.
        va_copy(ap_copy, ap);
        int needed = vsnprintf (buf, size, fmt, ap);
        va_end(ap_copy);

        // NB. C99 (which modern Linux and OS X follow) says vsnprintf
        // failure returns the length it would have needed.  But older
        // glibc and current Windows return -1 for failure, i.e., not
        // telling us how much was needed.

        if (needed <= (int)size && needed >= 0) {
            // It fit fine so we're done.
            return std::string (buf, (size_t) needed);
        }

        // vsnprintf reported that it wanted to write more characters
        // than we allotted.  So try again using a dynamic buffer.  This
        // doesn't happen very often if we chose our initial size well.
        size = (needed > 0) ? (needed+1) : (size*2);
        dynamicbuf.resize (size);
        buf = &dynamicbuf[0];
    }
}
于 2008-09-16T06:52:13.540 回答
13

我正在使用#3：boost 字符串格式库——但我不得不承认我从来没有对格式规范的差异有任何问题。

对我来说就像一个魅力 - 外部依赖可能更糟（一个非常稳定的库）

编辑：添加一个示例如何使用 boost::format 而不是 printf：

sprintf(buffer, "This is a string with some %s and %d numbers", "strings", 42);

boost::format 库会是这样的：

string = boost::str(boost::format("This is a string with some %s and %d numbers") %"strings" %42);

希望这有助于澄清 boost::format 的用法

我在 4 或 5 个应用程序中使用 boost::format 作为 sprintf / printf 替换（将格式化字符串写入文件，或自定义输出到日志文件），并且从未遇到格式差异问题。可能有一些（或多或少晦涩难懂的）格式说明符是不同的——但我从来没有遇到过问题。

相比之下，我有一些格式规范，我真的不能用流做（据我记得）

于 2008-09-16T06:18:25.510 回答
2

您可以使用带有格式的 std::string 和 iostreams，例如 setw() 调用和 iomanip 中的其他调用

于 2008-09-16T06:19:00.377 回答
1

以下可能是替代解决方案：

void A::printto(ostream outputstream) {
    char buffer[100];
    string s = "stuff";
    sprintf(buffer, "some %s", s);
    outputstream << buffer << endl;
    b.printto(outputstream);
}

（B::printto类似），并定义

void A::print(FILE *f) {
    printto(ofstream(f));
}

string A::to_str() {
    ostringstream os;
    printto(os);
    return os.str();
}

当然，您应该真正使用 snprintf 而不是 sprintf 以避免缓冲区溢出。您还可以选择性地将风险更大的 sprintfs 更改为 << 格式，这样更安全，但更改尽可能少。

于 2008-09-16T06:53:09.513 回答
1

您应该尝试 Loki 库的 SafeFormat 头文件 ( http://loki-lib.sourceforge.net/index.php?n=Idioms.Printf )。它类似于 boost 的字符串格式库，但保留了 printf(...) 函数的语法。

我希望这有帮助！

于 2008-09-16T08:00:22.113 回答
1

{fmt} 库提供fmt::sprintf了执行printf兼容格式的函数（包括根据POSIX 规范的位置参数）并返回结果为std::string：

std::string s = fmt::sprintf("The answer is %d.", 42);

免责声明：我是这个库的作者。

于 2019-05-23T01:42:20.487 回答
0

这是关于序列化的吗？还是正确打印？如果是前者，也要考虑 boost::serialization。这都是关于对象和子对象的“递归”序列化。

于 2008-09-16T06:18:19.940 回答