Source/System/FileIO/ScanParseSkel/OSGXMLScanParseSkel.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *             Copyright (C) 2000-2006 by the OpenSG Forum                   *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
  10  *                                                                           *
  11 \*---------------------------------------------------------------------------*/
  12 /*---------------------------------------------------------------------------*\
  13  *                                License                                    *
  14  *                                                                           *
  15  * This library is free software; you can redistribute it and/or modify it   *
  16  * under the terms of the GNU Library General Public License as published    *
  17  * by the Free Software Foundation, version 2.                               *
  18  *                                                                           *
  19  * This library is distributed in the hope that it will be useful, but       *
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  22  * Library General Public License for more details.                          *
  23  *                                                                           *
  24  * You should have received a copy of the GNU Library General Public         *
  25  * License along with this library; if not, write to the Free Software       *
  26  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  27  *                                                                           *
  28 \*---------------------------------------------------------------------------*/
  29 /*---------------------------------------------------------------------------*\
  30  *                                Changes                                    *
  31  *                                                                           *
  32  *                                                                           *
  33  *                                                                           *
  34  *                                                                           *
  35  *                                                                           *
  36  *                                                                           *
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef _OSGXMLSCANPARSESKEL_H_
  40 #define _OSGXMLSCANPARSESKEL_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 //---------------------------------------------------------------------------
  46 //  Includes
  47 //---------------------------------------------------------------------------
  48
  49 #include "OSGSystemDef.h"
  50 #include "OSGBaseTypes.h"
  51
  52 #ifdef OSG_WITH_EXPAT
  53
  54 #include <vector>
  55 #include <stack>
  56 #include <map>
  57
  58 #include <boost/function.hpp>
  59
  60 OSG_BEGIN_NAMESPACE
  61
  62 //---------------------------------------------------------------------------
  63 //  Forward References
  64 //---------------------------------------------------------------------------
  65
  66 //---------------------------------------------------------------------------
  67 //   Types
  68 //---------------------------------------------------------------------------
  69
  70 //---------------------------------------------------------------------------
  71 //  Class
  72 //---------------------------------------------------------------------------
  73
  74 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  75
  76 class ScanParseSkel;
  77
  78 typedef ScanParseSkel *ScanParseSkelP;
  79
  80 #endif
  81
  82 /*! \ingroup GrpSystemFileIOScanParse
  83     \ingroup GrpLibOSGSystem
  84  */
  85
  86 class OSG_SYSTEM_DLLMAPPING XMLScanParseSkel
  87 {
  88   public:
  89
  90     //-----------------------------------------------------------------------
  91     //   types
  92     //-----------------------------------------------------------------------
  93
  94     enum CBResult
  95     {
  96         NoError = 0x0000,
  97         Error   = 0x0001
  98     };
  99
 100     typedef boost::function<CBResult (      XMLScanParseSkel *,
 101                                       const std::string      &)> XMLCallback1;
 102     typedef boost::function<CBResult (      XMLScanParseSkel *,
 103                                       const std::string      &,
 104                                       const std::string      &)> XMLCallback2;
 105
 106     struct XMLCallbacks
 107     {
 108         XMLCallback1 _startElementCB;
 109         XMLCallback2 _handleAttributeCB;
 110         XMLCallback1 _endElementCB;
 111         XMLCallback1 _handleDataBlockCB;
 112     };
 113
 114     typedef CBResult (XMLScanParseSkel::*XMLCB1)(const std::string &);
 115     typedef CBResult (XMLScanParseSkel::*XMLCB2)(const std::string &,
 116                                                  const std::string &);
 117
 118     typedef std::map<std::string, XMLCallbacks *>           CallbackMap;
 119     typedef std::map<std::string, XMLCallbacks *>::iterator CallbackMapIt;
 120
 121     typedef std::stack<           XMLCallbacks *>           CallbackStack;
 122
 123     //-----------------------------------------------------------------------
 124     //   constants
 125     //-----------------------------------------------------------------------
 126
 127     //-----------------------------------------------------------------------
 128     //   enums
 129     //-----------------------------------------------------------------------
 130
 131   private:
 132
 133     //-----------------------------------------------------------------------
 134     //   enums
 135     //-----------------------------------------------------------------------
 136
 137     //-----------------------------------------------------------------------
 138     //   types
 139     //-----------------------------------------------------------------------
 140
 141     //-----------------------------------------------------------------------
 142     //   friend classes
 143     //-----------------------------------------------------------------------
 144
 145     //-----------------------------------------------------------------------
 146     //   friend functions
 147     //-----------------------------------------------------------------------
 148
 149     //-----------------------------------------------------------------------
 150     //   class variables
 151     //-----------------------------------------------------------------------
 152
 153     //-----------------------------------------------------------------------
 154     //   class functions
 155     //-----------------------------------------------------------------------
 156
 157     //-----------------------------------------------------------------------
 158     //   instance variables
 159     //-----------------------------------------------------------------------
 160
 161     //-----------------------------------------------------------------------
 162     //   instance functions
 163     //-----------------------------------------------------------------------
 164
 165         // prohibit default functions (move to 'public' if you need one)
 166
 167     XMLScanParseSkel(const XMLScanParseSkel &source);
 168     void operator =(const XMLScanParseSkel &source);
 169
 170   protected:
 171
 172     //-----------------------------------------------------------------------
 173     //   enums
 174     //-----------------------------------------------------------------------
 175
 176     //-----------------------------------------------------------------------
 177     //   types
 178     //-----------------------------------------------------------------------
 179
 180     //-----------------------------------------------------------------------
 181     //   class variables
 182     //-----------------------------------------------------------------------
 183
 184     //-----------------------------------------------------------------------
 185     //   class functions
 186     //-----------------------------------------------------------------------
 187
 188     static void handleChar  (      void  * pUserData,
 189                              const Char8 * szData,
 190                                    Int32   iLength);
 191     static void startElement(      void  * pUserData,
 192                              const Char8 * szName,
 193                              const Char8 **vAtts);
 194
 195     static void endElement  (      void  * pUserData,
 196                              const Char8 * szName);
 197
 198     //-----------------------------------------------------------------------
 199     //   instance variables
 200     //-----------------------------------------------------------------------
 201
 202     UInt32               _uiLoadOptions;
 203     CBResult             _eErrorState;
 204
 205     std::string          _szDataLine;
 206     std::string          _szAttrName;
 207     std::string          _szAttrValue;
 208
 209     std::stack<UInt32>   _sOptionStack;
 210
 211     XMLCallbacks         _oIgnoreCB;
 212     CallbackMap          _mCallbackMap;
 213     CallbackStack        _sCallbackStack;
 214
 215     //-----------------------------------------------------------------------
 216     //   instance functions
 217     //-----------------------------------------------------------------------
 218
 219     void     startElement         (const std::string &szName );
 220     void     handleAttribute      (const std::string &szName,
 221                                    const std::string &szValue);
 222     void     endElement           (const std::string &szName );
 223     void     handleCharBlock      (const std::string &szData );
 224
 225
 226     CBResult ignoreStartElement   (const std::string &szName );
 227     CBResult ignoreHandleAttribute(const std::string &szName,
 228                                    const std::string &szValue);
 229     CBResult ignoreEndElement     (const std::string &szName );
 230     CBResult ignoreHandleCharBlock(const std::string &szData );
 231
 232   public :
 233
 234     //-----------------------------------------------------------------------
 235     //   class functions
 236     //-----------------------------------------------------------------------
 237
 238     //-----------------------------------------------------------------------
 239     //   instance functions
 240     //-----------------------------------------------------------------------
 241
 242     XMLScanParseSkel(void);
 243     virtual ~XMLScanParseSkel(void);
 244
 245     /*------------------------- your_category -------------------------------*/
 246
 247     virtual void scanStream(      std::istream &sInputStream);
 248
 249     virtual void scanFile  (const Char8        *szFilename  );
 250
 251     /*------------------------- your_operators ------------------------------*/
 252
 253
 254     /*------------------------- assignment ----------------------------------*/
 255
 256     /*------------------------- comparison ----------------------------------*/
 257
 258     /*------------------------- comparison ----------------------------------*/
 259 };
 260
 261 OSG_END_NAMESPACE
 262
 263 #endif
 264
 265 #endif /* _OSGXMLSCANPARSESKEL_H_ */