NewlineValue Class Reference

#include <evo/impl/sys.h>

Detailed Description

Holds a Newline value that can be null, which implicitly converts to NL_SYS (system default newline).

• This is useful for storing and forwarding a newline choice to an object that may define it's own default newline (like Stream and StreamOut)
• See Newline and NewlineDefault

Public Member Functions
	NewlineValue ()
	Constructor initializes as null. More...
	NewlineValue (Newline nl)
	Constructor initializes with a Newline value. More...
	NewlineValue (const NewlineDefault &)
	Constructor initializes as null via NewlineDefault. More...
	NewlineValue (const NewlineValue &src)
	Copy constructor. More...
const char *	getnewline () const
	Get newline string pointer for current value. More...
const char *	getnewline (uint &size, const char *default_newline, uint default_size) const
	Get newline string pointer and size for current value, or use default string if null. More...
uint	getnewlinesize () const
	Get newline string size for current value. More...
bool	null ()
	Get whether null. More...
	operator Newline () const
	Implicit conversion to a Newline value. More...
NewlineValue &	operator= (Newline nl)
	Assignment operator sets to Newline value. More...
NewlineValue &	operator= (NewlineDefault)
	Assignment operator sets as null via NewlineDefault. More...
NewlineValue &	operator= (const NewlineValue &src)
	Assignment operator to set as copy. More...

Constructor & Destructor Documentation

NewlineValue() [1/4]

NewlineValue ( )

inline

Constructor initializes as null.

NewlineValue() [2/4]

NewlineValue ( Newline  nl )

inline

Constructor initializes with a Newline value.

Parameters

nl	Newline value

NewlineValue() [3/4]

NewlineValue ( const NewlineDefault &  )

inline

Constructor initializes as null via NewlineDefault.

NewlineValue() [4/4]

NewlineValue ( const NewlineValue &  src )

inline

Copy constructor.

Parameters

src	Source to copy

Member Function Documentation

getnewline() [1/2]

const char* getnewline ( ) const

inline

Get newline string pointer for current value.

• If null this uses NL_SYS
• Call getnewlinesize() to get newline string size

Returns

Newline string pointer

getnewline() [2/2]

const char* getnewline ( uint &  size, const char *  default_newline, uint  default_size  ) const

inline

Get newline string pointer and size for current value, or use default string if null.

Parameters

size	Set to newline string size [out]
default_newline	Default newline string to use if null
default_size	Default newline string size to use if null

Returns

Newline string pointer

getnewlinesize()

uint getnewlinesize ( ) const

inline

Get newline string size for current value.

• If null this uses NL_SYS

Returns

Newline string size

null()

bool null ( )

inline

Get whether null.

Returns

Whether null

operator Newline()

operator Newline ( ) const

inline

Implicit conversion to a Newline value.

• If null this returns NL_SYS

Returns

Newline value

operator=() [1/3]

NewlineValue& operator= ( Newline  nl )

inline

Assignment operator sets to Newline value.

Parameters

nl	Newline value

Returns

This

operator=() [2/3]

NewlineValue& operator= ( NewlineDefault  )

inline

Assignment operator sets as null via NewlineDefault.

Returns

This

operator=() [3/3]

NewlineValue& operator= ( const NewlineValue &  src )

inline

Assignment operator to set as copy.

Parameters

src	Newline value to copy

Returns

This

---

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

• evo/impl/sys.h