Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members

FXBzipStream.h

Go to the documentation of this file.
00001 /********************************************************************************
00002 *                                                                               *
00003 *                  BZip compression on arbitrary streams                        *
00004 *                                                                               *
00005 *********************************************************************************
00006 * Copyright (C) 2003 by Mathew Robertson.   All Rights Reserved.                *
00007 *********************************************************************************
00008 * This library is free software; you can redistribute it and/or                 *
00009 * modify it under the terms of the GNU Lesser General Public                    *
00010 * License as published by the Free Software Foundation; either                  *
00011 * version 2.1 of the License, or (at your option) any later version.            *
00012 *                                                                               *
00013 * This library is distributed in the hope that it will be useful,               *
00014 * but WITHOUT ANY WARRANTY; without even the implied warranty of                *
00015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU             *
00016 * Lesser General Public License for more details.                               *
00017 *                                                                               *
00018 * You should have received a copy of the GNU Lesser General Public              *
00019 * License along with this library; if not, write to the Free Software           *
00020 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.    *
00021 ********************************************************************************/
00022 #ifdef HAVE_LIBBZ2
00023 #ifndef FXBZIPSTREAM_H
00024 #define FXBZIPSTREAM_H
00025 
00026 #ifndef FXBUFFEREDSTREAM_H
00027 #include "FXBufferedStream.h"
00028 #endif
00029 namespace FXEX {
00030 
00031 /**
00032  * Provides a way to BZIP un/compress any type of FOX stream
00033  *
00034  * Notes:
00035  * - currently the 'work factor' of the Bzip library, has no public interface
00036  */
00037 class FXAPI FXBzipStream : public FXBufferedStream {
00038 private:
00039   FXint verbosity;  // the debugging level of the library
00040   FXint workFactor; // manipulate the compression algorithm - zero implies the default value
00041   FXint small;      // alter algorithm to use less memory at the expense of speed
00042   FXint blockSize;  // number of 100K block sizes - relates directly to compression factor
00043 
00044 protected:
00045   /// prior to saving to stream, compress it
00046   virtual FXbool bufferSave();
00047 
00048   /// after loading from stream, uncompress it
00049   virtual FXbool bufferLoad();
00050 
00051 public:
00052   /// Create a Bzip stream to save-to or load-from based on the direction of the underlying stream
00053   FXBzipStream(FXStream* s,FXint compFactor=COMPRESS_MAX,const FXObject* cont=NULL);
00054 
00055   /// Destructor
00056   virtual ~FXBzipStream() {}
00057   };
00058 
00059 } // namespace FXEX
00060 #endif // FXBZIPSTREAM_H
00061 #endif