|
CLASS moGZip
NAME
Contructor - creates a new GZip file
Destructor - closes the GZip file
VERSION
Version: 1.2.0
SYNOPSIS
moGZip(void);
moGZip(const char *filename, gzip_mode_t mode = GZIP_MODE_DEFAULT, mowc::encoding_t encoding = mowc::MO_ENCODING_UTF8);
moGZip(const mowc::mc_t *filename, gzip_mode_t mode = GZIP_MODE_DEFAULT, mowc::encoding_t encoding = mowc::MO_ENCODING_UTF32_INTERNAL);
moGZip(const mowc::wc_t *filename, gzip_mode_t mode = GZIP_MODE_DEFAULT, mowc::encoding_t encoding = mowc::MO_ENCODING_UTF32_INTERNAL);
moGZip(const wchar_t *filename, gzip_mode_t mode = GZIP_MODE_DEFAULT);
moGZip(const moWCString& filename, gzip_mode_t mode = GZIP_MODE_DEFAULT);
virtual ~moGZip();
private:
void Init(void);
PARAMETERS
filename - name of the output GZip file
mode - how to compress (filter & level)
encoding - how the filename is encoded
DESCRIPTION
To create a GZip-ed file, use this object as the output stream.
You can easer specify a filename on creation or use the Open()
function.
When deleted, this object ensures the GZip file is being properly
closed.
To write in the stream, use the usual stream functions.
The Init() function is used internally to initialize the object.
The mode is the level (0-9) and a filter flag:
GZIP_FILTER_DEFAULT best compression
GZIP_FILTER_FAST try quickly to compress
very well
GZIP_FILTER_HUFFMAN compress using Huffman only
The default mode is to compress everything to the best the
library can do.
SEE ALSO
Open, Close, moOStream
COPYRIGHTS
This documentation and the code being documented is proprietary and cannot be duplicated without the express and written consent of Made to Order Software Coporation.
Copyright (c) 1999-2007 by Made to Order Software Corporation
All rights reserved.
AUTHORS
Alexis Wilke, Doug Barbieri
CLASS
moGZip
NAME
Open - opens a GZip file for writing
Close - closes the GZip file attached to this moGZip object
VERSION
Version: 1.2.0
SYNOPSIS
bool Open(const char *filename, gzip_mode_t mode = GZIP_MODE_DEFAULT, mowc::encoding_t encoding = mowc::MO_ENCODING_UTF8);
bool Open(const mowc::mc_t *filename, gzip_mode_t mode = GZIP_MODE_DEFAULT, mowc::encoding_t encoding = mowc::MO_ENCODING_UTF32_INTERNAL);
bool Open(const mowc::wc_t *filename, gzip_mode_t mode = GZIP_MODE_DEFAULT, mowc::encoding_t encoding = mowc::MO_ENCODING_UTF32_INTERNAL);
bool Open(const wchar_t *filename, gzip_mode_t mode = GZIP_MODE_DEFAULT);
bool Open(const moWCString& filename, gzip_mode_t mode = GZIP_MODE_DEFAULT);
void Close(void);
DESCRIPTION
It is possible, with the same GZip object, to create multiple
GZip-ed files. For this, call the Open() function to close
the currently open GZip and open a new file.
The Close() will be called once you have sent all the data
via the moOStream functions.
SEE ALSO
Constructor, moOStream
COPYRIGHTS
This documentation and the code being documented is proprietary and cannot be duplicated without the express and written consent of Made to Order Software Coporation.
Copyright (c) 1999-2007 by Made to Order Software Corporation
All rights reserved.
AUTHORS
Alexis Wilke, Doug Barbieri
CLASS
moGZip
NAME
RawWrite - overwritten RawWrite() function
VERSION
Version: 1.2.0
SYNOPSIS
private:
int RawWrite(const void *buffer, size_t length);
PARAMETERS
buffer - a pointer to a buffer where the data is copied from
length - the number of bytes in buffer which will be copied to the output
DESCRIPTION
This function will be called by any of the functions which
write to the moOStream object (Put, Write).
SEE ALSO
Constructor, moOStream
COPYRIGHTS
This documentation and the code being documented is proprietary and cannot be duplicated without the express and written consent of Made to Order Software Coporation.
Copyright (c) 1999-2007 by Made to Order Software Corporation
All rights reserved.
AUTHORS
Alexis Wilke, Doug Barbieri
CLASS
moGunZip
NAME
Contructor - creates an object used to read an existing GZip file
Destructor - closes the GZip file
VERSION
Version: 1.2.0
SYNOPSIS
moGunZip(void);
moGunZip(const char *filename, mowc::encoding_t encoding = mowc::MO_ENCODING_UTF8);
moGunZip(const mowc::mc_t *filename, mowc::encoding_t encoding = mowc::MO_ENCODING_UTF32_INTERNAL);
moGunZip(const mowc::wc_t *filename, mowc::encoding_t encoding = mowc::MO_ENCODING_UTF32_INTERNAL);
moGunZip(const wchar_t *filename);
moGunZip(const moWCString& filename);
virtual ~moGunZip();
private:
void Init(void);
PARAMETERS
filename - name of the existing GZip file
encoding - the encoding of the filename
DESCRIPTION
To read a GZip-ed file, use this object as the input stream.
You can easer specify a filename on creation or use the Open()
function.
When deleted, this object ensures the GZip file is properly
closed.
To read from the stream, use the usual stream functions.
The Init() function is used internally to initialize the object.
SEE ALSO
Open, Close, moIStream
COPYRIGHTS
This documentation and the code being documented is proprietary and cannot be duplicated without the express and written consent of Made to Order Software Coporation.
Copyright (c) 1999-2007 by Made to Order Software Corporation
All rights reserved.
AUTHORS
Alexis Wilke, Doug Barbieri
CLASS
moGunZip
NAME
Open - opens a GZip-ed file for writing
Close - closes the GZip-ed file attached to this moGunZip object
VERSION
Version: 1.2.0
SYNOPSIS
bool Open(const char *filename, mowc::encoding_t encoding = mowc::MO_ENCODING_UTF8);
bool Open(const mowc::mc_t *filename, mowc::encoding_t encoding = mowc::MO_ENCODING_UTF32_INTERNAL);
bool Open(const mowc::wc_t *filename, mowc::encoding_t encoding = mowc::MO_ENCODING_UTF32_INTERNAL);
bool Open(const wchar_t *filename);
bool Open(const moWCString& filename);
void Close(void);
PARAMETERS
filename - name of the existing GZip file
encoding - the encoding of the filename
DESCRIPTION
It is possible, with the same GunZip object, to read multiple
GZip-ed files. For this, call the Open() function to close
the currently open GZip-ed file and open a new one.
The Close() can be called once you have read all the data
via the moIStream functions.
SEE ALSO
Constructor, moIStream
COPYRIGHTS
This documentation and the code being documented is proprietary and cannot be duplicated without the express and written consent of Made to Order Software Coporation.
Copyright (c) 1999-2007 by Made to Order Software Corporation
All rights reserved.
AUTHORS
Alexis Wilke, Doug Barbieri
CLASS
moGunZip
NAME
RawRead - overwritten RawRead() function
VERSION
Version: 1.2.0
SYNOPSIS
private:
int RawRead(void *buffer, size_t length);
PARAMETERS
buffer - a pointer to a buffer where the data is read to
length - the number of bytes in buffer which can be used
DESCRIPTION
This function will be called by any of the functions which
read from the moIStream object (Get, Read).
SEE ALSO
Constructor, moIStream
COPYRIGHTS
This documentation and the code being documented is proprietary and cannot be duplicated without the express and written consent of Made to Order Software Coporation.
Copyright (c) 1999-2007 by Made to Order Software Corporation
All rights reserved.
AUTHORS
Alexis Wilke, Doug Barbieri
CLASS
moGunZip::gzip_mode_t
NAME
Constructor - create and initialize the mode
Set - initialize the mode
VERSION
Version: 1.2.0
SYNOPSIS
gzip_mode_t(void);
gzip_mode_t(unsigned long mode);
gzip_mode_t(unsigned long filter, unsigned long level);
gzip_mode_t& operator = (unsigned long mode);
void Set(unsigned long filter, unsigned long level);
PARAMETERS
filter - the filter type, one of:
GZIP_FILTER_DEFAULT
GZIP_FILTER_FAST
GZIP_FILTER_HUFFMAN
level - the strength of the compression
mode - the combined filter and level
DESCRIPTION
These functions will set the mode to the specified filter
and level. The constructor without a parameter will set
the mode to the default (GZIP_MODE_DEFAULT).
SEE ALSO
Filter, Level
COPYRIGHTS
This documentation and the code being documented is proprietary and cannot be duplicated without the express and written consent of Made to Order Software Coporation.
Copyright (c) 1999-2007 by Made to Order Software Corporation
All rights reserved.
AUTHORS
Alexis Wilke, Doug Barbieri
Links:
molib
the sandbox
|
