An ISstream with internal List storage. Always UNCOMPRESSED. More...

#include <ICharStream.H>

Inheritance diagram for ICharStream:

[legend]

Collaboration diagram for ICharStream:

[legend]

Public Member Functions
	ICharStream (IOstreamOption streamOpt=IOstreamOption())
	Default construct (empty), optionally with specified stream option.
	ICharStream (const std::string &buffer, IOstreamOption streamOpt=IOstreamOption())
	Copy construct from string content.
	ICharStream (List< char > &&buffer, IOstreamOption streamOpt=IOstreamOption())
	Move construct from List.
template<int SizeMin>
	ICharStream (DynamicList< char, SizeMin > &&buffer, IOstreamOption streamOpt=IOstreamOption())
	Move construct from DynamicList (uses current size).
std::streampos	tellg () const
	Position of the get buffer.
std::streampos	input_pos () const
	The current get position within the buffer (tellg).
label	size () const
	The input list size. Same as capacity().
std::streamsize	capacity () const
	The get buffer capacity.
std::streamsize	remaining () const
	The number of characters remaining in the get area. Same as (capacity() - input_pos()).
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 input characters (is modifiable!).
auto	str () const
	For IStringStream compatibility, return the buffer as string copy.
void	reset (const char *buffer, size_t nbytes)
	Reset content (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 stream and return contents as a List.
virtual void	rewind () override
	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.
Istream &	operator() () const
	A non-const reference to const Istream.
Public Member Functions inherited from ISstream
	ISstream (std::istream &is, const string &streamName, IOstreamOption streamOpt=IOstreamOption())
	Construct wrapper around std::istream, set stream status.
	ISstream (std::istream &is, const string &streamName, IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct wrapper around std::istream, set stream status.
	ISstream (std::istream &is, const string &streamName, IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct wrapper around std::istream, set stream status.
virtual	~ISstream ()=default
	Destructor.
virtual const fileName &	name () const override
	The name of the input serial stream. (eg, the name of the Fstream file name).
virtual fileName &	name ()
	The name of the input serial stream, for modification.
virtual const std::istream &	stdStream () const
	Const access to underlying std::istream.
virtual std::istream &	stdStream ()
	Access to underlying std::istream.
virtual std::ios_base::fmtflags	flags () const override
	Return 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::istream.
*return False if stream exhausted before finding the comment end bool	seekCommentEnd_Cstyle ()
	Discard until end of C-style comment '.
bool	continueReadUntilRightBrace (std::string &str, const bool stripComments=true)
	Raw, low-level get into a string. Continues reading after an initial left-brace until it finds the matching closing right-brace.
ISstream &	get (char &c)
	Raw, low-level get character function.
int	peek ()
	Raw, low-level peek function.
ISstream &	getLine (std::string &str, char delim='\n')
	Raw, low-level getline (until delimiter) into a string.
std::streamsize	getLine (std::nullptr_t, char delim='\n')
	Low-level discard until delimiter.
ISstream &	putback (const char c)
	Raw, low-level putback character function.
virtual Istream &	read (token &t) override
	Return next token from stream.
virtual Istream &	read (char &c) override
	Read a character.
virtual Istream &	read (word &str) override
	Read a word.
virtual Istream &	read (string &str) override
	Read a string (including enclosing double-quotes).
virtual Istream &	read (int32_t &val) override
	Read int32_t.
virtual Istream &	read (int64_t &val) override
	Read int64_t.
virtual Istream &	read (uint32_t &val) override
	Read uint32_t.
virtual Istream &	read (uint64_t &val) override
	Read uint64_t.
virtual Istream &	read (float &val) override
	Read a float.
virtual Istream &	read (double &val) override
	Read a double.
virtual Istream &	read (char *data, std::streamsize count) override
	Read binary block (with any possible block delimiters). Reading into a null pointer behaves like a forward seek of count characters.
virtual Istream &	readRaw (char *data, std::streamsize count) override
	Low-level raw binary read (without possible block delimiters). Reading into a null pointer behaves like a forward seek of count characters.
virtual bool	beginRawRead () override
	Start of low-level raw binary read.
virtual bool	endRawRead () override
	End of low-level raw binary read.
Public Member Functions inherited from Istream
	Istream (const Istream &)=default
	Copy construct.
virtual	~Istream ()=default
	Destructor.
	Istream (IOstreamOption streamOpt=IOstreamOption())
	Default construct (ASCII, uncompressed), construct with specified stream option.
	Istream (IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct with format (uncompressed).
const token &	peekBack () const noexcept
	Examine putback token without removing it.
void	putBackClear ()
	Drop the putback token.
void	putBack (const token &tok)
	Put back a token (copy). Only a single put back is permitted.
void	putBack (token &&tok)
	Put back a token (move). Only a single put back is permitted.
bool	getBack (token &tok)
	Retrieve the put-back token if there is one.
bool	readBegin (const char *funcName)
	Begin read of data chunk, starts with '('.
bool	readEnd (const char *funcName)
	End read of data chunk, ends with ')'.
char	readBeginList (const char *funcName)
	Begin read of list data, starts with '(' or '{'.
char	readEndList (const char *funcName)
	End read of list data, ends with ')' or '}'.
Istream &	operator() () const
	Return a non-const reference to const Istream.
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::icharstream >
	StreamAllocator ()=default
	Default construct (empty).
Protected Member Functions inherited from Istream
bool	hasPutback () const noexcept
	True if putback token is in use.
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::icharstream >
Foam::icharstream	stream_
	The std::stream.
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 IOstream
static fileName	staticName_
	Name for any generic stream - normally treat as readonly.

Detailed Description

An ISstream with internal List storage. Always UNCOMPRESSED.

An input stream that reads from a List and manages the List storage. Similar to IStringStream but with a List for its storage instead of as string to allow reuse of List contents without copying.

See also: Foam::OCharStream Foam::ISpanStream Foam::OSpanStream

Definition at line 263 of file ICharStream.H.

Constructor & Destructor Documentation

◆ ICharStream() [1/4]

ICharStream ( IOstreamOption streamOpt = IOstreamOption() )

inlineexplicit

Default construct (empty), optionally with specified stream option.

Definition at line 279 of file ICharStream.H.

References IOstreamOption::format(), ISstream::ISstream(), StreamAllocator< Foam::icharstream >::stream_, and IOstreamOption::version().

Referenced by ICharStream(), ICharStream(), ICharStream(), and operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ICharStream() [2/4]

ICharStream	(	const std::string &	buffer,
		IOstreamOption	streamOpt = IOstreamOption() )

inlineexplicit

Copy construct from string content.

Definition at line 291 of file ICharStream.H.

References ICharStream(), and StreamAllocator< Foam::icharstream >::stream_.

Here is the call graph for this function:

◆ ICharStream() [3/4]

ICharStream	(	List< char > &&	buffer,
		IOstreamOption	streamOpt = IOstreamOption() )

inlineexplicit

Move construct from List.

Definition at line 305 of file ICharStream.H.

References ICharStream(), and StreamAllocator< Foam::icharstream >::stream_.

Here is the call graph for this function:

◆ ICharStream() [4/4]

template<int SizeMin>

ICharStream	(	DynamicList< char, SizeMin > &&	buffer,
		IOstreamOption	streamOpt = IOstreamOption() )

inlineexplicit

Move construct from DynamicList (uses current size).

Definition at line 320 of file ICharStream.H.

References ICharStream(), and StreamAllocator< Foam::icharstream >::stream_.

Here is the call graph for this function:

Member Function Documentation

◆ tellg()

std::streampos tellg ( ) const

inline

Position of the get buffer.

Definition at line 339 of file ICharStream.H.

References StreamAllocator< Foam::icharstream >::stream_.

◆ input_pos()

std::streampos input_pos ( ) const

inline

The current get position within the buffer (tellg).

Definition at line 344 of file ICharStream.H.

References StreamAllocator< Foam::icharstream >::stream_.

◆ size()

label size ( ) const

inline

The input list size. Same as capacity().

Definition at line 349 of file ICharStream.H.

References StreamAllocator< Foam::icharstream >::stream_.

◆ capacity()

std::streamsize capacity ( ) const

inline

The get buffer capacity.

Definition at line 354 of file ICharStream.H.

References StreamAllocator< Foam::icharstream >::stream_.

◆ remaining()

std::streamsize remaining ( ) const

inline

The number of characters remaining in the get area. Same as (capacity() - input_pos()).

Definition at line 360 of file ICharStream.H.

References StreamAllocator< Foam::icharstream >::stream_.

◆ view() [1/2]

auto view ( ) const

inline

A string_view of buffer contents.

Definition at line 365 of file ICharStream.H.

References StreamAllocator< Foam::icharstream >::stream_.

◆ view() [2/2]

auto view	(	size_t	pos,
		size_t	len = std::string::npos ) const

inline

A sub-slice string view of the buffer contents.

Definition at line 370 of file ICharStream.H.

References Foam::pos(), and StreamAllocator< Foam::icharstream >::stream_.

Here is the call graph for this function:

◆ list()

UList< char > list ( ) const

inline

A list span of the input characters (is modifiable!).

Definition at line 378 of file ICharStream.H.

References StreamAllocator< Foam::icharstream >::stream_.

◆ str()

auto str ( ) const

inline

For IStringStream compatibility, return the buffer as string copy.

Use sparingly - it creates a full copy!!

Definition at line 385 of file ICharStream.H.

References StreamAllocator< Foam::icharstream >::stream_.

◆ reset()

void reset	(	const char *	buffer,
		size_t	nbytes )

inline

Reset content (copy).

Definition at line 393 of file ICharStream.H.

References StreamAllocator< Foam::icharstream >::stream_, and ISstream::syncState().

Here is the call graph for this function:

◆ swap() [1/2]

void swap ( List< char > & other )

inline

Exchange stream content and parameter contents, reset positions.

Definition at line 402 of file ICharStream.H.

References StreamAllocator< Foam::icharstream >::stream_, and ISstream::syncState().

Here is the call graph for this function:

◆ swap() [2/2]

template<int SizeMin>

void swap ( DynamicList< char, SizeMin > & other )

inline

Exchange stream content and parameter contents, reset positions.

Definition at line 412 of file ICharStream.H.

References StreamAllocator< Foam::icharstream >::stream_, and ISstream::syncState().

Here is the call graph for this function:

◆ release()

DynamicList< char > release ( )

inline

Reset stream and return contents as a List.

Definition at line 421 of file ICharStream.H.

References StreamAllocator< Foam::icharstream >::stream_, and ISstream::syncState().

Here is the call graph for this function:

◆ rewind()

virtual void rewind ( )

inlineoverridevirtual

Rewind the stream, clearing any old errors.

Reimplemented from ISstream.

Reimplemented in dummyISstream.

Definition at line 431 of file ICharStream.H.

References Istream::rewind(), StreamAllocator< Foam::icharstream >::stream_, and ISstream::syncState().

Referenced by solidReaction< ReactionThermo >::solidReaction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ seek()

void seek ( std::streampos pos )

inline

Reposition the stream from the start.

Definition at line 441 of file ICharStream.H.

References Foam::pos(), StreamAllocator< Foam::icharstream >::stream_, and ISstream::syncState().

Here is the call graph for this function:

◆ print()

virtual void print ( Ostream & os ) const

inlineoverridevirtual

Print stream description.

Reimplemented from ISstream.

Definition at line 453 of file ICharStream.H.

References os(), and StreamAllocator< Foam::icharstream >::stream_.

Here is the call graph for this function:

◆ operator()()

Istream & operator() ( ) const

inline

A non-const reference to const Istream.

Needed for read-constructors where the stream argument is temporary

Definition at line 468 of file ICharStream.H.

References ICharStream().

Here is the call graph for this function:

The documentation for this class was generated from the following file:

src/OpenFOAM/db/IOstreams/memory/ICharStream.H

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ICharStream() [1/4]

◆ ICharStream() [2/4]

◆ ICharStream() [3/4]

◆ ICharStream() [4/4]

Member Function Documentation

◆ tellg()

◆ input_pos()

◆ size()

◆ capacity()

◆ remaining()

◆ view() [1/2]

◆ view() [2/2]

◆ list()

◆ str()

◆ reset()

◆ swap() [1/2]

◆ swap() [2/2]

◆ release()

◆ rewind()

◆ seek()

◆ print()

◆ operator()()