src/OpenFOAM/db/IOstreams/IOstreams/Istream.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::Istream
  27
  28 Description
  29     An Istream is an abstract base class for all input systems
  30     (streams, files, token lists etc).  The basic operations
  31     are construct, close, read token, read primitive and read binary
  32     block.
  33
  34     In addition, version control and line number counting is incorporated.
  35     Usually one would use the read primitive member functions, but if one
  36     were reading a stream on unknown data sequence one can read token by
  37     token, and then analyse.
  38
  39 SourceFiles
  40     Istream.C
  41
  42 \*---------------------------------------------------------------------------*/
  43
  44 #ifndef Istream_H
  45 #define Istream_H
  46
  47 #include "IOstream.H"
  48 #include "token.H"
  49
  50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  51
  52 namespace Foam
  53 {
  54
  55 /*---------------------------------------------------------------------------*\
  56                            Class Istream Declaration
  57 \*---------------------------------------------------------------------------*/
  58
  59 class Istream
  60 :
  61     public IOstream
  62 {
  63     // Private data
  64
  65         //- Has a token been put back on the stream
  66         bool putBack_;
  67
  68         //- The last token put back on the stream
  69         token putBackToken_;
  70
  71
  72 public:
  73
  74     // Constructors
  75
  76         //- Set stream status
  77         Istream
  78         (
  79             streamFormat format=ASCII,
  80             versionNumber version=currentVersion,
  81             compressionType compression=UNCOMPRESSED
  82         )
  83         :
  84             IOstream(format, version, compression),
  85             putBack_(false)
  86         {}
  87
  88
  89     // Destructor
  90
  91         virtual ~Istream()
  92         {}
  93
  94
  95     // Member functions
  96
  97         // Read functions
  98
  99             //- Put back token
 100             void putBack(const token&);
 101
 102             //- Get the put back token
 103             bool getBack(token&);
 104
 105              //- Return next token from stream
 106             virtual Istream& read(token&) = 0;
 107
 108             //- Read a character
 109             virtual Istream& read(char&) = 0;
 110
 111             //- Read a word
 112             virtual Istream& read(word&) = 0;
 113
 114             // Read a string (including enclosing double-quotes)
 115             virtual Istream& read(string&) = 0;
 116
 117             //- Read a label
 118             virtual Istream& read(label&) = 0;
 119
 120             //- Read a floatScalar
 121             virtual Istream& read(floatScalar&) = 0;
 122
 123             //- Read a doubleScalar
 124             virtual Istream& read(doubleScalar&) = 0;
 125
 126             //- Read binary block
 127             virtual Istream& read(char*, std::streamsize) = 0;
 128
 129             //- Rewind and return the stream so that it may be read again
 130             virtual Istream& rewind() = 0;
 131
 132
 133         // Read List punctuation tokens
 134
 135             Istream& readBegin(const char* funcName);
 136             Istream& readEnd(const char* funcName);
 137             Istream& readEndBegin(const char* funcName);
 138
 139             char readBeginList(const char* funcName);
 140             char readEndList(const char* funcName);
 141
 142
 143     // Member operators
 144
 145         //- Return a non-const reference to const Istream
 146         //  Needed for read-constructors where the stream argument is temporary:
 147         //  e.g. thing thisThing(IFstream("thingFileName")());
 148         Istream& operator()() const;
 149 };
 150
 151
 152 // --------------------------------------------------------------------
 153 // ------ Manipulators (not taking arguments)
 154 // --------------------------------------------------------------------
 155
 156 typedef Istream& (*IstreamManip)(Istream&);
 157
 158 //- operator>> handling for manipulators without arguments
 159 inline Istream& operator>>(Istream& is, IstreamManip f)
 160 {
 161     return f(is);
 162 }
 163
 164 //- operator>> handling for manipulators without arguments
 165 inline Istream& operator>>(Istream& is, IOstreamManip f)
 166 {
 167     f(is);
 168     return is;
 169 }
 170
 171
 172 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 173
 174 } // End namespace Foam
 175
 176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 177
 178 #ifdef NoRepository
 179 #   include "HashTable.C"
 180 #endif
 181
 182 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 183
 184 #endif
 185
 186 // ************************************************************************* //