wordIO.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2019 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 "word.H"
27 #include "IOstreams.H"
28 
29 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
30 
32 :
33  string()
34 {
35  is >> *this;
36 }
37 
38 
40 {
41  token t(is);
42 
43  if (!t.good())
44  {
45  is.setBad();
46  return is;
47  }
48 
49  if (t.isWord())
50  {
51  w = t.wordToken();
52  }
53  else if (t.isString())
54  {
55  // Convert string to word stripping invalid characters
56  w = t.stringToken();
57  string::stripInvalid<word>(w);
58 
59  // flag empty strings and bad chars as an error
60  if (w.empty() || w.size() != t.stringToken().size())
61  {
62  is.setBad();
64  << "wrong token type - expected word, found "
65  "non-word characters "
66  << t.info()
67  << exit(FatalIOError);
68  return is;
69  }
70  }
71  else
72  {
73  is.setBad();
75  << "wrong token type - expected word, found "
76  << t.info()
77  << exit(FatalIOError);
78 
79  return is;
80  }
81 
82  // Check state of IOstream
83  is.check("Istream& operator>>(Istream&, word&)");
84 
85  return is;
86 }
87 
88 
90 {
91  os.write(w);
92  os.check("Ostream& operator<<(Ostream&, const word&)");
93  return os;
94 }
95 
96 
97 // ************************************************************************* //
bool isWord() const
Definition: tokenI.H:261
virtual Ostream & write(const char)=0
Write character.
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
virtual bool check(const char *operation) const
Check IOstream status for given operation.
Definition: IOstream.C:92
InfoProxy< token > info() const
Return info proxy.
Definition: token.H:391
const word & wordToken() const
Definition: tokenI.H:266
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
A token holds items read from Istream.
Definition: token.H:72
word()
Construct null.
Definition: wordI.H:59
Useful combination of include files which define Sin, Sout and Serr and the use of IO streams general...
void setBad()
Set stream to be bad.
Definition: IOstream.H:484
A class for handling words, derived from string.
Definition: word.H:59
Istream & operator>>(Istream &, directionInfo &)
bool good() const
Definition: tokenI.H:228
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
const string & stringToken() const
Definition: tokenI.H:320
bool isString() const
Definition: tokenI.H:315
#define FatalIOErrorInFunction(ios)
Report an error message using Foam::FatalIOError.
Definition: error.H:335
Ostream & operator<<(Ostream &, const ensightPart &)
A class for handling character strings derived from std::string.
Definition: string.H:76
IOerror FatalIOError