Lister Class Reference

Collaboration diagram for Lister:

Classes
struct	Which_Mode

Public Types
enum	MODE

Public Member Functions
Lister &	array_indenting (const bool enabled, const Which_Mode which=LOCAL_MODE_SET)
bool	array_indenting (const Which_Mode &which=LOCAL_MODE_SET) const
Lister &	assign_align (const bool enabled, const Which_Mode which=LOCAL_MODE_SET)
bool	assign_align (const Which_Mode &which=LOCAL_MODE_SET) const
bool	begin_aggregates (const Which_Mode &which=LOCAL_MODE_SET) const
Lister &	begin_aggregates (const bool enabled, const Which_Mode &which=LOCAL_MODE_SET)
void	clear ()
unsigned int	flush (int wrap_depth=0)
Lister &	indent (int depth)
unsigned int	indent_depth (int level) const
Lister &	indent_width (const int width, const Which_Mode &which=LOCAL_MODE_SET)
int	indent_width (const Which_Mode &which=LOCAL_MODE_SET) const
bool	indenting () const
Lister &	informal_NL (const char *new_line_characters, const Which_Mode &which=LOCAL_MODE_SET)
const char *	informal_NL (const Which_Mode &which=LOCAL_MODE_SET) const
	Lister (const Lister &lister)
	Lister (std::ostream &out=std::cout)
bool	mode (const MODE selection, const Which_Mode &which=LOCAL_MODE_SET) const
Lister &	mode (const MODE selection, const bool enabled, const Which_Mode &which=LOCAL_MODE_SET)
const bool *	modes (const Which_Mode &which=LOCAL_MODE_SET) const
Lister &	modes (const bool *mode_set, const Which_Mode &which=LOCAL_MODE_SET)
Lister &	name_end_aggregates (const bool enabled, const Which_Mode which=LOCAL_MODE_SET)
bool	name_end_aggregates (const Which_Mode which=LOCAL_MODE_SET) const
Lister &	new_line (int wrap_depth=0)
Lister &	NL (const char *new_line_characters, const Which_Mode &which=LOCAL_MODE_SET)
const char *	NL (const Which_Mode &which=LOCAL_MODE_SET) const
std::ostream &	operator<< (const Parameter &parameter)
std::ostream &	operator<< (const Value &value)
Lister &	output_stream (std::ostream &out)
std::ostream &	output_stream () const
int	page_width (const Which_Mode &which=LOCAL_MODE_SET) const
Lister &	page_width (const int width, const Which_Mode &which=LOCAL_MODE_SET)
int	parameter_name (const std::string &name, bool verbatim=false)
unsigned int	pending () const
std::string	pending_characters () const
Lister &	reset_total ()
Lister &	single_line_comments (const bool enabled, const Which_Mode &which=LOCAL_MODE_SET)
bool	single_line_comments (const Which_Mode &which=LOCAL_MODE_SET) const
Lister &	strict (const bool enabled, const Which_Mode &which=LOCAL_MODE_SET)
bool	strict (const Which_Mode &which=LOCAL_MODE_SET) const
const char *	strict_NL (const Which_Mode &which=LOCAL_MODE_SET) const
Lister &	strict_NL (const char *new_line_characters, const Which_Mode &which=LOCAL_MODE_SET)
unsigned int	total () const
Lister &	uppercase_aggregates (const bool enabled, const Which_Mode &which=LOCAL_MODE_SET)
bool	uppercase_aggregates (const Which_Mode &which=LOCAL_MODE_SET) const
Lister &	use_statement_delimiter (const bool enabled, const Which_Mode &which=LOCAL_MODE_SET)
bool	use_statement_delimiter (const Which_Mode &which=LOCAL_MODE_SET) const
Lister &	value_units (const std::string &units)
Lister &	value_units (const Value &value)
bool	verbatim_strings (const Which_Mode &which=LOCAL_MODE_SET) const
Lister &	verbatim_strings (const bool enabled, const Which_Mode &which=LOCAL_MODE_SET)
Lister &	write (const String &text, int wrap_depth=0)
Lister &	write (const Integer &integer, int wrap_depth=0)
unsigned int	write (int wrap_to=0, const std::string &leading="", const std::string &trailing="")
Lister &	write (const Array &array, int wrap_depth=0)
Lister &	write (const std::string &characters, int wrap_depth=0)
Lister &	write (const Real &real, int wrap_depth=0)
Lister &	write (const Assignment &assignment, int wrap_depth=0)
Lister &	write (const char character, int wrap_depth=0)
Lister &	write (const Value &value, int wrap_depth=0)
Lister &	write (const Parameter &parameter, int wrap_depth=0)
Lister &	write (const Aggregate &aggregate, int wrap_depth=0)
Lister &	write_comment (const std::string &comment, int depth=0)

Static Public Member Functions
static void	default_array_indenting (const bool enabled)
static bool	default_array_indenting ()
static void	default_assign_align (const bool enabled)
static bool	default_assign_align ()
static bool	default_begin_aggregates ()
static void	default_begin_aggregates (const bool enabled)
static void	default_indent_width (const int width)
static int	default_indent_width ()
static bool	default_mode (const MODE selection)
static void	default_mode (const MODE selection, const bool enabled)
static bool	default_name_end_aggregates ()
static void	default_name_end_aggregates (const bool enabled)
static void	default_NL (const char *new_line_characters)
static const char *	default_NL ()
static int	default_page_width ()
static void	default_page_width (const int width)
static bool	default_single_line_comments ()
static void	default_single_line_comments (const bool enabled)
static void	default_strict (const bool enabled)
static bool	default_strict ()
static void	default_uppercase_aggregates (const bool enabled)
static bool	default_uppercase_aggregates ()
static void	default_use_statement_delimiter (const bool enabled)
static bool	default_use_statement_delimiter ()
static bool	default_verbatim_strings ()
static void	default_verbatim_strings (const bool enabled)

Public Attributes
	Begin_Aggregates
	Uppercase_Aggregates
	Name_End_Aggregates
	Assign_Align
	Array_Indenting
	Use_Statement_Delimiter
	Single_Line_Comments
	Verbatim_Strings
	TOTAL_MODES

Static Public Attributes
static int	Default_Indent_Width
static const char *	Default_Informal_NL_Characters
static const Which_Mode	DEFAULT_MODE_SET
static int	Default_Page_Width
static const char *	Default_Strict_NL_Characters
static const char *const	ID
static const Which_Mode	LOCAL_MODE_SET
static const int	NO_INDENT

Protected Attributes
int	Assign_Align_Depth
int	Indent_Width
const char *	Informal_NL_Characters
bool	Modes [TOTAL_MODES]
const char *	New_Line
int	Page_Width
const char *	Strict_NL_Characters

Static Protected Attributes
static bool	Default_Modes [TOTAL_MODES]
static const char *	Default_New_Line
static const bool	STRICT_MODES [TOTAL_MODES]

---

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