Source/Base/Base/OSGIOStream.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *             Copyright (C) 2000-2003 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 _OSGIOSTREAM_H_
  40 #define _OSGIOSTREAM_H_
  41
  42 #include "OSGConfig.h"
  43 #include "OSGBaseDef.h"
  44
  45 #include <iostream>
  46 #include <iomanip>
  47 #include <fstream>
  48
  49 #ifdef WIN32
  50 #define OSG_STREAM_API __cdecl
  51 #else
  52 #define OSG_STREAM_API
  53 #endif
  54
  55 OSG_BEGIN_NAMESPACE
  56
  57 class Fixed32;
  58
  59 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  60 struct SetIndent
  61 {
  62     SetIndent(unsigned int uiIndent) : _uiIndent(uiIndent) {}
  63
  64     unsigned int _uiIndent;
  65 };
  66
  67 struct _IncIndent {};
  68 struct _DecIndent {};
  69 struct _BeginElem {};
  70 struct _EndElem   {};
  71 struct _EndElemNL {};
  72
  73 typedef void (*_IncIndent_)(_IncIndent);
  74 typedef void (*_DecIndent_)(_DecIndent);
  75 typedef void (*_BeginElem_)(_BeginElem);
  76 typedef void (*_EndElem_  )(_EndElem  );
  77 typedef void (*_EndElemNL_)(_EndElemNL);
  78 #endif
  79
  80 /*! \name Stream Controls
  81     \{
  82  */
  83
  84 /*! \ingroup GrpBaseBaseStreamIO */
  85 OSG_BASE_DLLMAPPING void IncIndent(_IncIndent);
  86 /*! \ingroup GrpBaseBaseStreamIO */
  87 OSG_BASE_DLLMAPPING void DecIndent(_DecIndent);
  88 /*! \ingroup GrpBaseBaseStreamIO */
  89 OSG_BASE_DLLMAPPING void BeginElem(_BeginElem);
  90 /*! \ingroup GrpBaseBaseStreamIO */
  91 OSG_BASE_DLLMAPPING void EndElem  (_EndElem  );
  92 /*! \ingroup GrpBaseBaseStreamIO */
  93 OSG_BASE_DLLMAPPING void EndElemNL(_EndElemNL);
  94
  95 /*! \} */
  96
  97 /*! \ingroup GrpBaseBase
  98     \ingroup GrpBaseBaseStreamIO
  99     \ingroup GrpLibOSGBase
 100     \nohierarchy
 101  */
 102
 103 class OSG_BASE_DLLMAPPING OutStream
 104 {
 105     /*==========================  PUBLIC  =================================*/
 106
 107   public:
 108
 109     /*---------------------------------------------------------------------*/
 110     /*! \name                    Constructor                               */
 111     /*! \{                                                                 */
 112
 113     OutStream(std::ostream &baseStream);
 114
 115     /*! \}                                                                 */
 116     /*---------------------------------------------------------------------*/
 117     /*! \name                   Destructor                                 */
 118     /*! \{                                                                 */
 119
 120     virtual ~OutStream(void);
 121
 122     /*! \}                                                                 */
 123     /*---------------------------------------------------------------------*/
 124     /*! \name                   formated output                            */
 125     /*! \{                                                                 */
 126
 127     OutStream &operator<<(               long        __n);
 128     OutStream &operator<<(      unsigned long        __n);
 129
 130     OutStream &operator<<(               bool        __n);
 131     OutStream &operator<<(               char        __c);
 132
 133     OutStream &operator<<(               short       __n);
 134     OutStream &operator<<(      unsigned short       __n);
 135
 136     OutStream &operator<<(               int         __n);
 137     OutStream &operator<<(      unsigned int         __n);
 138
 139     OutStream &operator<<(               long long   __n);
 140     OutStream &operator<<(      unsigned long long   __n);
 141
 142     OutStream &operator<<(                    double __f);
 143     OutStream &operator<<(                    float  __f);
 144
 145     OutStream &operator<<(               long double __f);
 146
 147     OutStream &operator<<(const          Fixed32    &val);
 148
 149     OutStream &operator<<(const void                *__p);
 150
 151     OutStream &operator<<(const char                *__p);
 152     OutStream &operator<<(const std::string         &__s);
 153
 154     /*! \}                                                                 */
 155     /*---------------------------------------------------------------------*/
 156     /*! \name                   formated output                            */
 157     /*! \{                                                                 */
 158
 159 #ifndef WIN32
 160     OutStream &operator<<(std::_Setbase      __f);
 161 #else
 162     template <class Arg>
 163     OutStream &operator<<(std::_Smanip<Arg> &__f);
 164 #endif
 165
 166     OutStream &operator<<(std::ostream& (OSG_STREAM_API *__pf)(std::ostream&));
 167
 168     /*! \}                                                                 */
 169     /*---------------------------------------------------------------------*/
 170     /*! \name                   formated output                            */
 171     /*! \{                                                                 */
 172
 173     virtual OutStream &operator<<( SetIndent);
 174     virtual OutStream &operator<<(_IncIndent_);
 175     virtual OutStream &operator<<(_DecIndent_);
 176
 177     virtual OutStream &operator<<(_BeginElem_);
 178     virtual OutStream &operator<<(_EndElem_  );
 179     virtual OutStream &operator<<(_EndElemNL_);
 180
 181     /*! \}                                                                 */
 182     /*==========================  PROTECTRED  =============================*/
 183
 184   protected:
 185
 186     std::ostream *_pBaseStream;
 187
 188     /*==========================  PRIVATE  ================================*/
 189
 190   private:
 191
 192     OutStream(const OutStream &source);
 193     void operator =(const OutStream &source);
 194 };
 195
 196 /*! \ingroup GrpBaseBase
 197     \ingroup GrpBaseBaseStreamIO
 198     \ingroup GrpLibOSGBase
 199     \nohierarchy
 200  */
 201
 202 template<class ParentT>
 203 class FileStreamMixin : public ParentT
 204 {
 205     /*==========================  PUBLIC  =================================*/
 206
 207   public:
 208
 209     typedef ParentT Inherited;
 210
 211     /*---------------------------------------------------------------------*/
 212     /*! \name                    Constructor                               */
 213     /*! \{                                                                 */
 214
 215     FileStreamMixin(const char *szFileName);
 216
 217     /*! \}                                                                 */
 218     /*---------------------------------------------------------------------*/
 219     /*! \name                   Destructor                                 */
 220     /*! \{                                                                 */
 221
 222     virtual ~FileStreamMixin(void);
 223
 224     /*! \}                                                                 */
 225     /*---------------------------------------------------------------------*/
 226     /*! \name                   formated output                            */
 227     /*! \{                                                                 */
 228
 229     void close(void);
 230
 231     operator bool (void);
 232
 233     /*! \}                                                                 */
 234     /*==========================  PROTECTRED  =============================*/
 235
 236   protected:
 237
 238     std::ofstream _oFileStream;
 239
 240     /*==========================  PRIVATE  ================================*/
 241
 242   private:
 243 };
 244
 245 /*! \ingroup GrpBaseBase
 246     \ingroup GrpBaseBaseStreamIO
 247     \ingroup GrpLibOSGBase
 248     \nohierarchy
 249  */
 250
 251 template<class ParentT>
 252 class IndentOutStreamMixin : public ParentT
 253 {
 254     /*==========================  PUBLIC  =================================*/
 255
 256   public:
 257
 258     typedef ParentT Inherited;
 259
 260     /*---------------------------------------------------------------------*/
 261     /*! \name                    Constructor                               */
 262     /*! \{                                                                 */
 263
 264     IndentOutStreamMixin(std::ostream &baseStream);
 265
 266     /*! \}                                                                 */
 267     /*---------------------------------------------------------------------*/
 268     /*! \name                   Destructor                                 */
 269     /*! \{                                                                 */
 270
 271     virtual ~IndentOutStreamMixin(void);
 272
 273     /*! \}                                                                 */
 274     /*---------------------------------------------------------------------*/
 275     /*! \name                   formated output                            */
 276     /*! \{                                                                 */
 277
 278     virtual IndentOutStreamMixin &operator<<(SetIndent setIndent);
 279
 280     virtual IndentOutStreamMixin &operator<<(_IncIndent_);
 281     virtual IndentOutStreamMixin &operator<<(_DecIndent_);
 282     virtual IndentOutStreamMixin &operator<<(_BeginElem_);
 283     virtual IndentOutStreamMixin &operator<<(_EndElem_  );
 284     virtual IndentOutStreamMixin &operator<<(_EndElemNL_);
 285
 286     /*! \}                                                                 */
 287     /*---------------------------------------------------------------------*/
 288     /*! \name                   formated output                            */
 289     /*! \{                                                                 */
 290
 291     /*! \}                                                                 */
 292     /*==========================  PROTECTRED  =============================*/
 293
 294   protected:
 295
 296     /*==========================  PRIVATE  ================================*/
 297
 298     std::string  _szIndent;
 299     unsigned int _uiIndentStep;
 300
 301   private:
 302 };
 303
 304
 305 /*! \ingroup GrpBaseBase
 306     \ingroup GrpBaseBaseStreamIO
 307     \ingroup GrpLibOSGBase
 308     \nohierarchy
 309  */
 310
 311 class OSG_BASE_DLLMAPPING InStream
 312 {
 313     /*==========================  PUBLIC  =================================*/
 314
 315   public:
 316
 317     /*---------------------------------------------------------------------*/
 318     /*! \name                    Constructor                               */
 319     /*! \{                                                                 */
 320
 321     InStream(std::istream &baseStream);
 322
 323     /*! \}                                                                 */
 324     /*---------------------------------------------------------------------*/
 325     /*! \name                   Destructor                                 */
 326     /*! \{                                                                 */
 327
 328     virtual ~InStream(void);
 329
 330     /*! \}                                                                 */
 331     /*==========================  PROTECTRED  =============================*/
 332
 333   protected:
 334
 335     std::istream *_pBaseStream;
 336
 337     /*==========================  PRIVATE  ================================*/
 338
 339   private:
 340
 341     InStream(const InStream &source);
 342     void operator =(const InStream &source);
 343 };
 344
 345 /*! \name Streams
 346     \{
 347  */
 348
 349 /*! \ingroup GrpBaseBaseStreamIO */
 350 typedef FileStreamMixin                     <OutStream>   FileOutStream;
 351 /*! \ingroup GrpBaseBaseStreamIO */
 352 typedef FileStreamMixin<IndentOutStreamMixin<OutStream> > IndentFileOutStream;
 353
 354 /*! \}
 355  */
 356
 357 OSG_END_NAMESPACE
 358
 359 #include "OSGIOStream.inl"
 360
 361 #endif // _OSG_IOSTREAM_H_