Source/System/FileIO/Base/OSGIOFileTypeBase.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 _OSGIOFILETYPEBASE_H_
  40 #define _OSGIOFILETYPEBASE_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGConfig.h"
  46 #include "OSGSystemDef.h"
  47 #include "OSGBaseTypes.h"
  48 #include "OSGLog.h"
  49
  50 #include <boost/lexical_cast.hpp>
  51 #include <map>
  52 #include <stack>
  53 #include <string>
  54
  55 OSG_BEGIN_NAMESPACE
  56
  57 /*! \ingroup GrpSystemFileIOBase
  58     \ingroup GrpLibOSGSystem
  59  */
  60
  61 class OSG_SYSTEM_DLLMAPPING IOFileTypeBase
  62 {
  63     /*==========================  PUBLIC  =================================*/
  64
  65   public:
  66
  67     /*---------------------------------------------------------------------*/
  68     /*! \name Public Types                                                 */
  69     /*! \{                                                                 */
  70
  71     typedef IOFileTypeBase Self;
  72
  73     enum
  74     {
  75         OSG_READ_SUPPORTED  = 1,  /**< The file type supports reading. */
  76         OSG_WRITE_SUPPORTED = 2   /**< The file type supports writing. */
  77     };
  78
  79     /*! \nohierarchy
  80      */
  81
  82     struct OSG_SYSTEM_DLLMAPPING IOOption
  83     {
  84         IOOption(void                                             );
  85         IOOption(const IOOption    &other                         );
  86         IOOption(const std::string &name, const std::string &value);
  87
  88         std::string optName;
  89         std::string optValue;
  90     };
  91
  92     typedef std::map  <std::string, IOOption> OptionSet;
  93     typedef std::stack<OptionSet            > OptionStack;
  94
  95     /*! \}                                                                 */
  96     /*---------------------------------------------------------------------*/
  97     /*! \name Flags                                                        */
  98     /*! \{                                                                 */
  99
 100     UInt32 getFlags(void) const;
 101
 102     /*! \}                                                                 */
 103     /*---------------------------------------------------------------------*/
 104     /*! \name Option Handling Helpers                                      */
 105     /*! \{                                                                 */
 106
 107     static bool hasOption  (const OptionSet   &optSet,
 108                             const std::string &name   );
 109
 110     template <class ValueTypeT>
 111     static bool setOptionAs(      OptionSet   &optSet,
 112                             const std::string &name,
 113                             const ValueTypeT  &value  );
 114     static void setOption  (      OptionSet   &optSet,
 115                             const std::string &name,
 116                             const std::string &value  );
 117
 118     static bool unsetOption(      OptionSet  &optSet,
 119                             const std::string &name   );
 120
 121     template <class ValueTypeT>
 122     static bool getOptionAs(const OptionSet   &optSet,
 123                             const std::string &name,
 124                                   ValueTypeT  &value  );
 125     static bool getOption  (const OptionSet   &optSet,
 126                             const std::string &name,
 127                                   std::string &value  );
 128
 129     /*! \}                                                                 */
 130     /*---------------------------------------------------------------------*/
 131     /*! \name Option Handling                                              */
 132     /*! \{                                                                 */
 133
 134     void              pushOptions(bool               copyTop = true);
 135     void              popOptions (void                             );
 136
 137     OptionSet const  &getOptions (void                             ) const;
 138     OptionSet        &editOptions(void                             );
 139
 140     bool              hasOption  (const std::string &name          ) const;
 141
 142     template <class ValueTypeT>
 143     bool              setOptionAs(const std::string &name,
 144                                   const ValueTypeT  &value         );
 145     void              setOption  (const std::string &name,
 146                                   const std::string &value         );
 147
 148     bool              unsetOption(const std::string &name          );
 149
 150     template <class ValueTypeT>
 151     bool              getOptionAs(const std::string &name,
 152                                         ValueTypeT  &value         ) const;
 153     bool              getOption  (const std::string &name,
 154                                         std::string &value         ) const;
 155
 156     /*! \}                                                                 */
 157     /*=========================  PROTECTED  ===============================*/
 158
 159   protected:
 160
 161     /*---------------------------------------------------------------------*/
 162     /*! \name Constructors                                                 */
 163     /*! \{                                                                 */
 164
 165     IOFileTypeBase(UInt32 const  flags);
 166     IOFileTypeBase(Self   const &other);
 167
 168     /*---------------------------------------------------------------------*/
 169     /*! \name Destructor                                                   */
 170     /*! \{                                                                 */
 171
 172     virtual ~IOFileTypeBase(void);
 173
 174     /*! \}                                                                 */
 175     /*---------------------------------------------------------------------*/
 176     /*! \name Members                                                      */
 177     /*! \{                                                                 */
 178
 179     UInt32       _flags;
 180     OptionStack  _optStack;
 181
 182     /*! \}                                                                 */
 183     /*---------------------------------------------------------------------*/
 184 };
 185
 186 OSG_END_NAMESPACE
 187
 188 #include "OSGIOFileTypeBase.inl"
 189
 190 #endif // _OSGIOFILETYPEBASE_H_