Output stream that wraps lines on white-space characters at the specified line length, and with support for indentation. More...
#include <ookii/line_wrapping_stream.h>
Public Types | |
| using | base_type = std::basic_ostream< CharType, Traits > |
| The concrete type that this class derives from. | |
| using | streambuf_type = std::basic_streambuf< CharType, Traits > |
| The concrete base stream buffer type used by this stream. | |
Public Member Functions | |
| basic_line_wrapping_ostream () | |
| Initializes a new instance of the basic_line_wrapping_ostream class. More... | |
| basic_line_wrapping_ostream (base_type &base_stream, size_t max_line_length, bool count_formatting=false) | |
| Initializes a new instance of the basic_line_wrapping_ostream class with the specified underlying stream and maximum line length. More... | |
| basic_line_wrapping_ostream (basic_line_wrapping_ostream &&other) noexcept | |
| Move constructor. More... | |
| void | flush (bool flush_last_line) |
| Flushes the buffer to the underlying stream buffer, optionally including the the final, partial line. More... | |
| void | init (base_type &base_stream, size_t max_line_length, bool count_formatting=false) |
| Initializes a new instance of the basic_line_wrapping_ostream class with the specified underlying stream and maximum line length. More... | |
| basic_line_wrapping_ostream & | operator= (basic_line_wrapping_ostream &&other) noexcept |
| Move assignment operator. More... | |
| void | swap (basic_line_wrapping_ostream &other) noexcept |
| Swaps this basic_line_wrapping_ostream instance with another. More... | |
Static Public Member Functions | |
| static basic_line_wrapping_ostream | for_cerr (short default_width=80) |
| Creates a basic_line_wrapping_ostream that writes to the standard error stream, using the console width as the line width. More... | |
| static basic_line_wrapping_ostream | for_cout (short default_width=80) |
| Creates a basic_line_wrapping_ostream that writes to the standard output stream, using the console width as the line width. More... | |
Detailed Description
template<typename CharType, typename Traits = std::char_traits<CharType>>
class ookii::basic_line_wrapping_ostream< CharType, Traits >
Output stream that wraps lines on white-space characters at the specified line length, and with support for indentation.
This stream writes its output to the stream buffer of another stream, which could be any stream (like a file stream, or string stream).
- Warning
- This class assumes that the target stream is at the start of a line when writing starts, and that no other users are writing to the same stream. Otherwise, output will not be correctly wrapped or indented.
-
Flushing this stream will not flush the contents of the last unfinished line. Use ookii::flush() with the
flush_last_lineparameter set totrueto make sure all content is flushed (this may insert an additional new line character).
Several typedefs for common character types are provided:
| Type | Definition |
|---|---|
ookii::line_wrapping_ostream | ookii::basic_line_wrapping_ostream<char> |
ookii::wline_wrapping_ostream | ookii::basic_line_wrapping_ostream<wchar_t> |
- Template Parameters
-
CharType The type of characters used by the target stream. Traits The character traits used by the target stream.
Constructor & Destructor Documentation
◆ basic_line_wrapping_ostream() [1/3]
|
inline |
Initializes a new instance of the basic_line_wrapping_ostream class.
You must call the init() method before the stream is usable.
◆ basic_line_wrapping_ostream() [2/3]
|
inline |
Initializes a new instance of the basic_line_wrapping_ostream class with the specified underlying stream and maximum line length.
- Parameters
-
base_stream The stream whose stream buffer to write output to. max_line_length The maximum line length, or a value of 0 or larger than 65536 to specify no limit. Use the use_console_width constant to use the console width as the maximum. count_formatting Include virtual terminal sequences when calculating the length of a line.
◆ basic_line_wrapping_ostream() [3/3]
|
inlinenoexcept |
Move constructor.
- Parameters
-
other The basic_line_wrapping_ostream to move from.
Member Function Documentation
◆ flush()
|
inline |
Flushes the buffer to the underlying stream buffer, optionally including the the final, partial line.
If the buffer contains a line that's shorter than the maximum and was not terminated by a line break, the normal basic_ostream::flush() function will not flush that final line, because doing so would make it impossible to find the correct place to wrap the line later if that place was already flushed.
This function offers the ability to flush the buffer including the last line. If there is a non-empty, non-terminated line in the buffer, that line will be flushed, followed by a line break.
- Parameters
-
flush_last_line trueto flush the final non-terminated line;falseto leave that line in the buffer.
- Returns
- The result of calling
pubsync()on the underlying stream buffer.
◆ for_cerr()
|
inlinestatic |
Creates a basic_line_wrapping_ostream that writes to the standard error stream, using the console width as the line width.
- Parameters
-
default_width The maximum line length to use if the console width cannot be determined.
◆ for_cout()
|
inlinestatic |
Creates a basic_line_wrapping_ostream that writes to the standard output stream, using the console width as the line width.
- Parameters
-
default_width The maximum line length to use if the console width cannot be determined.
◆ init()
|
inline |
Initializes a new instance of the basic_line_wrapping_ostream class with the specified underlying stream and maximum line length.
- Parameters
-
base_stream The stream whose stream buffer to write output to. max_line_length The maximum line length, or a value of 0 or larger than 65536 to specify no limit. Use the use_console_width constant to use the console width as the maximum. count_formatting Include virtual terminal sequences when calculating the length of a line.
◆ operator=()
|
inlinenoexcept |
Move assignment operator.
- Parameters
-
other The basic_line_wrapping_ostream to move from.
◆ swap()
|
inlinenoexcept |
Swaps this basic_line_wrapping_ostream instance with another.
- Parameters
-
other The instance to swap with.
The documentation for this class was generated from the following file:
- /mnt/d/Sven/Documents/Code/Ookii.CommandLine.Cpp/include/ookii/line_wrapping_stream.h
