Wide counterpart of String. More...

#include <StormByte/string/wstring.hxx>

Public Types
using	value_type = wchar_t
	Code unit type.

using	const_iterator = const wchar_t *
	Contiguous observer.

using	const_reverse_iterator = std::reverse_iterator< const_iterator >
	Reverse observer.

Public Member Functions
void	swap (WString &other) noexcept
	Swaps buffers with `other`.

Life
	WString () noexcept
	Null text.

	WString (const wchar_t *str) noexcept
	Copies a wide C string.

	WString (std::wstring_view str) noexcept
	Copies a view into an owned NUL-terminated buffer.

	WString (WCString text) noexcept
	Takes an owned buffer.

	WString (const String &other) noexcept
	Wide text from UTF-8.

	WString (const WString &other) noexcept
	Copy constructor.

	WString (WString &&other) noexcept
	Move constructor.

	~WString () noexcept=default
	Releases the buffer.

WString &	operator= (const WString &other) noexcept
	Copy assignment.

WString &	operator= (WString &&other) noexcept
	Move assignment.

Range
const_iterator	begin () const noexcept
	First character, or null.

const_iterator	end () const noexcept
	One past the last character, or null.

const_iterator	cbegin () const noexcept
	First character, or null.

const_iterator	cend () const noexcept
	One past the last character, or null.

const_reverse_iterator	rbegin () const noexcept
	Reverse begin.

const_reverse_iterator	rend () const noexcept
	Reverse end.

const_reverse_iterator	crbegin () const noexcept
	Reverse begin.

const_reverse_iterator	crend () const noexcept
	Reverse end.

const wchar_t *	data () const noexcept
	Contiguous pointer; null when the buffer is null.

std::size_t	size () const noexcept
	Code-unit count; `0` when null or empty.

std::size_t	length () const noexcept
	Same as size.

bool	empty () const noexcept
	Whether size is zero.

wchar_t	operator[] (std::size_t index) const noexcept
	Code unit at `index`.

	operator bool () const noexcept
	Whether a buffer is held.

Conversions
	operator std::wstring_view () const noexcept
	Non-owning view of the text.

	operator std::wstring () const
	Copy of the text in the caller’s heap.

	operator const wchar_t * () const noexcept
	View of the owned buffer.

	operator String () const noexcept
	UTF-8 text (wide encoded in the module).

const WCString &	Bytes () const noexcept
	Owned code units.

Comparison
bool	operator== (const WString &other) const noexcept
	Content equality.

bool	operator!= (const WString &other) const noexcept
	Content inequality.

bool	operator== (const wchar_t *str) const noexcept
	Content equality with a wide C string.

bool	operator!= (const wchar_t *str) const noexcept
	Content inequality with a wide C string.

std::strong_ordering	operator<=> (const WString &other) const noexcept
	Content order.

std::strong_ordering	operator<=> (const wchar_t *str) const noexcept
	Content order against a wide C string.

Helpers
WString	ToLower () const noexcept
	ASCII-letter lower case of this text.

WString	ToUpper () const noexcept
	ASCII-letter upper case of this text.

WString	SanitizeNewlines () const noexcept
	CR LF to LF on this text.

WString	RemoveWhitespace () const noexcept
	Drops `iswspace` code units from this text.

bool	IsInteger () const noexcept
	Whether this text is an integer token.

std::vector< WString >	Split () const noexcept
	Whitespace-separated tokens.

std::queue< WString >	Explode (wchar_t delimiter) const noexcept
	Tokens on `delimiter`.

static WString	ToLower (std::wstring_view str) noexcept
	ASCII-letter lower case; other code points copied.

static WString	ToUpper (std::wstring_view str) noexcept
	ASCII-letter upper case; other code points copied.

static WString	SanitizeNewlines (std::wstring_view str) noexcept
	Turns CR LF into LF.

static WString	RemoveWhitespace (std::wstring_view str) noexcept
	Drops `iswspace` code units.

static bool	IsInteger (std::wstring_view str) noexcept
	Optional sign plus ASCII digits.

static void	Split (std::wstring_view str, std::vector< WString > &out) noexcept
	Whitespace-separated tokens.

static void	Explode (std::wstring_view str, wchar_t delimiter, std::queue< WString > &out) noexcept
	Tokens on `delimiter`.

Detailed Description

Wide counterpart of String.

Owned wide text composed of StormByte::WCString.

Defined in wstring.hxx.

Not a std::wstring. Iterators are constant and contiguous so algorithms that read a range of wchar_t work. In-place mutating algorithms do not: helpers return a new WString.

operator std::wstring_view is implicit and inline. operator std::wstring is explicit and inline (caller heap).

Conversion to String is explicit and runs in the module (wide → UTF-8). Conversion from String copies wide units in the module.

ToUpper / ToLower map only ASCII A–Z / a–z (as wchar_t). Other code points are copied. On 16-bit wchar_t, a well-formed surrogate pair is copied together.

Member Typedef Documentation

◆ const_iterator

using StormByte::String::WString::const_iterator = const wchar_t*

Contiguous observer.

◆ const_reverse_iterator

using StormByte::String::WString::const_reverse_iterator = std::reverse_iterator<const_iterator>

Reverse observer.

◆ value_type

using StormByte::String::WString::value_type = wchar_t

Code unit type.

Constructor & Destructor Documentation

◆ WString() [1/7]

StormByte::String::WString::WString ( )

noexcept

Null text.

◆ WString() [2/7]

StormByte::String::WString::WString ( const wchar_t * str )

explicitnoexcept

Copies a wide C string.

Parameters

str	Source; may be null.

◆ WString() [3/7]

StormByte::String::WString::WString ( std::wstring_view str )

explicitnoexcept

Copies a view into an owned NUL-terminated buffer.

Parameters

str Source.

◆ WString() [4/7]

StormByte::String::WString::WString ( WCString text )

explicitnoexcept

Takes an owned buffer.

Parameters

text Buffer.

◆ WString() [5/7]

StormByte::String::WString::WString ( const String & other )

explicitnoexcept

Wide text from UTF-8.

Parameters

other UTF-8 source.

◆ WString() [6/7]

StormByte::String::WString::WString ( const WString & other )

noexcept

Copy constructor.

Parameters

other Text to copy.

◆ WString() [7/7]

StormByte::String::WString::WString ( WString && other )

noexcept

Move constructor.

Parameters

other Text to take. other becomes null.

◆ ~WString()

StormByte::String::WString::~WString ( )

defaultnoexcept

Releases the buffer.

Member Function Documentation

◆ begin()

const_iterator StormByte::String::WString::begin ( ) const

inlinenoexcept

First character, or null.

Returns: Iterator.

◆ Bytes()

const WCString & StormByte::String::WString::Bytes ( ) const

inlinenoexcept

Owned code units.

Returns: Internal WCString.

◆ cbegin()

const_iterator StormByte::String::WString::cbegin ( ) const

inlinenoexcept

First character, or null.

Returns: Iterator.

◆ cend()

const_iterator StormByte::String::WString::cend ( ) const

inlinenoexcept

One past the last character, or null.

Returns: Iterator.

◆ crbegin()

const_reverse_iterator StormByte::String::WString::crbegin ( ) const

inlinenoexcept

Reverse begin.

Returns: Reverse iterator.

◆ crend()

const_reverse_iterator StormByte::String::WString::crend ( ) const

inlinenoexcept

Reverse end.

Returns: Reverse iterator.

◆ data()

const wchar_t * StormByte::String::WString::data ( ) const

inlinenoexcept

Contiguous pointer; null when the buffer is null.

Returns: Pointer to the first code unit.

◆ empty()

bool StormByte::String::WString::empty ( ) const

inlinenoexcept

Whether size is zero.

Returns: Emptiness. A null buffer is empty.

◆ end()

const_iterator StormByte::String::WString::end ( ) const

inlinenoexcept

One past the last character, or null.

Returns: Iterator.

◆ Explode() [1/2]

static void StormByte::String::WString::Explode	(	std::wstring_view	str,
		wchar_t	delimiter,
		std::queue< WString > &	out
	)

staticnoexcept

Tokens on delimiter.

out is the caller’s container.

Parameters

	str	Source.
	delimiter	Separator.
[out]	out	Tokens, including empty ones.

◆ Explode() [2/2]

std::queue< WString > StormByte::String::WString::Explode ( wchar_t delimiter ) const

inlinenoexcept

Tokens on delimiter.

The queue is built in the caller.

Parameters

delimiter Separator.

Returns: Tokens, including empty ones.

◆ IsInteger() [1/2]

bool StormByte::String::WString::IsInteger ( ) const

inlinenoexcept

Whether this text is an integer token.

Returns: Whether it matches IsInteger(std::wstring_view).

◆ IsInteger() [2/2]

static bool StormByte::String::WString::IsInteger ( std::wstring_view str )

staticnoexcept

Optional sign plus ASCII digits.

Parameters

str Source.

Returns: Whether str is an integer token.

◆ length()

std::size_t StormByte::String::WString::length ( ) const

inlinenoexcept

Same as size.

Returns: Length.

◆ operator bool()

StormByte::String::WString::operator bool ( ) const

inlineexplicitnoexcept

Whether a buffer is held.

Returns: false only for a null WCString. L"" is valid and empty.

◆ operator const wchar_t *()

StormByte::String::WString::operator const wchar_t * ( ) const

inlineexplicitnoexcept

View of the owned buffer.

Returns: Buffer, or null.

Note: Same lifetime as std::wstring::c_str().

◆ operator std::wstring()

StormByte::String::WString::operator std::wstring ( ) const

inlineexplicit

Copy of the text in the caller’s heap.

Returns: Empty string when the buffer is null.

◆ operator std::wstring_view()

StormByte::String::WString::operator std::wstring_view ( ) const

inlinenoexcept

Non-owning view of the text.

Returns: Empty view when the buffer is null.

Note: Same lifetime as std::wstring::c_str().

◆ operator String()

StormByte::String::WString::operator String ( ) const

explicitnoexcept

UTF-8 text (wide encoded in the module).

Returns: Owned String.

◆ operator!=() [1/2]

bool StormByte::String::WString::operator!= ( const wchar_t * str ) const

inlinenoexcept

Content inequality with a wide C string.

Parameters

str	May be null.

Returns: Whether the texts differ.

◆ operator!=() [2/2]

bool StormByte::String::WString::operator!= ( const WString & other ) const

inlinenoexcept

Content inequality.

Parameters

other Other text.

Returns: Whether the texts differ.

◆ operator<=>() [1/2]

std::strong_ordering StormByte::String::WString::operator<=> ( const wchar_t * str ) const

inlinenoexcept

Content order against a wide C string.

Parameters

str	May be null.

Returns: Ordering.

◆ operator<=>() [2/2]

std::strong_ordering StormByte::String::WString::operator<=> ( const WString & other ) const

inlinenoexcept

Content order.

Null is less than any text.

Parameters

other Other text.

Returns: Ordering.

◆ operator=() [1/2]

WString & StormByte::String::WString::operator= ( const WString & other )

noexcept

Copy assignment.

Parameters

other Text to copy.

Returns: *this.

◆ operator=() [2/2]

WString & StormByte::String::WString::operator= ( WString && other )

noexcept

Move assignment.

Parameters

other Text to take. other becomes null.

Returns: *this.

◆ operator==() [1/2]

bool StormByte::String::WString::operator== ( const wchar_t * str ) const

inlinenoexcept

Content equality with a wide C string.

Parameters

str	May be null.

Returns: Whether the texts are equal.

◆ operator==() [2/2]

bool StormByte::String::WString::operator== ( const WString & other ) const

inlinenoexcept

Content equality.

Parameters

other Other text.

Returns: Whether the texts are equal.

◆ operator[]()

wchar_t StormByte::String::WString::operator[] ( std::size_t index ) const

inlinenoexcept

Code unit at index.

Parameters

index Position in [0, size()]. size() is the trailing NUL.

Returns: Character.

Note: Null or index > size() is undefined and asserts when assertions are on.

◆ rbegin()

const_reverse_iterator StormByte::String::WString::rbegin ( ) const

inlinenoexcept

Reverse begin.

Returns: Reverse iterator.

◆ RemoveWhitespace() [1/2]

WString StormByte::String::WString::RemoveWhitespace ( ) const

inlinenoexcept

Drops iswspace code units from this text.

Returns: New text.

◆ RemoveWhitespace() [2/2]

static WString StormByte::String::WString::RemoveWhitespace ( std::wstring_view str )

staticnoexcept

Drops iswspace code units.

Parameters

str Source.

Returns: New text.

◆ rend()

const_reverse_iterator StormByte::String::WString::rend ( ) const

inlinenoexcept

Reverse end.

Returns: Reverse iterator.

◆ SanitizeNewlines() [1/2]

WString StormByte::String::WString::SanitizeNewlines ( ) const

inlinenoexcept

CR LF to LF on this text.

Returns: New text.

◆ SanitizeNewlines() [2/2]

static WString StormByte::String::WString::SanitizeNewlines ( std::wstring_view str )

staticnoexcept

Turns CR LF into LF.

Parameters

str Source.

Returns: New text.

◆ size()

std::size_t StormByte::String::WString::size ( ) const

inlinenoexcept

Code-unit count; 0 when null or empty.

Returns: Length.

◆ Split() [1/2]

std::vector< WString > StormByte::String::WString::Split ( ) const

inlinenoexcept

Whitespace-separated tokens.

The vector is built in the caller.

Returns: Tokens.

◆ Split() [2/2]

static void StormByte::String::WString::Split	(	std::wstring_view	str,
		std::vector< WString > &	out
	)

staticnoexcept

Whitespace-separated tokens.

out is the caller’s container.

Parameters

	str	Source.
[out]	out	Tokens.

◆ swap()

void StormByte::String::WString::swap ( WString & other )

noexcept

Swaps buffers with other.

Parameters

other Other text.

◆ ToLower() [1/2]

WString StormByte::String::WString::ToLower ( ) const

inlinenoexcept

ASCII-letter lower case of this text.

Returns: New text.

◆ ToLower() [2/2]

static WString StormByte::String::WString::ToLower ( std::wstring_view str )

staticnoexcept

ASCII-letter lower case; other code points copied.

Parameters

str Source.

Returns: New text.

◆ ToUpper() [1/2]

WString StormByte::String::WString::ToUpper ( ) const

inlinenoexcept

ASCII-letter upper case of this text.

Returns: New text.

◆ ToUpper() [2/2]

static WString StormByte::String::WString::ToUpper ( std::wstring_view str )

staticnoexcept

ASCII-letter upper case; other code points copied.

Parameters

str Source.

Returns: New text.

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

lib/public/StormByte/string/wstring.hxx

Public Types

Public Member Functions

Helpers

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ const_reverse_iterator

◆ value_type

Constructor & Destructor Documentation

◆ WString() [1/7]

◆ WString() [2/7]

◆ WString() [3/7]

◆ WString() [4/7]

◆ WString() [5/7]

◆ WString() [6/7]

◆ WString() [7/7]

◆ ~WString()

Member Function Documentation

◆ begin()

◆ Bytes()

◆ cbegin()

◆ cend()

◆ crbegin()

◆ crend()

◆ data()

◆ empty()

◆ end()

◆ Explode() [1/2]

◆ Explode() [2/2]

◆ IsInteger() [1/2]

◆ IsInteger() [2/2]

◆ length()

◆ operator bool()

◆ operator const wchar_t *()

◆ operator std::wstring()

◆ operator std::wstring_view()

◆ operator String()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator<=>() [1/2]

◆ operator<=>() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ operator[]()

◆ rbegin()

◆ RemoveWhitespace() [1/2]

◆ RemoveWhitespace() [2/2]

◆ rend()

◆ SanitizeNewlines() [1/2]

◆ SanitizeNewlines() [2/2]

◆ size()

◆ Split() [1/2]

◆ Split() [2/2]

◆ swap()

◆ ToLower() [1/2]

◆ ToLower() [2/2]

◆ ToUpper() [1/2]

◆ ToUpper() [2/2]