Source/System/FileIO/OpenFlight/OSGOFRecords.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *                Copyright (C) 2008 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 _OSGOFRECORDS_H_
  40 #define _OSGOFRECORDS_H_
  41
  42 #include "boost/function.hpp"
  43
  44 #include "OSGFileIODef.h"
  45 #include "OSGBaseTypes.h"
  46 #include "OSGBaseFunctions.h"
  47 #include "OSGSingletonHolder.h"
  48 #include "OSGNode.h"
  49 #include "OSGMaterialChunk.h"
  50 #include "OSGMemoryObject.h"
  51
  52 #include "OSGTypedGeoIntegralProperty.h"
  53 #include "OSGTypedGeoVectorProperty.h"
  54
  55 #include <map>
  56
  57 OSG_BEGIN_NAMESPACE
  58
  59 //---------------------------------------------------------------------------
  60 //  Class
  61 //---------------------------------------------------------------------------
  62
  63 class OFRecord;
  64 class OFDatabase;
  65
  66 class Geometry;
  67
  68 /*! \brief General VRML Node Desc
  69     \ingroup GrpFileIOOpenFlight
  70     \nohierarchy
  71  */
  72
  73 struct OFRecordHeader
  74 {
  75     UInt16 sOpCode;
  76     UInt16 sLength;
  77
  78     bool read(std::istream &is)
  79     {
  80         is.read(reinterpret_cast<char *>(&sOpCode), 2);
  81         is.read(reinterpret_cast<char *>(&sLength), 2);
  82
  83         sOpCode = osgNetToHost(sOpCode);
  84         sLength = osgNetToHost(sLength);
  85
  86         return is.good();
  87     }
  88 };
  89
  90 /*! \ingroup GrpFileIOOpenFlight
  91  */
  92
  93 typedef TransitPtr<OFRecord> OFRecordTransitPtr;
  94
  95 //---------------------------------------------------------------------------
  96 //  Class
  97 //---------------------------------------------------------------------------
  98
  99 /*! \ingroup GrpFileIOOpenFlight
 100     \nohierarchy
 101  */
 102
 103 class OSG_FILEIO_DLLMAPPING OFRecordFactoryBase
 104 {
 105     /*==========================  PUBLIC  =================================*/
 106
 107   public :
 108
 109     typedef boost::function<
 110         OFRecordTransitPtr (const OFRecordHeader &,
 111                                   OFDatabase     & )> CreateRecord;
 112
 113     /*! \nohierarchy
 114      */
 115     class OSG_FILEIO_DLLMAPPING RegisterRecord
 116     {
 117       public:
 118
 119         RegisterRecord(CreateRecord fCreate,
 120                        UInt16       sRecordOpCode);
 121     };
 122
 123     /*---------------------------------------------------------------------*/
 124     /*! \name                   Class Get                                  */
 125     /*! \{                                                                 */
 126
 127     /*! \}                                                                 */
 128     /*---------------------------------------------------------------------*/
 129     /*! \name                    Helper                                    */
 130     /*! \{                                                                 */
 131
 132
 133     /*! \}                                                                 */
 134     /*---------------------------------------------------------------------*/
 135     /*! \name                     Field                                    */
 136     /*! \{                                                                 */
 137
 138     void registerRecord(CreateRecord fRecord,
 139                         UInt16       sRecordOpCode);
 140
 141     /*! \}                                                                 */
 142     /*---------------------------------------------------------------------*/
 143     /*! \name                   Prototypes                                 */
 144     /*! \{                                                                 */
 145
 146     OFRecordTransitPtr createRecord(const OFRecordHeader &oHeader,
 147                                           OFDatabase     &oDB     );
 148
 149     /*! \}                                                                 */
 150     /*---------------------------------------------------------------------*/
 151     /*! \name                      Node                                    */
 152     /*! \{                                                                 */
 153
 154     /*! \}                                                                 */
 155     /*---------------------------------------------------------------------*/
 156     /*! \name                      FieldValue                              */
 157     /*! \{                                                                 */
 158
 159
 160     /*! \}                                                                 */
 161     /*---------------------------------------------------------------------*/
 162     /*! \name                        Dump                                  */
 163     /*! \{                                                                 */
 164
 165     /*! \}                                                                 */
 166     /*=========================  PROTECTED  ===============================*/
 167
 168   protected:
 169
 170     template <class SingletonT>
 171     friend class SingletonHolder;
 172
 173     typedef std::map<UInt16,
 174                      CreateRecord> NameRecordCreateMap;
 175
 176     /*---------------------------------------------------------------------*/
 177     /*! \name                   Constructors                               */
 178     /*! \{                                                                 */
 179
 180     OFRecordFactoryBase(void);
 181
 182     /*! \}                                                                 */
 183     /*---------------------------------------------------------------------*/
 184     /*! \name                   Destructor                                 */
 185     /*! \{                                                                 */
 186
 187     virtual ~OFRecordFactoryBase(void);
 188
 189     /*! \}                                                                 */
 190     /*---------------------------------------------------------------------*/
 191     /*! \name                      Member                                  */
 192     /*! \{                                                                 */
 193
 194     /*! \}                                                                 */
 195     /*---------------------------------------------------------------------*/
 196     /*! \name                      Member                                  */
 197     /*! \{                                                                 */
 198
 199     NameRecordCreateMap _mRegisteredRecords;
 200
 201     /*! \}                                                                 */
 202     /*==========================  PRIVATE  ================================*/
 203
 204   private:
 205
 206     /*!\brief prohibit default function (move to 'public' if needed) */
 207     OFRecordFactoryBase(const OFRecordFactoryBase &source);
 208     /*!\brief prohibit default function (move to 'public' if needed) */
 209     void operator =(const OFRecordFactoryBase &source);
 210 };
 211
 212 #if defined(WIN32)
 213 OSG_FILEIO_EXPIMP_TMPL
 214 template class OSG_FILEIO_DLLMAPPING SingletonHolder<OFRecordFactoryBase>;
 215 #endif
 216
 217 /*! \ingroup GrpFileIOOpenFlight
 218  */
 219
 220 typedef SingletonHolder<OFRecordFactoryBase> OFRecordFactory;
 221
 222 //---------------------------------------------------------------------------
 223 //  Class
 224 //---------------------------------------------------------------------------
 225
 226 /*! \ingroup GrpFileIOOpenFlight
 227     \nohierarchy
 228  */
 229
 230 class OSG_FILEIO_DLLMAPPING OFRecord : public MemoryObject
 231 {
 232   public:
 233     /*---------------------------------------------------------------------*/
 234
 235     enum CategoryE
 236     {
 237       RC_Control      = 0,
 238       RC_Primary      = 1,
 239       RC_Ancillary    = 2,
 240       RC_Continuation = 3,
 241
 242       RC_Undefined    = 4
 243     };
 244
 245     /*---------------------------------------------------------------------*/
 246
 247     static const Char8 *getOpCodeString  (UInt16    sOpCode);
 248     static const Char8 *getCategoryString(CategoryE cat    );
 249
 250     /*---------------------------------------------------------------------*/
 251
 252     virtual UInt16       getOpCode        (void) const = 0;
 253             const Char8 *getOpCodeString  (void) const;
 254
 255     virtual CategoryE    getCategory      (void) const = 0;
 256             const Char8 *getCategoryString(void) const;
 257
 258     /*---------------------------------------------------------------------*/
 259
 260     virtual bool read        (std::istream &is      );
 261     virtual bool readContinue(std::istream &is,
 262                               UInt16        uiLength);
 263
 264     virtual NodeTransitPtr convertToNode(void);
 265
 266     virtual bool           addChild     (OFRecord *pChild) = 0;
 267
 268     /*---------------------------------------------------------------------*/
 269
 270     virtual void dump(UInt32 uiIndent) const;
 271
 272   protected:
 273
 274     typedef MemoryObject Inherited;
 275
 276     /*---------------------------------------------------------------------*/
 277
 278     OFDatabase &_oDB;
 279     UInt16      _sLength;
 280
 281     /*---------------------------------------------------------------------*/
 282
 283     void readChar8 (std::istream &is, Char8  *cVal, UInt32 iSize);
 284
 285     /*---------------------------------------------------------------------*/
 286
 287     template<class ValueT>
 288     UInt32 readVal(std::istream &is,  ValueT &val);
 289
 290     /*---------------------------------------------------------------------*/
 291
 292              OFRecord(const OFRecordHeader &oHeader,
 293                             OFDatabase     &oDB    );
 294     virtual ~OFRecord(void);
 295 };
 296
 297 /*! \ingroup GrpFileIOOpenFlight
 298  */
 299
 300 typedef RefCountPtr<OFRecord, MemObjRefCountPolicy> OFRecordRCPtr;
 301
 302 //---------------------------------------------------------------------------
 303 //  Forward declarations
 304 //---------------------------------------------------------------------------
 305
 306 /*! \ingroup GrpFileIOOpenFlight
 307  */
 308 class OFPrimaryRecord;
 309 /*! \ingroup GrpFileIOOpenFlight
 310  */
 311 typedef RefCountPtr<OFPrimaryRecord,
 312                     MemObjRefCountPolicy>  OFPrimaryRecordRCPtr;
 313
 314 /*! \ingroup GrpFileIOOpenFlight
 315  */
 316 class OFAncillaryRecord;
 317 /*! \ingroup GrpFileIOOpenFlight
 318  */
 319 typedef RefCountPtr<OFAncillaryRecord,
 320                     MemObjRefCountPolicy>  OFAncillaryRecordRCPtr;
 321
 322 //---------------------------------------------------------------------------
 323 //  Class
 324 //---------------------------------------------------------------------------
 325
 326 /*! \ingroup GrpFileIOOpenFlight
 327     \nohierarchy
 328  */
 329
 330 class OFPrimaryRecord : public OFRecord
 331 {
 332   public:
 333     static const CategoryE Category = RC_Primary;
 334
 335     /*---------------------------------------------------------------------*/
 336
 337     static  CategoryE getClassCategory(void);
 338     virtual CategoryE getCategory     (void) const;
 339
 340     /*---------------------------------------------------------------------*/
 341
 342     virtual bool addChild(OFRecord *pChild);
 343
 344     /*---------------------------------------------------------------------*/
 345
 346     virtual void dump(UInt32 uiIndent) const;
 347
 348   protected:
 349     typedef OFRecord  Inherited;
 350
 351     typedef std::vector<OFPrimaryRecordRCPtr  >  PrimaryStore;
 352     typedef std::vector<OFAncillaryRecordRCPtr>  AncillaryStore;
 353
 354              OFPrimaryRecord(const OFRecordHeader &oHeader,
 355                                    OFDatabase     &oDB    );
 356     virtual ~OFPrimaryRecord(void                         ) = 0;
 357
 358     PrimaryStore   _primaryChildren;
 359     AncillaryStore _ancillaryChildren;
 360 };
 361
 362 //---------------------------------------------------------------------------
 363 //  Class
 364 //---------------------------------------------------------------------------
 365
 366 /*! \ingroup GrpFileIOOpenFlight
 367     \nohierarchy
 368  */
 369
 370 class OFAncillaryRecord : public OFRecord
 371 {
 372   public:
 373     static const CategoryE Category = RC_Ancillary;
 374
 375     /*---------------------------------------------------------------------*/
 376
 377     static  CategoryE getClassCategory(void);
 378     virtual CategoryE getCategory     (void) const;
 379
 380     /*---------------------------------------------------------------------*/
 381
 382     virtual bool           addChild     (OFRecord *pChild);
 383     virtual NodeTransitPtr convertToNode(void            );
 384     virtual NodeTransitPtr convert      (Node     *pNode );
 385
 386   protected:
 387     typedef OFRecord  Inherited;
 388
 389              OFAncillaryRecord(const OFRecordHeader &oHeader,
 390                                      OFDatabase     &oDB    );
 391     virtual ~OFAncillaryRecord(void                         ) = 0;
 392 };
 393
 394 //---------------------------------------------------------------------------
 395 //  Class
 396 //---------------------------------------------------------------------------
 397
 398 /*! \ingroup GrpFileIOOpenFlight
 399     \nohierarchy
 400  */
 401
 402 class OFControlRecord : public OFRecord
 403 {
 404   public:
 405     static const CategoryE Category = RC_Control;
 406
 407     /*---------------------------------------------------------------------*/
 408
 409     static  CategoryE getClassCategory(void);
 410     virtual CategoryE getCategory     (void) const;
 411
 412     /*---------------------------------------------------------------------*/
 413
 414     virtual bool addChild(OFRecord *pChild);
 415
 416   protected:
 417     typedef OFRecord  Inherited;
 418
 419              OFControlRecord(const OFRecordHeader &oHeader,
 420                                    OFDatabase     &oDB    );
 421     virtual ~OFControlRecord(void                         ) = 0;
 422 };
 423
 424 /*! \ingroup GrpFileIOOpenFlight
 425  */
 426 typedef RefCountPtr<OFControlRecord,
 427                     MemObjRefCountPolicy>  OFControlRecordRCPtr;
 428
 429 //---------------------------------------------------------------------------
 430 //  Class
 431 //---------------------------------------------------------------------------
 432
 433 /*! \ingroup GrpFileIOOpenFlight
 434     \nohierarchy
 435  */
 436
 437 class OSG_FILEIO_DLLMAPPING OFUnknownRecord : public OFRecord
 438 {
 439   protected:
 440
 441     typedef OFRecord Inherited;
 442
 443     /*---------------------------------------------------------------------*/
 444
 445     UInt16                     _sOpCode;
 446     std::vector<OFRecordRCPtr> _vChildren;
 447
 448     /*---------------------------------------------------------------------*/
 449
 450              OFUnknownRecord(const OFRecordHeader &oHeader,
 451                                    OFDatabase     &oDB    );
 452     virtual ~OFUnknownRecord(void                         );
 453
 454     /*---------------------------------------------------------------------*/
 455
 456     friend class OFRecordFactoryBase;
 457
 458   public:
 459
 460     virtual bool           read         (std::istream &is    );
 461     virtual NodeTransitPtr convertToNode(void                );
 462     virtual bool           addChild     (OFRecord     *pChild);
 463
 464     /*---------------------------------------------------------------------*/
 465
 466     virtual UInt16    getOpCode  (void) const;
 467     virtual CategoryE getCategory(void) const;
 468
 469     /*---------------------------------------------------------------------*/
 470
 471     virtual void dump(UInt32 uiIndent) const;
 472 };
 473
 474 OSG_END_NAMESPACE
 475
 476 #include "OSGOFRecords.inl"
 477
 478 #endif /* _OSGOFRECORDS_H_ */