doxygenXmlParser.H
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) 2012-2013 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 Class
25  Foam::doxygenXmlParser
26 
27 Description
28  Parser for doxygen XML
29 
30 SourceFiles
31  doxygenXmlParser.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef doxygenXmlParser_H
36 #define doxygenXmlParser_H
37 
38 #include "dictionary.H"
39 #include "IFstream.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class doxygenXmlParser Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class doxygenXmlParser
51 :
52  public dictionary
53 {
54 
55 public:
56 
57  //- Construct from components
59  (
60  const fileName& fName,
61  const string& startTag,
62  const string& searchStr,
63  const bool exactMatch
64  );
65 
66 
67  // Member functions
68 
69  //- Skip past a block
70  void skipBlock(IFstream& is, const word& blockName) const;
71 
72  //- Skip forward to block
73  void skipForward(IFstream& is, const word& blockName) const;
74 
75  //- Return the entry
76  template<class Type>
77  void getEntry(IFstream& is, Type& entry) const;
78 
79  //- Return the entry value
80  template<class Type>
81  void getValue(IFstream& is, Type& entry) const;
82 };
83 
84 
85 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
86 
87 } // End namespace Foam
88 
89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 
91 #ifdef NoRepository
93 #endif
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 #endif
98 
99 // ************************************************************************* //
void getValue(IFstream &is, Type &entry) const
Return the entry value.
A class for handling file names.
Definition: fileName.H:69
doxygenXmlParser(const fileName &fName, const string &startTag, const string &searchStr, const bool exactMatch)
Construct from components.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
void skipForward(IFstream &is, const word &blockName) const
Skip forward to block.
A class for handling words, derived from string.
Definition: word.H:59
void getEntry(IFstream &is, Type &entry) const
Return the entry.
Input from file stream.
Definition: IFstream.H:81
Parser for doxygen XML.
void skipBlock(IFstream &is, const word &blockName) const
Skip past a block.
Namespace for OpenFOAM.
A keyword and a list of tokens is an &#39;entry&#39;.
Definition: entry.H:65