Diffpack Documentation

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Search

ASCIIReporter Class Reference

a report manager based on plain ASCII files. More...

#include <ASCIIReporter.h>

Inheritance diagram for ASCIIReporter::

Public Methods
	ASCIIReporter (Os os)
	ASCIIReporter (const String &filename)
virtual	~ASCIIReporter ()
virtual Reporter&	header (const String &title, const String &author, bool fullpage=true, bool singlefile=true, const char *purpose=NULL)
virtual Reporter&	trailer ()
virtual String	getSectionRef ()
virtual Reporter&	section (const String &txt)
virtual Reporter&	section (const String &txt, const String &label)
virtual Reporter&	subsection (const String &txt)
virtual Reporter&	subsection (const String &txt, const String &label)
virtual Reporter&	subsubsection (const String &txt)
virtual Reporter&	subsubsection (const String &txt, const String &label)
virtual Reporter&	pagebreak ()
virtual Reporter&	linebreak ()
virtual Reporter&	eject (int n=1)
virtual Reporter&	drawline ()
virtual String	cellpad (const String &s)
virtual Reporter&	centerline (const String &txt)
virtual Reporter&	insertDocument (const String &basename)
virtual Reporter&	insertVerbatim (const String &file)
virtual Reporter&	beginCenter ()
virtual Reporter&	endCenter ()
virtual Reporter&	beginTabular (int ncols, const String &col_format)
virtual Reporter&	endTabular ()
virtual Reporter&	beginTable (int ncols, const String &col_format)
virtual Reporter&	endTable (const String &caption, const String &label)
virtual Reporter&	beginItemize ()
virtual Reporter&	endItemize ()
virtual Reporter&	beginEnumerate ()
virtual Reporter&	endEnumerate ()
virtual Reporter&	beginFigure (const String &psfilename, real cmWidth=10.0)
virtual Reporter&	endFigure (const String &caption, const String &label)
virtual Reporter&	beginDispmath ()
virtual Reporter&	endDispmath ()
virtual String	makeLabelRef (const String &label)
virtual void	process (bool postscript=true)
virtual void	print (bool postscript=true)
virtual void	preview (bool postscript=true)
Protected Methods
virtual void	putTextline (const String &txt)
virtual void	putTabularline (const String &txt)
virtual void	putTableline (const String &txt)
virtual void	putItemline (const String &txt)
virtual void	putEnumline (const String &txt)
virtual void	putFigureline (const String &txt)
virtual void	putDispmathline (const String &txt)
virtual void	putCenterline (const String &txt)
void	fill (const char c='', const int n=1)
void	space (const int n=1)

Detailed Description

a report manager based on plain ASCII files.

NAME: ASCIIReporter - a report manager based on plain ASCII files

DESCRIPTION:

This class offers an interface to report generation in plain ASCII format, suitable for printing by "mpage" or similar formatting utilities. Note that there is no support for PostScript figures in an ASCII report.

Constructor & Destructor Documentation

ASCIIReporter::ASCIIReporter ( Os os )

See class "Reporter".

ASCIIReporter::ASCIIReporter ( const String & filename )

See documentation of one of the overloaded constructor.

ASCIIReporter::~ASCIIReporter ( ) [inline, virtual]

Member Function Documentation

Reporter & ASCIIReporter::beginCenter ( ) [virtual]

Start a centered block of displayed text. All "put" operations before the next call to "endCenter" will be produce text that is centered on the line.
Reimplemented from Reporter.

Reporter & ASCIIReporter::beginDispmath ( ) [virtual]

Starts a block of displayed text in math mode. This block is ended by a call to "endDispmath". Usually, it is more convenient to use a single call to "displaymath".
Reimplemented from Reporter.

Reporter & ASCIIReporter::beginEnumerate ( ) [virtual]

Similar to the itemize environment, except that all items are numbered 1,2,...,n.
Reimplemented from Reporter.

Reporter & ASCIIReporter::beginFigure ( const String & psfilename,

real cmWidth = 10.0 ) [virtual]

Starts a figure block which inserts the PostScript illustration given by "psfilename". The figure is scaled to have a width of "cmWidth" centimeters. This environment must be ended by a call to "endFigure". Usually, we perform these actions by a single call to the function "figure". Note that inclusion of figures may not be possible for all types of report classes. In these cases, the figure environment is neglected and its use result in a warning message. The parameters "caption" and "label" in "endTable" are used to generate a table caption and adding a label for easy reference.
Reimplemented from Reporter.

Reporter & ASCIIReporter::beginItemize ( ) [virtual]

Start a block of itemized text. All "put" operations before using "endItemized" result in an item on the list.
Reimplemented from Reporter.

Reporter & ASCIIReporter::beginTable ( int ncols,

const String & col_format ) [virtual]

Table entries are forced to be left justified, i.e., the argument "col_format" is neglected. In order to get the table entries lined up properly, the user is encouraged to apply the "put" functions that operate on array structures. If it is preferable to use the simple "String"-based "put", the function "cellpad" is usually needed to obtain a satisfactory result. This is clearly illustrated when running the example program from the "Reporter" documentation in ASCII mode.
Reimplemented from Reporter.

Reporter & ASCIIReporter::beginTabular ( int ncols,

const String & col_format ) [virtual]

As "beginTable" without caption and labelling. This environment is closed by "endTabular".
Reimplemented from Reporter.

String ASCIIReporter::cellpad ( const String & s ) [virtual]

Utility for easy formatting of table cells, see "beginTable".
Reimplemented from Reporter.

Reporter & ASCIIReporter::centerline ( const String & txt ) [virtual]

Print a centered line without extra spacing.
Reimplemented from Reporter.

Reporter & ASCIIReporter::drawline ( ) [virtual]

Just that, draw a line across the full pagewidth. However, when used within a table environment it is meant to be a line across the full table.
Reimplemented from Reporter.

Reporter & ASCIIReporter::eject ( int n = 1 ) [virtual]

Produce n blank lines (that actually shows up in final printing).
Reimplemented from Reporter.

Reporter & ASCIIReporter::endCenter ( ) [virtual]

Reimplemented from Reporter.

Reporter & ASCIIReporter::endDispmath ( ) [virtual]

Reimplemented from Reporter.

Reporter & ASCIIReporter::endEnumerate ( ) [virtual]

Reimplemented from Reporter.

Reporter & ASCIIReporter::endFigure ( const String & caption,

const String & label ) [virtual]

Reimplemented from Reporter.

Reporter & ASCIIReporter::endItemize ( ) [virtual]

Reimplemented from Reporter.

Reporter & ASCIIReporter::endTable ( const String & caption,

const String & label ) [virtual]

Reimplemented from Reporter.

Reporter & ASCIIReporter::endTabular ( ) [virtual]

Reimplemented from Reporter.

void ASCIIReporter::fill ( const char c = ' ',

const int n = 1 ) [protected]

String ASCIIReporter::getSectionRef ( ) [virtual]

Returns a "String" containing the current section reference.
Reimplemented from Reporter.

Reporter & ASCIIReporter::header ( const String & title,

const String & author,

bool fullpage = true,

bool singlefile = true,

const char * purpose = NULL ) [virtual]

Create titles for the first page. The arguments "fullpage" and "singlefile" decides whether a separate titlepage is generated and whether the present file will hold one or many reports. The "purpose" string leads to a comment in the header about the purpose of the report (if it is a "NULL" string, which is default, no such comment appears). Usually, "header" is the initial call to a function in a reporter. The function "trailer" provides its counterpart for use at the end of a report.
Reimplemented from Reporter.

Reporter & ASCIIReporter::insertDocument ( const String & basename ) [virtual]

Insert a document in the report. The argument should reflect the basename of the document's name, without extensions such as ".ps" or ".tex". In ASCII reports, insertion of documents is impossible, `\`LaTeX`\` reports appends the extension ".tex" to the basename and includes that document, while HTML reports append ".ps" to the basename, assumes that it is a PostScript file and make a hyperlink to this file.
Reimplemented from Reporter.

Reporter & ASCIIReporter::insertVerbatim ( const String & file ) [virtual]

Insert a document as is (verbatim mode).
Reimplemented from Reporter.

Reporter & ASCIIReporter::linebreak ( ) [virtual]

Start a new line.
Reimplemented from Reporter.

String ASCIIReporter::makeLabelRef ( const String & label ) [virtual]

Receives a string previously used as "label" argument in a figure or table environment. The function returns a valid label reference based on the cross-refererencing mechanisms of the underlying report format.
Reimplemented from Reporter.

Reporter & ASCIIReporter::pagebreak ( ) [virtual]

Start a new page.
Reimplemented from Reporter.

void ASCIIReporter::preview ( bool postscript = true ) [virtual]

Reimplemented from Reporter.

void ASCIIReporter::print ( bool postscript = true ) [virtual]

Reimplemented from Reporter.

void ASCIIReporter::process ( bool postscript = true ) [virtual]

System defaults may be overruled by the environment variables "ASCIIRep_CLEANUP_CMD", "ASCIIRep_PROCESS_TXT_CMD", "ASCIIRep_PROCESS_PS_CMD", "ASCIIRep_PRINT_TXT_CMD", "ASCIIRep_PRINT_PS_CMD", "ASCIIRep_PREVIEW_TXT_CMD", "ASCIIRep_PREVIEW_PS_CMD". See the file "ReporterSysCmd.h" for examples.
Reimplemented from Reporter.

void ASCIIReporter::putCenterline ( const String & txt ) [protected, virtual]

Reimplemented from Reporter.

void ASCIIReporter::putDispmathline ( const String & txt ) [protected, virtual]

Reimplemented from Reporter.

void ASCIIReporter::putEnumline ( const String & txt ) [protected, virtual]

Reimplemented from Reporter.

void ASCIIReporter::putFigureline ( const String & txt ) [protected, virtual]

Reimplemented from Reporter.

void ASCIIReporter::putItemline ( const String & txt ) [protected, virtual]

Reimplemented from Reporter.

void ASCIIReporter::putTableline ( const String & txt ) [protected, virtual]

Reimplemented from Reporter.

void ASCIIReporter::putTabularline ( const String & txt ) [protected, virtual]

Reimplemented from Reporter.

void ASCIIReporter::putTextline ( const String & txt ) [protected, virtual]

Reimplemented from Reporter.

Reporter & ASCIIReporter::section ( const String & txt,

const String & label ) [inline, virtual]

See documentation of one of the overloaded functions.
Reimplemented from Reporter.

Reporter & ASCIIReporter::section ( const String & txt ) [virtual]

Start a new section. An overloaded version of the function equips the section with a label. This enables easy reference to sections in LaTeX documents and hyperlinks in HTML documents. See also the "putLabel" function.
Reimplemented from Reporter.

void ASCIIReporter::space ( const int n = 1 ) [protected]

Reporter & ASCIIReporter::subsection ( const String & txt,

const String & label ) [virtual]

See documentation of one of the overloaded functions.
Reimplemented from Reporter.

Reporter & ASCIIReporter::subsection ( const String & txt ) [virtual]

Start a new subsection (numbered within the current section). An overloaded version enables marking the subsection with a label, see the comments for the "section" function.
Reimplemented from Reporter.

Reporter & ASCIIReporter::subsubsection ( const String & txt,

const String & label ) [virtual]

Reimplemented from Reporter.

Reporter & ASCIIReporter::subsubsection ( const String & txt ) [virtual]

Reimplemented from Reporter.

Reporter & ASCIIReporter::trailer ( ) [virtual]

Close a report, see "header".
Reimplemented from Reporter.

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

ASCIIReporter.h

Diffpack Documentation

ASCIIReporter Class Reference

Public Methods

Protected Methods

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation