如何將注入添加到流操作符

Question

在我們的項目中，我們在對象模型中使用C++流操作符（< <）來打印出易讀的數據格式。一個簡單的例子是這樣的：

std::ostream& operator<<(std::ostream & oStream, const OwnClass& iOwnClass) { 
    oStream << "[SomeMember1: " << iOwnClass._ownMember1 << "]\n"; 
    oStream << "[SomeMember2: " << iOwnClass._ownMember2 << "]\n"; 
} 

在日誌中由此產生：

[SomeMember1: foo] 
[SomeMember2: bar] 

我們現在需要的是能夠縮進該操作的結果。有些調用類可能不需要像這樣的結果，但想在每行之前添加2個空格縮進。我們可以添加一個成員到我們的班級，指定縮進，但這似乎不是一個優雅的解決方案。

當然這不是一個很大的問題，但是如果這樣做能夠工作，我們的日誌記錄將會更好。

感謝

Answer 1

最簡單的解決方案是在 ostream和實際的streambuf之間放置一個過濾streambuf。喜歡的東西：

class IndentingOStreambuf : public std::streambuf 
{ 
    std::streambuf*  myDest; 
    bool    myIsAtStartOfLine; 
    std::string   myIndent; 
    std::ostream*  myOwner; 
protected: 
    virtual int   overflow(int ch) 
    { 
     if (myIsAtStartOfLine && ch != '\n') { 
      myDest->sputn(myIndent.data(), myIndent.size()); 
     } 
     myIsAtStartOfLine = ch == '\n'; 
     return myDest->sputc(ch); 
    } 
public: 
    explicit   IndentingOStreambuf( 
          std::streambuf* dest, int indent = 4) 
     : myDest(dest) 
     , myIsAtStartOfLine(true) 
     , myIndent(indent, ' ') 
     , myOwner(NULL) 
    { 
    } 
    explicit   IndentingOStreambuf(
          std::ostream& dest, int indent = 4) 
     : myDest(dest.rdbuf()) 
     , myIsAtStartOfLine(true) 
     , myIndent(indent, ' ') 
     , myOwner(&dest) 
    { 
     myOwner->rdbuf(this); 
    } 
    virtual    ~IndentingOStreambuf() 
    { 
     if (myOwner != NULL) { 
      myOwner->rdbuf(myDest); 
     } 
    } 
}; 

要插入，只需要創建一個流緩衝的一個實例：

IndentingOStreambuf indent(std::cout); 
// Indented output... 

當indent超出範圍，一切恢復正常。

（用於記錄，我有一個更復雜一些： LoggingOStreambuf需要__FILE__和__LINE__作爲參數，設置 myIndent到一個格式化字符串這些參數，再加上時間 郵票，它復位於凹坑每次輸出後的字符串，收集 所有的輸出在std::ostringstream，並且在析構函數原子 輸出到myDest）

Answer 2

不太好辦法做到這一點是添加一個全局變量，它告訴壓痕。例如：

std::string OwnClassIndentation; 
std::ostream& operator<<(std::ostream & oStream, const OwnClass& iOwnClass) { 
    oStream << "[SomeMember1:" << OwnClassIndentation << iOwnClass._ownMember1 << "]\n"; 
    oStream << "[SomeMember2:" << OwnClassIndentation << iOwnClass._ownMember2 << "]\n"; 
} 

然後根據情況進行設置。

Answer 3

您可以使自己的流類具有縮進變量並覆蓋該類的endl，插入縮進。

Answer 4

這可以使用自定義的流操縱器來完成，該流操縱器將所需的縮進級別存儲在流的內部可擴展數組的字中。您可以使用功能ios_base::xalloc來請求這樣一個詞。這個功能會給你你單詞的索引。您可以使用ios_base::iword訪問它。一種方式來實現，這將是這樣的：

struct indent { 
    indent(int level) : level(level) {} 
private: 
    friend std::ostream& operator<<(std::ostream& stream, const indent& val); 

    int level; 
}; 

std::ostream& operator<<(std::ostream& stream, const indent& val) { 
    for(int i = 0; i < val.level; i++) { 
     stream << " "; 
    } 
    return stream; 
} 

std::ostream& operator<<(std::ostream & oStream, const OwnClass& iOwnClass) { 
    oStream << indent(oStream.iword(index)) << "[SomeMember1: " << 
       iOwnClass._ownMember1 << "]\n"; 
    oStream << indent(oStream.iword(index)) << "[SomeMember2: " << 
       iOwnClass._ownMember2 << "]\n"; 
} 

你必須弄清楚在哪裏存儲index。這實際上允許您將自定義狀態添加到流中（請注意，這不會是線程安全的開箱即用）。每個想要縮進的函數都應該將請求的縮進添加到流中，並在完成時再次減去它。你可以確保這始終使用保護加/減所需的縮進（恕我直言，這是比使用機械手更優雅）發生：

class indent_guard { 
public: 
    indent_guard(int level, std::ostream& stream, int index) 
    : level(level), 
     stream(stream), 
     index(index) 
    { 
     stream.iword(index) += level; 
    } 

    ~indent_guard() { 
     stream.iword(index) -= level; 
    } 

private: 
    int level; 
    std::ostream& stream; 
    int index; 
}; 

你可以使用這樣的：

void some_func() { 
    indent_guard(2, std::cout, index); 

    // all output inside this function will be indented by 2 spaces 

    some_func(); // recursive call - output will be indented by 4 spaces 

    // here it will be 2 spaces again 
}