Aegis  4.25.D505
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
output_filter Class Reference

#include <filter.h>

Inheritance diagram for output_filter:
output output_filter_base64 output_filter_bzip2 output_filter_dot_blank_lines output_filter_gzip output_filter_indent output_filter_prefix output_filter_quoted_printable output_filter_set_width output_filter_uuencode output_filter_wrap_make output_filter_wrap_simple

Public Member Functions

virtual ~output_filter ()

Protected Member Functions

 output_filter (const output::pointer &deeper)
nstring filename (void) const
int page_width (void) const
int page_length (void) const
long ftell_inner (void) const
void write_inner (const void *data, size_t length)
void end_of_line_inner (void)
void flush_inner (void)
nstring type_name (void) const
void deeper_fputc (char c)
void deeper_fputs (const char *s)
void deeper_fputs (const nstring &s)
void deeper_write (const void *d, size_t ds)

Private Member Functions

 output_filter ()
 output_filter (const output_filter &)
output_filteroperator= (const output_filter &)

Private Attributes

output::pointer deeper

Detailed Description

The output_filter class is used to represent the processing common to all output filters, so that filters need only implement the necessary methods.

Definition at line 29 of file filter.h.


Constructor & Destructor Documentation

virtual output_filter::~output_filter ( ) [virtual]

The destructor.

output_filter::output_filter ( const output::pointer deeper) [protected]

The constructor. For use by derived classes only.

Parameters:
deeperWhere to write the filtered output.

The default constructor. Do not use.

The copy constructor. Do not use.


Member Function Documentation

void output_filter::deeper_fputc ( char  c) [inline, protected]

Definition at line 72 of file filter.h.

void output_filter::deeper_fputs ( const char *  s) [inline, protected]

Definition at line 73 of file filter.h.

void output_filter::deeper_fputs ( const nstring s) [inline, protected]

Definition at line 74 of file filter.h.

void output_filter::deeper_write ( const void *  d,
size_t  ds 
) [inline, protected]

Definition at line 75 of file filter.h.

void output_filter::end_of_line_inner ( void  ) [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.

Reimplemented in output_filter_indent, output_filter_prefix, output_filter_wrap_simple, output_filter_uuencode, output_filter_bzip2, output_filter_gzip, output_filter_wrap_make, output_filter_base64, output_filter_quoted_printable, and output_filter_dot_blank_lines.

nstring output_filter::filename ( void  ) const [protected, virtual]

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

Implements output.

Reimplemented in output_filter_uuencode.

void output_filter::flush_inner ( void  ) [protected, virtual]

The flush_inner method is called by the flush method once all the data has been written. The default implementation does nothing.

Reimplemented from output.

long output_filter::ftell_inner ( void  ) const [protected, virtual]

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

Implements output.

Reimplemented in output_filter_indent, output_filter_uuencode, output_filter_base64, output_filter_prefix, output_filter_bzip2, output_filter_gzip, and output_filter_dot_blank_lines.

output_filter& output_filter::operator= ( const output_filter ) [private]

The assignment operator. Do not use.

int output_filter::page_length ( void  ) const [protected, virtual]

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

Reimplemented from output.

Reimplemented in output_filter_uuencode.

int output_filter::page_width ( void  ) const [protected, virtual]

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

Reimplemented from output.

Reimplemented in output_filter_uuencode, output_filter_quoted_printable, output_filter_prefix, and output_filter_set_width.

nstring output_filter::type_name ( void  ) const [protected, virtual]
void output_filter::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.

Reimplemented in output_filter_indent, output_filter_uuencode, output_filter_wrap_make, output_filter_wrap_simple, output_filter_base64, output_filter_prefix, output_filter_quoted_printable, output_filter_bzip2, output_filter_gzip, and output_filter_dot_blank_lines.


Field Documentation

The deeper instance variable is used to remember where to write the filtered output.

Definition at line 82 of file filter.h.


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