SourcePro® API Reference Guide

 
List of all members | Public Member Functions | Related Functions
RWCSubString Class Reference

Allows some subsection of an RWCString to be addressed by defining a starting position and an extent. More...

#include <rw/cstring.h>

Public Member Functions

bool isNull () const
 
size_t length () const
 
int operator! () const
 
char & operator() (size_t i)
 
char operator() (size_t i) const
 
RWCSubStringoperator= (const RWCSubString &str)
 
RWCSubStringoperator= (const RWCConstSubString &str)
 
RWCSubStringoperator= (const RWCString &str)
 
RWCSubStringoperator= (const std::string &str)
 
RWCSubStringoperator= (const char *str)
 
char & operator[] (char i)
 
char operator[] (char i) const
 
char & operator[] (signed char i)
 
char operator[] (signed char i) const
 
char & operator[] (short i)
 
char operator[] (short i) const
 
char & operator[] (int i)
 
char operator[] (int i) const
 
char & operator[] (long i)
 
char operator[] (long i) const
 
char & operator[] (long long i)
 
char operator[] (long long i) const
 
char & operator[] (unsigned char i)
 
char operator[] (unsigned char i) const
 
char & operator[] (unsigned short i)
 
char operator[] (unsigned short i) const
 
char & operator[] (unsigned int i)
 
char operator[] (unsigned int i) const
 
char & operator[] (unsigned long i)
 
char operator[] (unsigned long i) const
 
char & operator[] (unsigned long long i)
 
char operator[] (unsigned long long i) const
 
size_t start () const
 
void toLower ()
 
void toUpper ()
 

Related Functions

(Note that these are not member functions.)

bool operator!= (const RWCSubString &lhs, const RWCSubString &rhs)
 
bool operator!= (const RWCSubString &lhs, const RWCConstSubString &rhs)
 
bool operator!= (const RWCConstSubString &lhs, const RWCSubString &rhs)
 
bool operator!= (const RWCSubString &lhs, const std::string &rhs)
 
bool operator!= (const std::string &lhs, const RWCSubString &rhs)
 
bool operator!= (const RWCSubString &lhs, const char *rhs)
 
bool operator!= (const char *lhs, const RWCSubString &rhs)
 
bool operator!= (const RWCSubString &lhs, char rhs)
 
bool operator!= (char lhs, const RWCSubString &rhs)
 
bool operator< (const RWCSubString &lhs, const RWCSubString &rhs)
 
bool operator< (const RWCSubString &lhs, const RWCConstSubString &rhs)
 
bool operator< (const RWCConstSubString &lhs, const RWCSubString &rhs)
 
bool operator< (const RWCSubString &lhs, const std::string &rhs)
 
bool operator< (const std::string &lhs, const RWCSubString &rhs)
 
bool operator< (const RWCSubString &lhs, const char *rhs)
 
bool operator< (const char *lhs, const RWCSubString &rhs)
 
bool operator< (const RWCSubString &lhs, char rhs)
 
bool operator< (char lhs, const RWCSubString &rhs)
 
bool operator<= (const RWCSubString &lhs, const RWCSubString &rhs)
 
bool operator<= (const RWCSubString &lhs, const RWCConstSubString &rhs)
 
bool operator<= (const RWCConstSubString &lhs, const RWCSubString &rhs)
 
bool operator<= (const RWCSubString &lhs, const std::string &rhs)
 
bool operator<= (const std::string &lhs, const RWCSubString &rhs)
 
bool operator<= (const RWCSubString &lhs, const char *rhs)
 
bool operator<= (const char *lhs, const RWCSubString &rhs)
 
bool operator<= (const RWCSubString &lhs, char rhs)
 
bool operator<= (char lhs, const RWCSubString &rhs)
 
bool operator== (const RWCSubString &lhs, const RWCSubString &rhs)
 
bool operator== (const RWCSubString &lhs, const RWCConstSubString &rhs)
 
bool operator== (const RWCConstSubString &lhs, const RWCSubString &rhs)
 
bool operator== (const RWCSubString &lhs, const std::string &rhs)
 
bool operator== (const std::string &lhs, const RWCSubString &rhs)
 
bool operator== (const RWCSubString &lhs, const char *rhs)
 
bool operator== (const char *lhs, const RWCSubString &rhs)
 
bool operator== (const RWCSubString &lhs, char rhs)
 
bool operator== (char lhs, const RWCSubString &rhs)
 
bool operator> (const RWCSubString &lhs, const RWCSubString &rhs)
 
bool operator> (const RWCSubString &lhs, const RWCConstSubString &rhs)
 
bool operator> (const RWCConstSubString &lhs, const RWCSubString &rhs)
 
bool operator> (const RWCSubString &lhs, const std::string &rhs)
 
bool operator> (const std::string &lhs, const RWCSubString &rhs)
 
bool operator> (const RWCSubString &lhs, const char *rhs)
 
bool operator> (const char *lhs, const RWCSubString &rhs)
 
bool operator> (const RWCSubString &lhs, char rhs)
 
bool operator> (char lhs, const RWCSubString &rhs)
 
bool operator>= (const RWCSubString &lhs, const RWCSubString &rhs)
 
bool operator>= (const RWCSubString &lhs, const RWCConstSubString &rhs)
 
bool operator>= (const RWCConstSubString &lhs, const RWCSubString &rhs)
 
bool operator>= (const RWCSubString &lhs, const std::string &rhs)
 
bool operator>= (const std::string &lhs, const RWCSubString &rhs)
 
bool operator>= (const RWCSubString &lhs, const char *rhs)
 
bool operator>= (const char *lhs, const RWCSubString &rhs)
 
bool operator>= (const RWCSubString &lhs, char rhs)
 
bool operator>= (char lhs, const RWCSubString &rhs)
 

Detailed Description

The class RWCSubString allows some subsection of an RWCString to be addressed by defining a starting position and an extent. For example the 7th through the 11th elements, inclusive, would have a starting position of 7 and an extent of 5. The specification of a starting position and extent can also be done on your behalf by such functions as RWCString::strip() or the overloaded function call operator taking a regular expression as an argument. There are no public constructors – RWCSubStrings are constructed by various functions of the RWCString class and then destroyed immediately.

A zero length substring is one with a defined starting position and an extent of zero. It can be thought of as starting just before the indicated character, but not including it. It can be used as an lvalue. A null substring is also legal and is frequently used to indicate that a requested substring, perhaps through a search, does not exist. A null substring can be detected with member function isNull(). However, it cannot be used as an lvalue.

Synopsis
#include <rw/cstring.h>
RWCString s("test string");
s(6,3); // "tri"
Persistence
None
Example
#include <iostream>
#include <rw/cstring.h>
int main()
{
RWCString s ("What I tell you is true.");
std::cout << "Take the string: [" << s << "]\n";
// Create a substring and use it as an lvalue:
s(16, 0) = "three times ";
std::cout << "After assigning text to a substring, the full string becomes: ["
<< s << "]" << std::endl;
return 0;
}

Program output:

Take the string: [What I tell you is true.]
After assigning text to a substring, the full string becomes: [What I tell you three times is true.]

Member Function Documentation

bool RWCSubString::isNull ( void  ) const
inline

Returns true if this is a null substring.

size_t RWCSubString::length ( ) const
inline

Returns the extent (i.e., length) of the substring.

int RWCSubString::operator! ( ) const
inline

Returns true if this is a null substring.

char & RWCSubString::operator() ( size_t  i)
inline

Returns the i th character of the substring. The index i must be between zero and the length of the substring less one. Bounds checking is enabled by defining the preprocessor macro RWBOUNDS_CHECK before including <rw/cstring.h>.

Exceptions
RWBoundsErrif RWBOUNDS_CHECK is defined and the index is out of range.
char RWCSubString::operator() ( size_t  i) const
inline

Returns the i th character of the substring. The index i must be between zero and the length of the substring less one. Bounds checking is enabled by defining the preprocessor macro RWBOUNDS_CHECK before including <rw/cstring.h>.

Exceptions
RWBoundsErrif RWBOUNDS_CHECK is defined and the index is out of range.
RWCSubString & RWCSubString::operator= ( const RWCSubString str)
inline

Assignment from an RWCSubString. Example:

RWCString a(10, 'a');
...
b(2, 3) = a(5,5);

Copies 5 characters of a's data into the substring b(2,3). The number of elements need not match; if they differ, b is resized appropriately. If self is the null substring, then the statement has no effect. Returns a reference to self.

RWCSubString & RWCSubString::operator= ( const RWCConstSubString str)
inline

Assignment from an RWCConstSubString. Example:

const RWCString a(10, 'a');
...
b(2, 3) = a(5,5);

Copies 5 characters of a's data into the substring b(2,3). The number of elements need not match; if they differ, b is resized appropriately. If self is the null substring, then the statement has no effect. Returns a reference to self.

RWCSubString & RWCSubString::operator= ( const RWCString str)
inline

Assignment from an RWCString. Example:

...
b(2, 3) = a;

Copies a's data into the substring b(2,3). The number of elements need not match; if they differ, b is resized appropriately. If self is the null substring, then the statement has no effect. Returns a reference to self.

RWCSubString & RWCSubString::operator= ( const std::string &  str)
inline

Assignment from an std::string. Example:

std::string a;
...
b(2, 3) = a;

Copies a's data into the substring b(2,3). The number of elements need not match; if they differ, b is resized appropriately. If self is the null substring, then the statement has no effect. Returns a reference to self.

RWCSubString & RWCSubString::operator= ( const char *  str)
inline

Assignment from a character string. Example:

RWCString str("Mary had a lamb");
char dat[] = "Perrier";
str(11,4) = dat; // "Mary had a Perrier"

The number of characters selected need not match; if they differ, str is resized appropriately. If self is the null substring, then the statement has no effect. Returns a reference to self.

char & RWCSubString::operator[] ( char  i)
inline

Returns the i th character of the substring. The index i must be between zero and the length of the substring less one. i is converted to a size_t and bounds checking is performed.

Exceptions
RWBoundsErrif the index is out of range.
char RWCSubString::operator[] ( char  i) const
inline

Returns the i th character of the substring. The index i must be between zero and the length of the substring less one. i is converted to a size_t and bounds checking is performed.

Exceptions
RWBoundsErrif the index is out of range.
char & RWCSubString::operator[] ( signed char  i)
inline

Returns the i th character of the substring. The index i must be between zero and the length of the substring less one. i is converted to a size_t and bounds checking is performed.

Exceptions
RWBoundsErrif the index is out of range.
char RWCSubString::operator[] ( signed char  i) const
inline

Returns the i th character of the substring. The index i must be between zero and the length of the substring less one. i is converted to a size_t and bounds checking is performed.

Exceptions
RWBoundsErrif the index is out of range.
char & RWCSubString::operator[] ( short  i)
inline

Returns the i th character of the substring. The index i must be between zero and the length of the substring less one. i is converted to a size_t and bounds checking is performed.

Exceptions
RWBoundsErrif the index is out of range.
char RWCSubString::operator[] ( short  i) const
inline

Returns the i th character of the substring. The index i must be between zero and the length of the substring less one. i is converted to a size_t and bounds checking is performed.

Exceptions
RWBoundsErrif the index is out of range.
char & RWCSubString::operator[] ( int  i)
inline

Returns the i th character of the substring. The index i must be between zero and the length of the substring less one. i is converted to a size_t and bounds checking is performed.

Exceptions
RWBoundsErrif the index is out of range.
char RWCSubString::operator[] ( int  i) const
inline

Returns the i th character of the substring. The index i must be between zero and the length of the substring less one. i is converted to a size_t and bounds checking is performed.

Exceptions
RWBoundsErrif the index is out of range.
char & RWCSubString::operator[] ( long  i)
inline

Returns the i th character of the substring. The index i must be between zero and the length of the substring less one. i is converted to a size_t and bounds checking is performed.

Exceptions
RWBoundsErrif the index is out of range.
char RWCSubString::operator[] ( long  i) const
inline

Returns the i th character of the substring. The index i must be between zero and the length of the substring less one. i is converted to a size_t and bounds checking is performed.

Exceptions
RWBoundsErrif the index is out of range.
char & RWCSubString::operator[] ( long long  i)
inline

Returns the i th character of the substring. The index i must be between zero and the length of the substring less one. i is converted to a size_t and bounds checking is performed.

Exceptions
RWBoundsErrif the index is out of range.
char RWCSubString::operator[] ( long long  i) const
inline

Returns the i th character of the substring. The index i must be between zero and the length of the substring less one. i is converted to a size_t and bounds checking is performed.

Exceptions
RWBoundsErrif the index is out of range.
char & RWCSubString::operator[] ( unsigned char  i)
inline

Returns the i th character of the substring. The index i must be between zero and the length of the substring less one. i is converted to a size_t and bounds checking is performed.

Exceptions
RWBoundsErrif the index is out of range.
char RWCSubString::operator[] ( unsigned char  i) const
inline

Returns the i th character of the substring. The index i must be between zero and the length of the substring less one. i is converted to a size_t and bounds checking is performed.

Exceptions
RWBoundsErrif the index is out of range.
char & RWCSubString::operator[] ( unsigned short  i)
inline

Returns the i th character of the substring. The index i must be between zero and the length of the substring less one. i is converted to a size_t and bounds checking is performed.

Exceptions
RWBoundsErrif the index is out of range.
char RWCSubString::operator[] ( unsigned short  i) const
inline

Returns the i th character of the substring. The index i must be between zero and the length of the substring less one. i is converted to a size_t and bounds checking is performed.

Exceptions
RWBoundsErrif the index is out of range.
char & RWCSubString::operator[] ( unsigned int  i)
inline

Returns the i th character of the substring. The index i must be between zero and the length of the substring less one. i is converted to a size_t and bounds checking is performed.

Exceptions
RWBoundsErrif the index is out of range.
char RWCSubString::operator[] ( unsigned int  i) const
inline

Returns the i th character of the substring. The index i must be between zero and the length of the substring less one. i is converted to a size_t and bounds checking is performed.

Exceptions
RWBoundsErrif the index is out of range.
char & RWCSubString::operator[] ( unsigned long  i)
inline

Returns the i th character of the substring. The index i must be between zero and the length of the substring less one. i is converted to a size_t and bounds checking is performed.

Exceptions
RWBoundsErrif the index is out of range.
char RWCSubString::operator[] ( unsigned long  i) const
inline

Returns the i th character of the substring. The index i must be between zero and the length of the substring less one. i is converted to a size_t and bounds checking is performed.

Exceptions
RWBoundsErrif the index is out of range.
char & RWCSubString::operator[] ( unsigned long long  i)
inline

Returns the i th character of the substring. The index i must be between zero and the length of the substring less one. i is converted to a size_t and bounds checking is performed.

Exceptions
RWBoundsErrif the index is out of range.
char RWCSubString::operator[] ( unsigned long long  i) const
inline

Returns the i th character of the substring. The index i must be between zero and the length of the substring less one. i is converted to a size_t and bounds checking is performed.

Exceptions
RWBoundsErrif the index is out of range.
size_t RWCSubString::start ( void  ) const
inline

Returns the index of the starting element of the substring.

void RWCSubString::toLower ( )
inline

Changes all upper-case letters in self to lower-case. Uses the C++ Standard Library function std::tolower().

void RWCSubString::toUpper ( )
inline

Changes all lower-case letters in self to upper-case. Uses the C++ Standard Library function std::toupper().

Friends And Related Function Documentation

bool operator!= ( const RWCSubString lhs,
const RWCSubString rhs 
)
related

The equivalent of calling:

!(lhs == rhs)
bool operator!= ( const RWCSubString lhs,
const RWCConstSubString rhs 
)
related

The equivalent of calling:

!(lhs == rhs)
bool operator!= ( const RWCConstSubString lhs,
const RWCSubString rhs 
)
related

The equivalent of calling:

!(lhs == rhs)
bool operator!= ( const RWCSubString lhs,
const std::string &  rhs 
)
related

The equivalent of calling:

!(lhs == rhs)
bool operator!= ( const std::string &  lhs,
const RWCSubString rhs 
)
related

The equivalent of calling:

!(lhs == rhs)
bool operator!= ( const RWCSubString lhs,
const char *  rhs 
)
related

The equivalent of calling:

!(lhs == rhs)
bool operator!= ( const char *  lhs,
const RWCSubString rhs 
)
related

The equivalent of calling:

!(lhs == rhs)
bool operator!= ( const RWCSubString lhs,
char  rhs 
)
related

The equivalent of calling:

!(lhs == rhs)
bool operator!= ( char  lhs,
const RWCSubString rhs 
)
related

The equivalent of calling:

!(lhs == rhs)
bool operator< ( const RWCSubString lhs,
const RWCSubString rhs 
)
related

Returns true if lhs lexicographically precedes rhs. Otherwise returns false. Use member RWCString::collate() or RWCString::strXForm() for locale-sensitive comparisons.

bool operator< ( const RWCSubString lhs,
const RWCConstSubString rhs 
)
related

Returns true if lhs lexicographically precedes rhs. Otherwise returns false. Use member RWCString::collate() or RWCString::strXForm() for locale-sensitive comparisons.

bool operator< ( const RWCConstSubString lhs,
const RWCSubString rhs 
)
related

Returns true if lhs lexicographically precedes rhs. Otherwise returns false. Use member RWCString::collate() or RWCString::strXForm() for locale-sensitive comparisons.

bool operator< ( const RWCSubString lhs,
const std::string &  rhs 
)
related

Returns true if lhs lexicographically precedes rhs. Otherwise returns false. Use member RWCString::collate() or RWCString::strXForm() for locale-sensitive comparisons.

bool operator< ( const std::string &  lhs,
const RWCSubString rhs 
)
related

Returns true if lhs lexicographically precedes rhs. Otherwise returns false. Use member RWCString::collate() or RWCString::strXForm() for locale-sensitive comparisons.

bool operator< ( const RWCSubString lhs,
const char *  rhs 
)
related

Returns true if lhs lexicographically precedes rhs. Otherwise returns false. Use member RWCString::collate() or RWCString::strXForm() for locale-sensitive comparisons.

Note
This function is incompatible with rhs strings with embedded nulls.
bool operator< ( const char *  lhs,
const RWCSubString rhs 
)
related

Returns true if lhs lexicographically precedes rhs. Otherwise returns false. Use member RWCString::collate() or RWCString::strXForm() for locale-sensitive comparisons.

Note
This function is incompatible with lhs strings with embedded nulls.
bool operator< ( const RWCSubString lhs,
char  rhs 
)
related

Returns true if lhs is empty or the first character in lhs is less than rhs. Otherwise returns false.

bool operator< ( char  lhs,
const RWCSubString rhs 
)
related

Returns true if the length of rhs is at least one and the first character of rhs is greater than lhs.

bool operator<= ( const RWCSubString lhs,
const RWCSubString rhs 
)
related

The equivalent of calling:

!(rhs < lhs)
bool operator<= ( const RWCSubString lhs,
const RWCConstSubString rhs 
)
related

The equivalent of calling:

!(rhs < lhs)
bool operator<= ( const RWCConstSubString lhs,
const RWCSubString rhs 
)
related

The equivalent of calling:

!(rhs < lhs)
bool operator<= ( const RWCSubString lhs,
const std::string &  rhs 
)
related

The equivalent of calling:

!(rhs < lhs)
bool operator<= ( const std::string &  lhs,
const RWCSubString rhs 
)
related

The equivalent of calling:

!(rhs < lhs)
bool operator<= ( const RWCSubString lhs,
const char *  rhs 
)
related

The equivalent of calling:

!(rhs < lhs)
bool operator<= ( const char *  lhs,
const RWCSubString rhs 
)
related

The equivalent of calling:

!(rhs < lhs)
bool operator<= ( const RWCSubString lhs,
char  rhs 
)
related

The equivalent of calling:

!(rhs < lhs)
bool operator<= ( char  lhs,
const RWCSubString rhs 
)
related

The equivalent of calling:

!(rhs < lhs)
bool operator== ( const RWCSubString lhs,
const RWCSubString rhs 
)
related

Returns true if lhs is lexicographically equal to rhs. Otherwise returns false. Use member RWCString::collate() or RWCString::strXForm() for locale-sensitive comparisons.

bool operator== ( const RWCSubString lhs,
const RWCConstSubString rhs 
)
related

Returns true if lhs is lexicographically equal to rhs. Otherwise returns false. Use member RWCString::collate() or RWCString::strXForm() for locale-sensitive comparisons.

bool operator== ( const RWCConstSubString lhs,
const RWCSubString rhs 
)
related

Returns true if lhs is lexicographically equal to rhs. Otherwise returns false. Use member RWCString::collate() or RWCString::strXForm() for locale-sensitive comparisons.

bool operator== ( const RWCSubString lhs,
const std::string &  rhs 
)
related

Returns true if lhs is lexicographically equal to rhs. Otherwise returns false. Use member RWCString::collate() or RWCString::strXForm() for locale-sensitive comparisons.

bool operator== ( const std::string &  lhs,
const RWCSubString rhs 
)
related

Returns true if lhs is lexicographically equal to rhs. Otherwise returns false. Use member RWCString::collate() or RWCString::strXForm() for locale-sensitive comparisons.

bool operator== ( const RWCSubString lhs,
const char *  rhs 
)
related

Returns true if lhs is lexicographically equal to rhs. Otherwise returns false. Use member RWCString::collate() or RWCString::strXForm() for locale-sensitive comparisons.

Note
This function is incompatible with rhs strings with embedded nulls.
bool operator== ( const char *  lhs,
const RWCSubString rhs 
)
related

Returns true if lhs is lexicographically equal to rhs. Otherwise returns false. Use member RWCString::collate() or RWCString::strXForm() for locale-sensitive comparisons.

Note
This function is incompatible with lhs strings with embedded nulls.
bool operator== ( const RWCSubString lhs,
char  rhs 
)
related

Returns true if lhs has a length of one and the first character lhs is identical to the char rhs.

bool operator== ( char  lhs,
const RWCSubString rhs 
)
related

Returns true if rhs has a length of one and the first character rhs is identical to the char lhs.

bool operator> ( const RWCSubString lhs,
const RWCSubString rhs 
)
related

The equivalent of calling:

!(rhs < lhs)
bool operator> ( const RWCSubString lhs,
const RWCConstSubString rhs 
)
related

The equivalent of calling:

!(rhs < lhs)
bool operator> ( const RWCConstSubString lhs,
const RWCSubString rhs 
)
related

The equivalent of calling:

!(rhs < lhs)
bool operator> ( const RWCSubString lhs,
const std::string &  rhs 
)
related

The equivalent of calling:

!(rhs < lhs)
bool operator> ( const std::string &  lhs,
const RWCSubString rhs 
)
related

The equivalent of calling:

!(rhs < lhs)
bool operator> ( const RWCSubString lhs,
const char *  rhs 
)
related

The equivalent of calling:

!(rhs < lhs)
bool operator> ( const char *  lhs,
const RWCSubString rhs 
)
related

The equivalent of calling:

!(rhs < lhs)
bool operator> ( const RWCSubString lhs,
char  rhs 
)
related

The equivalent of calling:

!(rhs < lhs)
bool operator> ( char  lhs,
const RWCSubString rhs 
)
related

The equivalent of calling:

!(rhs < lhs)
bool operator>= ( const RWCSubString lhs,
const RWCSubString rhs 
)
related

The equivalent of calling:

!(lhs < rhs)
bool operator>= ( const RWCSubString lhs,
const RWCConstSubString rhs 
)
related

The equivalent of calling:

!(lhs < rhs)
bool operator>= ( const RWCConstSubString lhs,
const RWCSubString rhs 
)
related

The equivalent of calling:

!(lhs < rhs)
bool operator>= ( const RWCSubString lhs,
const std::string &  rhs 
)
related

The equivalent of calling:

!(lhs < rhs)
bool operator>= ( const std::string &  lhs,
const RWCSubString rhs 
)
related

The equivalent of calling:

!(lhs < rhs)
bool operator>= ( const RWCSubString lhs,
const char *  rhs 
)
related

The equivalent of calling:

!(lhs < rhs)
bool operator>= ( const char *  lhs,
const RWCSubString rhs 
)
related

The equivalent of calling:

!(lhs < rhs)
bool operator>= ( const RWCSubString lhs,
char  rhs 
)
related

The equivalent of calling:

!(lhs < rhs)
bool operator>= ( char  lhs,
const RWCSubString rhs 
)
related

The equivalent of calling:

!(lhs < rhs)

Copyright © 2023 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved.