Source

lrc / src / strategies / zLibCompression.hxx

Full commit
//      zLibCompression.hxx
//
//      Copyright 2011 Andreas Tscharner <andy@vis.ethz.ch>
//
//      This program is free software; you can redistribute it and/or modify
//      it under the terms of the GNU Lesser General Public License as
//      published by the Free Software Foundation; either version 3 of the
//      License, or (at your option) any later version.
//
//      This program is distributed in the hope that it will be useful,
//      but WITHOUT ANY WARRANTY; without even the implied warranty of
//      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//      GNU General Public License for more details.
//
//      You should have received a copy of the GNU Lesser General Public
//      License along with this program; if not, write to the Free Software
//      Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
//      MA 02110-1301, USA.


/*! \file zLibCompression.hxx
 *
 * This file contains the declaration of the zLib compression class. This
 * class is used to compress and decompress teh resource data using the zLib
 * algorithm.
 *
 * \author Andreas Tscharner
 * \date 2011-08-14
 */


#ifndef __ZLIBCOMPRESSION_HXX__
#define __ZLIBCOMPRESSION_HXX__


#include "../include/CompressDecompress.hxx"

/*! \class zLibCompression
 *
 * \brief Compression class that uses the \em zLib algorithm
 *
 * This class uses the zLib algorithm for compression and decompression of
 * the resource data.
 */
class zLibCompression : public lrc::CompressDecompress
{
	public:
		/*! \brief zLib compression
		 *
		 * This method compresses the given data using the zLib algorithm
		 */
		int compress(const unsigned char *, size_t, unsigned char **, size_t &);
		/*! \brief zLib decompression
		 *
		 * This method decompresses the given data using the zLib algorithm
		 */
		int decompress(const unsigned char *, size_t, unsigned char **, size_t &);
};


#endif /* __ZLIBCOMPRESSION_HXX__ */