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    SG_USING_STD(ostream);
  48    SG_USING_STD(istream);
  49    SG_USING_STD(ifstream);
  50    SG_USING_STD(cerr);
  51    SG_USING_STD(endl);
  52    SG_USING_STD(ios);
  53    SG_USING_STD(cout);
  54 #else
  55 #  include <string>
  56 #  if defined(sgi) && !defined(__GNUC__) && (_COMPILER_VERSION < 740)
  57 #    include <fstream.h>
  58 #    include <iostream.h>
  59 #  else
  60 #    include <fstream>
  61 #    include <iostream>
  62      using std::ostream;
  63      using std::istream;
  64      using std::ios;
  65      using std::cerr;
  66      using std::cout;
  67      using std::ifstream;
  68      using std::endl;
  69 #  endif
  70     using std::string;
  71 #endif
  72
  73 #include "FGJSBBase.h"
  74
  75 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  76 DEFINITIONS
  77 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  78
  79 #define ID_CONFIGFILE "$Id$"
  80
  81 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  82 FORWARD DECLARATIONS
  83 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  84
  85 namespace JSBSim {
  86
  87 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  88 CLASS DOCUMENTATION
  89 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  90
  91 /** Encapsulates reading a JSBSim config file.
  92     JSBSim config files are in XML format.
  93     @author Jon S. Berndt
  94     @version $Id$
  95 */
  96
  97 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  98 CLASS DECLARATION
  99 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 100
 101 class FGConfigFile : public FGJSBBase
 102 {
 103 public:
 104   /** Constructor
 105       @param Filename the name of the config file to be read. */
 106   FGConfigFile(string Filename);
 107   /// Destructor
 108   ~FGConfigFile();
 109
 110   /** Returns the next line from the currently open config file.
 111       Comments are bypassed and ignored.
 112       @return the next valid line from the config file OR "EOF" if end of file is
 113       reached.*/
 114   string GetNextConfigLine(void);
 115
 116   string GetCurrentLine(void) { return CurrentLine; }
 117
 118   /** Returns the value of the tag supplied.
 119       @param tag the tag for the value that is desired.
 120       @return tthe value of the tag supplied.*/
 121   string GetValue(string tag);
 122
 123   string GetValue(void);
 124   string GetCommentString(void) {return CommentString;}
 125   string GetLineComment(void) {return LineComment;}
 126   bool IsOpen(void) {return Opened;}
 127   FGConfigFile& operator>>(double&);
 128   FGConfigFile& operator>>(int&);
 129   FGConfigFile& operator>>(string&);
 130   void ResetLineIndexToZero(void);
 131
 132 private:
 133   ifstream cfgfile;
 134   string   CurrentLine;
 135   string   CommentString;
 136   string   LineComment;
 137   bool     CommentsOn;
 138   bool     Opened;
 139   unsigned int CurrentIndex;
 140   string GetLine(void);
 141
 142   void Debug(int from);
 143 };
 144 }
 145 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 146 #endif
 147