axmol/cocos2dx/support/zip_support/ZipUtils.h

/****************************************************************************
Copyright (c) 2010 cocos2d-x.org

http://www.cocos2d-x.org

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
****************************************************************************/
#ifndef __SUPPORT_ZIPUTILS_H__
#define __SUPPORT_ZIPUTILS_H__

namespace cocos2d
{
	/* XXX: pragma pack ??? */
	/** @struct CCZHeader
	*/
	struct CCZHeader {
		unsigned char			sig[4];				// signature. Should be 'CCZ!' 4 bytes
		unsigned short		    compression_type;	// should 0
		unsigned char		    version;			// should be 2 (although version type==1 is also supported)
		unsigned int 		    reserved;			// Reserverd for users.
		unsigned int		    len;				// size of the uncompressed file
	};

	enum {
		CCZ_COMPRESSION_ZLIB,				// zlib format.
		CCZ_COMPRESSION_BZIP2,				// bzip2 format (not supported yet)
		CCZ_COMPRESSION_GZIP,				// gzip format (not supported yet)
		CCZ_COMPRESSION_NONE,				// plain (not supported yet)
	};

    class ZipUtils
	{
	public:
		/** 
		* Inflates either zlib or gzip deflated memory. The inflated memory is
		* expected to be freed by the caller.
		*
		* It will allocate 256k for the destination buffer. If it is not enought it will multiply the previous buffer size per 2, until there is enough memory.
		* @returns the length of the deflated buffer
		*
		@since v0.8.1
		*/
		static int ccInflateMemory(unsigned char *in, unsigned int inLength, unsigned char **out);

		/** 
		* Inflates either zlib or gzip deflated memory. The inflated memory is
		* expected to be freed by the caller.
		*
		* outLenghtHint is assumed to be the needed room to allocate the inflated buffer.
		*
		* @returns the length of the deflated buffer
		*
		@since v1.0.0
		*/
		static int ccInflateMemoryWithHint(unsigned char *in, unsigned int inLength, unsigned char **out, unsigned int outLenghtHint);

		/** inflates a GZip file into memory
		*
		* @returns the length of the deflated buffer
		*
		* @since v0.99.5
		*/
		static int ccInflateGZipFile(const char *filename, unsigned char **out);

		/** inflates a CCZ file into memory
		*
		* @returns the length of the deflated buffer
		*
		* @since v0.99.5
		*/
		static int ccInflateCCZFile(const char *filename, unsigned char **out);

	private:
		static int ccInflateMemoryWithHint(unsigned char *in, unsigned int inLength, unsigned char **out, unsigned int *outLength, 
			unsigned int outLenghtHint);
	};

} // end of namespace cocos2d
#endif // __PLATFORM_WOPHONE_ZIPUTILS_H__