Generic input stream using standard (STL) streams. More...
Public Member Functions | |
ISstream (std::istream &is, const string &name, streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED) | |
Construct as wrapper around std::istream. More... | |
virtual | ~ISstream ()=default |
Destructor. More... | |
virtual const fileName & | name () const |
Return the name of the stream. More... | |
virtual fileName & | name () |
Return non-const access to the name of the stream. More... | |
virtual ios_base::fmtflags | flags () const |
Return flags of output stream. More... | |
ISstream & | get (char &c) |
Raw, low-level get character function. More... | |
int | peek () |
Raw, low-level peek function. More... | |
ISstream & | getLine (std::string &str, char delim='\n') |
Raw, low-level getline into a string function. More... | |
ISstream & | putback (const char c) |
Raw, low-level putback character function. More... | |
virtual Istream & | read (token &t) |
Return next token from stream. More... | |
virtual Istream & | read (char &c) |
Read a character. More... | |
virtual Istream & | read (word &str) |
Read a word. More... | |
virtual Istream & | read (string &str) |
Read a string (including enclosing double-quotes). More... | |
virtual Istream & | read (label &val) |
Read a label. More... | |
virtual Istream & | read (floatScalar &val) |
Read a floatScalar. More... | |
virtual Istream & | read (doubleScalar &val) |
Read a doubleScalar. More... | |
virtual Istream & | read (char *buf, std::streamsize count) |
Read binary block. More... | |
virtual Istream & | readRaw (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 description of IOstream to Ostream. More... | |
Public Member Functions inherited from Istream | |
Istream (streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED) | |
Construct and set stream status. More... | |
virtual | ~Istream ()=default |
Destructor. More... | |
void | putBack (const token &tok) |
Put back token. More... | |
bool | getBack (token &tok) |
Get the put back token if there is one and return true. More... | |
bool | peekBack (token &tok) |
Peek at the put back token without removing it. 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... | |
Istream & | operator() () const |
Return a non-const reference to const Istream. More... | |
Public Member Functions inherited from IOstream | |
IOstream (const IOstreamOption option) | |
Construct with specified stream option. More... | |
IOstream (streamFormat format, versionNumber version, compressionType compression=UNCOMPRESSED) | |
Construct with format, version. More... | |
virtual | ~IOstream ()=default |
Destructor. More... | |
virtual bool | check (const char *operation) const |
Check IOstream status for given operation. More... | |
void | fatalCheck (const char *operation) const |
Check IOstream status for given operation. More... | |
bool | opened () const |
Return true if stream has been opened. More... | |
bool | closed () const |
Return true if stream is closed. More... | |
bool | good () const |
Return true if next operation might succeed. More... | |
bool | eof () const |
Return true if end of input seen. More... | |
bool | fail () const |
Return true if next operation will fail. More... | |
bool | bad () const |
Return true if stream is corrupted. More... | |
operator bool () const | |
Return true if the stream has not failed. More... | |
bool | operator! () const |
Return true if the stream has failed. More... | |
unsigned | labelByteSize () const |
The label byte-size associated with the stream. More... | |
unsigned | scalarByteSize () const |
The scalar byte-size associated with the stream. More... | |
void | setLabelByteSize (unsigned nbytes) |
Set the label byte-size associated with the stream. More... | |
void | setScalarByteSize (unsigned nbytes) |
Set the scalar byte-size associated with the stream. More... | |
template<class T = label> | |
std::enable_if< std::is_integral< T >::value, bool >::type | checkLabelSize () const |
template<class T = scalar> | |
std::enable_if< std::is_floating_point< T >::value, bool >::type | checkScalarSize () const |
label | lineNumber () const |
Const access to the current stream line number. More... | |
label & | lineNumber () |
Non-const access to the current stream line number. More... | |
label | lineNumber (const label num) |
Set the stream line number. More... | |
void | setEof () |
Set stream to have reached eof. More... | |
void | setFail () |
Set stream to have failed. More... | |
void | setBad () |
Set stream to be bad. 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... | |
void | print (Ostream &os, const int streamState) const |
Print information about the stream state bits. More... | |
InfoProxy< IOstream > | info () const |
Return info proxy. More... | |
Public Member Functions inherited from IOstreamOption | |
IOstreamOption () noexcept | |
Construct null. (default: ASCII, uncompressed, currentVersion) More... | |
IOstreamOption (streamFormat format) noexcept | |
Construct with format. (default: uncompressed, currentVersion) More... | |
IOstreamOption (streamFormat format, compressionType compression, versionNumber version=currentVersion) noexcept | |
Construct with format and compression, optionally with version. More... | |
IOstreamOption (streamFormat format, versionNumber version, compressionType compression) noexcept | |
Construct with format, version, compression. More... | |
streamFormat | format () const noexcept |
Get the current stream format. More... | |
streamFormat | format (const streamFormat format) 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 &compressionName) |
Set the stream compression, from string value. More... | |
versionNumber | version () const noexcept |
Get the stream version. More... | |
versionNumber | version (const versionNumber verNum) noexcept |
Set the stream version. 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, 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 () |
Return the default precision. More... | |
static unsigned int | defaultPrecision (unsigned int prec) |
Reset the default precision. More... | |
Static Public Member Functions inherited from IOstreamOption | |
static streamFormat | formatEnum (const word &formatName) |
The stream format enum corresponding to the string. More... | |
static compressionType | compressionEnum (const word &compName) |
The compression enum corresponding to the string. More... | |
Static Public Attributes inherited from IOstream | |
static unsigned int | precision_ |
Default precision. More... | |
Static Public Attributes inherited from IOstreamOption | |
static const Enum< streamFormat > | formatNames |
Stream format names (ascii, binary) More... | |
static const versionNumber | originalVersion |
The original version number. More... | |
static const versionNumber | currentVersion |
The current version number. More... | |
Protected Member Functions inherited from IOstream | |
void | setOpened () |
Set stream opened. More... | |
void | setClosed () |
Set stream closed. More... | |
void | setState (ios_base::iostate state) |
Set stream state. More... | |
void | setGood () |
Set stream to be good. More... | |
Protected Attributes inherited from IOstream | |
streamAccess | openClosed_ |
ios_base::iostate | ioState_ |
unsigned short | labelByteSize_ |
The label byte-size (could also be stored as byte) More... | |
unsigned short | scalarByteSize_ |
The scalar byte-size (could also be stored as byte) 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... | |
Generic input stream using standard (STL) streams.
Definition at line 54 of file ISstream.H.
|
inline |
Construct as wrapper around std::istream.
Definition at line 32 of file ISstreamI.H.
|
virtualdefault |
Destructor.
|
inlinevirtual |
Return the name of the stream.
Useful for Fstream to return the filename
Reimplemented from IOstream.
Definition at line 111 of file ISstream.H.
Referenced by dynamicCode::copyAndFilter(), IStringStream::print(), ISstream::print(), FIREMeshReader::readCells(), FIREMeshReader::readFaces(), and FIRECore::readPoints().
|
inlinevirtual |
Return non-const access to the name of the stream.
Useful to alter the stream name
Reimplemented from IOstream.
Definition at line 118 of file ISstream.H.
|
virtual |
Return flags of output stream.
Implements IOstream.
Reimplemented in dummyISstream.
Definition at line 866 of file ISstream.C.
|
inline |
Raw, low-level get character function.
Definition at line 58 of file ISstreamI.H.
References Foam::constant::universal::c, IOstream::good(), IOstream::lineNumber_, and IOstream::setState().
Referenced by Foam::ReadHex(), and Foam::readToNewline().
|
inline |
Raw, low-level peek function.
Does not remove the character from the stream. Returns the next character in the stream or EOF if the end of file is read.
Definition at line 72 of file ISstreamI.H.
|
inline |
Raw, low-level getline into a string function.
Definition at line 78 of file ISstreamI.H.
Referenced by dynamicCode::copyAndFilter(), AC3DsurfaceFormatCore::cueTo(), FIRECore::getFireString(), surfaceFormatsCore::getLineNoComment(), edgeMeshFormatsCore::getLineNoComment(), csvTableReader< Type >::operator()(), ensightReadFile::read(), NASedgeFormat::read(), AC3DsurfaceFormat< Face >::read(), NASsurfaceFormat< Face >::read(), AC3DsurfaceFormatCore::readCmd(), externalCoupledMixedFvPatchField< scalar >::readData(), externalCoupledTemperatureMixedFvPatchScalarField::readData(), STARCDsurfaceFormatCore::readInpCellTable(), ensightSurfaceReader::readLine(), and lumpedPointState::readPlain().
|
inline |
Raw, low-level putback character function.
Definition at line 92 of file ISstreamI.H.
References Foam::constant::universal::c.
|
virtual |
Return next token from stream.
Implements Istream.
Reimplemented in dummyISstream.
Definition at line 158 of file ISstream.C.
References token::ADD, token::ASSIGN, token::BEGIN_BLOCK, token::BEGIN_LIST, token::BEGIN_SQR, token::BEGIN_STRING, Foam::constant::universal::c, Foam::charToWord(), token::COLON, token::COMMA, token::DIVIDE, token::DOLLAR, token::END_BLOCK, token::END_LIST, token::END_SQR, token::END_STATEMENT, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Istream::getBack(), token::HASH, token::lineNumber(), token::MULTIPLY, Foam::read(), token::setBad(), token::setType(), token::SUBTRACT, and Foam::val.
Referenced by Foam::getToken(), STARCDsurfaceFormat< Face >::read(), STARCDedgeFormat::read(), STARCDMeshReader::readBoundary(), STARCDMeshReader::readCells(), STARCDMeshReader::readPoints(), and STARCDCore::readPoints().
|
virtual |
Read a character.
Implements Istream.
Reimplemented in dummyISstream.
Definition at line 398 of file ISstream.C.
References Foam::constant::universal::c.
|
virtual |
Read a word.
Implements Istream.
Reimplemented in dummyISstream.
Definition at line 405 of file ISstream.C.
References token::BEGIN_LIST, Foam::constant::universal::c, token::END_LIST, Foam::endl(), errLen, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, IOWarningInFunction, Foam::nl, and word::valid().
|
virtual |
Read a string (including enclosing double-quotes).
Backslashes are retained, except when escaping double-quotes and an embedded newline character.
Implements Istream.
Reimplemented in ensightReadFile, and dummyISstream.
Definition at line 486 of file ISstream.C.
References token::BEGIN_STRING, Foam::constant::universal::c, token::END_STRING, errLen, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and token::NL.
|
virtual |
Read a label.
Implements Istream.
Reimplemented in ensightReadFile, and dummyISstream.
Definition at line 784 of file ISstream.C.
References Foam::val.
|
virtual |
Read a floatScalar.
Implements Istream.
Reimplemented in dummyISstream.
Definition at line 792 of file ISstream.C.
References Foam::val.
|
virtual |
Read a doubleScalar.
Implements Istream.
Reimplemented in dummyISstream.
Definition at line 800 of file ISstream.C.
References Foam::val.
|
virtual |
Read binary block.
Implements Istream.
Reimplemented in ensightReadFile, and dummyISstream.
Definition at line 808 of file ISstream.C.
References Foam::BitOps::count().
|
virtual |
Low-level raw binary read.
Implements Istream.
Reimplemented in dummyISstream.
Definition at line 818 of file ISstream.C.
References Foam::BitOps::count(), and Istream::read().
|
virtual |
Start of low-level raw binary read.
Implements Istream.
Reimplemented in dummyISstream.
Definition at line 827 of file ISstream.C.
References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and format().
|
virtual |
End of low-level raw binary read.
Implements Istream.
Reimplemented in dummyISstream.
Definition at line 843 of file ISstream.C.
|
virtual |
Rewind the stream so that it may be read again.
Implements Istream.
Reimplemented in UIListStream, IListStream, dummyISstream, and IFstream.
Definition at line 852 of file ISstream.C.
Referenced by IStringStream::reset(), IFstream::rewind(), simpleObjectRegistry::setNamedInt(), and simpleObjectRegistry::setValues().
|
virtual |
Set stream flags.
Implements IOstream.
Reimplemented in dummyISstream.
Definition at line 872 of file ISstream.C.
References f().
|
inlinevirtual |
Access to underlying std::istream.
Reimplemented in IFstream.
Definition at line 192 of file ISstream.H.
Referenced by FIRECore::getFireLabel(), FIRECore::getFirePoint(), FIRECore::getFireString(), and Foam::tellg().
|
inlinevirtual |
Const access to underlying std::istream.
Reimplemented in IFstream.
Definition at line 198 of file ISstream.H.
|
virtual |
Print description of IOstream to Ostream.
Reimplemented from IOstream.
Reimplemented in UIListStream, IListStream, IStringStream, and IFstream.
Definition at line 36 of file SstreamsPrint.C.
References ISstream::name(), and IOstream::print().
Referenced by IFstream::print(), and IStringStream::print().