ObjectiveLib: GzipInStream.h Source File

00001 //
00002 // $Id: GzipInStream.h,v 1.11 2007/03/06 20:42:19 will_mason Exp $
00003 //
00004 // vi: set ft=objc:
00005 
00006 /*
00007  * ObjectiveLib - a library of containers and algorithms for Objective-C
00008  *
00009  * Copyright (c) 2004-2007
00010  * Will Mason
00011  *
00012  * Portions:
00013  *
00014  * Copyright (c) 1994
00015  * Hewlett-Packard Company
00016  *
00017  * Copyright (c) 1996,1997
00018  * Silicon Graphics Computer Systems, Inc.
00019  *
00020  * Copyright (c) 1997
00021  * Moscow Center for SPARC Technology
00022  *
00023  * Copyright (c) 1999 
00024  * Boris Fomitchev
00025  *
00026  * This library is free software; you can redistribute it and/or
00027  * modify it under the terms of the GNU Lesser General Public
00028  * License as published by the Free Software Foundation; either
00029  * version 2.1 of the License, or (at your option) any later version.
00030  *
00031  * This library is distributed in the hope that it will be useful,
00032  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00033  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00034  * Lesser General Public License for more details.
00035  *
00036  * You should have received a copy of the GNU Lesser General Public
00037  * License along with this library; if not, write to the Free Software
00038  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00039  *
00040  * You may contact the author at will_mason@users.sourceforge.net.
00041  */
00042 
00043 #if !defined(GZIPINSTREAM_OL_GUARD)
00044 #define GZIPINSTREAM_OL_GUARD
00045 
00046 #include <ObjectiveLib/ZlibInStream.h>
00047 
00048 @class OLMap;
00049 
00063 @interface OLGzipInStream : OLZlibInStream
00064 {
00065 @protected
00069     char*       fileName;
00070 
00074     char*       comment;
00075 
00079     OLMap*      extraFields;
00080 
00084     uint32_t    modTime;
00085 
00089     uint32_t    crc;
00090 
00094     BOOL        endOfStream;
00095 }
00096 
00097 + (id) streamWithInStream: (OLInStream*)underStream;
00098 
00102 /* @{ */
00119 - (id) initWithInStream: (OLInStream*)underStream bufferSize: (unsigned)size readZlibHeader: (BOOL)zlibHeader;
00120 #if !defined(OL_NO_OPENSTEP)
00121 - (void) dealloc;
00122 #endif
00123 /* @} */
00124 
00131 - (const char*) comment;
00132 
00145 - (const uint8_t*) extraField: (const char*)identifier count: (unsigned*)countOut;
00146 
00147 #if defined(OL_NO_OPENSTEP)
00148 - (void) freeStreamResources;
00149 #endif
00150 
00158 - (uint32_t) modificationTime;
00159 
00166 - (const char*) originalFileName;
00167 - (unsigned) readBytes: (uint8_t*)dest count: (unsigned)max;
00168 
00169 @end
00170 
00171 #endif