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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: stream_utils.hpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/02/12 21:58:18  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [CORE_001] Dev-tree R1.18
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef UTIL___STREAM_UTILS__HPP
  10. #define UTIL___STREAM_UTILS__HPP
  11. /*  $Id: stream_utils.hpp,v 1000.1 2004/02/12 21:58:18 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.  * Authors:  Denis Vakatov, Anton Lavrentiev
  37.  *
  38.  * File Description:
  39.  *   Stream utilities:
  40.  *   1. Push an arbitrary block of data back to C++ input stream.
  41.  *   2. Non-blocking read from a stream.
  42.  *
  43.  */
  44. #include <corelib/ncbistre.hpp>
  45. /** @addtogroup StreamSupport
  46.  *
  47.  * @{
  48.  */
  49. BEGIN_NCBI_SCOPE
  50. #ifdef NCBI_COMPILER_MIPSPRO
  51. class CMIPSPRO_ReadsomeTolerantStreambuf : public CNcbiStreambuf
  52. {
  53. public:
  54.     // Do not use these two ugly, weird, ad-hoc methods, ever!!!
  55.     void MIPSPRO_ReadsomeBegin(void);
  56.     void MIPSPRO_ReadsomeEnd  (void);
  57. protected:
  58.     CMIPSPRO_ReadsomeTolerantStreambuf();
  59.     const CT_CHAR_TYPE* m_MIPSPRO_ReadsomeGptr;
  60.     unsigned int        m_MIPSPRO_ReadsomeGptrSetLevel;
  61. };
  62. inline
  63. CMIPSPRO_ReadsomeTolerantStreambuf::CMIPSPRO_ReadsomeTolerantStreambuf() :
  64.     m_MIPSPRO_ReadsomeGptrSetLevel(0)
  65. {
  66. }
  67. inline
  68. void CMIPSPRO_ReadsomeTolerantStreambuf::MIPSPRO_ReadsomeBegin(void)
  69. {
  70.     if (!m_MIPSPRO_ReadsomeGptrSetLevel++)
  71.         m_MIPSPRO_ReadsomeGptr = gptr();
  72. }
  73. inline
  74. void CMIPSPRO_ReadsomeTolerantStreambuf::MIPSPRO_ReadsomeEnd(void)
  75. {
  76.     --m_MIPSPRO_ReadsomeGptrSetLevel;
  77. }
  78. #endif // NCBI_COMPILER_MIPSPRO
  79. struct NCBI_XUTIL_EXPORT CStreamUtils {
  80. // Push the block of data [buf, buf+buf_size) back to the input stream "is".
  81. // If "del_ptr" is not NULL, then `delete[] (CT_CHAR_TYPE*) del_ptr' is called
  82. // some time between the moment you call this function and when either the
  83. // passed data is all read from the stream, or if the stream is destroyed.
  84. // Until all of the passed data is read from the stream, this block of
  85. // data may be used by the input stream.
  86. // NOTE 1:  at the function's discretion, a copy of the data can be created
  87. //          and used instead of the original [buf, buf+buf_size) area.
  88. // NOTE 2:  this data does not go to the original streambuf of "is".
  89. // NOTE 3:  it's okay if "is" is actually a duplex stream (iostream).
  90. // NOTE 4:  after a pushback "is" is not allowed to do stream positioning
  91. //          relative to current position (ios::cur); only direct-access
  92. //          (ios::beg, ios::end) seeks are okay (if permitted by "is").
  93. // NOTE 5:  stream re-positioning made after pushback clears all pushback data.
  94.     static void       Pushback(CNcbiIstream&       is,
  95.                                CT_CHAR_TYPE*       buf,
  96.                                streamsize          buf_size,
  97.                                void*               del_ptr);
  98. // Acts just like its counterpart with 4 args (above), but this variant always
  99. // copies the "pushback data" into internal buffer, so you can do whatever you
  100. // want to with the [buf, buf+buf_size) area after calling this function.
  101.     static void       Pushback(CNcbiIstream&       is,
  102.                                const CT_CHAR_TYPE* buf,
  103.                                streamsize          buf_size);
  104. // Read at most "buf_size" bytes from the stream "is" into a buffer pointed
  105. // to by "buf". This call tries its best to be non-blocking.
  106. // Return the number of bytes actually read (or 0 if nothing was read, in
  107. // case of either an error or no data currently available).
  108.     static streamsize Readsome(CNcbiIstream&       is,
  109.                                CT_CHAR_TYPE*       buf,
  110.                                streamsize          buf_size);
  111. };
  112. /* @} */
  113. END_NCBI_SCOPE
  114. /*
  115.  * ---------------------------------------------------------------------------
  116.  * $Log: stream_utils.hpp,v $
  117.  * Revision 1000.1  2004/02/12 21:58:18  gouriano
  118.  * PRODUCTION: UPGRADED [CORE_001] Dev-tree R1.18
  119.  *
  120.  * Revision 1.18  2004/01/20 20:33:52  lavr
  121.  * Remove HAVE_BUGGY_IOS_CALLBACKS from this header
  122.  *
  123.  * Revision 1.17  2003/12/29 15:15:10  lavr
  124.  * Class CShowmanycStreambuf removed
  125.  *
  126.  * Revision 1.16  2003/12/18 13:23:40  ucko
  127.  * It seems MIPSpro also lacks showmanyc, so extend our
  128.  * streambuf-with-showmanyc class to cover it as well and make it
  129.  * CMIPSPRO_ReadsomeTolerantStreambuf's base class.
  130.  *
  131.  * Revision 1.15  2003/12/18 03:43:28  ucko
  132.  * Add CGCC_ShowmanycStreambuf as a layer between streambuf and
  133.  * CConn_Streambuf for the benefit of Readsome.
  134.  *
  135.  * Revision 1.14  2003/10/23 16:16:46  vasilche
  136.  * Added Windows export modifiers.
  137.  *
  138.  * Revision 1.13  2003/10/22 18:14:16  lavr
  139.  * Change base class of CPushback_Streambuf into CNcbiStreambuf
  140.  *
  141.  * Revision 1.12  2003/09/22 20:26:56  lavr
  142.  * Undef HAVE_BUGGY_IOS_CALLBACKS before defining
  143.  *
  144.  * Revision 1.11  2003/04/17 17:50:34  siyan
  145.  * Added doxygen support
  146.  *
  147.  * Revision 1.10  2003/04/14 21:09:07  lavr
  148.  * Define HAVE_BUGGY_IOS_CALLBACKS for Sun Workshop compiler in MT mode
  149.  *
  150.  * Revision 1.9  2003/03/30 06:59:50  lavr
  151.  * MIPS-specific workaround for lame-designed stream read ops
  152.  *
  153.  * Revision 1.8  2002/12/19 14:51:00  dicuccio
  154.  * Added export specifier for Win32 DLL builds.
  155.  *
  156.  * Revision 1.7  2002/11/28 03:27:19  lavr
  157.  * File description updated
  158.  *
  159.  * Revision 1.6  2002/11/27 21:07:19  lavr
  160.  * Rename "stream_pushback" -> "stream_utils" and enclose utils in a class
  161.  *
  162.  * Revision 1.5  2002/11/06 03:50:39  lavr
  163.  * Correct duplicated NOTE 4; move log to end; change guard macro
  164.  *
  165.  * Revision 1.4  2002/10/29 22:06:22  ucko
  166.  * Make *buf const in the copying version of UTIL_StreamPushback.
  167.  *
  168.  * Revision 1.3  2002/02/05 19:37:04  lavr
  169.  * List of included header files revised
  170.  *
  171.  * Revision 1.2  2002/02/04 20:20:28  lavr
  172.  * Notes about stream repositioning added
  173.  *
  174.  * Revision 1.1  2001/12/09 06:28:59  vakatov
  175.  * Initial revision
  176.  *
  177.  * ===========================================================================
  178.  */
  179. #endif  /* UTIL___STREAM_UTILS__HPP */