Ostream.C
Go to the documentation of this file.
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 "word.H"
27 #include "Ostream.H"
28 #include "token.H"
29 #include "keyType.H"
30 #include "IOstreams.H"
31 
32 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
33 
34 // Decrement the indent level
36 {
37  if (indentLevel_ == 0)
38  {
39  cerr<< "Ostream::decrIndent() : attempt to decrement 0 indent level"
40  << std::endl;
41  }
42  else
43  {
44  indentLevel_--;
45  }
46 }
47 
48 
49 // Write keyType
50 // write regular expression as quoted string
51 // write plain word as word (unquoted)
53 {
54  return writeQuoted(kw, kw.isPattern());
55 }
56 
57 
58 // Write the keyword followed by appropriate indentation
60 {
61  indent();
62  write(kw);
63 
64  label nSpaces = entryIndentation_ - label(kw.size());
65 
66  // pattern is surrounded by quotes
67  if (kw.isPattern())
68  {
69  nSpaces -= 2;
70  }
71 
72  // could also increment by indentSize_ ...
73  if (nSpaces < 1)
74  {
75  nSpaces = 1;
76  }
77 
78  while (nSpaces--)
79  {
80  write(char(token::SPACE));
81  }
82 
83  return *this;
84 }
85 
86 
87 // ************************************************************************* //
static const unsigned short entryIndentation_
Indentation of the entry from the start of the keyword.
Definition: Ostream.H:66
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
bool isPattern() const
Should be treated as a match rather than a literal string.
Definition: keyTypeI.H:76
virtual void indent()=0
Add indentation characters.
A class for handling keywords in dictionaries.
Definition: keyType.H:56
Useful combination of include files which define Sin, Sout and Serr and the use of IO streams general...
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:251
unsigned short indentLevel_
Current indent level.
Definition: Ostream.H:69
virtual Ostream & write(const token &)=0
Write next token to stream.
virtual Ostream & writeQuoted(const std::string &, const bool quoted=true)=0
Write std::string surrounded by quotes.
void decrIndent()
Decrememt the indent level.
Definition: Ostream.C:35
Ostream & writeKeyword(const keyType &)
Write the keyword followed by an appropriate indentation.
Definition: Ostream.C:59
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53