TT_CStringConstants< TChar > Struct Template Reference

Description:

template<typename TChar>
struct alib::strings::TT_CStringConstants< TChar >

This template class has three specializations for types nchar, wchar, and xchar, which each provide the following static constexpr methods:

• EmptyString,
• NewLine, and
• DefaultWhitespaces.

The class is useful to implement methods that are templated with the character type they use.

Note

In non-templated code (that works with fixed or logical character sizes), it might lead to better readability if the following shortcut/alias functions of namespace alib are used:

• EMPTY_CSTRING, EMPTY_COMPLEMENT_CSTRING, EMPTY_STRANGE_CSTRING, EMPTY_NCSTRING, EMPTY_WCSTRING, EMPTY_XCSTRING,
• NEW_LINE, COMPLEMENT_NEW_LINE, STRANGE_NEW_LINE, NNEW_LINE, WNEW_LINE, XNEW_LINE and
• DEFAULT_WHITESPACES, COMPLEMENT_DEFAULT_WHITESPACES, STRANGE_DEFAULT_WHITESPACES, NDEFAULT_WHITESPACES, WDEFAULT_WHITESPACES, XDEFAULT_WHITESPACES.

Note

Constants for nulled strings are given with NULL_STRING, NULL_COMPLEMENT_STRING, NULL_STRANGE_STRING, NULL_NSTRING, NULL_WSTRING and NULL_XSTRING. However, those are returning type String instead of CString. For nulled objects of type CString use the keyword nullptr which performs implicit constexpr creation.

See also

See also manual chapter 6.3 String Constants.

Template Parameters

TChar

The character type.

Definition at line 496 of file cstring.hpp.

#include <cstring.hpp>

Collaboration diagram for TT_CStringConstants< TChar >:

Public Static Field Index:
static constexpr CString< TChar >	NewLine

Public Static Method Index:
static constexpr CString< TChar >	DefaultWhitespaces ())
	"carriage return" and "tabulator", hence " \n\r\t".
static constexpr CString< TChar >	EmptyString ()

Field Details:

NewLine

template<typename TChar >

CString<TChar> NewLine

inlinestaticconstexpr

On Windows OS, the returned string contains characters '\r' and '\n', on other platforms just character '\n'.

Returns

A zero-terminated string containing platform-dependent "newline" charcater(s).

Definition at line 505 of file cstring.hpp.

Method Details:

DefaultWhitespaces()

template<typename TChar >

static constexpr CString< TChar > DefaultWhitespaces ( )

inlinestaticconstexpr

"carriage return" and "tabulator", hence " \n\r\t".

Returns

A zero-terminated string containing default whitespace characters "space", "newline"

EmptyString()

template<typename TChar >

static constexpr CString< TChar > EmptyString ( )

inlinestaticconstexpr

Returns

A zero-terminated empty string.

---

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

• cstring.hpp