dummyISstream Class Reference

Dummy input stream, which can be used as a placeholder for interfaces taking an Istream or ISstream. Aborts at any attempt to read from it. More...

Inheritance diagram for dummyISstream:
[legend]
Collaboration diagram for dummyISstream:
[legend]

Public Member Functions

 dummyISstream ()=default
 Default construct. More...
 
virtual ~dummyISstream ()=default
 Destructor. More...
 
virtual Istreamread (token &)
 Return next token from stream. More...
 
virtual Istreamread (char &)
 Read a character. More...
 
virtual Istreamread (word &)
 Read a word. More...
 
virtual Istreamread (string &)
 Read a string (including enclosing double-quotes). More...
 
virtual Istreamread (label &)
 Read a label. More...
 
virtual Istreamread (floatScalar &)
 Read a floatScalar. More...
 
virtual Istreamread (doubleScalar &)
 Read a doubleScalar. More...
 
virtual Istreamread (char *, std::streamsize)
 Read binary block. More...
 
virtual IstreamreadRaw (char *, std::streamsize)
 Low-level raw binary read. More...
 
virtual bool beginRawRead ()
 Start of low-level raw binary read. More...
 
virtual bool endRawRead ()
 End of low-level raw binary read. More...
 
virtual void rewind ()
 Rewind the stream so that it may be read again. More...
 
virtual ios_base::fmtflags flags () const
 Return flags of stream. More...
 
virtual ios_base::fmtflags flags (const ios_base::fmtflags)
 Set flags of stream. More...
 
- Public Member Functions inherited from IStringStream
 IStringStream (IOstreamOption streamOpt=IOstreamOption())
 Default construct or with specified stream option. More...
 
 IStringStream (const std::string &s, IOstreamOption streamOpt=IOstreamOption())
 Construct from std::string. More...
 
 IStringStream (const char *s, IOstreamOption streamOpt=IOstreamOption())
 Construct from char*. More...
 
 IStringStream (const IStringStream &str)
 Copy construct, copies content and format. More...
 
virtual void reset (const std::string &s)
 Reset the input buffer and rewind the stream. More...
 
virtual void print (Ostream &os) const
 Print stream description to Ostream. More...
 
Istreamoperator() () const
 Return a non-const reference to const Istream. More...
 
- Public Member Functions inherited from StringStreamAllocator< std::istringstream >
Foam::string str () const
 Get the string - as Foam::string rather than std::string. More...
 
void str (const std::string &s)
 Set the string. More...
 
- Public Member Functions inherited from ISstream
 ISstream (std::istream &is, const string &streamName, IOstreamOption streamOpt=IOstreamOption())
 Construct wrapper around std::istream, set stream status. More...
 
 ISstream (std::istream &is, const string &streamName, IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver=IOstreamOption::currentVersion, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
 Construct wrapper around std::istream, set stream status. More...
 
virtual ~ISstream ()=default
 Destructor. More...
 
virtual const fileNamename () const
 Return the name of the stream. More...
 
virtual fileNamename ()
 Return stream name for modification. More...
 
virtual ios_base::fmtflags flags () const
 Return flags of output stream. More...
 
bool seekCommentEnd_Cstyle ()
 Discard until end of C-style comment '*‍/'. More...
 
bool continueReadUntilRightBrace (std::string &str, const bool stripComments=true)
 
ISstreamget (char &c)
 Raw, low-level get character function. More...
 
int peek ()
 Raw, low-level peek function. More...
 
ISstreamgetLine (std::string &str, char delim='\n')
 Raw, low-level getline (until delimiter) into a string. More...
 
std::streamsize getLine (std::nullptr_t, char delim='\n')
 Low-level discard until delimiter. More...
 
ISstreamputback (const char c)
 Raw, low-level putback character function. More...
 
virtual Istreamread (token &t)
 Return next token from stream. More...
 
virtual Istreamread (char &c)
 Read a character. More...
 
virtual Istreamread (word &str)
 Read a word. More...
 
virtual Istreamread (string &str)
 Read a string (including enclosing double-quotes). More...
 
virtual Istreamread (label &val)
 Read a label. More...
 
virtual Istreamread (floatScalar &val)
 Read a floatScalar. More...
 
virtual Istreamread (doubleScalar &val)
 Read a doubleScalar. More...
 
virtual Istreamread (char *buf, std::streamsize count)
 Read binary block. More...
 
virtual IstreamreadRaw (char *data, std::streamsize count)
 Low-level raw binary read. More...
 
virtual bool beginRawRead ()
 Start of low-level raw binary read. More...
 
virtual bool endRawRead ()
 End of low-level raw binary read. More...
 
virtual void rewind ()
 Rewind the stream so that it may be read again. More...
 
virtual ios_base::fmtflags flags (const ios_base::fmtflags flags)
 Set stream flags. More...
 
virtual std::istream & stdStream ()
 Access to underlying std::istream. More...
 
virtual const std::istream & stdStream () const
 Const access to underlying std::istream. More...
 
virtual void print (Ostream &os) const
 Print stream description to Ostream. More...
 
- Public Member Functions inherited from Istream
 Istream (const Istream &)=default
 Copy construct. More...
 
virtual ~Istream ()=default
 Destructor. More...
 
 Istream (IOstreamOption streamOpt=IOstreamOption())
 
 Istream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver=IOstreamOption::currentVersion, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
 Construct with format, version (compression) More...
 
const tokenpeekBack () const noexcept
 Examine putback token without removing it. More...
 
bool peekBack (token &tok)
 Fetch putback token without removing it. More...
 
void putBack (const token &tok)
 Put back a token. Only a single put back is permitted. More...
 
bool getBack (token &tok)
 Get the put-back token if there is one. More...
 
virtual Istreamread (token &)=0
 Return next token from stream. More...
 
virtual Istreamread (char &)=0
 Read a character. More...
 
virtual Istreamread (word &)=0
 Read a word. More...
 
virtual Istreamread (string &)=0
 Read a string (including enclosing double-quotes) More...
 
virtual Istreamread (label &)=0
 Read a label. More...
 
virtual Istreamread (floatScalar &)=0
 Read a floatScalar. More...
 
virtual Istreamread (doubleScalar &)=0
 Read a doubleScalar. More...
 
virtual Istreamread (char *, std::streamsize)=0
 Read binary block. More...
 
virtual bool beginRawRead ()=0
 Start of low-level raw binary read. More...
 
virtual bool endRawRead ()=0
 End of low-level raw binary read. More...
 
virtual IstreamreadRaw (char *, std::streamsize)=0
 Low-level raw binary read. More...
 
virtual void rewind ()=0
 Rewind the stream so that it may be read again. More...
 
bool readBegin (const char *funcName)
 Begin read of data chunk, starts with '('. More...
 
bool readEnd (const char *funcName)
 End read of data chunk, ends with ')'. More...
 
char readBeginList (const char *funcName)
 Begin read of list data, starts with '(' or '{'. More...
 
char readEndList (const char *funcName)
 End read of list data, ends with ')' or '}'. More...
 
Istreamoperator() () const
 Return a non-const reference to const Istream. More...
 
- Public Member Functions inherited from IOstream
 IOstream (const IOstream &)=default
 Copy construct. More...
 
virtual ~IOstream ()=default
 Destructor. More...
 
 IOstream (IOstreamOption streamOpt=IOstreamOption())
 
 IOstream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
 Construct with format, version (compression) More...
 
virtual const fileNamename () const
 Return the name of the stream. More...
 
virtual fileNamename ()
 Return stream name for modification. More...
 
fileName relativeName () const
 Return the name of the stream relative to the current case. More...
 
virtual bool check (const char *operation) const
 Check IOstream status for given operation. More...
 
bool fatalCheck (const char *operation) const
 Check IOstream status for given operation. More...
 
bool opened () const noexcept
 True if stream has been opened. More...
 
bool closed () const noexcept
 True if stream is closed. More...
 
bool good () const noexcept
 True if next operation might succeed. More...
 
bool eof () const noexcept
 True if end of input seen. More...
 
bool fail () const noexcept
 True if next operation will fail. More...
 
bool bad () const noexcept
 True if stream is corrupted. More...
 
 operator bool () const noexcept
 Return true if the stream has not failed. More...
 
bool operator! () const noexcept
 Return true if the stream has failed. More...
 
unsigned labelByteSize () const noexcept
 The sizeof (label) in bytes associated with the stream. More...
 
unsigned scalarByteSize () const noexcept
 The sizeof (scalar) in bytes associated with the stream. More...
 
void setLabelByteSize (unsigned nbytes) noexcept
 Set the sizeof (label) in bytes associated with the stream. More...
 
void setScalarByteSize (unsigned nbytes) noexcept
 Set the sizeof (scalar) in bytes associated with the stream. More...
 
template<class T = label>
std::enable_if< std::is_integral< T >::value, bool >::type checkLabelSize () const noexcept
 
template<class T = scalar>
std::enable_if< std::is_floating_point< T >::value, bool >::type checkScalarSize () const noexcept
 
label lineNumber () const noexcept
 Const access to the current stream line number. More...
 
label & lineNumber () noexcept
 Non-const access to the current stream line number. More...
 
label lineNumber (const label num) noexcept
 Set the stream line number. More...
 
virtual ios_base::fmtflags flags () const =0
 Return flags of stream. More...
 
void setEof () noexcept
 Set stream state as reached 'eof'. More...
 
void setFail () noexcept
 Set stream state as 'failed'. More...
 
void setBad ()
 Set stream state to be 'bad'. More...
 
virtual ios_base::fmtflags flags (const ios_base::fmtflags f)=0
 Set flags of stream. More...
 
ios_base::fmtflags setf (const ios_base::fmtflags f)
 Set flags of stream. More...
 
ios_base::fmtflags setf (const ios_base::fmtflags f, const ios_base::fmtflags mask)
 Set flags of given field of stream. More...
 
void unsetf (const ios_base::fmtflags f)
 Unset flags of stream. More...
 
virtual void print (Ostream &os) const
 Print stream description to Ostream. More...
 
void print (Ostream &os, const int streamState) const
 Print information about the stream state bits. More...
 
InfoProxy< IOstreaminfo () const
 Return info proxy. More...
 
- Public Member Functions inherited from IOstreamOption
constexpr IOstreamOption (streamFormat fmt=streamFormat::ASCII, compressionType comp=compressionType::UNCOMPRESSED) noexcept
 
constexpr IOstreamOption (streamFormat fmt, compressionType comp, versionNumber ver) noexcept
 Construct from components (format, compression, version) More...
 
constexpr IOstreamOption (streamFormat fmt, versionNumber ver, compressionType comp=compressionType::UNCOMPRESSED) noexcept
 Construct from components (format, version, compression) More...
 
 IOstreamOption (const IOstreamOption &opt, streamFormat fmt) noexcept
 Copy construct with change of format. More...
 
streamFormat format () const noexcept
 Get the current stream format. More...
 
streamFormat format (const streamFormat fmt) noexcept
 Set the stream format. More...
 
streamFormat format (const word &formatName)
 Set the stream format from string value. More...
 
compressionType compression () const noexcept
 Get the stream compression. More...
 
compressionType compression (const compressionType comp) noexcept
 Set the stream compression. More...
 
compressionType compression (const word &compName)
 Set the stream compression from string value. More...
 
versionNumber version () const noexcept
 Get the stream version. More...
 
versionNumber version (const versionNumber ver) noexcept
 Set the stream version. More...
 
versionNumber version (const token &tok)
 Set the stream version from token. More...
 

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 }
 Data format (ascii | binary) More...
 
enum  compressionType : char { UNCOMPRESSED = 0 , COMPRESSED }
 Compression treatment (UNCOMPRESSED | COMPRESSED) More...
 
- Static Public Member Functions inherited from IOstream
static unsigned int defaultPrecision () noexcept
 Return the default precision. More...
 
static unsigned int defaultPrecision (unsigned int prec) noexcept
 Reset the default precision. More...
 
- Static Public Member Functions inherited from IOstreamOption
static streamFormat formatEnum (const word &formatName, const streamFormat deflt=streamFormat::ASCII)
 
static streamFormat formatEnum (const word &key, const dictionary &dict, const streamFormat deflt=streamFormat::ASCII)
 Failsafe construct streamFormat from optional dictionary lookup. More...
 
static compressionType compressionEnum (const word &compName, const compressionType deflt=compressionType::UNCOMPRESSED)
 The compression enum corresponding to the string. More...
 
static compressionType compressionEnum (const word &key, const dictionary &dict, const compressionType deflt=compressionType::UNCOMPRESSED)
 Failsafe construct compressionType from optional dictionary lookup. More...
 
- Static Public Attributes inherited from IOstream
static unsigned int precision_
 Default precision. More...
 
- Static Public Attributes inherited from IOstreamOption
static const Enum< streamFormatformatNames
 Stream format names (ascii, binary) More...
 
static const versionNumber currentVersion
 The current version number (2.0) More...
 
- Protected Types inherited from StringStreamAllocator< std::istringstream >
typedef std::istringstream stream_type
 The stream type. More...
 
- Protected Member Functions inherited from StringStreamAllocator< std::istringstream >
 StringStreamAllocator ()=default
 Default construct. More...
 
 StringStreamAllocator (const std::string &s)
 Copy construct from string. More...
 
- Protected Member Functions inherited from Istream
bool hasPutback () const noexcept
 True if putback token is in use. More...
 
- Protected Member Functions inherited from IOstream
void setOpened () noexcept
 Set stream opened. More...
 
void setClosed () noexcept
 Set stream closed. More...
 
void setState (std::ios_base::iostate state) noexcept
 Set stream state. More...
 
void setGood () noexcept
 Set stream state to be good. More...
 
- Protected Attributes inherited from StringStreamAllocator< std::istringstream >
stream_type stream_
 The input/output stream. More...
 
- Protected Attributes inherited from IOstream
std::ios_base::iostate ioState_
 Mirror of internal stream io state. More...
 
streamAccess openClosed_
 The stream open/closed state. More...
 
unsigned char sizeofLabel_
 The sizeof (label), possibly read from the header. More...
 
unsigned char sizeofScalar_
 The sizeof (scalar), possibly read from the header. More...
 
label lineNumber_
 The file line. More...
 
- Static Protected Attributes inherited from IOstream
static fileName staticName_
 Name for any generic stream - normally treat as readonly. More...
 

Detailed Description

Dummy input stream, which can be used as a placeholder for interfaces taking an Istream or ISstream. Aborts at any attempt to read from it.

Note
The inheritance from an empty IStringStream is solely for convenience of implementation and should not be relied upon.
Source files

Definition at line 56 of file dummyISstream.H.

Constructor & Destructor Documentation

◆ dummyISstream()

dummyISstream ( )
default

Default construct.

◆ ~dummyISstream()

virtual ~dummyISstream ( )
virtualdefault

Destructor.

Member Function Documentation

◆ read() [1/8]

virtual Istream & read ( token )
inlinevirtual

Return next token from stream.

Reimplemented from ISstream.

Definition at line 76 of file dummyISstream.H.

References NotImplemented.

◆ read() [2/8]

virtual Istream & read ( char &  )
inlinevirtual

Read a character.

Reimplemented from ISstream.

Definition at line 83 of file dummyISstream.H.

References NotImplemented.

◆ read() [3/8]

virtual Istream & read ( word )
inlinevirtual

Read a word.

Reimplemented from ISstream.

Definition at line 90 of file dummyISstream.H.

References NotImplemented.

◆ read() [4/8]

virtual Istream & read ( string str)
inlinevirtual

Read a string (including enclosing double-quotes).

Backslashes are retained, except when escaping double-quotes and an embedded newline character.

Reimplemented from ISstream.

Definition at line 97 of file dummyISstream.H.

References NotImplemented.

◆ read() [5/8]

virtual Istream & read ( label &  )
inlinevirtual

Read a label.

Reimplemented from ISstream.

Definition at line 104 of file dummyISstream.H.

References NotImplemented.

◆ read() [6/8]

virtual Istream & read ( floatScalar )
inlinevirtual

Read a floatScalar.

Reimplemented from ISstream.

Definition at line 111 of file dummyISstream.H.

References NotImplemented.

◆ read() [7/8]

virtual Istream & read ( doubleScalar )
inlinevirtual

Read a doubleScalar.

Reimplemented from ISstream.

Definition at line 118 of file dummyISstream.H.

References NotImplemented.

◆ read() [8/8]

virtual Istream & read ( char *  ,
std::streamsize   
)
inlinevirtual

Read binary block.

Reimplemented from ISstream.

Definition at line 125 of file dummyISstream.H.

References NotImplemented.

◆ readRaw()

virtual Istream & readRaw ( char *  ,
std::streamsize   
)
inlinevirtual

Low-level raw binary read.

Reimplemented from ISstream.

Definition at line 132 of file dummyISstream.H.

References NotImplemented.

◆ beginRawRead()

virtual bool beginRawRead ( )
inlinevirtual

Start of low-level raw binary read.

Reimplemented from ISstream.

Definition at line 139 of file dummyISstream.H.

◆ endRawRead()

virtual bool endRawRead ( )
inlinevirtual

End of low-level raw binary read.

Reimplemented from ISstream.

Definition at line 145 of file dummyISstream.H.

◆ rewind()

virtual void rewind ( )
inlinevirtual

Rewind the stream so that it may be read again.

Reimplemented from ISstream.

Definition at line 151 of file dummyISstream.H.

◆ flags() [1/2]

virtual ios_base::fmtflags flags ( ) const
inlinevirtual

Return flags of stream.

Reimplemented from ISstream.

Definition at line 155 of file dummyISstream.H.

◆ flags() [2/2]

virtual ios_base::fmtflags flags ( const ios_base::fmtflags  )
inlinevirtual

Set flags of stream.

Reimplemented from ISstream.

Definition at line 161 of file dummyISstream.H.


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