How to easily indent output to ofstream?

by

This is the perfect situation to use a facet.

A custom version of the codecvt facet can be imbued onto a stream.

So your usage would look like this:

int main()
{
    /* Imbue std::cout before it is used */
    std::ios::sync_with_stdio(false);
    std::cout.imbue(std::locale(std::locale::classic(), new IndentFacet()));

    std::cout << "Line 1\nLine 2\nLine 3\n";

    /* You must imbue a file stream before it is opened. */
    std::ofstream       data;
    data.imbue(indentLocale);
    data.open("PLOP");

    data << "Loki\nUses Locale\nTo do something silly\n";
}

The definition of the facet is slightly complex.
But the whole point is that somebody using the facet does not need to know anything about the formatting. The formatting is applied independent of how the stream is being used.

#include <locale>
#include <algorithm>
#include <iostream>
#include <fstream>

class IndentFacet: public std::codecvt<char,char,std::mbstate_t>
{
  public:
   explicit IndentFacet(size_t ref = 0): std::codecvt<char,char,std::mbstate_t>(ref)    {}

    typedef std::codecvt_base::result               result;
    typedef std::codecvt<char,char,std::mbstate_t>  parent;
    typedef parent::intern_type                     intern_type;
    typedef parent::extern_type                     extern_type;
    typedef parent::state_type                      state_type;

    int&    state(state_type& s) const          {return *reinterpret_cast<int*>(&s);}
  protected:
    virtual result do_out(state_type& tabNeeded,
                         const intern_type* rStart, const intern_type*  rEnd, const intern_type*&   rNewStart,
                         extern_type*       wStart, extern_type*        wEnd, extern_type*&         wNewStart) const
    {
        result  res = std::codecvt_base::noconv;

        for(;(rStart < rEnd) && (wStart < wEnd);++rStart,++wStart)
        {
            // 0 indicates that the last character seen was a newline.
            // thus we will print a tab before it. Ignore it the next
            // character is also a newline
            if ((state(tabNeeded) == 0) && (*rStart != '\n'))
            {
                res                 = std::codecvt_base::ok;
                state(tabNeeded)    = 1;
                *wStart="\t";
                ++wStart;
                if (wStart == wEnd)
                {
                    res     = std::codecvt_base::partial;
                    break;
                }
            }
            // Copy the next character.
            *wStart         = *rStart;

            // If the character copied was a '\n' mark that state
            if (*rStart == '\n')
            {
                state(tabNeeded)    = 0;
            }
        }

        if (rStart != rEnd)
        {
            res = std::codecvt_base::partial;
        }
        rNewStart   = rStart;
        wNewStart   = wStart;

        return res;
    }

    // Override so the do_out() virtual function is called.
    virtual bool do_always_noconv() const throw()
    {
        return false;   // Sometime we add extra tabs
    }

};

See: Tom’s notes below

More Related Contents:

  1. std::ofstream, check if file exists before writing
  2. Read file line by line using ifstream in C++
  3. Fastest way to check if a file exists using standard C++/C++11,14,17/C?
  4. changing the delimiter for cin (c++)
  5. How does std::flush work?
  6. Setting the internal buffer used by a standard stream (pubsetbuf)
  7. How to get error message when ifstream open fails
  8. Creating an input stream from constant memory
  9. C++ custom stream manipulator that changes next item on stream
  10. Read binary data from std::cin
  11. How to read file content into istringstream?
  12. How can I compose output streams, so output goes multiple places at once?
  13. Why does ostream_iterator not work as expected?
  14. C++ copy a stream object
  15. How to read entire stream into a std::string?
  16. do I need to close a std::fstream? [duplicate]
  17. std::ostringstream printing the address of the c-string instead of its content
  18. Order of execution in operator
  19. How does std::copy work with stream iterators
  20. How to write to middle of a file in C++?
  21. Replace a line in text file
  22. Is there a standard date/time class in C++?
  23. Why we need to return reference to istream/ostream while overloading >> and
  24. OpenCV cv::Mat to std::ifstream for base64 encoding
  25. Performance Difference Between C and C++ Style File IO
  26. Getting an array of bytes out of Windows::Storage::Streams::IBuffer
  27. static constexpr member of same type as class being defined
  28. LCOV/GCOV branch coverage with C++ producing branches all over the place
  29. Why “Foo f(Bar());” can be a declaration of a function that takes type Bar and returns type Foo? [duplicate]
  30. What does *& mean in a function parameter

Leave a Comment