File size: 7,000 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::ISstream
Description
Generic input stream.
SourceFiles
ISstreamI.H
ISstream.C
\*---------------------------------------------------------------------------*/
#ifndef ISstream_H
#define ISstream_H
#include "Istream.H"
#include "fileName.H"
#include "DynamicList.H"
#include <iostream>
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class ISstream Declaration
\*---------------------------------------------------------------------------*/
class ISstream
:
public Istream
{
// Private Static Data
//- Initial capacity of the character buffer
static const int bufInitialCapacity = 1024;
//- Amount of the buffer used in error messages. Less than the buffer
// length to facilitate readability.
static const int bufErrorLength = 80;
// Private Data
//- The name of this stream
fileName name_;
//- Reference to the standard stream
istream& is_;
//- Character buffer
DynamicList<char> buf_;
// Private Member Functions
char nextValid();
//- Read a verbatim string (excluding block delimiters).
Istream& readVerbatim(verbatimString&);
//- Read a variable name into a string
Istream& readVariable(string&);
//- Read a delimited set of characters into a string
Istream& readDelimited(string&, const char begin, const char end);
//- Read a work token
void readWordToken(token&);
public:
// Constructors
//- Construct as wrapper around istream
inline ISstream
(
istream& is,
const string& name,
const streamFormat format = ASCII,
const versionNumber version = currentVersion,
const compressionType compression = UNCOMPRESSED
);
//- Destructor
virtual ~ISstream()
{}
// Member Functions
// Inquiry
//- Return the name of the stream
// Useful for Fstream to return the filename
virtual const fileName& name() const
{
return name_;
}
//- Return non-const access to the name of the stream
// Useful to alter the stream name
virtual fileName& name()
{
return name_;
}
//- Return flags of output stream
virtual ios_base::fmtflags flags() const;
// Read functions
//- Low-level get character function.
inline ISstream& get(char&);
//- 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.
inline int peek();
//- Low-level putback character function.
inline ISstream& putback(const char&);
//- Read line into a string
// with optional support for continuation lines
ISstream& getLine(string&, const bool continuation = true);
//- Read a '(...)' delimited set of characters into a string
Istream& readList(string&);
//- Read a '{...}' delimited set of characters into a string
Istream& readBlock(string&);
//- Return next token from stream
virtual Istream& read(token&);
//- Read a character
virtual Istream& read(char&);
//- Read a word
virtual Istream& read(word&);
//- Read a string (including enclosing double-quotes).
// Backslashes are retained, except when escaping double-quotes
// and an embedded newline character.
virtual Istream& read(string&);
//- Read an int32_t
virtual Istream& read(int32_t&);
//- Read an int64_t
virtual Istream& read(int64_t&);
//- Read a uint32_t
virtual Istream& read(uint32_t&);
//- Read a uint64_t
virtual Istream& read(uint64_t&);
//- Read a floatScalar
virtual Istream& read(floatScalar&);
//- Read a doubleScalar
virtual Istream& read(doubleScalar&);
//- Read a longDoubleScalar
virtual Istream& read(longDoubleScalar&);
//- Read binary block
virtual Istream& read(char*, std::streamsize);
//- Rewind and return the stream so that it may be read again
virtual Istream& rewind();
// Stream state functions
//- Set flags of output stream
virtual ios_base::fmtflags flags(const ios_base::fmtflags flags);
// STL stream
//- Access to underlying std::istream
virtual istream& stdStream()
{
return is_;
}
//- Const access to underlying std::istream
virtual const istream& stdStream() const
{
return is_;
}
// Print
//- Print description of IOstream to Ostream
virtual void print(Ostream&) const;
// Member Operators
//- Disallow default bitwise assignment
void operator=(const ISstream&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "ISstreamI.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|