src/LDOM/LDOM_OSStream.hxx

   1 // Created on: 2001-10-01
   2 // Created by: Julia DOROVSKIKH
   3 // Copyright (c) 2001-2014 OPEN CASCADE SAS
   4 //
   5 // This file is part of Open CASCADE Technology software library.
   6 //
   7 // This library is free software; you can redistribute it and/or modify it under
   8 // the terms of the GNU Lesser General Public License version 2.1 as published
   9 // by the Free Software Foundation, with special exception defined in the file
  10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 // distribution for complete text of the license and disclaimer of any warranty.
  12 //
  13 // Alternatively, this file may be used under the terms of Open CASCADE
  14 // commercial license or contractual agreement.
  15
  16 #ifndef LDOM_OSStream_HeaderFile
  17 #define LDOM_OSStream_HeaderFile
  18
  19 #include <NCollection_DefineAlloc.hxx>
  20 #include <NCollection_BaseAllocator.hxx>
  21 #include <Standard_OStream.hxx>
  22
  23 #include <stdio.h> /* EOF */
  24
  25 //! Class LDOM_SBuffer inherits std::streambuf and
  26 //! redefines some virtual methods of it (overflow() and xsputn()).
  27 //! This class contains pointers on first and current element
  28 //! of sequence, also it has methods for the sequence management.
  29 class LDOM_SBuffer : public std::streambuf
  30 {
  31   //! One element of sequence.
  32   //! Can only be allocated by the allocator and assumes
  33   //! it is IncAllocator, so destructor isn't required.
  34   struct LDOM_StringElem
  35   {
  36     char*            buf;  //!< pointer on data string
  37     int              len;  //!< quantity of really written data
  38     LDOM_StringElem* next; //!< pointer on the next element of a sequence
  39
  40     DEFINE_NCOLLECTION_ALLOC
  41
  42     LDOM_StringElem(const int, const Handle(NCollection_BaseAllocator)&);
  43     ~LDOM_StringElem();
  44
  45   private:
  46     LDOM_StringElem (const LDOM_StringElem&);
  47     LDOM_StringElem& operator= (const LDOM_StringElem&);
  48   };
  49
  50 public:
  51   //! Constructor. Sets a default value for the
  52   //!              length of each sequence element.
  53   Standard_EXPORT LDOM_SBuffer (const Standard_Integer theMaxBuf);
  54
  55   //! Concatenates strings of all sequence elements
  56   //! into one string. Space for output string is allocated
  57   //! with operator new.
  58   //! Caller of this function is responsible
  59   //! for memory release after the string usage.
  60   Standard_EXPORT Standard_CString str () const;
  61
  62   //! Returns full length of data contained
  63   Standard_Integer Length () const {return myLength;}
  64
  65   //! Clears first element of sequence and removes all others
  66   Standard_EXPORT void Clear ();
  67
  68   // Methods of std::streambuf
  69
  70   Standard_EXPORT virtual int overflow(int c = EOF) Standard_OVERRIDE;
  71   Standard_EXPORT virtual int underflow() Standard_OVERRIDE;
  72   //virtual int uflow();
  73
  74   Standard_EXPORT virtual std::streamsize xsputn(const char* s, std::streamsize n) Standard_OVERRIDE;
  75   //virtual int xsgetn(char* s, int n);
  76   //virtual int sync();
  77
  78   Standard_EXPORT ~LDOM_SBuffer ();
  79   // Destructor
  80
  81 private:
  82
  83   Standard_Integer      myMaxBuf; // default length of one element
  84   Standard_Integer      myLength; // full length of contained data
  85   LDOM_StringElem* myFirstString; // the head of the sequence
  86   LDOM_StringElem* myCurString;   // current element of the sequence
  87   Handle(NCollection_BaseAllocator) myAlloc; //allocator for chunks
  88 };
  89
  90 //! Subclass if std::ostream allowing to increase performance
  91 //! of outputting data into a string avoiding reallocation of buffer.
  92 //! Class LDOM_OSStream implements output into a sequence of
  93 //! strings and getting the result as a string.
  94 //! It inherits Standard_OStream (std::ostream).
  95 //! Beside methods of std::ostream, it also has additional
  96 //! useful methods: str(), Length() and Clear().
  97 class LDOM_OSStream : public Standard_OStream
  98 {
  99 public:
 100   //! Constructor
 101   Standard_EXPORT LDOM_OSStream(const Standard_Integer theMaxBuf);
 102
 103   Standard_EXPORT virtual ~LDOM_OSStream();
 104
 105   Standard_CString str () const {return myBuffer.str();}
 106
 107   Standard_Integer Length () const { return myBuffer.Length(); }
 108
 109   void Clear () { myBuffer.Clear(); }
 110
 111  private:
 112   LDOM_SBuffer myBuffer;
 113
 114 public:
 115   // byte order mark defined at the start of a stream
 116   enum BOMType {
 117     BOM_UNDEFINED,
 118     BOM_UTF8,
 119     BOM_UTF16BE,
 120     BOM_UTF16LE,
 121     BOM_UTF32BE,
 122     BOM_UTF32LE,
 123     BOM_UTF7,
 124     BOM_UTF1,
 125     BOM_UTFEBCDIC,
 126     BOM_SCSU,
 127     BOM_BOCU1,
 128     BOM_GB18030
 129   };
 130 };
 131
 132 #endif