Input from file stream as an ISstream, normally using std::ifstream
for the actual input.
More...
Public Member Functions | |
ClassName ("IFstream") | |
Declare type-name (with debug switch) More... | |
IFstream (const fileName &pathname, IOstreamOption streamOpt=IOstreamOption()) | |
Construct from pathname, default or specified stream options. More... | |
IFstream (const fileName &pathname, IOstreamOption::streamFormat fmt) | |
Construct from pathname and format. More... | |
~IFstream ()=default | |
Destructor. More... | |
std::streamsize | fileSize () const |
Return the size of the underlying file (-1 on error). This corresponds to Foam::fileSize() but with extra handling of compressed files. More... | |
virtual std::istream & | stdStream () override |
Access to underlying std::istream. More... | |
virtual const std::istream & | stdStream () const override |
Const access to underlying std::istream. More... | |
virtual void | rewind () override |
Rewind the stream so that it may be read again. More... | |
virtual void | print (Ostream &os) const override |
Print stream description. More... | |
IFstream & | operator() () const |
Return a non-const reference to const IFstream. More... | |
ISstream & | get (char &c) |
Get character(s) More... | |
virtual const fileName & | name () const override |
Read/write access to the name of the stream. More... | |
virtual fileName & | name () |
Read/write access to the name of the stream. 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::compressionType cmp=IOstreamOption::UNCOMPRESSED) | |
Construct wrapper around std::istream, set stream status. More... | |
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. More... | |
virtual | ~ISstream ()=default |
Destructor. More... | |
virtual const fileName & | name () const override |
The name of the input serial stream. (eg, the name of the Fstream file name) More... | |
virtual fileName & | name () |
The name of the input serial stream, for modification. More... | |
virtual std::ios_base::fmtflags | flags () const override |
Return current stream flags. More... | |
virtual std::ios_base::fmtflags | flags (std::ios_base::fmtflags f) override |
Set stream flags, return old stream flags. More... | |
void | syncState () |
Set stream state to match that of the std::istream. More... | |
**return False if stream exhausted before finding the comment end *bool | seekCommentEnd_Cstyle () |
Discard until end of C-style comment '. More... | |
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. 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 (until delimiter) into a string. More... | |
std::streamsize | getLine (std::nullptr_t, char delim='\n') |
Low-level discard until delimiter. More... | |
ISstream & | putback (const char c) |
Raw, low-level putback character function. More... | |
virtual Istream & | read (token &t) override |
Return next token from stream. More... | |
virtual Istream & | read (char &c) override |
Read a character. More... | |
virtual Istream & | read (word &str) override |
Read a word. More... | |
virtual Istream & | read (string &str) override |
Read a string (including enclosing double-quotes). More... | |
virtual Istream & | read (label &val) override |
Read a label. More... | |
virtual Istream & | read (float &val) override |
Read a float. More... | |
virtual Istream & | read (double &val) override |
Read a double. More... | |
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. More... | |
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. More... | |
virtual bool | beginRawRead () override |
Start of low-level raw binary read. More... | |
virtual bool | endRawRead () override |
End of low-level raw binary read. More... | |
Public Member Functions inherited from Istream | |
Istream (const Istream &)=default | |
Copy construct. More... | |
virtual | ~Istream ()=default |
Destructor. More... | |
Istream (IOstreamOption streamOpt=IOstreamOption()) | |
Default construct (ASCII, uncompressed), construct with specified stream option. More... | |
Istream (IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED) | |
Construct with format (uncompressed) More... | |
const token & | peekBack () const noexcept |
Examine putback token without removing it. More... | |
void | putBackClear () |
Drop the putback token. More... | |
void | putBack (const token &tok) |
Put back a token (copy). Only a single put back is permitted. More... | |
void | putBack (token &&tok) |
Put back a token (move). Only a single put back is permitted. More... | |
bool | getBack (token &tok) |
Retrieve the put-back token if there is one. 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 IOstream &)=default | |
Copy construct. More... | |
virtual | ~IOstream ()=default |
Destructor. More... | |
IOstream (IOstreamOption streamOpt=IOstreamOption()) | |
Default construct (ASCII, uncompressed), construct with specified stream option. More... | |
IOstream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED) | |
Construct with format, version (compression) 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 |
Check if the label byte-size associated with the stream is the same as the given type. More... | |
template<class T = scalar> | |
std::enable_if< std::is_floating_point< T >::value, bool >::type | checkScalarSize () const noexcept |
Check if the scalar byte-size associated with the stream is the same as the given type. More... | |
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... | |
void | setEof () noexcept |
Set stream state as reached 'eof'. More... | |
void | setFail () noexcept |
Set stream state as 'failed'. More... | |
void | setBad () noexcept |
Set stream state to be 'bad'. More... | |
std::ios_base::fmtflags | setf (std::ios_base::fmtflags f) |
Set stream flag(s), return old stream flags. More... | |
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. More... | |
void | unsetf (std::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 noexcept |
Return info proxy, used to print IOstream information to a stream. More... | |
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. More... | |
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... | |
Static Public Member Functions | |
static DynamicList< char > | readContents (const fileName &pathname) |
Get file contents from specified file (compressed/uncompressed). Returns an empty list if the file cannot be opened. More... | |
static DynamicList< char > | readContents (IFstream &ifs) |
Get file contents from IFstream (assumed to be rewound) 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 unsigned int | minPrecision (unsigned int prec) noexcept |
Set the minimum default precision. More... | |
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). More... | |
static floatFormat | floatFormatEnum (const word &key, const dictionary &dict, const floatFormat deflt=floatFormat::general) |
getOrDefault floatFormat from dictionary, warn only on bad enumeration. More... | |
static streamFormat | formatEnum (const word &fmtName, const streamFormat deflt=streamFormat::ASCII) |
Lookup streamFormat enum corresponding to the string (ascii | binary). More... | |
static streamFormat | formatEnum (const word &key, const dictionary &dict, const streamFormat deflt=streamFormat::ASCII) |
getOrDefault streamFormat from dictionary, warn only on bad enumeration. 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) |
getOrDefault compressionType from dictionary, warn only on bad enumeration. 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... | |
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 | 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 Attributes inherited from IOstream | |
static unsigned int | precision_ |
Default precision. More... | |
Static Public Attributes inherited from IOstreamOption | |
static const Enum< floatFormat > | floatFormatNames |
Names for float formats (general, fixed, scientific) More... | |
static const Enum< streamFormat > | formatNames |
Stream format names (ascii, binary) More... | |
static const versionNumber | currentVersion |
The current version number (2.0) 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 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... | |
Input from file stream as an ISstream, normally using std::ifstream
for the actual input.
Definition at line 51 of file IFstream.H.
|
explicit |
Construct from pathname, default or specified stream options.
Definition at line 149 of file IFstream.C.
References IOstreamOption::COMPRESSED, IOstreamOption::compression(), Foam::ensightOutput::debug, Foam::endl(), ifstreamPointer::get(), InfoInFunction, Foam::name(), and ifstreamPointer::whichCompression().
|
inline |
Construct from pathname and format.
Definition at line 79 of file IFstream.H.
|
default |
Destructor.
ClassName | ( | "IFstream" | ) |
Declare type-name (with debug switch)
|
static |
Get file contents from specified file (compressed/uncompressed). Returns an empty list if the file cannot be opened.
Definition at line 130 of file IFstream.C.
References IOstreamOption::BINARY, and IOstream::good().
|
static |
Get file contents from IFstream (assumed to be rewound)
Definition at line 36 of file IFstream.C.
References DynamicList< T, SizeMin >::capacity(), DynamicList< T, SizeMin >::clear(), IOstreamOption::COMPRESSED, IOstreamOption::compression(), UList< T >::data(), IFstream::fileSize(), Foam::max(), ISstream::readRaw(), DynamicList< T, SizeMin >::resize(), DynamicList< T, SizeMin >::setCapacity(), UList< T >::size_bytes(), and IFstream::stdStream().
std::streamsize fileSize | ( | ) | const |
Return the size of the underlying file (-1 on error). This corresponds to Foam::fileSize() but with extra handling of compressed files.
The return type is std::streamsize
instead of off_t
.
Definition at line 200 of file IFstream.C.
References IOstreamOption::COMPRESSED, Foam::fileSize(), ifstreamPointer::get(), Foam::name(), and ifstreamPointer::whichCompression().
Referenced by IFstream::readContents().
|
overridevirtual |
Access to underlying std::istream.
Reimplemented from ISstream.
Definition at line 239 of file IFstream.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and ifstreamPointer::get().
Referenced by Foam::getPrimitive(), ensightReadFile::getTimeStepFooter(), IFstream::readContents(), and Foam::readEnsightString().
|
overridevirtual |
Const access to underlying std::istream.
Reimplemented from ISstream.
Definition at line 254 of file IFstream.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and ifstreamPointer::get().
|
overridevirtual |
Rewind the stream so that it may be read again.
Includes special handling for compressed streams.
Reimplemented from ISstream.
Definition at line 269 of file IFstream.C.
References IOstreamOption::COMPRESSED, ifstreamPointer::get(), Foam::name(), ifstreamPointer::reopen_gz(), ISstream::rewind(), and ifstreamPointer::whichCompression().
|
overridevirtual |
Print stream description.
Reimplemented from ISstream.
Definition at line 284 of file IFstream.C.
References os(), and ISstream::print().
Foam::IFstream & operator() | ( | ) | const |
Return a non-const reference to const IFstream.
Needed for read-constructors where the stream argument is temporary: e.g. thing thisThing(IFstream("fileName")());
Definition at line 293 of file IFstream.C.
References Foam::check(), Foam::exit(), IOerror::exit(), Foam::FatalIOError, FatalIOErrorInFunction, FUNCTION_NAME, Foam::isFile(), and Foam::name().
|
inline |
Get character(s)
Definition at line 49 of file ISstreamI.H.
|
inlineoverride |
Read/write access to the name of the stream.
Definition at line 147 of file ISstream.H.
Referenced by NASedgeFormat::read(), STARCDsurfaceFormat< Face >::read(), NASsurfaceFormat< Face >::read(), STARCDedgeFormat::read(), ensightSurfaceReader::readField(), ensightSurfaceReader::readGeometry(), STARCDCore::readHeader(), and STARCDCore::readPoints().
|
inline |
Read/write access to the name of the stream.
Definition at line 155 of file ISstream.H.