Aegis  4.25.D505
Data Structures | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes
output_filter_quoted_printable Class Reference

#include <quoted_print.h>

Inheritance diagram for output_filter_quoted_printable:
output_filter output

Data Structures

struct  glyph_t

Public Member Functions

virtual ~output_filter_quoted_printable ()

Static Public Member Functions

static pointer create (const output::pointer &deeper, bool allow_international_characters=false)

Protected Member Functions

nstring type_name (void) const
void write_inner (const void *data, size_t length)
void end_of_line_inner (void)
int page_width (void) const

Private Types

enum  { MAX_LINE_LEN = 76 }

Private Member Functions

 output_filter_quoted_printable (const output::pointer &deeper, bool allow_international_characters=false)
void eoln (bool soft)
void eoln_partial (void)
void eoln_hard (void)
 output_filter_quoted_printable ()
 output_filter_quoted_printable (const output_filter_quoted_printable &)
output_filter_quoted_printableoperator= (const output_filter_quoted_printable &)

Private Attributes

bool allow_international_characters
glyph_t glyph [MAX_LINE_LEN+1]
int pos

Detailed Description

The output_filter_quoted_printable class is used to filter an output stream to include quored printable encoding of the content, as required.

Definition at line 28 of file quoted_print.h.


Member Enumeration Documentation

anonymous enum [private]
Enumerator:
MAX_LINE_LEN 

Definition at line 90 of file quoted_print.h.


Constructor & Destructor Documentation

The destructor.

output_filter_quoted_printable::output_filter_quoted_printable ( const output::pointer deeper,
bool  allow_international_characters = false 
) [private]

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

Parameters:
deeperThe output stream this filter uses to write its output.
allow_international_charactersWhether or not internalional characters are allowed or not.

The default constructor. Do not use.

The copy constructor. Do not use.


Member Function Documentation

static pointer output_filter_quoted_printable::create ( const output::pointer deeper,
bool  allow_international_characters = false 
) [static]

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

Parameters:
deeperThe output stream this filter uses to write its output.
allow_international_charactersWhether or not internalional characters are allowed or not.
void output_filter_quoted_printable::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.

Reimplemented from output_filter.

void output_filter_quoted_printable::eoln ( bool  soft) [private]

The eoln method is used to send the contents of the glyph array to the deeper output stream.

Parameters:
softEither the array got too long (true), or a newline was seen (false).
void output_filter_quoted_printable::eoln_hard ( void  ) [private]

The eoln_hard method is used to output a hard end-of-line, when a newline character is seen.

The newline_partial method is used to output a soft end-of-line when the quoted line length exceeds the MAX_LINE_LEN limit.

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

The assignment apperator. Do not use.

int output_filter_quoted_printable::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_filter.

nstring output_filter_quoted_printable::type_name ( void  ) const [protected, virtual]

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

Reimplemented from output_filter.

void output_filter_quoted_printable::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.

Reimplemented from output_filter.


Field Documentation

The allow_international_characters instance variable is used to remember whether or not internalional characters are allowed (true) or to be quoted as unprintable (false).

Definition at line 80 of file quoted_print.h.

The glyph instance variable is used to remember

Definition at line 96 of file quoted_print.h.

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

Definition at line 102 of file quoted_print.h.


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