Provides read-write access to a range of code units within a referenced RWUString. More...

#include <rw/i18n/RWUSubString.h>

Public Member Functions
	RWUSubString (const RWUSubString &source)

size_t	boundsCheckIndex (size_t offset) const

const RWUChar16 *	data () const

bool	isNull () const

size_t	length () const

RWUChar16 &	operator() (size_t offset)

RWUChar16	operator() (size_t offset) const

RWUSubString &	operator= (const RWBasicUString &source)

RWUSubString &	operator= (const RWUChar16 *source)

RWUSubString &	operator= (const RWUChar32 *source)

RWUSubString &	operator= (const RWUConstSubString &source)

RWUSubString &	operator= (const RWUSubString &source)

RWUSubString &	operator= (RWUChar16 codeUnit)

RWUSubString &	operator= (RWUChar32 codeUnit)

RWUChar16 &	operator[] (size_t offset)

RWUChar16	operator[] (size_t offset) const

size_t	start () const

Friends
class	RWUString

Related Symbols
(Note that these are not member symbols.)
bool	operator!= (const RWBasicUString &lhs, const RWUSubString &rhs)

bool	operator!= (const RWUChar16 *lhs, const RWUSubString &rhs)

bool	operator!= (const RWUChar32 *lhs, const RWUSubString &rhs)

bool	operator!= (const RWUSubString &lhs, const RWBasicUString &rhs)

bool	operator!= (const RWUSubString &lhs, const RWUChar16 *rhs)

bool	operator!= (const RWUSubString &lhs, const RWUChar32 *rhs)

bool	operator!= (const RWUSubString &lhs, const RWUSubString &rhs)

bool	operator< (const RWBasicUString &lhs, const RWUSubString &rhs)

bool	operator< (const RWUChar16 *lhs, const RWUSubString &rhs)

bool	operator< (const RWUChar32 *lhs, const RWUSubString &rhs)

bool	operator< (const RWUSubString &lhs, const RWBasicUString &rhs)

bool	operator< (const RWUSubString &lhs, const RWUChar16 *rhs)

bool	operator< (const RWUSubString &lhs, const RWUChar32 *rhs)

bool	operator< (const RWUSubString &lhs, const RWUSubString &rhs)

std::ostream &	operator<< (std::ostream &os, const RWUSubString &ustr)

bool	operator<= (const RWBasicUString &lhs, const RWUSubString &rhs)

bool	operator<= (const RWUChar16 *lhs, const RWUSubString &rhs)

bool	operator<= (const RWUChar32 *lhs, const RWUSubString &rhs)

bool	operator<= (const RWUSubString &lhs, const RWBasicUString &rhs)

bool	operator<= (const RWUSubString &lhs, const RWUChar16 *rhs)

bool	operator<= (const RWUSubString &lhs, const RWUChar32 *rhs)

bool	operator<= (const RWUSubString &lhs, const RWUSubString &rhs)

bool	operator== (const RWBasicUString &lhs, const RWUSubString &rhs)

bool	operator== (const RWUChar16 *lhs, const RWUSubString &rhs)

bool	operator== (const RWUChar32 *lhs, const RWUSubString &rhs)

bool	operator== (const RWUSubString &lhs, const RWBasicUString &rhs)

bool	operator== (const RWUSubString &lhs, const RWUChar16 *rhs)

bool	operator== (const RWUSubString &lhs, const RWUChar32 *rhs)

bool	operator== (const RWUSubString &lhs, const RWUSubString &rhs)

bool	operator> (const RWBasicUString &lhs, const RWUSubString &rhs)

bool	operator> (const RWUChar16 *lhs, const RWUSubString &rhs)

bool	operator> (const RWUChar32 *lhs, const RWUSubString &rhs)

bool	operator> (const RWUSubString &lhs, const RWBasicUString &rhs)

bool	operator> (const RWUSubString &lhs, const RWUChar16 *rhs)

bool	operator> (const RWUSubString &lhs, const RWUChar32 *rhs)

bool	operator> (const RWUSubString &lhs, const RWUSubString &rhs)

bool	operator>= (const RWBasicUString &lhs, const RWUSubString &rhs)

bool	operator>= (const RWUChar16 *lhs, const RWUSubString &rhs)

bool	operator>= (const RWUChar32 *lhs, const RWUSubString &rhs)

bool	operator>= (const RWUSubString &lhs, const RWBasicUString &rhs)

bool	operator>= (const RWUSubString &lhs, const RWUChar16 *rhs)

bool	operator>= (const RWUSubString &lhs, const RWUChar32 *rhs)

bool	operator>= (const RWUSubString &lhs, const RWUSubString &rhs)

std::istream &	operator>> (std::istream &is, RWUSubString &ustr)

Detailed Description

RWUSubString allows read-write access to a range of code units within a referenced RWUString. The range is defined by a starting position and an length within the referenced string. For example, the 7th through the 11th elements, inclusive, would have a starting position of 7 and an extent of 5.

There are no public constructors. RWUSubString instances are constructed by various functions of the RWUString class. Typically, substrings are created and used anonymously, then destroyed immediately.

RWUSubString performs bounds checking in all methods that accept an offset value. These methods throw an RWBoundsErr exception if an offset exceeds the current bounds of the substring.

Example: #include <rw/i18n/RWUConversionContext.h>

#include <rw/i18n/RWUString.h>

#include <rw/i18n/RWUSubString.h>

#include <iostream>

using std::cout;

using std::endl;

int main() {

// Indicate that source and target strings are

// encoded as ISO8859-1.

RWUConversionContext context("ISO8859-1");

// Initialize a Unicode string.

RWUString str("Encoded as Latin-1");

// Modify a substring.

str(11, 5) = "ISO8859";

// Print the result.

cout << str << endl;

return 0;

}

RWUConversionContext
Specifies the default character encoding scheme for conversions between narrow character strings and ...
Definition RWUConversionContext.h:101

RWUString
Stores and manipulates Unicode character sequences encoded as UTF-16 code units.
Definition RWUString.h:187

Program Output:

Encoded as ISO8859-1

Constructor & Destructor Documentation

◆ RWUSubString()

RWUSubString::RWUSubString ( const RWUSubString & source )

inline

Constructs an RWUSubString from source.

Member Function Documentation

◆ boundsCheckIndex()

size_t RWUSubString::boundsCheckIndex ( size_t offset ) const

inline

Returns offset if the value is in bounds.

Exceptions

RWBoundsErr Thrown if self is a null substring or if offset is greater than or equal to length()

◆ data()

const RWUChar16 * RWUSubString::data ( ) const

inline

Returns a pointer to the string contents referenced by self.

The storage referenced by this pointer is owned by the RWUString associated with this substring. This storage may not be deleted or modified. The pointer becomes invalid if the RWUString is modified or destroyed.

Exceptions

RWBoundsErr Thrown if self is a null substring.

◆ isNull()

bool RWUSubString::isNull ( ) const

inline

Returns true if the substring defined by self is null or empty; otherwise, false.

◆ length()

size_t RWUSubString::length ( ) const

inline

Returns the number of code units in the substring defined by self.

◆ operator()() [1/2]

RWUChar16 & RWUSubString::operator() ( size_t offset )

inline

Returns a reference object that provides read-write access to the code unit located at index offset within self. The result can be used as an RWUChar16 value, or as an l-value in an RWUChar16 assignment expression. The value of offset must be less than length().

Exceptions

RWBoundsErr Thrown if self is a null substring, or if offset is greater than or equal to length().

◆ operator()() [2/2]

RWUChar16 RWUSubString::operator() ( size_t offset ) const

inline

Returns the code unit located at index offset within self. The value of offset must be less than length().

Exceptions

RWBoundsErr Thrown if self is a null substring, or if offset is greater than or equal to length().

◆ operator=() [1/7]

RWUSubString & RWUSubString::operator= ( const RWBasicUString & source )

inline

Replaces the substring defined by self with source.

◆ operator=() [2/7]

RWUSubString & RWUSubString::operator= ( const RWUChar16 * source )

inline

Replaces the substring defined by self with the null-terminated array source.

◆ operator=() [3/7]

RWUSubString & RWUSubString::operator= ( const RWUChar32 * source )

inline

Replaces the substring defined by self with the null-terminated array source.

◆ operator=() [4/7]

RWUSubString & RWUSubString::operator= ( const RWUConstSubString & source )

inline

Replaces the substring defined by self with source.

◆ operator=() [5/7]

RWUSubString & RWUSubString::operator= ( const RWUSubString & source )

inline

Replaces the substring defined by self with source.

◆ operator=() [6/7]

RWUSubString & RWUSubString::operator= ( RWUChar16 codeUnit )

inline

Replaces the substring defined by self with codeUnit.

◆ operator=() [7/7]

RWUSubString & RWUSubString::operator= ( RWUChar32 codeUnit )

inline

Replaces the substring defined by self with codeUnit.

◆ operator[]() [1/2]

RWUChar16 & RWUSubString::operator[] ( size_t offset )

inline

Returns a reference object that provides read-write access to the code unit located at index offset within self. The result can be used as an RWUChar16 value, or as an l-value in an RWUChar16 assignment expression. The value of offset must be less than length().

Exceptions

RWBoundsErr Thrown if self is a null substring, or if offset is greater than or equal to length().

◆ operator[]() [2/2]

RWUChar16 RWUSubString::operator[] ( size_t offset ) const

inline

Returns the code unit located at index offset within self. The value of offset must be less than length().

Exceptions

RWBoundsErr Thrown if self is a null substring, or if offset is greater than or equal to length().

◆ start()

size_t RWUSubString::start ( ) const

inline

Returns the start position of the substring defined by self within the RWUString referenced by self. A return value of RW_NPOS indicates that self is a null substring.

Friends And Related Symbol Documentation

◆ operator!=() [1/7]

bool operator!=	(	const RWBasicUString &	lhs,
		const RWUSubString &	rhs )

◆ operator!=() [2/7]

bool operator!=	(	const RWUChar16 *	lhs,
		const RWUSubString &	rhs )

The lhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodeUnits() in that case.

◆ operator!=() [3/7]

bool operator!=	(	const RWUChar32 *	lhs,
		const RWUSubString &	rhs )

The lhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodePoints() in that case.

◆ operator!=() [4/7]

bool operator!=	(	const RWUSubString &	lhs,
		const RWBasicUString &	rhs )

◆ operator!=() [5/7]

bool operator!=	(	const RWUSubString &	lhs,
		const RWUChar16 *	rhs )

The rhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodeUnits() in that case.

◆ operator!=() [6/7]

bool operator!=	(	const RWUSubString &	lhs,
		const RWUChar32 *	rhs )

The rhs string must be null-terminated. This method cannot be used to compare strings containing embedded nulls; use RWBasicUString::compareCodePoints() in that case.

◆ operator!=() [7/7]

bool operator!=	(	const RWUSubString &	lhs,
		const RWUSubString &	rhs )

Returns true if lhs does not have the same length as, or lexicographically differs from, rhs; otherwise, false. Also returns false if both substrings are invalid. This operator represents the logical negation of operator==.