output_bzip2 Class Reference

#include <bzip2.h>

Inheritance diagram for output_bzip2:

Public Member Functions
virtual	~output_bzip2 ()
Static Public Member Functions
static pointer	create (const output::pointer &deeper)
Protected Member Functions
nstring	filename () const
long	ftell_inner () const
void	write_inner (const void *data, size_t length)
int	page_width () const
int	page_length () const
const char *	type_name () const
void	end_of_line_inner ()
Private Types
enum	{ BUFFER_SIZE = 1 << 14 }
Private Member Functions
	output_bzip2 (const output::pointer &deeper)
void	bzlib_fatal_error (int err)
	output_bzip2 ()
	output_bzip2 (const output_bzip2 &)
output_bzip2 &	operator= (const output_bzip2 &)
Private Attributes
output::pointer	deeper
bz_stream	stream
char *	buf
long	pos
bool	bol

---

Detailed Description

The output_bzip2 class is used to represent an output filter which compresses the data before writing it to the deeper output stream.

Definition at line 31 of file bzip2.h.

---

Member Enumeration Documentation

anonymous enum [private]

Enumerator:

BUFFER_SIZE

Definition at line 95 of file bzip2.h.

---

Constructor & Destructor Documentation

virtual output_bzip2::~output_bzip2

(

)

[virtual]

The destructor.

output_bzip2::output_bzip2

(

const output::pointer &

deeper

)

[private]

The constructor. It is private on purpose, use the create class method instead.

Parameters:

deeper

the output stream this filter will write its output to.

output_bzip2::output_bzip2

(

)

[private]

The default constructor. Do not use.

output_bzip2::output_bzip2

(

const output_bzip2 &

)

[private]

The copy constructor. Do not use.

---

Member Function Documentation

static pointer output_bzip2::create

(

const output::pointer &

deeper

)

[static]

The create class method is used to create new dynamically allocated instances of this class.

Parameters:

deeper

the output stream this filter will write its output to.

nstring output_bzip2::filename

(

)

const [protected, virtual]

The filename method is used to obtain the filename of this output.

Implements output.

long output_bzip2::ftell_inner

(

)

const [protected, virtual]

The ftell_inner method is used to determine the current file position, without taking the buffering into account.

Implements output.

void output_bzip2::write_inner	(	const void *	data,
		size_t	length
	)			[protected, virtual]

The write_inner method is used write data to the output, without taking the buffering into account.

Implements output.

int output_bzip2::page_width

(

)

const [protected, virtual]

The page_width method is used to obtain the width of the page of the output device.

Reimplemented from output.

int output_bzip2::page_length

(

)

const [protected, virtual]

The page_length method is used to obtain the length of the page of the output device.

Reimplemented from output.

const char* output_bzip2::type_name

(

)

const [protected, virtual]

The type_name method is used to determine the name of this output device or file or type.

Implements output.

void output_bzip2::end_of_line_inner

(

)

[protected, virtual]

The end_of_line_inner method is used to ensure that the current output position is at the beginning of a line, without taking the buffering into account.

Implements output.

void output_bzip2::bzlib_fatal_error

(

int

err

)

[private]

The bzlib_fatal_error method is used to report a fatal error from the bzip2 engine.

output_bzip2& output_bzip2::operator=

(

const output_bzip2 &

)

[private]

The assignment operator. Do not use.

---

Field Documentation

output::pointer output_bzip2::deeper [private]

The deeper instance variable is used to remember the output stream this filter will write its output to.

Definition at line 87 of file bzip2.h.

bz_stream output_bzip2::stream [private]

The stream instance variable is used to remember somthign that the bzip2 code wants to remember. It is opaque to us.

Definition at line 93 of file bzip2.h.

char* output_bzip2::buf [private]

The buf instance variable is used to remember the buffered output data.

Definition at line 101 of file bzip2.h.

long output_bzip2::pos [private]

The pos instance variable is used to remember the current output position.

Definition at line 107 of file bzip2.h.

bool output_bzip2::bol [private]

The bol instance variable is used to remember whether or not the output is positioned at the beginning of a lone.

Definition at line 113 of file bzip2.h.

---

The documentation for this class was generated from the following file:

• libaegis/output/bzip2.h