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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: streambuf.hpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/02/12 21:59:44  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [CORE_001] Dev-tree R1.7
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef UTIL_COMPRESS__STREAMBUF__HPP
  10. #define UTIL_COMPRESS__STREAMBUF__HPP
  11. /*  $Id: streambuf.hpp,v 1000.1 2004/02/12 21:59:44 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:  Vladimir Ivanov
  37.  *
  38.  * File Description:  CCompression based C++ streambuf
  39.  *
  40.  */
  41. #include <util/compress/stream.hpp>
  42. BEGIN_NCBI_SCOPE
  43. /** @addtogroup CompressionStreams
  44.  *
  45.  * @{
  46.  */
  47. //////////////////////////////////////////////////////////////////////////////
  48. //
  49. // CCompression based streambuf class
  50. //
  51. class NCBI_XUTIL_EXPORT CCompressionStreambuf : public CNcbiStreambuf
  52. {
  53. public:
  54.     // 'ctors
  55.     // If read/write stream processor is 0, that read/write operation
  56.     // will fail on this stream.
  57.     CCompressionStreambuf(
  58.         CNcbiIos*                    stream,
  59.         CCompressionStreamProcessor* read_stream_processor,
  60.         CCompressionStreamProcessor* write_stream_processor
  61.     );
  62.     virtual ~CCompressionStreambuf(void);
  63.     // Get streambuf status
  64.     bool  IsOkay(void) const;
  65.     // Finalize stream's compression/decompression process for read/write.
  66.     // This function calls a processor's Finish() and End() functions.
  67.     virtual void Finalize(CCompressionStream::EDirection dir =
  68.             CCompressionStream::eReadWrite);
  69. protected:
  70.     // Streambuf overloaded functions
  71.     virtual CT_INT_TYPE overflow(CT_INT_TYPE c);
  72.     virtual CT_INT_TYPE underflow(void);
  73.     virtual int         sync(void);
  74.     virtual streamsize  xsputn(const CT_CHAR_TYPE* buf, streamsize count);
  75.     virtual streamsize  xsgetn(CT_CHAR_TYPE* buf, streamsize n);
  76.     // This method is declared here to be disabled (exception) at run-time
  77.     virtual streambuf*  setbuf(CT_CHAR_TYPE* buf, streamsize buf_size);
  78. protected:
  79.     // Get compression/stream processor for specified I/O direction.
  80.     // Return 0 if a processor for the specified direction does not
  81.     // installed.
  82.     CCompressionProcessor* GetCompressionProcessor(
  83.          CCompressionStream::EDirection dir) const;
  84.     CCompressionStreamProcessor* GetStreamProcessor(
  85.          CCompressionStream::EDirection dir) const;
  86.     // Get stream processor's status
  87.     bool IsStreamProcessorOkay(
  88.          CCompressionStream::EDirection dir) const;
  89.     // Sync I/O buffers for the specified direction.
  90.     // Return 0 if the get area is empty and there are no more characters to
  91.     // output; otherwise, it returns -1 (EOF).
  92.     virtual int Sync(CCompressionStream::EDirection dir);
  93.     // Process a data from the input buffer and put result into the out.buffer
  94.     bool Process(CCompressionStream::EDirection dir);
  95.     virtual bool ProcessStreamRead(void);
  96.     virtual bool ProcessStreamWrite(void);
  97. protected:
  98.     CNcbiIos*     m_Stream;   // Underlying I/O stream
  99.     CCompressionStreamProcessor* 
  100.                   m_Reader;   // Processor's info for reading from m_Stream
  101.     CCompressionStreamProcessor*
  102.                   m_Writer;   // Processor's info for writing into m_Stream
  103.     CT_CHAR_TYPE* m_Buf;      // Pointer to internal buffers
  104. };
  105. /* @} */
  106. //
  107. // Inline function
  108. //
  109. inline CCompressionProcessor*
  110.     CCompressionStreambuf::GetCompressionProcessor(
  111.         CCompressionStream::EDirection dir) const
  112. {
  113.     return dir == CCompressionStream::eRead ? m_Reader->m_Processor :
  114.                                               m_Writer->m_Processor;
  115. }
  116. inline CCompressionStreamProcessor*
  117.     CCompressionStreambuf::GetStreamProcessor(
  118.         CCompressionStream::EDirection dir) const
  119. {
  120.     return dir == CCompressionStream::eRead ? m_Reader : m_Writer;
  121. }
  122. inline bool CCompressionStreambuf::IsOkay(void) const
  123. {
  124.     return !!m_Stream  &&  !!m_Buf;
  125. }
  126. inline bool CCompressionStreambuf::IsStreamProcessorOkay(
  127.             CCompressionStream::EDirection dir) const
  128. {
  129.     CCompressionStreamProcessor* sp = GetStreamProcessor(dir);
  130.     return IsOkay()  && sp  &&  !sp->m_Finalized  && 
  131.            sp->m_Processor  &&  sp->m_Processor->IsBusy();
  132. }
  133. inline bool CCompressionStreambuf::Process(CCompressionStream::EDirection dir)
  134. {
  135.     return dir == CCompressionStream::eRead ?
  136.                   ProcessStreamRead() :  ProcessStreamWrite();
  137. }
  138. inline streambuf* CCompressionStreambuf::setbuf(CT_CHAR_TYPE* /* buf */,
  139.                                                 streamsize    /* buf_size */)
  140. {
  141.     NCBI_THROW(CCompressionException, eCompression,
  142.                "CCompressionStreambuf::setbuf() not allowed");
  143.     return this; // notreached
  144. }
  145. END_NCBI_SCOPE
  146. /*
  147.  * ===========================================================================
  148.  * $Log: streambuf.hpp,v $
  149.  * Revision 1000.1  2004/02/12 21:59:44  gouriano
  150.  * PRODUCTION: UPGRADED [CORE_001] Dev-tree R1.7
  151.  *
  152.  * Revision 1.7  2004/01/20 21:07:59  ucko
  153.  * Fix typo in previous revision.
  154.  *
  155.  * Revision 1.6  2004/01/20 20:38:14  lavr
  156.  * Proper Doxygen vs ncbi namespace group nesting
  157.  *
  158.  * Revision 1.5  2004/01/06 18:59:39  ivanov
  159.  * Removed the extra semicolon
  160.  *
  161.  * Revision 1.4  2003/06/17 15:47:31  ivanov
  162.  * The second Compression API redesign. Rewritten CCompressionStreambuf to use
  163.  * I/O stream processors of class CCompressionStreamProcessor.
  164.  *
  165.  * Revision 1.3  2003/06/03 20:09:16  ivanov
  166.  * The Compression API redesign. Added some new classes, rewritten old.
  167.  *
  168.  * Revision 1.2  2003/04/15 16:51:12  ivanov
  169.  * Fixed error with flushing the streambuf after it finalizaton
  170.  *
  171.  * Revision 1.1  2003/04/11 19:54:47  ivanov
  172.  * Move streambuf.hpp from 'include/...' to 'src/...'
  173.  *
  174.  * Revision 1.1  2003/04/07 20:42:11  ivanov
  175.  * Initial revision
  176.  *
  177.  * ===========================================================================
  178.  */
  179. #endif  /* UTIL_COMPRESS__STREAMBUF__HPP */