src/OpenFOAM/db/dictionary/entry/entry.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::entry
  27
  28 Description
  29     A keyword and a list of tokens is an 'entry'.
  30
  31     An entry can be read, written and printed, and the types and values of
  32     its tokens analysed.  An entry is a high-level building block for data
  33     description.  It is a front-end for the token parser. A list of entries
  34     can be used as a set of keyword syntax elements, for example.
  35
  36 SourceFiles
  37     entry.C
  38     entryIO.C
  39
  40 \*---------------------------------------------------------------------------*/
  41
  42 #ifndef entry_H
  43 #define entry_H
  44
  45 #include "keyType.H"
  46 #include "IDLList.H"
  47 #include "fileName.H"
  48 #include "autoPtr.H"
  49
  50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  51
  52 namespace Foam
  53 {
  54
  55 class ITstream;
  56 class dictionary;
  57
  58 // Forward declaration of friend functions and operators
  59
  60 class entry;
  61 Ostream& operator<<(Ostream&, const entry&);
  62
  63 /*---------------------------------------------------------------------------*\
  64                            Class entry Declaration
  65 \*---------------------------------------------------------------------------*/
  66
  67 class entry
  68 :
  69     public IDLList<entry>::link
  70 {
  71     // Private data
  72
  73         //- Keyword of entry
  74         keyType keyword_;
  75
  76
  77     // Private Member Functions
  78
  79         //- Get the next valid keyword otherwise return false
  80         static bool getKeyword(keyType& keyword, Istream& is);
  81
  82
  83 public:
  84
  85     // Constructors
  86
  87         //- Construct from keyword
  88         entry(const keyType& keyword);
  89
  90         //- Construct as copy
  91         entry(const entry&);
  92
  93         //- Construct on freestore as copy with reference to the
  94         //  dictionary the copy belongs to
  95         virtual autoPtr<entry> clone
  96         (
  97             const dictionary& parentDict
  98         ) const = 0;
  99
 100         //- Construct on freestore as copy
 101         //  Note: the parent directory is set to dictionary::null
 102         virtual autoPtr<entry> clone() const;
 103
 104         //- Construct from Istream and insert into dictionary
 105         static bool New(dictionary& parentDict, Istream& is);
 106
 107         //- Construct on freestore from Istream and return
 108         static autoPtr<entry> New(Istream& is);
 109
 110
 111     // Destructor
 112
 113         virtual ~entry()
 114         {}
 115
 116
 117     // Member functions
 118
 119         //- Return keyword
 120         const keyType& keyword() const
 121         {
 122             return keyword_;
 123         }
 124
 125         //- Return non-const access to keyword
 126         keyType& keyword()
 127         {
 128             return keyword_;
 129         }
 130
 131         //- Return the dictionary name
 132         virtual const fileName& name() const = 0;
 133
 134         //- Return the dictionary name
 135         virtual fileName& name() = 0;
 136
 137         //- Return line number of first token in dictionary
 138         virtual label startLineNumber() const = 0;
 139
 140         //- Return line number of last token in dictionary
 141         virtual label endLineNumber() const = 0;
 142
 143         //- Return true if this entry is a stream
 144         virtual bool isStream() const
 145         {
 146             return false;
 147         }
 148
 149         //- Return token stream if this entry is a primitive entry
 150         virtual ITstream& stream() const = 0;
 151
 152         //- Return true if this entry is a dictionary
 153         virtual bool isDict() const
 154         {
 155             return false;
 156         }
 157
 158         //- Return dictionary if this entry is a dictionary
 159         virtual const dictionary& dict() const = 0;
 160
 161         //- Return non-const access to dictionary if this entry is a dictionary
 162         virtual dictionary& dict() = 0;
 163
 164         //- Write
 165         virtual void write(Ostream&) const = 0;
 166
 167
 168     // Member operators
 169
 170         void operator=(const entry&);
 171
 172         bool operator==(const entry&) const;
 173         bool operator!=(const entry&) const;
 174
 175
 176     // Ostream operator
 177
 178         friend Ostream& operator<<(Ostream&, const entry&);
 179 };
 180
 181
 182 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 183
 184 } // End namespace Foam
 185
 186 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 187
 188 #endif
 189
 190 // ************************************************************************* //