An OSstream with internal List storage. More...
#include <OCharStream.H>


Public Member Functions | |
| OCharStream (IOstreamOption streamOpt=IOstreamOption()) | |
| Default construct (empty output). | |
| OCharStream (::Foam::List< char > &&buffer, IOstreamOption streamOpt=IOstreamOption()) | |
| Move construct from a List of initial storage. | |
| template<int SizeMin> | |
| OCharStream (::Foam::DynamicList< char, SizeMin > &&buffer, IOstreamOption streamOpt=IOstreamOption()) | |
| Move construct from a DynamicList of initial storage (uses entire capacity). | |
| std::streampos | tellp () const |
| Position of the put buffer. | |
| std::streampos | output_pos () const |
| The current output position within the buffer (tellp). | |
| std::streamsize | count () const |
| The number of bytes outputted. | |
| label | size () const |
| The current output size. Same as count(), output_pos(), tellp(). | |
| std::streamsize | capacity () const |
| The put buffer capacity. | |
| void | reserve (std::streamsize n) |
| Reserve output space for at least this amount. | |
| void | reserve_exact (std::streamsize n) |
| Reserve output space for at least this amount. Does not apply min-size or capacity doubling etc. | |
| void | extend (std::streamsize n) |
Increase (reserve) space for another n entries. | |
| void | extend_exact (std::streamsize n) |
Increase (reserve) space for another n entries. | |
| auto | view () const |
| A string_view of buffer contents. | |
| auto | view (size_t pos, size_t len=std::string::npos) const |
| A sub-slice string view of the buffer contents. | |
| UList< char > | list () const |
| A list span of the current output characters (is modifiable!). | |
| auto | str () const |
| For OStringStream compatibility, return the buffer as string copy. | |
| void | swap (List< char > &other) |
| Exchange stream content and parameter contents, reset positions. | |
| template<int SizeMin> | |
| void | swap (DynamicList< char, SizeMin > &other) |
| Exchange stream content and parameter contents, reset positions. | |
| DynamicList< char > | release () |
| Reset buffer and return contents. | |
| virtual void | rewind () |
| Rewind the stream, clearing any old errors. | |
| void | seek (std::streampos pos) |
| Reposition the stream from the start. | |
| virtual void | print (Ostream &os) const override |
| Print stream description. | |
| void | push_back (char c) |
| Append a single character to the end. | |
| void | pop_back (int n=1) |
| Rewind the end by 1 or more elements. | |
| void | append (std::streamsize count, char c) |
| Append repeated character content. | |
| void | append (const char *data, std::streamsize count) |
| Append character content. | |
| void | append (std::string_view sv) |
| Append character content. | |
| void | overwrite (std::streampos pos, char c) |
| Overwrite a single character. | |
| void | overwrite (std::streampos pos, const char *data, std::streamsize count) |
| Overwrite a sub-slice with character content. | |
| void | overwrite (std::streampos pos, std::string_view sv) |
| Overwrite a sub-slice with character content. | |
| void | setBlockSize (int n) |
| Block size was used in OpenFOAM-v2306 and earlier. | |
| Public Member Functions inherited from OSstream | |
| OSstream (const OSstream &)=default | |
| Copy construct. | |
| void | operator= (const OSstream &)=delete |
| No copy assignment. | |
| OSstream (std::ostream &os, const string &streamName, IOstreamOption streamOpt=IOstreamOption()) | |
| Construct wrapper around std::ostream, set stream status. | |
| OSstream (std::ostream &os, const string &streamName, IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED) | |
| Construct wrapper around std::ostream, set stream status. | |
| OSstream (std::ostream &os, const string &streamName, IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED) | |
| Construct wrapper around std::ostream, set stream status. | |
| virtual const fileName & | name () const override |
| Get the name of the output serial stream. (eg, the name of the Fstream file name). | |
| virtual fileName & | name () |
| The name of the output serial stream, for modification. | |
| virtual const std::ostream & | stdStream () const |
| Const access to underlying std::ostream. | |
| virtual std::ostream & | stdStream () |
| Access to underlying std::ostream. | |
| virtual std::ios_base::fmtflags | flags () const override |
| Get current stream flags. | |
| virtual std::ios_base::fmtflags | flags (std::ios_base::fmtflags f) override |
| Set stream flags, return old stream flags. | |
| void | syncState () |
| Set stream state to match that of the std::ostream. | |
| virtual bool | write (const token &tok) override |
| Write token to stream or otherwise handle it. | |
| virtual Ostream & | write (const char c) override |
| Write character. | |
| virtual Ostream & | writeQuoted (const char *str, std::streamsize len, const bool quoted=true) override |
| Write character/string content, with/without surrounding quotes. | |
| virtual Ostream & | write (const char *str) override |
| Write character string. | |
| virtual Ostream & | write (const word &str) override |
| Write word. | |
| virtual Ostream & | write (const std::string &str) override |
| Write string (quoted). | |
| virtual Ostream & | write (const int32_t val) override |
| Write int32_t. | |
| virtual Ostream & | write (const int64_t val) override |
| Write int64_t. | |
| virtual Ostream & | write (const uint32_t val) override |
| Write uint32_t. | |
| virtual Ostream & | write (const uint64_t val) override |
| Write uint64_t. | |
| virtual Ostream & | write (const float val) override |
| Write float. | |
| virtual Ostream & | write (const double val) override |
| Write double. | |
| virtual Ostream & | write (const char *data, std::streamsize count) override |
| Write binary block. | |
| virtual Ostream & | writeRaw (const char *data, std::streamsize count) override |
| Low-level raw binary output. | |
| virtual bool | beginRawWrite (std::streamsize count) override |
| Begin marker for low-level raw binary output. | |
| virtual bool | endRawWrite () override |
| End marker for low-level raw binary output. | |
| virtual void | indent () override |
| Add indentation characters. | |
| virtual void | flush () override |
| Flush stream. | |
| virtual void | endl () override |
| Add newline and flush stream. | |
| virtual char | fill () const override |
| Get the current padding character. | |
| virtual char | fill (const char fillch) override |
| Set padding character for formatted field up to field width. | |
| virtual int | width () const override |
| Get width of output field. | |
| virtual int | width (const int w) override |
| Set width of output field. | |
| virtual int | precision () const override |
| Get precision of output field. | |
| virtual int | precision (const int p) override |
| Set precision of output field. | |
| virtual Ostream & | writeQuoted (const std::string &str, const bool quoted=true) |
| Inherit write methods from Ostream. | |
| Public Member Functions inherited from Ostream | |
| Ostream (const Ostream &)=default | |
| Copy construct. | |
| virtual | ~Ostream ()=default |
| Destructor. | |
| Ostream (IOstreamOption streamOpt=IOstreamOption()) | |
| Default construct (ASCII, uncompressed), construct with specified stream option. | |
| Ostream (IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED) | |
| Construct with format (uncompressed). | |
| virtual Ostream & | write (const keyType &kw) |
| Write keyType. | |
| unsigned short | indentSize () const noexcept |
| Return indent size (spaces per level). | |
| unsigned short | indentSize (unsigned short val) noexcept |
| Change indent size (spaces per level), return old value. | |
| unsigned short | indentLevel () const noexcept |
| Return the indent level. | |
| unsigned short | indentLevel (unsigned short val) noexcept |
| Change the indent level, return old value. | |
| void | incrIndent () noexcept |
| Increment the indent level. | |
| void | decrIndent () |
| Decrement the indent level. | |
| virtual Ostream & | writeKeyword (const keyType &kw) |
| Write the keyword followed by an appropriate indentation. | |
| virtual Ostream & | beginBlock (const keyType &kw) |
| Write begin block group with the given name. | |
| virtual Ostream & | beginBlock () |
| Write begin block group without a name. | |
| virtual Ostream & | endBlock () |
| Write end block group. | |
| virtual Ostream & | endEntry () |
| Write end entry (';') followed by newline. | |
| template<class T> | |
| Ostream & | writeEntry (const keyType &key, const T &value) |
| Write a keyword/value entry. | |
| template<class T> | |
| Ostream & | writeEntryIfDifferent (const word &key, const T &value1, const T &value2) |
| Write a keyword/value entry only when the two values differ. | |
| Ostream & | operator() () const |
| Return a non-const reference to const Ostream. | |
| unsigned short & | indentLevel () noexcept |
| Access to indent level. | |
| unsigned short & | indentSize () noexcept |
| Access to indent size. | |
| Public Member Functions inherited from IOstream | |
| IOstream (const IOstream &)=default | |
| Copy construct. | |
| virtual | ~IOstream ()=default |
| Destructor. | |
| IOstream (IOstreamOption streamOpt=IOstreamOption()) | |
| Default construct (ASCII, uncompressed), construct with specified stream option. | |
| IOstream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED) | |
| Construct with format, version (compression). | |
| fileName | relativeName () const |
| Return the name of the stream relative to the current case. | |
| virtual bool | check (const char *operation) const |
| Check IOstream status for given operation. | |
| bool | fatalCheck (const char *operation) const |
| Check IOstream status for given operation. | |
| bool | opened () const noexcept |
| True if stream has been opened. | |
| bool | closed () const noexcept |
| True if stream is closed. | |
| bool | good () const noexcept |
| True if next operation might succeed. | |
| bool | eof () const noexcept |
| True if end of input seen. | |
| bool | fail () const noexcept |
| True if next operation will fail. | |
| bool | bad () const noexcept |
| True if stream is corrupted. | |
| operator bool () const noexcept | |
| True if the stream has not failed. | |
| bool | operator! () const noexcept |
| True if the stream has failed. | |
| unsigned | labelByteSize () const noexcept |
| The sizeof (label) in bytes associated with the stream. | |
| unsigned | scalarByteSize () const noexcept |
| The sizeof (scalar) in bytes associated with the stream. | |
| void | setLabelByteSize (unsigned nbytes) noexcept |
| Set the sizeof (label) in bytes associated with the stream. | |
| void | setScalarByteSize (unsigned nbytes) noexcept |
| Set the sizeof (scalar) in bytes associated with the stream. | |
| template<class T, class = std::enable_if_t<std::is_integral_v<T>>> | |
| bool | checkLabelSize () const noexcept |
| Test if the label byte-size associated with the stream is the same as the given type. | |
| template<class T, class = std::enable_if_t<std::is_floating_point_v<T>>> | |
| bool | checkScalarSize () const noexcept |
| Test if the scalar byte-size associated with the stream is the same as the given type. | |
| bool | checkNativeSizes () const noexcept |
| Test if the label/scalar byte-size associated with the stream are the native label/scalar sizes. | |
| bool | fatalCheckNativeSizes (const char *operation) const |
| Assert that the label/scalar byte-size associated with the stream are the native label/scalar sizes. | |
| label | lineNumber () const noexcept |
| Const access to the current stream line number. | |
| label & | lineNumber () noexcept |
| Non-const access to the current stream line number. | |
| label | lineNumber (const label num) noexcept |
| Set the stream line number. | |
| void | setEof () noexcept |
| Set stream state as reached 'eof'. | |
| void | setFail () noexcept |
| Set stream state as 'failed'. | |
| void | setBad () noexcept |
| Set stream state to be 'bad'. | |
| std::ios_base::fmtflags | setf (std::ios_base::fmtflags f) |
| Set stream flag(s), return old stream flags. | |
| std::ios_base::fmtflags | setf (const std::ios_base::fmtflags f, const std::ios_base::fmtflags mask) |
| Set stream flag(s) with mask, return old stream flags. | |
| std::ios_base::fmtflags | unsetf (std::ios_base::fmtflags f) |
| Unset stream flags, return old stream flags. | |
| void | print (Ostream &os, const int streamState) const |
| Print information about the stream state bits. | |
| InfoProxy< IOstream > | info () const noexcept |
| Return info proxy, used to print IOstream information to a stream. | |
| Public Member Functions inherited from IOstreamOption | |
| constexpr | IOstreamOption (streamFormat fmt=streamFormat::ASCII, compressionType comp=compressionType::UNCOMPRESSED) noexcept |
| Default construct (ASCII, UNCOMPRESSED, currentVersion) or construct with format, compression. | |
| constexpr | IOstreamOption (streamFormat fmt, compressionType comp, versionNumber ver) noexcept |
| Construct from components (format, compression, version). | |
| constexpr | IOstreamOption (streamFormat fmt, versionNumber ver, compressionType comp=compressionType::UNCOMPRESSED) noexcept |
| Construct from components (format, version, compression). | |
| IOstreamOption (const IOstreamOption &opt, streamFormat fmt) noexcept | |
| Copy construct with change of format. | |
| streamFormat | format () const noexcept |
| Get the current stream format. | |
| streamFormat | format (const streamFormat fmt) noexcept |
| Set the stream format. | |
| streamFormat | format (const word &formatName) |
| Set the stream format from string value. | |
| compressionType | compression () const noexcept |
| Get the stream compression. | |
| compressionType | compression (const compressionType comp) noexcept |
| Set the stream compression. | |
| compressionType | compression (const word &compName) |
| Set the stream compression from string value. | |
| versionNumber | version () const noexcept |
| Get the stream version. | |
| versionNumber | version (const versionNumber ver) noexcept |
| Set the stream version. | |
| versionNumber | version (const token &tok) |
| Set the stream version from token. | |
Additional Inherited Members | |
| Public Types inherited from IOstream | |
| enum | streamAccess : char { CLOSED = 0 , OPENED } |
| Enumeration for stream open/closed state. More... | |
| Public Types inherited from IOstreamOption | |
| enum | streamFormat : char { ASCII = 0 , BINARY , COHERENT , UNKNOWN_FORMAT } |
| Data format (ascii | binary | coherent). More... | |
| enum | compressionType : char { UNCOMPRESSED = 0 , COMPRESSED } |
| Compression treatment (UNCOMPRESSED | COMPRESSED). More... | |
| enum | appendType : char { NO_APPEND = 0 , APPEND_APP , APPEND_ATE , NON_APPEND = NO_APPEND , APPEND = APPEND_APP } |
| File appending (NO_APPEND | APPEND_APP | APPEND_ATE). More... | |
| enum | atomicType : char { NON_ATOMIC = 0 , ATOMIC } |
| Atomic operations (output). More... | |
| enum class | floatFormat : unsigned { general = unsigned(0) , fixed = unsigned(std::ios_base::fixed) , scientific = unsigned(std::ios_base::scientific) } |
| Float formats (eg, time directory name formats). More... | |
| Static Public Member Functions inherited from IOstream | |
| static unsigned int | defaultPrecision () noexcept |
| Return the default precision. | |
| static unsigned int | defaultPrecision (unsigned int prec) noexcept |
| Reset the default precision. | |
| static unsigned int | minPrecision (unsigned int prec) noexcept |
| Set the minimum default precision. | |
| Static Public Member Functions inherited from IOstreamOption | |
| static floatFormat | floatFormatEnum (const word &fmtName, const floatFormat deflt=floatFormat::general) |
| Lookup floatFormat enum corresponding to the string (general | fixed | scientific). | |
| static floatFormat | floatFormatEnum (const word &key, const dictionary &dict, const floatFormat deflt=floatFormat::general) |
| getOrDefault floatFormat from dictionary, warn only on bad enumeration. | |
| static streamFormat | formatEnum (const word &fmtName, const streamFormat deflt=streamFormat::ASCII) |
| Lookup streamFormat enum corresponding to the string (ascii | binary). | |
| static streamFormat | formatEnum (const word &key, const dictionary &dict, const streamFormat deflt=streamFormat::ASCII) |
| getOrDefault streamFormat from dictionary, warn only on bad enumeration. | |
| static compressionType | compressionEnum (const word &compName, const compressionType deflt=compressionType::UNCOMPRESSED) |
| The compression enum corresponding to the string. | |
| static compressionType | compressionEnum (const word &key, const dictionary &dict, const compressionType deflt=compressionType::UNCOMPRESSED) |
| getOrDefault compressionType from dictionary, warn only on bad enumeration. | |
| Static Public Attributes inherited from IOstream | |
| static unsigned int | precision_ |
| Default precision. | |
| Static Public Attributes inherited from IOstreamOption | |
| static const Enum< floatFormat > | floatFormatNames |
| Names for float formats (general, fixed, scientific). | |
| static const Enum< streamFormat > | formatNames |
| Stream format names (ascii, binary). | |
| static const versionNumber | currentVersion |
| The current version number (2.0). | |
| Protected Member Functions inherited from StreamAllocator< Foam::ocharstream > | |
| StreamAllocator ()=default | |
| Default construct (empty). | |
| Protected Member Functions inherited from IOstream | |
| void | setOpened () noexcept |
| Set stream opened. | |
| void | setClosed () noexcept |
| Set stream closed. | |
| void | setState (std::ios_base::iostate state) noexcept |
| Set stream state. | |
| void | setGood () noexcept |
| Set stream state to be good. | |
| Protected Attributes inherited from StreamAllocator< Foam::ocharstream > | |
| Foam::ocharstream | stream_ |
| The std::stream. | |
| Protected Attributes inherited from Ostream | |
| unsigned short | indentSize_ = 4 |
| Number of spaces per indent level. | |
| unsigned short | indentLevel_ = 0 |
| Current indent level. | |
| Protected Attributes inherited from IOstream | |
| std::ios_base::iostate | ioState_ |
| Mirror of internal stream io state. | |
| streamAccess | openClosed_ |
| The stream open/closed state. | |
| unsigned char | sizeofLabel_ |
| The sizeof (label), possibly read from the header. | |
| unsigned char | sizeofScalar_ |
| The sizeof (scalar), possibly read from the header. | |
| label | lineNumber_ |
| The file line. | |
| Static Protected Attributes inherited from Ostream | |
| static constexpr const unsigned short | entryIndentation_ = 16 |
| Indentation of the entry from the start of the keyword. | |
| Static Protected Attributes inherited from IOstream | |
| static fileName | staticName_ |
| Name for any generic stream - normally treat as readonly. | |
An OSstream with internal List storage.
An output stream that writes to a List and manages the List storage. Similar to OStringStream but with a List for its storage instead of as string to allow reuse of List contents without copying.
Internally imposes a 512 byte min-size and uses capacity doubling.
Definition at line 354 of file OCharStream.H.
|
inlineexplicit |
Default construct (empty output).
Definition at line 370 of file OCharStream.H.
References IOstreamOption::format(), OSstream::OSstream(), StreamAllocator< Foam::ocharstream >::stream_, and IOstreamOption::version().
Referenced by masterOFstream::masterOFstream(), OCharStream(), OCharStream(), and threadedCollatedOFstream::threadedCollatedOFstream().


|
inlineexplicit |
Move construct from a List of initial storage.
Definition at line 382 of file OCharStream.H.
References OCharStream(), and StreamAllocator< Foam::ocharstream >::stream_.

|
inlineexplicit |
Move construct from a DynamicList of initial storage (uses entire capacity).
Definition at line 398 of file OCharStream.H.
References OCharStream(), and StreamAllocator< Foam::ocharstream >::stream_.

|
inline |
Position of the put buffer.
Definition at line 415 of file OCharStream.H.
References StreamAllocator< Foam::ocharstream >::stream_.
|
inline |
The current output position within the buffer (tellp).
Definition at line 420 of file OCharStream.H.
References StreamAllocator< Foam::ocharstream >::stream_.
|
inline |
The number of bytes outputted.
Definition at line 425 of file OCharStream.H.
References StreamAllocator< Foam::ocharstream >::stream_.
Referenced by append(), append(), fileRegEx::apply(), overwrite(), and dictionaryValue::processDict().

|
inline |
The current output size. Same as count(), output_pos(), tellp().
Definition at line 430 of file OCharStream.H.
References StreamAllocator< Foam::ocharstream >::stream_.
|
inline |
The put buffer capacity.
Definition at line 435 of file OCharStream.H.
References StreamAllocator< Foam::ocharstream >::stream_.
|
inline |
Reserve output space for at least this amount.
Definition at line 440 of file OCharStream.H.
References n, and StreamAllocator< Foam::ocharstream >::stream_.
Referenced by masterOFstream::masterOFstream(), threadedCollatedOFstream::threadedCollatedOFstream(), and decomposedBlockData::writeBlockEntry().

|
inline |
Reserve output space for at least this amount. Does not apply min-size or capacity doubling etc.
Definition at line 446 of file OCharStream.H.
References n, and StreamAllocator< Foam::ocharstream >::stream_.
|
inline |
Increase (reserve) space for another n entries.
Definition at line 451 of file OCharStream.H.
References n, and StreamAllocator< Foam::ocharstream >::stream_.
|
inline |
Increase (reserve) space for another n entries.
Definition at line 456 of file OCharStream.H.
References n, and StreamAllocator< Foam::ocharstream >::stream_.
|
inline |
A string_view of buffer contents.
Definition at line 461 of file OCharStream.H.
References StreamAllocator< Foam::ocharstream >::stream_.
Referenced by entry::operator==(), and ITstream::toString().

|
inline |
A sub-slice string view of the buffer contents.
Definition at line 466 of file OCharStream.H.
References Foam::pos(), and StreamAllocator< Foam::ocharstream >::stream_.

|
inline |
A list span of the current output characters (is modifiable!).
Definition at line 474 of file OCharStream.H.
References StreamAllocator< Foam::ocharstream >::stream_.
|
inline |
For OStringStream compatibility, return the buffer as string copy.
Use sparingly - it creates a full copy!!
Definition at line 481 of file OCharStream.H.
References StreamAllocator< Foam::ocharstream >::stream_.
Referenced by fileRegEx::apply(), and dictionaryValue::processDict().

|
inline |
Exchange stream content and parameter contents, reset positions.
Definition at line 486 of file OCharStream.H.
References StreamAllocator< Foam::ocharstream >::stream_, and OSstream::syncState().

|
inline |
Exchange stream content and parameter contents, reset positions.
Definition at line 496 of file OCharStream.H.
References StreamAllocator< Foam::ocharstream >::stream_, and OSstream::syncState().

|
inline |
Reset buffer and return contents.
Definition at line 505 of file OCharStream.H.
References StreamAllocator< Foam::ocharstream >::stream_, and OSstream::syncState().
Referenced by decomposedBlockData::writeBlockEntry().


|
inlinevirtual |
Rewind the stream, clearing any old errors.
Definition at line 515 of file OCharStream.H.
References StreamAllocator< Foam::ocharstream >::stream_, and OSstream::syncState().
Referenced by fileRegEx::apply().


|
inline |
Reposition the stream from the start.
Definition at line 524 of file OCharStream.H.
References Foam::pos(), StreamAllocator< Foam::ocharstream >::stream_, and OSstream::syncState().

|
inlineoverridevirtual |
Print stream description.
Reimplemented from OSstream.
Definition at line 533 of file OCharStream.H.
References os(), and StreamAllocator< Foam::ocharstream >::stream_.

|
inline |
Append a single character to the end.
Definition at line 546 of file OCharStream.H.
References StreamAllocator< Foam::ocharstream >::stream_.
|
inline |
Rewind the end by 1 or more elements.
Definition at line 551 of file OCharStream.H.
References n, and StreamAllocator< Foam::ocharstream >::stream_.
|
inline |
Append repeated character content.
Definition at line 556 of file OCharStream.H.
References count(), and StreamAllocator< Foam::ocharstream >::stream_.
Referenced by masterOFstream::masterOFstream(), masterOFstream::masterOFstream(), masterOFstream::masterOFstream(), and masterOFstream::masterOFstream().


|
inline |
Append character content.
Definition at line 564 of file OCharStream.H.
References count(), and StreamAllocator< Foam::ocharstream >::stream_.

|
inline |
Append character content.
Definition at line 572 of file OCharStream.H.
References StreamAllocator< Foam::ocharstream >::stream_.
|
inline |
Overwrite a single character.
Definition at line 580 of file OCharStream.H.
References Foam::pos(), and StreamAllocator< Foam::ocharstream >::stream_.

|
inline |
Overwrite a sub-slice with character content.
Definition at line 588 of file OCharStream.H.
References count(), Foam::pos(), and StreamAllocator< Foam::ocharstream >::stream_.

|
inline |
Overwrite a sub-slice with character content.
Definition at line 601 of file OCharStream.H.
References Foam::pos(), and StreamAllocator< Foam::ocharstream >::stream_.

|
inline |
Block size was used in OpenFOAM-v2306 and earlier.
Definition at line 612 of file OCharStream.H.
References n.