/usr/include/freefoam/OpenFOAM/Istream.H is in libfreefoam-dev 0.1.0+dfsg-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
\\/ 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::Istream
Description
An Istream is an abstract base class for all input systems
(streams, files, token lists etc). The basic operations
are construct, close, read token, read primitive and read binary
block.
In addition, version control and line number counting is incorporated.
Usually one would use the read primitive member functions, but if one
were reading a stream on unknown data sequence one can read token by
token, and then analyse.
SourceFiles
Istream.C
\*---------------------------------------------------------------------------*/
#ifndef Istream_H
#define Istream_H
#include "IOstream.H"
#include <OpenFOAM/token.H>
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class Istream Declaration
\*---------------------------------------------------------------------------*/
class Istream
:
public IOstream
{
// Private data
//- Has a token been put back on the stream
bool putBack_;
//- The last token put back on the stream
token putBackToken_;
public:
// Constructors
//- Set stream status
Istream
(
streamFormat format=ASCII,
versionNumber version=currentVersion,
compressionType compression=UNCOMPRESSED
)
:
IOstream(format, version, compression),
putBack_(false)
{}
// Destructor
virtual ~Istream()
{}
// Member functions
// Read functions
//- Put back token
void putBack(const token&);
//- Get the put back token
bool getBack(token&);
//- Return next token from stream
virtual Istream& read(token&) = 0;
//- Read a character
virtual Istream& read(char&) = 0;
//- Read a word
virtual Istream& read(word&) = 0;
// Read a string (including enclosing double-quotes)
virtual Istream& read(string&) = 0;
//- Read a label
virtual Istream& read(label&) = 0;
//- Read a floatScalar
virtual Istream& read(floatScalar&) = 0;
//- Read a doubleScalar
virtual Istream& read(doubleScalar&) = 0;
//- Read binary block
virtual Istream& read(char*, std::streamsize) = 0;
//- Rewind and return the stream so that it may be read again
virtual Istream& rewind() = 0;
// Read List punctuation tokens
Istream& readBegin(const char* funcName);
Istream& readEnd(const char* funcName);
Istream& readEndBegin(const char* funcName);
char readBeginList(const char* funcName);
char readEndList(const char* funcName);
// Member operators
//- Return a non-const reference to const Istream
// Needed for read-constructors where the stream argument is temporary:
// e.g. thing thisThing(IFstream("thingFileName")());
Istream& operator()() const;
};
// --------------------------------------------------------------------
// ------ Manipulators (not taking arguments)
// --------------------------------------------------------------------
typedef Istream& (*IstreamManip)(Istream&);
//- operator>> handling for manipulators without arguments
inline Istream& operator>>(Istream& is, IstreamManip f)
{
return f(is);
}
//- operator>> handling for manipulators without arguments
inline Istream& operator>>(Istream& is, IOstreamManip f)
{
f(is);
return is;
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
# include <OpenFOAM/HashTable.C>
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************ vim: set sw=4 sts=4 et: ************************ //
|