Description

Class for printing nicely formattated tables.

A table is a two-dimensional grid containing cells. A FormattedTable object holds information about how to format cells, functions to populate the cells, and functions to print the table.

Definition at line 15 of file FormattedTable.h.

#include <Rose/FormattedTable.h>

Classes
class	CellProperties
	Properties for a particular cell. More...

Public Types
enum class	Format { PLAIN , HTML , CSV , SHELL }
	Format when generating output. More...

enum class	Alignment { LEFT , RIGHT , CENTER }
	How text is aligned in a table cell. More...

Public Member Functions
	FormattedTable ()
	Construct an empty table.

	FormattedTable (size_t nRows, size_t nColumns)
	Construct a table with a certain number of cells.

const std::string &	get (size_t rowIdx, size_t colIdx) const
	Get the data for a table cell.

void	print (std::ostream &) const
	Print a table.


Format	format () const
	Property: Output format.

void	format (Format)
	Property: Output format.


const std::string &	indentation () const
	Property: Indentation.

void	indentation (const std::string &)
	Property: Indentation.


void	resize (size_t nRows, size_t nColumns)
	Resize the table data.

void	resize (size_t nRows)
	Resize the table data.


size_t	nRows () const
	Number of rows or columns of data.

size_t	nColumns () const
	Number of rows or columns of data.


void	insert (size_t rowIdx, size_t columnIdx, const std::string &repr)
	Insert data into a table.

void	insert (size_t rowIdx, size_t columnIdx, const std::string &repr, const CellProperties &)
	Insert data into a table.

template<typename T >
void	insert (size_t rowIdx, size_t columnIdx, const T &value)
	Insert data into a table.

template<typename T >
void	insert (size_t rowIdx, size_t columnIdx, const T &value, const CellProperties &prop)
	Insert data into a table.


const CellProperties &	cellProperties (size_t rowIdx, size_t columnIdx) const
	Properties for a data cell.

void	cellProperties (size_t rowIdx, size_t columnIdx, const CellProperties &)
	Properties for a data cell.


size_t	nColumnHeaderRows () const
	Property: Number of column header rows.

void	nColumnHeaderRows (size_t)
	Property: Number of column header rows.


const std::string &	columnHeader (size_t rowIdx, size_t columnIdx) const
	Property: Name for column headers.

void	columnHeader (size_t rowIdx, size_t columnIdx, const std::string &title)
	Property: Name for column headers.


const CellProperties &	columnHeaderProperties (size_t rowIdx, size_t columnIdx) const
	Properties for column headers.

void	columnHeaderProperties (size_t rowIdx, size_t columnIdx, const CellProperties &)
	Properties for column headers.

Member Enumeration Documentation

◆ Format

enum class Rose::FormattedTable::Format

strong

Format when generating output.

Enumerator
PLAIN	Use ASCII-art to draw the table borders.
HTML	Generate HTML output.
CSV	Comma separated values, RFC 4180.
SHELL	A format friendly for shell scripts. No header columns. Lines are separated by ASCII line feed characters (not carriage returns). Values are separated by horizontal tab characters. Line feeds and tabs are escaped in the values. Shell `$"` style escaping is used (C-like) in addition to escaped tabs and linefeeds.

Definition at line 22 of file FormattedTable.h.

◆ Alignment

enum class Rose::FormattedTable::Alignment

strong

How text is aligned in a table cell.

Enumerator
LEFT	Text is aligned to the left edge of the cell.
RIGHT	Text is aligned to the right edge of the cell.
CENTER	Text is centered in the cell.

Definition at line 35 of file FormattedTable.h.

Member Function Documentation

◆ format() [1/2]

Format Rose::FormattedTable::format ( ) const

Property: Output format.

How the table is formatted in general.

◆ format() [2/2]

void Rose::FormattedTable::format ( Format )

Property: Output format.

How the table is formatted in general.

◆ indentation() [1/2]

const std::string & Rose::FormattedTable::indentation ( ) const

Property: Indentation.

This property holds a string that is printed at the beginning of every line of output. This used for the plain-text format; it's ignored for HTML output.

◆ indentation() [2/2]

void Rose::FormattedTable::indentation ( const std::string & )

Property: Indentation.

This property holds a string that is printed at the beginning of every line of output. This used for the plain-text format; it's ignored for HTML output.

◆ resize() [1/2]

void Rose::FormattedTable::resize	(	size_t	nRows,
		size_t	nColumns
	)

Resize the table data.

Making a table smaller will remove data cells but not row and column properties. Making a table larger will insert cells with empty data, and if necessary create default row and column properties.

◆ resize() [2/2]

void Rose::FormattedTable::resize ( size_t nRows )

Resize the table data.

Making a table smaller will remove data cells but not row and column properties. Making a table larger will insert cells with empty data, and if necessary create default row and column properties.

◆ nRows()

size_t Rose::FormattedTable::nRows ( ) const

Number of rows or columns of data.

◆ nColumns()

size_t Rose::FormattedTable::nColumns ( ) const

Number of rows or columns of data.

◆ insert() [1/4]

void Rose::FormattedTable::insert	(	size_t	rowIdx,
		size_t	columnIdx,
		const std::string &	repr
	)

Insert data into a table.

If the row and/or column number is outside the current size of the table, then the table is automatically resized, but it's more efficient to resize the table before adding data.

Referenced by insert(), and insert().

◆ insert() [2/4]

void Rose::FormattedTable::insert	(	size_t	rowIdx,
		size_t	columnIdx,
		const std::string &	repr,
		const CellProperties &
	)

Insert data into a table.

If the row and/or column number is outside the current size of the table, then the table is automatically resized, but it's more efficient to resize the table before adding data.

◆ insert() [3/4]

template<typename T >

void Rose::FormattedTable::insert	(	size_t	rowIdx,
		size_t	columnIdx,
		const T &	value
	)

inline

Insert data into a table.

If the row and/or column number is outside the current size of the table, then the table is automatically resized, but it's more efficient to resize the table before adding data.

Definition at line 160 of file FormattedTable.h.

References insert().

◆ insert() [4/4]

template<typename T >

void Rose::FormattedTable::insert	(	size_t	rowIdx,
		size_t	columnIdx,
		const T &	value,
		const CellProperties &	prop
	)

inline

Insert data into a table.

If the row and/or column number is outside the current size of the table, then the table is automatically resized, but it's more efficient to resize the table before adding data.

Definition at line 163 of file FormattedTable.h.

References insert().

◆ cellProperties() [1/2]

const CellProperties & Rose::FormattedTable::cellProperties	(	size_t	rowIdx,
		size_t	columnIdx
	)		const

Properties for a data cell.

When inserting properties, the table is automatically extended.

◆ cellProperties() [2/2]

void Rose::FormattedTable::cellProperties	(	size_t	rowIdx,
		size_t	columnIdx,
		const CellProperties &
	)

Properties for a data cell.

When inserting properties, the table is automatically extended.

◆ nColumnHeaderRows() [1/2]

size_t Rose::FormattedTable::nColumnHeaderRows ( ) const

Property: Number of column header rows.

Column headers appear above the data and the number of column header rows is independent of the number of data rows that's returned by nRows. When the number of column header rows is decreased, the affected column header names are deleted; when the number of rows is increased, the new titles are set to empty strings.

◆ nColumnHeaderRows() [2/2]

void Rose::FormattedTable::nColumnHeaderRows ( size_t )

Property: Number of column header rows.

Column headers appear above the data and the number of column header rows is independent of the number of data rows that's returned by nRows. When the number of column header rows is decreased, the affected column header names are deleted; when the number of rows is increased, the new titles are set to empty strings.

◆ columnHeader() [1/2]

const std::string & Rose::FormattedTable::columnHeader	(	size_t	rowIdx,
		size_t	columnIdx
	)		const

Property: Name for column headers.

Column headers occupy one or more rows, but the rows do not count as data. Column information is extended as necessary when new column headers are added. When querying a column header that doesn't exist, an empty string is returned.

◆ columnHeader() [2/2]

void Rose::FormattedTable::columnHeader	(	size_t	rowIdx,
		size_t	columnIdx,
		const std::string &	title
	)

Property: Name for column headers.

Column headers occupy one or more rows, but the rows do not count as data. Column information is extended as necessary when new column headers are added. When querying a column header that doesn't exist, an empty string is returned.

◆ columnHeaderProperties() [1/2]

const CellProperties & Rose::FormattedTable::columnHeaderProperties	(	size_t	rowIdx,
		size_t	columnIdx
	)		const

Properties for column headers.

These are the properties for formatting column header cells. Column header row indices are indpendent of the data cell indices.

◆ columnHeaderProperties() [2/2]

void Rose::FormattedTable::columnHeaderProperties	(	size_t	rowIdx,
		size_t	columnIdx,
		const CellProperties &
	)

Properties for column headers.

These are the properties for formatting column header cells. Column header row indices are indpendent of the data cell indices.

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

FormattedTable.h

Description

Classes

Public Types

Public Member Functions

Member Enumeration Documentation

◆ Format

◆ Alignment

Member Function Documentation

◆ format() [1/2]

◆ format() [2/2]

◆ indentation() [1/2]

◆ indentation() [2/2]

◆ resize() [1/2]

◆ resize() [2/2]

◆ nRows()

◆ nColumns()

◆ insert() [1/4]

◆ insert() [2/4]

◆ insert() [3/4]

◆ insert() [4/4]

◆ cellProperties() [1/2]

◆ cellProperties() [2/2]

◆ nColumnHeaderRows() [1/2]

◆ nColumnHeaderRows() [2/2]

◆ columnHeader() [1/2]

◆ columnHeader() [2/2]

◆ columnHeaderProperties() [1/2]

◆ columnHeaderProperties() [2/2]