strbuffer.hpp
上传用户:yhdzpy8989
上传日期:2007-06-13
资源大小:13604k
文件大小:13k
源码类别:

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: strbuffer.hpp,v $
  4.  * PRODUCTION Revision 1000.2  2004/06/01 19:38:56  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.31
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef STRBUFFER__HPP
  10. #define STRBUFFER__HPP
  11. /*  $Id: strbuffer.hpp,v 1000.2 2004/06/01 19:38:56 gouriano Exp $
  12. * ===========================================================================
  13. *
  14. *                            PUBLIC DOMAIN NOTICE
  15. *               National Center for Biotechnology Information
  16. *
  17. *  This software/database is a "United States Government Work" under the
  18. *  terms of the United States Copyright Act.  It was written as part of
  19. *  the author's official duties as a United States Government employee and
  20. *  thus cannot be copyrighted.  This software/database is freely available
  21. *  to the public for use. The National Library of Medicine and the U.S.
  22. *  Government have not placed any restriction on its use or reproduction.
  23. *
  24. *  Although all reasonable efforts have been taken to ensure the accuracy
  25. *  and reliability of the software and data, the NLM and the U.S.
  26. *  Government do not and cannot warrant the performance or results that
  27. *  may be obtained by using this software or data. The NLM and the U.S.
  28. *  Government disclaim all warranties, express or implied, including
  29. *  warranties of performance, merchantability or fitness for any particular
  30. *  purpose.
  31. *
  32. *  Please cite the author in any work or product based on this material.
  33. *
  34. * ===========================================================================
  35. *
  36. * Author: Eugene Vasilchenko
  37. *
  38. * File Description:
  39. *   Reading buffer
  40. *
  41. * ---------------------------------------------------------------------------
  42. * $Log: strbuffer.hpp,v $
  43. * Revision 1000.2  2004/06/01 19:38:56  gouriano
  44. * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.31
  45. *
  46. * Revision 1.31  2004/05/24 18:12:44  gouriano
  47. * In text output files make indentation optional
  48. *
  49. * Revision 1.30  2003/12/31 20:52:17  gouriano
  50. * added possibility to seek (when possible) in CByteSourceReader
  51. *
  52. * Revision 1.29  2003/04/17 17:50:32  siyan
  53. * Added doxygen support
  54. *
  55. * Revision 1.28  2003/02/26 21:34:06  gouriano
  56. * modify C++ exceptions thrown by this library
  57. *
  58. * Revision 1.27  2002/12/19 14:51:00  dicuccio
  59. * Added export specifier for Win32 DLL builds.
  60. *
  61. * Revision 1.26  2002/11/04 21:29:00  grichenk
  62. * Fixed usage of const CRef<> and CRef<> constructor
  63. *
  64. * Revision 1.25  2002/01/29 16:21:20  grichenk
  65. * COStreamBuffer destructor fixed - no exceptions thrown
  66. *
  67. * Revision 1.24  2001/05/17 15:01:19  lavr
  68. * Typos corrected
  69. *
  70. * Revision 1.23  2001/03/14 17:59:24  vakatov
  71. * COStreamBuffer::  renamed GetFreeSpace() -> GetAvailableSpace()
  72. * to avoid clash with MS-Win system headers' #define
  73. *
  74. * Revision 1.22  2001/01/05 20:08:53  vasilche
  75. * Added util directory for various algorithms and utility classes.
  76. *
  77. * Revision 1.21  2000/12/26 22:23:45  vasilche
  78. * Fixed errors of compilation on Mac.
  79. *
  80. * Revision 1.20  2000/12/15 15:38:02  vasilche
  81. * Added support of Int8 and long double.
  82. * Enum values now have type Int4 instead of long.
  83. *
  84. * Revision 1.19  2000/10/20 15:51:28  vasilche
  85. * Fixed data error processing.
  86. * Added interface for constructing container objects directly into output stream.
  87. * object.hpp, object.inl and object.cpp were split to
  88. * objectinfo.*, objecttype.*, objectiter.* and objectio.*.
  89. *
  90. * Revision 1.18  2000/10/13 20:59:12  vasilche
  91. * Avoid using of ssize_t absent on some compilers.
  92. *
  93. * Revision 1.17  2000/10/13 20:22:47  vasilche
  94. * Fixed warnings on 64 bit compilers.
  95. * Fixed missing typename in templates.
  96. *
  97. * Revision 1.16  2000/08/15 19:44:42  vasilche
  98. * Added Read/Write hooks:
  99. * CReadObjectHook/CWriteObjectHook for objects of specified type.
  100. * CReadClassMemberHook/CWriteClassMemberHook for specified members.
  101. * CReadChoiceVariantHook/CWriteChoiceVariant for specified choice variants.
  102. * CReadContainerElementHook/CWriteContainerElementsHook for containers.
  103. *
  104. * Revision 1.15  2000/07/03 20:47:18  vasilche
  105. * Removed unused variables/functions.
  106. *
  107. * Revision 1.14  2000/06/16 20:01:21  vasilche
  108. * Avoid use of unexpected_exception() which is unimplemented on Mac.
  109. *
  110. * Revision 1.13  2000/06/16 16:31:08  vasilche
  111. * Changed implementation of choices and classes info to allow use of the same classes in generated and user written classes.
  112. *
  113. * Revision 1.12  2000/06/01 19:06:59  vasilche
  114. * Added parsing of XML data.
  115. *
  116. * Revision 1.11  2000/05/24 20:08:16  vasilche
  117. * Implemented XML dump.
  118. *
  119. * Revision 1.10  2000/05/03 14:38:06  vasilche
  120. * SERIAL: added support for delayed reading to generated classes.
  121. * DATATOOL: added code generation for delayed reading.
  122. *
  123. * Revision 1.9  2000/04/28 16:58:03  vasilche
  124. * Added classes CByteSource and CByteSourceReader for generic reading.
  125. * Added delayed reading of choice variants.
  126. *
  127. * Revision 1.8  2000/04/13 14:50:18  vasilche
  128. * Added CObjectIStream::Open() and CObjectOStream::Open() for easier use.
  129. *
  130. * Revision 1.7  2000/04/10 21:01:40  vasilche
  131. * Fixed Erase for map/set.
  132. * Added iteratorbase.hpp header for basic internal classes.
  133. *
  134. * Revision 1.6  2000/04/06 16:10:52  vasilche
  135. * Fixed bug with iterators in choices.
  136. * Removed unneeded calls to ReadExternalObject/WriteExternalObject.
  137. * Added output buffering to text ASN.1 data.
  138. *
  139. * Revision 1.5  2000/03/07 14:05:33  vasilche
  140. * Added stream buffering to ASN.1 binary input.
  141. * Optimized class loading/storing.
  142. * Fixed bugs in processing OPTIONAL fields.
  143. *
  144. * Revision 1.4  2000/02/17 20:02:29  vasilche
  145. * Added some standard serialization exceptions.
  146. * Optimized text/binary ASN.1 reading.
  147. * Fixed wrong encoding of StringStore in ASN.1 binary format.
  148. * Optimized logic of object collection.
  149. *
  150. * Revision 1.3  2000/02/11 17:10:20  vasilche
  151. * Optimized text parsing.
  152. *
  153. * Revision 1.2  2000/02/02 19:07:38  vasilche
  154. * Added THROWS_NONE to constructor/destructor of exception.
  155. *
  156. * Revision 1.1  2000/02/01 21:44:36  vasilche
  157. * Added CGeneratedChoiceTypeInfo for generated choice classes.
  158. * Added buffering to CObjectIStreamAsn.
  159. * Removed CMemberInfo subclasses.
  160. * Added support for DEFAULT/OPTIONAL members.
  161. *
  162. *
  163. * ===========================================================================
  164. */
  165. #include <corelib/ncbistd.hpp>
  166. #include <corelib/ncbiobj.hpp>
  167. #include <util/util_exception.hpp>
  168. #include <string.h>
  169. #include <util/bytesrc.hpp>
  170. /** @addtogroup StreamSupport
  171.  *
  172.  * @{
  173.  */
  174. BEGIN_NCBI_SCOPE
  175. class CByteSource;
  176. class CByteSourceReader;
  177. class CSubSourceCollector;
  178. #define THROWS1(arg)
  179. #define THROWS1_NONE
  180. class NCBI_XUTIL_EXPORT CIStreamBuffer
  181. {
  182. public:
  183.     CIStreamBuffer(void)
  184.         THROWS1((bad_alloc));
  185.     ~CIStreamBuffer(void);
  186.     
  187.     bool fail(void) const;
  188.     void ResetFail(void);
  189.     const char* GetError(void) const;
  190.     void Open(CByteSourceReader& reader);
  191.     void Close(void);
  192.     char PeekChar(size_t offset = 0)
  193.         THROWS1((CIOException, bad_alloc));
  194.     char PeekCharNoEOF(size_t offset = 0);
  195.     char GetChar(void)
  196.         THROWS1((CIOException, bad_alloc));
  197.     // precondition: GetChar or SkipChar was last method called
  198.     void UngetChar(char c);
  199.     // precondition: PeekChar(c) was called when c >= count
  200.     void SkipChars(size_t count);
  201.     // equivalent of SkipChars(1)
  202.     void SkipChar(void);
  203.     // read chars in buffer
  204.     void GetChars(char* buffer, size_t count)
  205.         THROWS1((CIOException));
  206.     // skip chars which may not be in buffer
  207.     void GetChars(size_t count)
  208.         THROWS1((CIOException));
  209.     // precondition: last char extracted was either 'r' or 'n'
  210.     // action: increment line count and
  211.     //         extract next complimentary 'r' or 'n' char if any
  212.     void SkipEndOfLine(char lastChar)
  213.         THROWS1((CIOException));
  214.     // action: skip all spaces (' ') and return next non space char
  215.     //         without extracting it
  216.     char SkipSpaces(void)
  217.         THROWS1((CIOException));
  218.     // find specified symbol and set position on it
  219.     void FindChar(char c)
  220.         THROWS1((CIOException));
  221.     // find specified symbol without skipping
  222.     // limit - search by 'limit' symbols
  223.     // return relative offset of symbol from current position
  224.     //     (limit if not found)
  225.     size_t PeekFindChar(char c, size_t limit)
  226.         THROWS1((CIOException));
  227.     const char* GetCurrentPos(void) const THROWS1_NONE;
  228.     // return: current line counter
  229.     size_t GetLine(void) const THROWS1_NONE;
  230.     size_t GetStreamOffset(void) const THROWS1_NONE;
  231.     void   SetStreamOffset(size_t pos);
  232.     
  233.     // action: read in buffer up to end of line
  234.     size_t ReadLine(char* buff, size_t size)
  235.         THROWS1((CIOException));
  236.     Int4 GetInt4(void)
  237.         THROWS1((CIOException));
  238.     Uint4 GetUint4(void)
  239.         THROWS1((CIOException));
  240.     Int8 GetInt8(void)
  241.         THROWS1((CIOException));
  242.     Uint8 GetUint8(void)
  243.         THROWS1((CIOException));
  244.     void StartSubSource(void);
  245.     CRef<CByteSource> EndSubSource(void);
  246. protected:
  247.     // action: fill buffer so *pos char is valid
  248.     // return: new value of pos pointer if buffer content was shifted
  249.     char* FillBuffer(char* pos, bool noEOF = false)
  250.         THROWS1((CIOException, bad_alloc));
  251.     char FillBufferNoEOF(char* pos)
  252.         THROWS1((CIOException, bad_alloc));
  253.     void BadNumber(void);
  254. private:
  255.     CRef<CByteSourceReader> m_Input;
  256.     const char* m_Error;
  257.     size_t m_BufferOffset; // offset of current buffer in source stream
  258.     size_t m_BufferSize;      // buffer size
  259.     char* m_Buffer;           // buffer pointer
  260.     char* m_CurrentPos;       // current char position in buffer
  261.     char* m_DataEndPos;       // end of valid content in buffer
  262.     size_t m_Line;            // current line counter
  263.     char* m_CollectPos;
  264.     CRef<CSubSourceCollector> m_Collector;
  265. };
  266. class NCBI_XUTIL_EXPORT COStreamBuffer
  267. {
  268. public:
  269.     COStreamBuffer(CNcbiOstream& out, bool deleteOut = false)
  270.         THROWS1((bad_alloc));
  271.     ~COStreamBuffer(void);
  272.     bool fail(void) const;
  273.     void ResetFail(void);
  274.     const char* GetError(void) const;
  275.     void Close(void);
  276.     // return: current line counter
  277.     size_t GetLine(void) const THROWS1_NONE;
  278.     size_t GetStreamOffset(void) const THROWS1_NONE;
  279.     size_t GetCurrentLineLength(void) const THROWS1_NONE;
  280.     bool ZeroIndentLevel(void) const THROWS1_NONE;
  281.     size_t GetIndentLevel(size_t step = 2) const THROWS1_NONE;
  282.     void IncIndentLevel(size_t step = 2) THROWS1_NONE;
  283.     void DecIndentLevel(size_t step = 2) THROWS1_NONE;
  284.     void SetBackLimit(size_t limit);
  285.     void FlushBuffer(bool fullBuffer = true) THROWS1((CIOException));
  286.     void Flush(void) THROWS1((CIOException));
  287.     void SetUseIndentation(bool set);
  288.     bool GetUseIndentation(void) const;
  289. protected:
  290.     // flush contents of buffer to underlying stream
  291.     // make sure 'reserve' char area is available in buffer
  292.     // return beginning of area
  293.     char* DoReserve(size_t reserve = 0)
  294.         THROWS1((CIOException, bad_alloc));
  295.     // flush contents of buffer to underlying stream
  296.     // make sure 'reserve' char area is available in buffer
  297.     // skip 'reserve' chars
  298.     // return beginning of skipped area
  299.     char* DoSkip(size_t reserve)
  300.         THROWS1((CIOException, bad_alloc));
  301.     // allocates count bytes area in buffer and skip this area
  302.     // returns beginning of this area
  303.     char* Skip(size_t count)
  304.         THROWS1((CIOException, bad_alloc));
  305.     char* Reserve(size_t count)
  306.         THROWS1((CIOException, bad_alloc));
  307. public:
  308.     void PutChar(char c)
  309.         THROWS1((CIOException));
  310.     void BackChar(char c);
  311.     void PutString(const char* str, size_t length)
  312.         THROWS1((CIOException, bad_alloc));
  313.     void PutString(const char* str)
  314.         THROWS1((CIOException, bad_alloc));
  315.     void PutString(const string& str)
  316.         THROWS1((CIOException, bad_alloc));
  317.     void PutIndent(void)
  318.         THROWS1((CIOException, bad_alloc));
  319.     void PutEol(bool indent = true)
  320.         THROWS1((CIOException, bad_alloc));
  321.     void PutEolAtWordEnd(size_t lineLength)
  322.         THROWS1((CIOException, bad_alloc));
  323.     void WrapAt(size_t lineLength, bool keepWord)
  324.         THROWS1((CIOException, bad_alloc));
  325.     void PutInt4(Int4 v)
  326.         THROWS1((CIOException, bad_alloc));
  327.     void PutUint4(Uint4 v)
  328.         THROWS1((CIOException, bad_alloc));
  329.     void PutInt8(Int8 v)
  330.         THROWS1((CIOException, bad_alloc));
  331.     void PutUint8(Uint8 v)
  332.         THROWS1((CIOException, bad_alloc));
  333.     void Write(const char* data, size_t dataLength)
  334.         THROWS1((CIOException, bad_alloc));
  335.     void Write(CByteSourceReader& reader)
  336.         THROWS1((CIOException, bad_alloc));
  337. private:
  338.     CNcbiOstream& m_Output;
  339.     bool m_DeleteOutput;
  340.     const char* m_Error;
  341.     size_t GetUsedSpace(void) const;
  342.     size_t GetAvailableSpace(void) const;
  343.     size_t GetBufferSize(void) const;
  344.     size_t m_IndentLevel;
  345.     size_t m_BufferOffset; // offset of current buffer in source stream
  346.     char* m_Buffer;           // buffer pointer
  347.     char* m_CurrentPos;       // current char position in buffer
  348.     char* m_BufferEnd;       // end of valid content in buffer
  349.     size_t m_Line;            // current line counter
  350.     size_t m_LineLength;
  351.     size_t m_BackLimit;
  352.     bool m_UseIndentation;
  353. };
  354. /* @} */
  355. #include <util/strbuffer.inl>
  356. END_NCBI_SCOPE
  357. #endif