]> git.mxchange.org Git - flightgear.git/blob - src/FDM/JSBSim/FGConfigFile.h
Change from JSBSim:
[flightgear.git] / src / FDM / JSBSim / FGConfigFile.h
1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2
3  Header:       FGConfigFile.h
4  Author:       Jon Berndt
5  Date started: 03/29/00
6
7  ------------- Copyright (C) 1999  Jon S. Berndt (jsb@hal-pc.org) -------------
8
9  This program is free software; you can redistribute it and/or modify it under
10  the terms of the GNU General Public License as published by the Free Software
11  Foundation; either version 2 of the License, or (at your option) any later
12  version.
13
14  This program is distributed in the hope that it will be useful, but WITHOUT
15  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
17  details.
18
19  You should have received a copy of the GNU General Public License along with
20  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
21  Place - Suite 330, Boston, MA  02111-1307, USA.
22
23  Further information about the GNU General Public License can also be found on
24  the world wide web at http://www.gnu.org.
25
26 HISTORY
27 --------------------------------------------------------------------------------
28 03/29/00   JSB   Created
29
30 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
31 SENTRY
32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
33
34 #ifndef FGCONFIGFILE_H
35 #define FGCONFIGFILE_H
36
37 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
38 INCLUDES
39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
40
41 #ifdef FGFS
42 #  include <simgear/compiler.h>
43 #  include STL_STRING
44 #  include STL_FSTREAM
45 #  include STL_IOSTREAM
46    SG_USING_STD(string);
47 #  if !defined(SG_HAVE_NATIVE_SGI_COMPILERS)
48      SG_USING_STD(ostream);
49      SG_USING_STD(istream);
50      SG_USING_STD(ifstream);
51      SG_USING_STD(cerr);
52      SG_USING_STD(endl);
53      SG_USING_STD(ios);
54      SG_USING_STD(cout);
55 #  endif
56 #else
57 #  include <string>
58 #  if defined(sgi) && !defined(__GNUC__)
59 #    include <fstream.h>
60 #    include <iostream.h>
61 #  else
62 #    include <fstream>
63 #    include <iostream>
64      using std::ostream;
65      using std::istream;
66      using std::ifstream;
67      using std::ios;
68      using std::cerr;
69      using std::endl;
70      using std::cout;
71 #  endif
72     using std::string;
73 #endif
74
75 #include "FGJSBBase.h"
76
77 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
78 DEFINITIONS
79 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
80
81 #define ID_CONFIGFILE "$Id$"
82
83 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
84 FORWARD DECLARATIONS
85 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
86
87 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
88 COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]
89 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
90
91 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
92 CLASS DOCUMENTATION
93 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
94
95 /** Encapsulates reading a JSBSim config file.
96     JSBSim config files are in XML format.
97     @author Jon S. Berndt
98     @version $Id$
99     @see <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/jsbsim/JSBSim/FGConfigFile.h?rev=HEAD&content-type=text/vnd.viewcvs-markup">
100          Header File </a>
101     @see <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/jsbsim/JSBSim/FGConfigFile.cpp?rev=HEAD&content-type=text/vnd.viewcvs-markup">
102          Source File </a>
103 */
104
105 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
106 CLASS DECLARATION
107 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
108
109 class FGConfigFile : public FGJSBBase
110 {
111 public:
112   /** Constructor
113       @param Filename the name of the config file to be read. */
114   FGConfigFile(string Filename);
115   /// Destructor
116   ~FGConfigFile();
117
118   /** Returns the next line from the currently open config file.
119       Comments are bypassed and ignored.
120       @return the next valid line from the config file OR "EOF" if end of file is
121       reached.*/
122   string GetNextConfigLine(void);
123   
124   string GetCurrentLine(void) { return CurrentLine; }
125
126   /** Returns the value of the tag supplied.
127       @param 
128       @return */
129   string GetValue(string);
130   string GetValue(void);
131   string GetCommentString(void) {return CommentString;}
132   string GetLineComment(void) {return LineComment;}
133   bool IsOpen(void) {return Opened;}
134   FGConfigFile& operator>>(double&);
135   FGConfigFile& operator>>(int&);
136   FGConfigFile& operator>>(string&);
137   void ResetLineIndexToZero(void);
138
139 private:
140   ifstream cfgfile;
141   string   CurrentLine;
142   string   CommentString;
143   string   LineComment;
144   bool     CommentsOn;
145   bool     Opened;
146   unsigned int CurrentIndex;
147   string GetLine(void);
148
149   void Debug(int from);
150 };
151
152 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
153 #endif
154