src/OpenFOAM/db/dictionary/dictionaryIO.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 \*---------------------------------------------------------------------------*/
  25
  26 #include "dictionary.H"
  27 #include "IFstream.H"
  28 #include "inputModeEntry.H"
  29 #include "regExp.H"
  30
  31 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  32
  33 Foam::dictionary::dictionary
  34 (
  35     const fileName& name,
  36     const dictionary& parentDict,
  37     Istream& is
  38 )
  39 :
  40     dictionaryName(parentDict.name() + "::" + name),
  41     parent_(parentDict)
  42 {
  43     read(is);
  44 }
  45
  46
  47 Foam::dictionary::dictionary(Istream& is)
  48 :
  49     dictionaryName(is.name()),
  50     parent_(dictionary::null)
  51 {
  52     // Reset input mode as this is a "top-level" dictionary
  53     functionEntries::inputModeEntry::clear();
  54
  55     read(is);
  56 }
  57
  58
  59 Foam::dictionary::dictionary(Istream& is, const bool keepHeader)
  60 :
  61     dictionaryName(is.name()),
  62     parent_(dictionary::null)
  63 {
  64     // Reset input mode as this is a "top-level" dictionary
  65     functionEntries::inputModeEntry::clear();
  66
  67     read(is, keepHeader);
  68 }
  69
  70
  71 // * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * * //
  72
  73 Foam::autoPtr<Foam::dictionary> Foam::dictionary::New(Istream& is)
  74 {
  75     return autoPtr<dictionary>(new dictionary(is));
  76 }
  77
  78
  79 // * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * * //
  80
  81 bool Foam::dictionary::read(Istream& is, const bool keepHeader)
  82 {
  83     if (!is.good())
  84     {
  85         FatalIOErrorIn("dictionary::read(Istream&, bool)", is)
  86             << "Istream not OK for reading dictionary "
  87             << exit(FatalIOError);
  88
  89         return false;
  90     }
  91
  92     token currToken(is);
  93     if (currToken != token::BEGIN_BLOCK)
  94     {
  95         is.putBack(currToken);
  96     }
  97
  98     while (!is.eof() && entry::New(*this, is))
  99     {}
 100
 101     // normally remove the FoamFile header entry if it exists
 102     if (!keepHeader)
 103     {
 104         remove("FoamFile");
 105     }
 106
 107     if (is.bad())
 108     {
 109         Info<< "dictionary::read(Istream&, bool) : "
 110             << "Istream not OK after reading dictionary " << name()
 111             << endl;
 112
 113         return false;
 114     }
 115
 116     return true;
 117 }
 118
 119
 120 bool Foam::dictionary::read(Istream& is)
 121 {
 122     return this->read(is, false);
 123 }
 124
 125
 126 bool Foam::dictionary::substituteKeyword(const word& keyword)
 127 {
 128     word varName = keyword(1, keyword.size()-1);
 129
 130     // lookup the variable name in the given dictionary
 131     const entry* ePtr = lookupEntryPtr(varName, true, true);
 132
 133     // if defined insert its entries into this dictionary
 134     if (ePtr != NULL)
 135     {
 136         const dictionary& addDict = ePtr->dict();
 137
 138         forAllConstIter(IDLList<entry>, addDict, iter)
 139         {
 140             add(iter());
 141         }
 142
 143         return true;
 144     }
 145
 146     return false;
 147 }
 148
 149
 150 // * * * * * * * * * * * * * * Istream Operator  * * * * * * * * * * * * * * //
 151
 152 Foam::Istream& Foam::operator>>(Istream& is, dictionary& dict)
 153 {
 154     // Reset input mode assuming this is a "top-level" dictionary
 155     functionEntries::inputModeEntry::clear();
 156
 157     dict.clear();
 158     dict.name() = is.name();
 159     dict.read(is);
 160
 161     return is;
 162 }
 163
 164
 165 // * * * * * * * * * * * * * * Ostream Operator  * * * * * * * * * * * * * * //
 166
 167 void Foam::dictionary::write(Ostream& os, bool subDict) const
 168 {
 169     if (subDict)
 170     {
 171         os  << nl << indent << token::BEGIN_BLOCK << incrIndent << nl;
 172     }
 173
 174     forAllConstIter(IDLList<entry>, *this, iter)
 175     {
 176         const entry& e = *iter;
 177
 178         // Write entry
 179         os  << e;
 180
 181         // Add extra new line between entries for "top-level" dictionaries
 182         if (!subDict && parent() == dictionary::null && e != *last())
 183         {
 184             os  << nl;
 185         }
 186
 187         // Check stream before going to next entry.
 188         if (!os.good())
 189         {
 190             WarningIn("dictionary::write(Ostream&, bool subDict)")
 191                 << "Can't write entry " << iter().keyword()
 192                 << " for dictionary " << name()
 193                 << endl;
 194         }
 195     }
 196
 197     if (subDict)
 198     {
 199         os  << decrIndent << indent << token::END_BLOCK << endl;
 200     }
 201 }
 202
 203
 204 Foam::Ostream& Foam::operator<<(Ostream& os, const dictionary& dict)
 205 {
 206     dict.write(os, true);
 207     return os;
 208 }
 209
 210
 211 // ************************************************************************* //