0031340: LDOM fails to read XML file starting with BOM
[occt.git] / 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 #include <Standard_Boolean.hxx>
23
24 #include <stdlib.h>
25 #include <stdio.h> /* EOF */
26
27 //! Class LDOM_SBuffer inherits std::streambuf and
28 //! redefines some virtual methods of it (overflow() and xsputn()).
29 //! This class contains pointers on first and current element 
30 //! of sequence, also it has methods for the sequence management.
31 class LDOM_SBuffer : public std::streambuf
32 {
33   //! One element of sequence.
34   //! Can only be allocated by the allocator and assumes
35   //! it is IncAllocator, so destructor isn't required.
36   struct LDOM_StringElem
37   {
38     char*            buf;  //!< pointer on data string
39     int              len;  //!< quantity of really written data
40     LDOM_StringElem* next; //!< pointer on the next element of a sequence
41
42     DEFINE_NCOLLECTION_ALLOC
43
44     LDOM_StringElem(const int, const Handle(NCollection_BaseAllocator)&);
45     ~LDOM_StringElem();
46
47   private:
48     LDOM_StringElem (const LDOM_StringElem&);
49     LDOM_StringElem& operator= (const LDOM_StringElem&);
50   };
51
52 public:
53   //! Constructor. Sets a default value for the
54   //!              length of each sequence element.
55   Standard_EXPORT LDOM_SBuffer (const Standard_Integer theMaxBuf);
56
57   //! Concatenates strings of all sequence elements
58   //! into one string. Space for output string is allocated
59   //! with operator new.
60   //! Caller of this function is responsible
61   //! for memory release after the string usage.
62   Standard_EXPORT Standard_CString str () const;
63
64   //! Returns full length of data contained
65   Standard_Integer Length () const {return myLength;}
66
67   //! Clears first element of sequence and removes all others
68   Standard_EXPORT void Clear ();
69
70   // Methods of std::streambuf
71
72   Standard_EXPORT virtual int overflow(int c = EOF) Standard_OVERRIDE;
73   Standard_EXPORT virtual int underflow() Standard_OVERRIDE;
74   //virtual int uflow();
75
76   Standard_EXPORT virtual std::streamsize xsputn(const char* s, std::streamsize n) Standard_OVERRIDE;
77   //virtual int xsgetn(char* s, int n);
78   //virtual int sync();
79
80   Standard_EXPORT ~LDOM_SBuffer ();
81   // Destructor
82
83 private:
84
85   Standard_Integer      myMaxBuf; // default length of one element
86   Standard_Integer      myLength; // full length of contained data
87   LDOM_StringElem* myFirstString; // the head of the sequence
88   LDOM_StringElem* myCurString;   // current element of the sequence
89   Handle(NCollection_BaseAllocator) myAlloc; //allocator for chunks
90 };
91
92 //! Subclass if std::ostream allowing to increase performance
93 //! of outputting data into a string avoiding reallocation of buffer.
94 //! Class LDOM_OSStream implements output into a sequence of
95 //! strings and getting the result as a string.
96 //! It inherits Standard_OStream (std::ostream).
97 //! Beside methods of std::ostream, it also has additional
98 //! useful methods: str(), Length() and Clear().
99 class LDOM_OSStream : public Standard_OStream
100 {
101 public:
102   //! Constructor
103   Standard_EXPORT LDOM_OSStream(const Standard_Integer theMaxBuf);
104
105   Standard_EXPORT virtual ~LDOM_OSStream();
106
107   Standard_CString str () const {return myBuffer.str();}
108
109   Standard_Integer Length () const { return myBuffer.Length(); }
110
111   void Clear () { myBuffer.Clear(); }
112
113  private:
114   LDOM_SBuffer myBuffer;
115
116 public:
117   // byte order mark defined at the start of a stream
118   enum BOMType {
119     BOM_UNDEFINED,
120     BOM_UTF8,
121     BOM_UTF16BE,
122     BOM_UTF16LE,
123     BOM_UTF32BE,
124     BOM_UTF32LE,
125     BOM_UTF7,
126     BOM_UTF1,
127     BOM_UTFEBCDIC,
128     BOM_SCSU,
129     BOM_BOCU1,
130     BOM_GB18030
131   };
132 };
133
134 #endif