path: root/src/OSSupport/GZipFile.h

// GZipFile.h

// Declares the cGZipFile class representing a RAII wrapper over zlib's GZip file routines





#pragma once

#include "zlib/zlib.h"





class cGZipFile
{
public:
	enum eMode
	{
		fmRead,      // Read-only. If the file doesn't exist, object will not be valid
		fmWrite,     // Write-only. If the file already exists, it will be overwritten
	} ;

	cGZipFile(void);
	~cGZipFile();

	/** Opens the file. Returns true if successful. Fails if a file has already been opened through this object. */
	bool Open(const AString & a_FileName, eMode a_Mode);

	/** Closes the file, flushing all buffers. This object may be then reused for a different file and / or mode */
	void Close(void);

	/** Reads the rest of the file and decompresses it into a_Contents. Returns the number of decompressed bytes, <0 for error */
	int ReadRestOfFile(AString & a_Contents);

	/** Writes a_Contents into file, compressing it along the way. Returns true if successful. Multiple writes are supported. */
	bool Write(const AString & a_Contents) { return Write(a_Contents.data(), static_cast<int>(a_Contents.size())); }

	bool Write(const char * a_Data, int a_Size);

protected:
	gzFile m_File;
	eMode  m_Mode;
} ;