Compression

Classes
class	CBZip2Compression
class	CBZip2CompressionFile
class	CBZip2Compressor
	CBZip2Compressor -- bzip2 based compressor. More...
class	CBZip2Decompressor
	CBZip2Decompressor -- bzip2 based decompressor. More...
class	CBZip2StreamCompressor
class	CBZip2StreamDecompressor
class	ICompression
class	CCompression
class	CCompressionFile
class	CCompressionProcessor
class	CCompressionException
class	CCompressionUtil
class	CNlmZipBtRdr
class	CDynamicCharArray
class	CNlmZipReader
class	CTarException
	CTarException --. More...
class	CTarEntryInfo
	CTarEntryInfo class. More...
class	CTar
	CTar class. More...
class	CZipCompression
	CZipCompression --. More...
class	CZipCompressionFile
	CZipCompressionFile --. More...
class	CZipCompressor
	CZipCompressor -- zlib based compressor. More...
class	CZipDecompressor
	CZipCompressor -- zlib based decompressor. More...
class	CZipStreamCompressor
	CZipStreamCompressor -- zlib based compression stream processor. More...
class	CZipStreamDecompressor
	CZipStreamDecompressor -- zlib based decompression stream processor. More...
Defines
#define	ERR_COMPRESS(subcode, message)   ERR_POST_X(subcode, Warning << message)
	Macro to report errors in compression API.
Typedefs
typedef unsigned int	TTarMode
Enumerations
enum	ETarModeBits {   fTarSetUID = 04000, fTarSetGID = 02000, fTarSticky = 01000, fTarURead = 00400,   fTarUWrite = 00200, fTarUExecute = 00100, fTarGRead = 00040, fTarGWrite = 00020,   fTarGExecute = 00010, fTarORead = 00004, fTarOWrite = 00002, fTarOExecute = 00001 }
	ETarMode --. More...
Functions
ostream &	operator<< (ostream &, const CTarEntryInfo &)
	Nice TOC(table of contents) printout.
void	CTar::Create (void)
	Create a new empty archive.
void	CTar::Close (void)
	Close the archive making sure all pending output is flushed.
auto_ptr< TEntries >	CTar::Append (const string &name)
	Append an entry at the end of the archive that already exists.
auto_ptr< TEntries >	CTar::Update (const string &name)
	Look for more recent copies, if available, of archive members, and place them at the end of the archive:.
auto_ptr< TEntries >	CTar::List (void)
	Get information about all matching archive entries.
void	CTar::Test (void)
	Verify archive integrity.
TFlags	CTar::GetFlags (void) const
	Get processing flags.
void	CTar::SetFlags (TFlags flags)
	Set processing flags.
void	CTar::SetMask (CMask *mask, EOwnership own=eNoOwnership)
	Set name mask.
void	CTar::UnsetMask (void)
	Unset name mask.
const string &	CTar::GetBaseDir (void) const
	Get base directory to use for files while extracting from/adding to the archive, and in the latter case used only for relative paths.
Variables
const streamsize	kCompressionDefaultBufSize = 16*1024
	Default compression I/O stream buffer size.
const int	kZlibDefaultWbits = -1
const int	kZlibDefaultMemLevel = -1
const int	kZlibDefaultStrategy = -1
const int	kZlibDefaultCompression = -1

---

Define Documentation

#define ERR_COMPRESS (  subcode, message   )     ERR_POST_X(subcode, Warning << message)

Macro to report errors in compression API. Definition at line 51 of file compress.hpp. Referenced by CBZip2CompressionFile::Close(), CZipCompression::CompressBuffer(), CBZip2Compression::CompressBuffer(), CZipCompression::DecompressBuffer(), CBZip2Compression::DecompressBuffer(), CZipDecompressor::End(), CZipCompressor::End(), CBZip2Decompressor::End(), CBZip2Compressor::End(), CZipCompressor::Finish(), CBZip2Compressor::Finish(), CZipCompressor::Flush(), CBZip2Compressor::Flush(), CZipDecompressor::Init(), CZipCompressor::Init(), CBZip2Decompressor::Init(), CBZip2Compressor::Init(), CBZip2CompressionFile::Open(), CZipDecompressor::Process(), CZipCompressor::Process(), CBZip2Decompressor::Process(), CBZip2Compressor::Process(), CBZip2CompressionFile::Read(), CBZip2CompressionFile::Write(), and CCompressionStreambuf::~CCompressionStreambuf().

---

Typedef Documentation

typedef unsigned int TTarMode

Definition at line 88 of file tar.hpp.

---

Enumeration Type Documentation

enum ETarModeBits

ETarMode --. Permission bits as defined in tar Enumerator: fTarSetUID  fTarSetGID  fTarSticky  fTarURead  fTarUWrite  fTarUExecute  fTarGRead  fTarGWrite  fTarGExecute  fTarORead  fTarOWrite  fTarOExecute  Definition at line 72 of file tar.hpp.

---

Function Documentation

auto_ptr< CTar::TEntries > CTar::Append (  const string &  name  )  [inline, inherited]

Append an entry at the end of the archive that already exists. Appended entry can be either a file, a directory, a symbolic link, a device special file (block or character), or a FIFO special file. The name is taken with respect to the base directory, if any set. Adding a directory results in all its files and subdirectories to get added (examine the return value to find out what has been added). Note that the final name of an entry may not contain embedded '..'. Leading slash in the absolute paths will be retained. The names of all appended entries will be converted to Unix format (that is, to have forward slashes in the paths, and drive letter, if any on MS-Windows, stripped). All entries will be added at the logical end (not always EOF) of the archive, when appending to non-empty one. Returns: A list of the appended entries. See also: Create, Update, SetBaseDir Definition at line 651 of file tar.hpp. References CTar::eAppend, CTar::x_Append(), and CTar::x_Open().

void CTar::Close (  void   )  [inline, inherited]

Close the archive making sure all pending output is flushed. Normally, direct call of this method need _not_ intersperse successive archive manipulations by other methods, as they open and close the archive automatically as necessary. Rather, this call is to make sure the archive is complete earlier than it usually be done in the destructor of the CTar object. See also: ~CTar Definition at line 644 of file tar.hpp. References CTar::x_Close(), and CTar::x_Flush(). Referenced by CTar::~CTar().

void CTar::Create (  void   )  [inline, inherited]

Create a new empty archive. If a file with such name already exists it will be rewritten. See also: Append Definition at line 638 of file tar.hpp. References CTar::eCreate, and CTar::x_Open().

const string & CTar::GetBaseDir (  void   )  const [inline, inherited]

Get base directory to use for files while extracting from/adding to the archive, and in the latter case used only for relative paths. See also: SetBaseDir Definition at line 706 of file tar.hpp. References CTar::m_BaseDir.

CTar::TFlags CTar::GetFlags (  void   )  const [inline, inherited]

Get processing flags. Definition at line 677 of file tar.hpp. References CTar::m_Flags.

auto_ptr< CTar::TEntries > CTar::List (  void   )  [inline, inherited]

Get information about all matching archive entries. Returns: An array containing information on those archive entries, whose names match pre-set mask. See also: SetMask Definition at line 665 of file tar.hpp. References CTar::eList, and CTar::x_Open().

ostream& operator<< (  ostream &  , const CTarEntryInfo &  )

Nice TOC(table of contents) printout. Definition at line 584 of file tar.cpp.

void CTar::SetFlags (  TFlags  flags  )  [inline, inherited]

Set processing flags. Definition at line 683 of file tar.hpp. References CTar::m_Flags.

void CTar::SetMask (  CMask *  mask, EOwnership  own = eNoOwnership )  [inline, inherited]

Set name mask. The set of masks is used to process existing entries in archive, and apply to list and extract operations only. If masks are not defined then all archive entries will be processed. By default, the masks are used case sensitively. To cancel this and use the masks case-insensitively SetFlags() can be called with fMaskNocase flag set. Parameters: mask  Set of masks. own  Flag to take ownership on the masks (delete upon CTar destruction). See also: Definition at line 689 of file tar.hpp. References CTar::m_Mask, CTar::m_MaskOwned, and CTar::UnsetMask().

void CTar::Test (  void   )  [inline, inherited]

Verify archive integrity. Read through the archive without actually extracting anything from it. Definition at line 671 of file tar.hpp. References CTar::eTest, and CTar::x_Open().

void CTar::UnsetMask (  void   )  [inline, inherited]

Unset name mask. Upon mask reset, all entries become subject to archive processing in list and extract operations. See also: SetMask Definition at line 697 of file tar.hpp. References CTar::m_Mask, and CTar::m_MaskOwned. Referenced by CTar::SetMask(), and CTar::~CTar().

auto_ptr< CTar::TEntries > CTar::Update (  const string &  name  )  [inline, inherited]

Look for more recent copies, if available, of archive members, and place them at the end of the archive:. if fUpdate is set in processing flags, only the existing archive entries (including directories) will be updated; that is, Update(".") won't recursively add "." if "." is not the archive member; it will, however, do the recursive update should "." be found in the archive. if fUpdate is unset, the existing entries will be updated (if their filesystem counterparts are newer), and inexistent entries will be added to the archive; that is, Update(".") will recursively scan "." to update both existing entries (if newer files found), and also add new entries for any files/directories, which are currently not in. Returns: A list of entries that have been updated. See also: Append, SetBaseDir, SetFlags Definition at line 658 of file tar.hpp. References CTar::eUpdate, auto_ptr< X >::get(), CTar::x_Append(), and CTar::x_Open().

---

Variable Documentation

const streamsize kCompressionDefaultBufSize = 16*1024

Default compression I/O stream buffer size. Definition at line 48 of file compress.hpp.

const int kZlibDefaultCompression = -1

Definition at line 97 of file zlib.hpp. Referenced by CZipCompression::GetDefaultLevel().

const int kZlibDefaultMemLevel = -1

Definition at line 95 of file zlib.hpp. Referenced by CZipCompression::CZipCompression().

const int kZlibDefaultStrategy = -1

Definition at line 96 of file zlib.hpp. Referenced by CZipCompression::CZipCompression(), and s_Compress().

const int kZlibDefaultWbits = -1

Definition at line 94 of file zlib.hpp. Referenced by CZipCompression::CZipCompression(), CCleanupApp::x_OpenIStream(), CAsn2FlatApp::x_OpenIStream(), and CAsn2FastaApp::x_OpenIStream().

---