String::Format Struct Reference

#include <evo/string.h>

Detailed Description

String formatter with state.

• This is associated with a String object and supports stateful (i.e. sticky) output formatting with "<<" operator on this object
• Formatting attributes include:
  • Aligned fields for formatting text "columns"
  • Integer base, prefix, and padding (in addition to field padding)
  • Floating point precision and padding (in additon to field padding)
  • String to use for "null" values (null char*, String, Int, etc)
• Note: Single character (char) and Newline (NL) values are not formatted as fields (i.e. not padded) since they're usually delimiters
• See: String Formatting

Example

#include <evo/string.h>
using namespace evo;

int main() {
    String str;

    // Use a temporary formatter to append line to str: 7B,1C8
    String::Format(str) << fHEX << 123 << ',' << 456 << NL;

    // Create a formatter and use to append line to str: 001,002
    String::Format out(str);
    out << FmtSetInt(fDEC, 3) << 1 << ',' << 2 << NL;

    return 0;
}

For more examples see: String Formatting

Public Types
typedef String	Out
	Associated output string type, type returned by write_out() More...
typedef String::Size	Size
	String data size type More...
typedef Format	This
	This type. More...

Public Member Functions
	Format (Out &out)
	Constructor. More...
	Format (const This &src)
	Copy constructor. More...
This &	operator<< (FmtAlign align)
	Set field alignment type to use. More...
This &	operator<< (FmtWidth width)
	Set field width to use. More...
This &	operator<< (const FmtSetField &field)
	Set field attributes to use. More...
This &	operator<< (Newline nl)
	Append a newline. More...
This &	operator<< (Flush)
	Flush output buffer – no-op for string. More...
This &	operator<< (const FmtSetNull &null)
	Set attributes for null values. More...
This &	operator<< (bool val)
	Append operator. More...
This &	operator<< (char ch)
	Append a character. More...
This &	operator<< (const FmtChar &ch)
	Append a repeated character. More...
This &	operator<< (const char *val)
	Append a terminated string. More...
This &	operator<< (const StringBase &val)
	Append a string. More...
This &	operator<< (FmtBase base)
	Set base for formatting integers. More...
This &	operator<< (FmtBasePrefix prefix)
	Set prefix for formatting integers. More...
This &	operator<< (const FmtSetInt &fmt_int)
	Set integer formatting attributes. More...
This &	operator<< (short num)
	Append a formatted signed integer. More...
This &	operator<< (int num)
	Append a formatted signed integer. More...
This &	operator<< (long num)
	Append a formatted signed integer. More...
This &	operator<< (longl num)
	Append a formatted signed integer. More...
This &	operator<< (ushort num)
	Append a formatted unsigned integer. More...
This &	operator<< (uint num)
	Append a formatted unsigned integer. More...
This &	operator<< (ulong num)
	Append a formatted unsigned integer. More...
This &	operator<< (ulongl num)
	Append a formatted unsigned integer. More...
template<class T >
This &	operator<< (const IntegerT< T > &num)
	Append a formatted integer class. More...
This &	operator<< (FmtPrecision prec)
	Set floating point formatting precision. More...
This &	operator<< (const FmtSetFloat &fmt_flt)
	Set floating point formatting attributes. More...
This &	operator<< (float num)
	Append a formatting floating point number. More...
This &	operator<< (double num)
	Append a formatting floating point number. More...
This &	operator<< (ldouble num)
	Append a formatting floating point number. More...
template<class T >
This &	operator<< (const FloatT< T > &num)
	Append a formatted integer class. More...
This &	operator<< (const FmtDump &fmtdump)
This &	operator= (const This &src)
	Assignment operator copies attributes. More...
Out &	write_out ()
	Get parent output string. More...

Public Attributes
FmtAttribs	fmt
	Formatting attributes (state) More...
Out &	out
	Associated output string. More...

Member Typedef Documentation

Out

typedef String Out

Associated output string type, type returned by write_out()

Size

typedef String::Size Size

String data size type

This

typedef Format This

This type.

Constructor & Destructor Documentation

Format() [1/2]

Format ( Out &  out )

inline

Constructor.

Parameters

out	Output string to associate and format to

Format() [2/2]

Format ( const This &  src )

inline

Copy constructor.

• This will reference the same string as src

Parameters

src	Source to copy

Member Function Documentation

operator<<() [1/30]

This& operator<< ( FmtAlign  align )

inline

Set field alignment type to use.

Parameters

align

Alignment type

Returns

This

operator<<() [2/30]

This& operator<< ( FmtWidth  width )

inline

Set field width to use.

Parameters

width

Field width to use

Returns

This

operator<<() [3/30]

This& operator<< ( const FmtSetField &  field )

inline

Set field attributes to use.

Parameters

field

Field attributes

Returns

This

operator<<() [4/30]

This& operator<< ( Newline  nl )

inline

Append a newline.

Parameters

nl	Newline type to append, NL for system default

Returns

This

operator<<() [5/30]

This& operator<< ( Flush  )

inline

Flush output buffer – no-op for string.

• Use param: fFLUSH

Returns

This

operator<<() [6/30]

This& operator<< ( const FmtSetNull &  null )

inline

Set attributes for null values.

Parameters

null	Null attributes

Returns

This

operator<<() [7/30]

This& operator<< ( bool  val )

inline

Append operator.

• Bool value is formatted as either "true" or "false" (without quotes)

Parameters

val	Bool value to append

Returns

This

operator<<() [8/30]

This& operator<< ( char  ch )

inline

Append a character.

Parameters

ch	Character to append

Returns

This

operator<<() [9/30]

This& operator<< ( const FmtChar &  ch )

inline

Append a repeated character.

Parameters

ch	Character info to append

Returns

This

operator<<() [10/30]

This& operator<< ( const char *  val )

inline

Append a terminated string.

• Field attributes apply

Parameters

val	String pointer, must be terminated, NULL for null string

Returns

This

operator<<() [11/30]

This& operator<< ( const StringBase &  val )

inline

Append a string.

• Field attributes apply

Parameters

val	String value

Returns

This

operator<<() [12/30]

This& operator<< ( FmtBase  base )

inline

Set base for formatting integers.

Parameters

base	Base to use, see FmtBase

Returns

This

operator<<() [13/30]

This& operator<< ( FmtBasePrefix  prefix )

inline

Set prefix for formatting integers.

Parameters

prefix

Integer prefix to use, see FmtBasePrefix

Returns

This

operator<<() [14/30]

This& operator<< ( const FmtSetInt &  fmt_int )

inline

Set integer formatting attributes.

Parameters

fmt_int

Integer formatting attributes

Returns

This

operator<<() [15/30]

This& operator<< ( short  num )

inline

Append a formatted signed integer.

• Integer and field attributes apply

Parameters

num	Integer to format

Returns

This

operator<<() [16/30]

This& operator<< ( int  num )

inline

Append a formatted signed integer.

• Integer and field attributes apply

Parameters

num	Integer to format

Returns

This

operator<<() [17/30]

This& operator<< ( long  num )

inline

Append a formatted signed integer.

• Integer and field attributes apply

Parameters

num	Integer to format

Returns

This

operator<<() [18/30]

This& operator<< ( longl  num )

inline

Append a formatted signed integer.

• Integer and field attributes apply

Parameters

num	Integer to format

Returns

This

operator<<() [19/30]

This& operator<< ( ushort  num )

inline

Append a formatted unsigned integer.

• Integer and field attributes apply

Parameters

num	Integer to format

Returns

This

operator<<() [20/30]

This& operator<< ( uint  num )

inline

Append a formatted unsigned integer.

• Integer and field attributes apply

Parameters

num	Integer to format

Returns

This

operator<<() [21/30]

This& operator<< ( ulong  num )

inline

Append a formatted unsigned integer.

• Integer and field attributes apply

Parameters

num	Integer to format

Returns

This

operator<<() [22/30]

This& operator<< ( ulongl  num )

inline

Append a formatted unsigned integer.

• Integer and field attributes apply

Parameters

num	Integer to format

Returns

This

operator<<() [23/30]

This& operator<< ( const IntegerT< T > &  num )

inline

Append a formatted integer class.

• Integer, field, and null attributes apply

Template Parameters

T	Integer POD type, deduced from param

Parameters

num	Integer to format (Int, UInt, etc)

Returns

This

operator<<() [24/30]

This& operator<< ( FmtPrecision  prec )

inline

Set floating point formatting precision.

Parameters

prec	Precision value, see FmtPrecision

Returns

This

operator<<() [25/30]

This& operator<< ( const FmtSetFloat &  fmt_flt )

inline

Set floating point formatting attributes.

Parameters

fmt_flt

Floating point formatting attributes

Returns

This

operator<<() [26/30]

This& operator<< ( float  num )

inline

Append a formatting floating point number.

• Floating point and field attributes apply

Parameters

num	Number to format

Returns

This

operator<<() [27/30]

This& operator<< ( double  num )

inline

Append a formatting floating point number.

• Floating point and field attributes apply

Parameters

num	Number to format

Returns

This

operator<<() [28/30]

This& operator<< ( ldouble  num )

inline

Append a formatting floating point number.

• Floating point and field attributes apply

Parameters

num	Number to format

Returns

This

operator<<() [29/30]

This& operator<< ( const FloatT< T > &  num )

inline

Append a formatted integer class.

• Floating point, field, and null attributes apply

Template Parameters

T	Floating point POD type, deduced from param

Parameters

num	Number to format (Float, FloatD, etc)

Returns

This

operator<<() [30/30]

This& operator<< ( const FmtDump &  fmtdump )

inline

operator=()

This& operator= ( const This &  src )

inline

Assignment operator copies attributes.

• This does not copy the referenced string

Parameters

src	Source to copy attributes from

Returns

This

write_out()

Out& write_out ( )

inline

Get parent output string.

Returns

Parent output string

Member Data Documentation

fmt

FmtAttribs fmt

Formatting attributes (state)

out

Out& out

Associated output string.

---

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

• evo/string.h