Source/System/FileIO/OSG/OSGOSGLoader.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *             Copyright (C) 2000-2002 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 _OSGLOADER_H_
  40 #define _OSGLOADER_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGSystemDef.h"
  46 #include "OSGBaseTypes.h"
  47 #include "OSGScanParseSkel.h"
  48 #include "OSGScanParseFieldTypeMapper.h"
  49
  50 #include "OSGNode.h"
  51 #include "OSGField.h"
  52 #include "OSGFieldContainer.h"
  53 #include "OSGFileContextAttachment.h"
  54
  55 #include "OSGDynamicAttachmentMixin.h"
  56
  57 #include <stack>
  58 #include <map>
  59 #include <string>
  60
  61 OSG_BEGIN_NAMESPACE
  62
  63 class FileContextAttachment;
  64
  65 /*! \ingroup GrpSystemFileIOOSG
  66     \nohierarchy
  67  */
  68
  69 struct OSGGenericAttDesc
  70 {
  71     typedef Attachment  Parent;
  72     typedef Attachment *ParentPtr;
  73
  74     static const Char8 *getTypeName      (void) { return "OSGGenericAtt"; }
  75     static const Char8 *getParentTypeName(void)
  76     {
  77         return "Attachment";
  78     }
  79     static const Char8 *getGroupName     (void) { return "OSGGenAtt"; }
  80
  81
  82     static InitContainerF         getInitMethod(void) { return NULL; }
  83
  84     static FieldDescriptionBase **getDesc      (void) { return NULL; }
  85 };
  86
  87 /*! \ingroup GrpSystemFileIOOSG
  88  */
  89
  90 typedef DynFieldAttachment<OSGGenericAttDesc>  OSGGenericAtt;
  91
  92 /*! \ingroup GrpSystemFileIOOSG
  93  */
  94 typedef OSGGenericAtt::ObjUnrecPtr             OSGGenericAttUnrecPtr;
  95
  96
  97 /*! \brief native osg loader (vrml syntax)
  98     \ingroup GrpSystemFileIOOSG
  99     \ingroup GrpLibOSGSystem
 100  */
 101
 102 class OSG_SYSTEM_DLLMAPPING OSGLoader :
 103     public ScanParseFieldTypeMapper<ScanParseSkel>
 104 {
 105     /*==========================  PRIVATE  ================================*/
 106
 107   private:
 108
 109     typedef ScanParseFieldTypeMapper<ScanParseSkel   >       Inherited;
 110     typedef std::map                <std::string,
 111                                      FieldContainerUnrecPtr> NamedFCMap;
 112     typedef OSGLoader                                        Self;
 113
 114     typedef boost::function<FieldContainer *(const Char8 *,
 115                                                    FieldContainer *,
 116                                                    Int32           )> Resolver;
 117
 118   public :
 119
 120     typedef boost::function<void(FieldContainer        * const,
 121                                  FileContextAttachment * const)> Functor;
 122
 123     /*---------------------------------------------------------------------*/
 124     /*! \name                   Constructors                               */
 125     /*! \{                                                                 */
 126
 127     OSGLoader(const std::vector<Functor>  &       endNodeFunctors,
 128                     FileContextAttachment * const pFileContext   );
 129
 130     /*! \}                                                                 */
 131     /*---------------------------------------------------------------------*/
 132     /*! \name                   Destructor                                 */
 133     /*! \{                                                                 */
 134
 135     virtual ~OSGLoader(void);
 136
 137     /*! \}                                                                 */
 138     /*---------------------------------------------------------------------*/
 139     /*! \name                Skel replacements                             */
 140     /*! \{                                                                 */
 141
 142     NodeTransitPtr           scanStream         (std::istream &iStream,
 143                                                  Resolver      fResolver);
 144     FieldContainerTransitPtr scanStreamContainer(std::istream &iStream,
 145                                                  Resolver      fResolver);
 146
 147     /*! \}                                                                 */
 148     /*---------------------------------------------------------------------*/
 149     /*! \name                Skel replacements                             */
 150     /*! \{                                                                 */
 151
 152     virtual bool    checkHeader       (      void                     );
 153
 154     virtual void    beginNode         (const Char8     *szNodeTypename,
 155                                        const Char8     *szNodename,
 156                                        const BitVector  bvLocalFlags  );
 157
 158     virtual void    endNode           (void);
 159
 160     virtual void    nullNode          (void);
 161
 162     virtual void    use               (const Char8  *szName           );
 163
 164     virtual void    beginField        (const Char8  *szFieldname,
 165                                        const UInt32  uiFieldTypeId    );
 166
 167     virtual void    endField          (void                           );
 168
 169     virtual void    addFieldValue     (const Char8  *szFieldVal       );
 170
 171     virtual Int32   mapExtIntFieldType(const Char8  *szFieldname,
 172                                        const Int32   iFieldTypeId     );
 173
 174     virtual UInt32  getFieldType      (const Char8  *szFieldname      );
 175
 176     virtual void    addRoute          (const Char8  *szOutNodename,
 177                                        const Char8  *szOutFieldname,
 178                                        const Char8  *szInNodename,
 179                                        const Char8  *szInFieldname    );
 180
 181     virtual void    beginFieldDecl    (const Char8  *szFieldType,
 182                                        const UInt32  uiFieldTypeId,
 183                                        const Char8  *szFieldName      );
 184
 185     virtual void    endFieldDecl      (      void                     );
 186
 187
 188     /*! \}                                                                 */
 189     /*---------------------------------------------------------------------*/
 190     /*! \name                      Get                                     */
 191     /*! \{                                                                 */
 192
 193     virtual FieldContainer *getReference (const Char8 *szName);
 194
 195     /*! \}                                                                 */
 196     /*=========================  PROTECTED  ===============================*/
 197
 198   protected:
 199
 200     /*---------------------------------------------------------------------*/
 201     /*! \name                      Member                                  */
 202     /*! \{                                                                 */
 203
 204           FieldContainerUnrecPtr                _pCurrentFC;
 205           NodeUnrecPtr                          _pRootNode;
 206           FieldContainerUnrecPtr                _pRootContainer;
 207           EditFieldHandlePtr                    _pCurrentField;
 208     const FieldDescriptionBase                 *_pCurrentFieldDesc;
 209           NamedFCMap                            _defMap;
 210           bool                                  _bReadContainer;
 211           Resolver                              _fResolver;
 212     const std::vector<Functor>                 &_endNodeFunctors;
 213
 214           std::stack<      FieldContainerUnrecPtr>  _fcStack;
 215           std::stack<      EditFieldHandlePtr    >  _fStack;
 216           std::stack<const FieldDescriptionBase *>  _fdStack;
 217
 218           BitVector                                _bvChanged;
 219           std::stack<      BitVector             > _sChangedStack;
 220
 221           FileContextAttachmentUnrecPtr            _pFileContext;
 222
 223     void              initFieldTypeMapper   (      void                      );
 224
 225     void              setFieldContainerValue(      FieldContainer   *pNewNode);
 226
 227     /*! \}                                                                 */
 228     /*==========================  PRIVATE  ================================*/
 229
 230   private:
 231
 232     /*!\brief prohibit default function (move to 'public' if needed) */
 233     OSGLoader(const OSGLoader &source);
 234     /*!\brief prohibit default function (move to 'public' if needed) */
 235     void operator =(const OSGLoader &source);
 236 };
 237
 238 //---------------------------------------------------------------------------
 239 //   Exported Types
 240 //---------------------------------------------------------------------------
 241
 242 // class pointer
 243
 244 typedef OSGLoader *OSGLoaderP;
 245
 246 OSG_END_NAMESPACE
 247
 248 #endif /* _OSGLOADER_H_ */