The character string class. More...

#include <pstring.h>

Inheritance diagram for PString:

Collaboration diagram for PString:

Public Types
typedef const char *	Initialiser

Public Member Functions
Overrides from class PObject
virtual PObject *	Clone () const
	Make a complete duplicate of the string. More...

virtual Comparison	Compare (const PObject &obj) const
	Get the relative rank of the two strings. More...

virtual void	PrintOn (ostream &strm) const
	Output the string to the specified stream. More...

virtual void	ReadFrom (istream &strm)
	Input the string from the specified stream. More...

virtual PINDEX	HashFunction () const
	Calculate a hash value for use in sets and dictionaries. More...

Overrides from class PContainer
virtual PBoolean	SetSize (PINDEX newSize)
	Set the size of the string. More...

virtual PBoolean	IsEmpty () const
	Determine if the string is empty. More...

virtual PBoolean	MakeUnique ()
	Make this instance to be the one and only reference to the container contents. More...

Size/Length functions
bool	MakeMinimumSize (PINDEX newLength=0)
	Set the actual memory block array size to the minimum required to hold the current string contents. More...

virtual PINDEX	GetLength () const
	Determine the length of the null terminated string. More...

bool	operator! () const
	Determine if the string is NOT empty. More...

Search & replace functions
PINDEX	Find (char ch, PINDEX offset=0) const
	Locate the position within the string of the character. More...

PINDEX	Find (const PString &str, PINDEX offset=0) const
	Locate the position within the string of the substring. More...

PINDEX	Find (const char *cstr, PINDEX offset=0) const

PINDEX	FindLast (char ch, PINDEX offset=P_MAX_INDEX) const
	Locate the position of the last matching character. More...

PINDEX	FindLast (const PString &str, PINDEX offset=P_MAX_INDEX) const
	Locate the position of the last matching substring. More...

PINDEX	FindLast (const char *cstr, PINDEX offset=P_MAX_INDEX) const
	Locate the position of the last matching substring. More...

PINDEX	FindOneOf (const PString &set, PINDEX offset=0) const
	Locate the position of one of the characters in the set. More...

PINDEX	FindOneOf (const char *cset, PINDEX offset=0) const
	Locate the position of one of the characters in the set. More...

PINDEX	FindSpan (const PString &set, PINDEX offset=0) const
	Locate the position of character not in the set. More...

PINDEX	FindSpan (const char *cset, PINDEX offset=0) const
	Locate the position of character not in the set. More...

PINDEX	FindRegEx (const PRegularExpression &regex, PINDEX offset=0) const
	Locate the position within the string of one of the regular expression. More...

PBoolean	FindRegEx (const PRegularExpression &regex, PINDEX &pos, PINDEX &len, PINDEX offset=0, PINDEX maxPos=P_MAX_INDEX) const
	Locate the position within the string of one of the regular expression. More...

PBoolean	MatchesRegEx (const PRegularExpression &regex) const
	Return true if the entire string matches the regular expression. More...

PString &	Replace (const PString &target, const PString &subs, PBoolean all=false, PINDEX offset=0)
	Locate the substring within the string and replace it with the specifed substring. More...

PString &	Splice (const PString &str, PINDEX pos, PINDEX len=0)
	Splice the string into the current string at the specified position. More...

PString &	Splice (const char *cstr, PINDEX pos, PINDEX len=0)
	Splice the string into the current string at the specified position. More...

PString &	Delete (PINDEX start, PINDEX len)
	Remove the substring from the string. More...

Sub-string functions
PString	operator() (PINDEX start, PINDEX end) const
	Extract a portion of the string into a new string. More...

PString	Left (PINDEX len) const
	Extract a portion of the string into a new string. More...

PString	Right (PINDEX len) const
	Extract a portion of the string into a new string. More...

PString	Mid (PINDEX start, PINDEX len=P_MAX_INDEX) const
	Extract a portion of the string into a new string. More...

PString	LeftTrim () const
	Create a string consisting of all characters from the source string except all spaces at the beginning of the string. More...

PString	RightTrim () const
	Create a string consisting of all characters from the source string except all spaces at the end of the string. More...

PString	Trim () const
	Create a string consisting of all characters from the source string except all spaces at the beginning and end of the string. More...

PString	ToLower () const
	Create a string consisting of all characters from the source string with all upper case letters converted to lower case. More...

PString	ToUpper () const
	Create a string consisting of all characters from the source string with all lower case letters converted to upper case. More...

bool	Split (char delimiter, PString &before, PString &after, bool trim=true) const
	Split the string into two substrings around delimiter. More...

PStringArray	Tokenise (const PString &separators, PBoolean onePerSeparator=true) const
	Split the string into an array of substrings. More...

PStringArray	Tokenise (const char *cseparators, PBoolean onePerSeparator=true) const
	Split the string into an array of substrings. More...

PStringArray	Lines () const
	Split the string into individual lines. More...

Public Member Functions inherited from PCharArray
	PCharArray (PINDEX initialSize=0)
	Construct a new dynamic array of char. More...

	PCharArray (char const *buffer, PINDEX length, PBoolean dynamic=true)
	Construct a new dynamic array of char. More...

	PCharArray (PContainerReference &reference_)

virtual void	PrintOn (ostream &strm) const
	Print the array. More...

virtual void	ReadFrom (istream &strm)
	Read the array. More...

Public Member Functions inherited from PBaseArray< char >
	PBaseArray (PINDEX initialSize=0)
	Construct a new dynamic array of elements of the specified type. More...

	PBaseArray (charconst *buffer, PINDEX length, PBoolean dynamic=true)
	Construct a new dynamic array of elements of the specified type. More...

PBoolean	SetAt (PINDEX index, charval)
	Set the specific element in the array. More...

char	GetAt (PINDEX index) const
	Get a value from the array. More...

void	Attach (const char *buffer, PINDEX bufferSize)
	Attach a pointer to a static block to the base array type. More...

char *	GetPointer (PINDEX minSize=0)
	Get a pointer to the internal array and assure that it is of at least the specified size. More...

char	operator[] (PINDEX index) const
	Get a value from the array. More...

char &	operator[] (PINDEX index)
	Get a reference to value from the array. More...

	operator charconst * () const
	Get a pointer to the internal array. More...

PBoolean	Concatenate (const PBaseArray &array)
	Concatenate one array to the end of this array. More...

Public Member Functions inherited from PAbstractArray
	PAbstractArray (PINDEX elementSizeInBytes, PINDEX initialSize=0)
	Create a new dynamic array of `initalSize` elements of `elementSizeInBytes` bytes each. More...

	PAbstractArray (PINDEX elementSizeInBytes, const void *buffer, PINDEX bufferSizeInElements, PBoolean dynamicAllocation)
	Create a new dynamic array of `bufferSizeInElements` elements of `elementSizeInBytes` bytes each. More...

void	Attach (const void *buffer, PINDEX bufferSize)
	Attach a pointer to a static block to the base array type. More...

void *	GetPointer (PINDEX minSize=1)
	Get a pointer to the internal array and assure that it is of at least the specified size. More...

PBoolean	Concatenate (const PAbstractArray &array)
	Concatenate one array to the end of this array. More...

Public Member Functions inherited from PContainer
	PContainer (PINDEX initialSize=0)
	Create a new unique container. More...

	PContainer (const PContainer &cont)
	Create a new refernce to container. More...

PContainer &	operator= (const PContainer &cont)
	Assign one container reference to another. More...

virtual	~PContainer ()
	Destroy the container class. More...

virtual PINDEX	GetSize () const
	Get the current size of the container. More...

__inline size_t	size () const

PBoolean	SetMinSize (PINDEX minSize)
	Set the minimum size of container. More...

__inline bool	empty () const

PBoolean	IsUnique () const
	Determine if container is unique reference. More...

Public Member Functions inherited from PObject
unsigned	GetTraceContextIdentifier () const
	Get PTRACE context identifier. More...

void	SetTraceContextIdentifier (unsigned id)

void	GetTraceContextIdentifier (PObject &obj)

void	GetTraceContextIdentifier (PObject *obj)

void	SetTraceContextIdentifier (const PObject &obj)

void	SetTraceContextIdentifier (const PObject *obj)

virtual	~PObject ()

template<class CLS >
CLS *	CloneAs () const
	As for Clone() but converts to specified type. More...

virtual const char *	GetClass (unsigned ancestor=0) const
	Get the current dynamic type of the object instance. More...

PBoolean	IsClass (const char *cls) const

virtual PBoolean	InternalIsDescendant (const char *clsName) const
	Determine if the dynamic type of the current instance is a descendent of the specified class. More...

__inline const PObject *	PTraceObjectInstance () const

virtual Comparison	CompareObjectMemoryDirect (const PObject &obj) const
	Determine the byte wise comparison of two objects. More...

bool	operator== (const PObject &obj) const
	Compare the two objects. More...

bool	operator!= (const PObject &obj) const
	Compare the two objects. More...

bool	operator< (const PObject &obj) const
	Compare the two objects. More...

bool	operator> (const PObject &obj) const
	Compare the two objects. More...

bool	operator<= (const PObject &obj) const
	Compare the two objects. More...

bool	operator>= (const PObject &obj) const
	Compare the two objects. More...

Protected Member Functions
virtual Comparison	InternalCompare (PINDEX offset, char c) const

virtual Comparison	InternalCompare (PINDEX offset, PINDEX length, const char *cstr) const

	PString (int dummy, const PString *str)

virtual void	AssignContents (const PContainer &)
	Copy the container contents. More...

	PString (PContainerReference &reference_, PINDEX len)

Protected Attributes
PINDEX	m_length

Construction
enum	ConversionType { Pascal, Basic, Literal, Signed, Unsigned, Decimal, Exponent, ScaleSI, Printf, NumConversionTypes }

	PString ()
	Construct an empty string. More...

	PString (const PString &str)
	Create a new reference to the specified string. More...

	PString (const PCharArray &buf)
	Create a new reference to the specified buffer. More...

	PString (const PBYTEArray &buf)
	Create a new string based on the BYTE array. More...

	PString (const std::string &str)
	Create a new string from the specified std::string. More...

	PString (const char *cstr)
	Create a string from the C string array. More...

	PString (const char *cstr, PINDEX len)
	Create a string from the UCS-2 string array. More...

	PString (char ch)
	Create a string from the UCS-2 array. More...

	PString (short n)
	Create a string from the integer type. More...

	PString (unsigned short n)
	Create a string from the integer type. More...

	PString (int n)
	Create a string from the integer type. More...

	PString (unsigned int n)
	Create a string from the integer type. More...

	PString (long n)
	Create a string from the integer type. More...

	PString (unsigned long n)
	Create a string from the integer type. More...

	PString (ConversionType type, const char *str,...)

	PString (ConversionType type, unsigned long value, unsigned param=10)

	PString (ConversionType type, signed long value, unsigned param=10)

	PString (ConversionType type, unsigned int value, unsigned param=10)

	PString (ConversionType type, signed int value, unsigned param=10)

	PString (ConversionType type, unsigned short value, unsigned param=10)

	PString (ConversionType type, signed short value, unsigned param=10)

	PString (ConversionType type, unsigned char value, unsigned param=10)

	PString (ConversionType type, signed char value, unsigned param=10)

	PString (ConversionType type, double value, unsigned places)

PString &	operator= (const PString &str)
	Assign the string to the current object. More...

PString &	operator= (const std::string &str)
	Assign the string to the current object. More...

PString &	operator= (const char *cstr)
	Assign the C string to the current object. More...

PString &	operator= (char ch)
	Assign the character to the current object. More...

PString &	operator= (short n)
	Assign a string from the integer type. More...

PString &	operator= (unsigned short n)
	Assign a string from the integer type. More...

PString &	operator= (int n)
	Assign a string from the integer type. More...

PString &	operator= (unsigned int n)
	Assign a string from the integer type. More...

PString &	operator= (long n)
	Assign a string from the integer type. More...

PString &	operator= (unsigned long n)
	Assign a string from the integer type. More...

virtual PString &	MakeEmpty ()
	Make the current string empty. More...

static const PString &	Empty ()
	Return an empty string. More...

Concatenation operators
PString	operator+ (const PString &str) const
	Concatenate two strings to produce a third. More...

PString	operator+ (const char *cstr) const
	Concatenate a C string to a PString to produce a third. More...

PString	operator+ (char ch) const
	Concatenate a single character to a PString to produce a third. More...

PString &	operator+= (const PString &str)
	Concatenate a string to another string, modifiying that string. More...

PString &	operator+= (const char *cstr)
	Concatenate a C string to a PString, modifiying that string. More...

PString &	operator+= (char ch)
	Concatenate a single character to a PString. More...

PString	operator& (const PString &str) const
	Concatenate two strings to produce a third. More...

PString	operator& (const char *cstr) const
	Concatenate a C string to a PString to produce a third. More...

PString	operator& (char ch) const
	Concatenate a single character to a PString to produce a third. More...

PString &	operator&= (const PString &str)
	Concatenate a string to another string, modifiying that string. More...

PString &	operator&= (const char *cstr)
	Concatenate a C string to a PString, modifiying that string. More...

PString &	operator&= (char ch)
	Concatenate a character to a PString, modifiying that string. More...

PString	operator+ (const char *cstr, const PString &str)
	Concatenate a PString to a C string to produce a third. More...

PString	operator+ (char ch, const PString &str)
	Concatenate a PString to a single character to produce a third. More...

PString	operator& (const char *cstr, const PString &str)
	Concatenate a PString to a C string to produce a third. More...

PString	operator& (char ch, const PString &str)
	Concatenate a PString to a single character to produce a third. More...

Comparison operators
bool	operator*= (const PString &str) const
	Compare two strings using case insensitive comparison. More...

bool	operator== (const PString &str) const
	Compare two strings using the `PObject::Compare()` function. More...

bool	operator!= (const PString &str) const
	Compare two strings using the `PObject::Compare()` function. More...

bool	operator< (const PString &str) const
	Compare two strings using the `PObject::Compare()` function. More...

bool	operator> (const PString &str) const
	Compare two strings using the `PObject::Compare()` function. More...

bool	operator<= (const PString &str) const
	Compare two strings using the `PObject::Compare()` function. More...

bool	operator>= (const PString &str) const
	Compare two strings using the `PObject::Compare()` function. More...

bool	operator= (const char cstr) const
	Compare a PString to a C string using a case insensitive compare function. More...

bool	operator== (const char *cstr) const
	Compare a PString to a C string using the `Compare()` function. More...

bool	operator!= (const char *cstr) const
	Compare a PString to a C string using the `PObject::Compare()` function. More...

bool	operator< (const char *cstr) const
	Compare a PString to a C string using the `PObject::Compare()` function. More...

bool	operator> (const char *cstr) const
	Compare a PString to a C string using the `PObject::Compare()` function. More...

bool	operator<= (const char *cstr) const
	Compare a PString to a C string using the `PObject::Compare()` function. More...

bool	operator>= (const char *cstr) const
	Compare a PString to a C string using the `PObject::Compare()` function. More...

Comparison	NumCompare (const PString &str, PINDEX count=P_MAX_INDEX, PINDEX offset=0) const
	Compare a string against a substring of the object. More...

Comparison	NumCompare (const char *cstr, PINDEX count=P_MAX_INDEX, PINDEX offset=0) const
	Compare a string against a substring of the object. More...

bool	operator= (const char cstr, const PString &str)
	Compare a PString to a C string using a case insensitive compare function. More...

bool	operator== (const char *cstr, const PString &str)
	Compare a PString to a C string using the `Compare()` function. More...

bool	operator!= (const char *cstr, const PString &str)
	Compare a PString to a C string using the `PObject::Compare()` function. More...

bool	operator< (const char *cstr, const PString &str)
	Compare a PString to a C string using the `PObject::Compare()` function. More...

bool	operator> (const char *cstr, const PString &str)
	Compare a PString to a C string using the `PObject::Compare()` function. More...

bool	operator<= (const char *cstr, const PString &str)
	Compare a PString to a C string using the `PObject::Compare()` function. More...

bool	operator>= (const char *cstr, const PString &str)
	Compare a PString to a C string using the `PObject::Compare()` function. More...

Conversion functions
PString &	sprintf (const char *cfmt,...)
	Concatenate a formatted output to the string. More...

PString &	vsprintf (const PString &fmt, va_list args)
	Concatenate a formatted output to the string. More...

PString &	vsprintf (const char *cfmt, va_list args)
	Concatenate a formatted output to the string. More...

template<typename T >
__inline T	As (T t=T()) const
	Convert the string to any type that can be converted using a stream. More...

long	AsInteger (unsigned base=10) const
	Convert the string to an integer value using the specified number base. More...

DWORD	AsUnsigned (unsigned base=10) const
	Convert the string to an integer value using the specified number base. More...

PInt64	AsInt64 (unsigned base=10) const
	Convert the string to an integer value using the specified number base. More...

PUInt64	AsUnsigned64 (unsigned base=10) const
	Convert the string to an integer value using the specified number base. More...

double	AsReal () const
	Convert the string to a floating point number. More...

PBYTEArray	ToPascal () const
	Convert a standard null terminated string to a "pascal" style string. More...

PString	ToLiteral () const
	Convert the string to C literal string format. More...

PString	FromLiteral (PINDEX &offset) const
	Parse a C literal string format as for PString::ToLiteral(). More...

	operator const unsigned char * () const
	Get the internal buffer as a pointer to unsigned characters. More...

	operator std::string () const
	Cast the PString to a std::string. More...

char *	GetPointerAndSetLength (PINDEX len)
	Get a pointer to the buffer and set the length of the string. More...

virtual const char *	GetPointer (PINDEX=0) const
	Get a const pointer to the buffer contents This function overrides the ancestor function that returns a char *. More...

PString	psprintf (const char *cfmt,...)
	Produce formatted output as a string. More...

PString	pvsprintf (const char *cfmt, va_list args)
	Produce formatted output as a string. More...

PString	pvsprintf (const PString &fmt, va_list args)
	Produce formatted output as a string. More...

Additional Inherited Members
Static Public Member Functions inherited from PObject
static const char *	Class ()
	Get the name of the class as a C string. More...

static __inline const PObject *	PTraceObjectInstance (const char *)

static __inline const PObject *	PTraceObjectInstance (const PObject *obj)

static Comparison	InternalCompareObjectMemoryDirect (const PObject obj1, const PObject obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...

Friends inherited from PObject

Detailed Description

The character string class.

It supports a wealth of additional functions for string processing and conversion. Operators are provided so that strings can virtually be treated as a basic type.

An important feature of the string class, which is not present in other container classes, is that when the string contents is changed, that is resized or elements set, the string is "dereferenced", and a duplicate made of its contents. That is this instance of the array is disconnected from all other references to the string data, if any, and a new string array contents created. For example consider the following:


          PString s1 = "String"; // New array allocated and set to "String"
          PString s2 = s1;       // s2 has pointer to same array as s1
and reference count is 2 for both
          s1[0] = 's';           // Breaks references into different strings

at the end s1 is "string" and s2 is "String" both with reference count of 1.

The functions that will "break" a reference are SetSize(), SetMinSize(), GetPointer(), SetAt() and operator[].

Note that the array is a '\0' terminated string as in C strings. Thus the memory allocated, and the length of the string may be different values.

Also note that the PString is inherently an 8 bit string. The character set is not defined for most operations and it may be any 8 bit character set. However when conversions are being made to or from 2 byte formats then the PString is assumed to be the UTF-8 format. The 2 byte format is nominally UCS-2 (aka BMP string) and while it is not exactly the same as UNICODE they are compatible enough for them to be treated the same for most real world usage.

Member Typedef Documentation

typedef const char* PString::Initialiser

Member Enumeration Documentation

enum PString::ConversionType

Enumerator
Pascal	Data is a length byte followed by characters.
Basic	Data is two length bytes followed by characters.
Literal	Data is C language style string with \ escape codes.
Signed	Convert a signed integer to a string.
Unsigned	Convert an unsigned integer to a string.
Decimal	Convert a real number to a string in decimal format.
Exponent	Convert a real number to a string in exponent format.
ScaleSI	Output scaled to SI units, e.g. k, M, G.
Printf	Formatted output, sprintf() style function.
NumConversionTypes

Constructor & Destructor Documentation

PString::PString ( )

Construct an empty string.

This will have one character in it which is the '\0' character.

Referenced by PHTML::operator=().

PString::PString ( const PString & str )

Create a new reference to the specified string.

The string memory is not copied, only the pointer to the data.

Parameters

str	String to create new reference to.

PString::PString ( const PCharArray & buf )

Create a new reference to the specified buffer.

The string memory is not copied, only the pointer to the data.

Parameters

buf	Buffer to create new reference to.

PString::PString ( const PBYTEArray & buf )

Create a new string based on the BYTE array.

Note it is up to the caller to assure the semantics of a binary object such as PBYTEArray are suitable to be used as a string.

Parameters

buf	Buffer to create new reference to.

PString::PString ( const std::string & str )

Create a new string from the specified std::string.

PString::PString ( const char * cstr )

Create a string from the C string array.

This is most commonly used with a literal string, eg "hello". A new memory block is allocated of a size sufficient to take the length of the string and its terminating '\0' character.

If UCS-2 is used then each char from the char pointer is mapped to a single UCS-2 character.

Parameters

cstr	Standard '\0' terminated C string.

PString::PString	(	const char *	cstr,
		PINDEX	len
	)

Create a string from the UCS-2 string array.

A new memory block is allocated of a size sufficient to take the length of the string and its terminating '\0' character.Create a string from the array. A new memory block is allocated of a size equal to len plus one which is sufficient to take the string and a terminating '\0' character.

If UCS-2 is used then each char from the char pointer is mapped to a single UCS-2 character.

Note that this function will allow a string with embedded '\0' characters to be created, but most of the functions here will be unable to access characters beyond the first '\0'. Furthermore, if the MakeMinimumSize() function is called, all data beyond that first '\0' character will be lost.

Parameters

cstr	Pointer to a string of characters.
len	Length of the string in bytes.

PString::PString ( char ch )

Create a string from the UCS-2 array.

A new memory block is allocated of a size equal to len plus one which is sufficient to take the string and a terminating '\0' character.

Note that this function will allow a string with embedded '\0' characters to be created, but most of the functions here will be unable to access characters beyond the first '\0'. Furthermore, if the MakeMinimumSize() function is called, all data beyond that first '\0' character will be lost.Create a string from the single character. This is most commonly used as a type conversion constructor when a literal character, eg 'A' is used in a string expression. A new memory block is allocated of two characters to take the char and its terminating '\0' character.

If UCS-2 is used then the char is mapped to a single UCS-2 character.

Parameters

ch	Single character to initialise string.

PString::PString ( short n )

Create a string from the integer type.

This will create a simple base 10, shortest length conversion of the integer (with sign character if appropriate) into the string.

Parameters

n	Integer to convert

PString::PString ( unsigned short n )

Create a string from the integer type.

This will create a simple base 10, shortest length conversion of the integer (with sign character if appropriate) into the string.

Parameters

n	Integer to convert

PString::PString ( int n )

Create a string from the integer type.

This will create a simple base 10, shortest length conversion of the integer (with sign character if appropriate) into the string.

Parameters

n	Integer to convert

PString::PString ( unsigned int n )

Create a string from the integer type.

This will create a simple base 10, shortest length conversion of the integer (with sign character if appropriate) into the string.

Parameters

n	Integer to convert

PString::PString ( long n )

Create a string from the integer type.

This will create a simple base 10, shortest length conversion of the integer (with sign character if appropriate) into the string.

Parameters

n	Integer to convert

PString::PString ( unsigned long n )

Create a string from the integer type.

This will create a simple base 10, shortest length conversion of the integer (with sign character if appropriate) into the string.

Parameters

n	Integer to convert

PString::PString	(	ConversionType	type,
		const char *	str,
			...
	)

Parameters

type	Type of data source for conversion.
str	String to convert.

PString::PString	(	ConversionType	type,
		unsigned long	value,
		unsigned	param = `10`
	)

PString::PString	(	ConversionType	type,
		signed long	value,
		unsigned	param = `10`
	)

PString::PString	(	ConversionType	type,
		unsigned int	value,
		unsigned	param = `10`
	)

PString::PString	(	ConversionType	type,
		signed int	value,
		unsigned	param = `10`
	)

PString::PString	(	ConversionType	type,
		unsigned short	value,
		unsigned	param = `10`
	)

PString::PString	(	ConversionType	type,
		signed short	value,
		unsigned	param = `10`
	)

PString::PString	(	ConversionType	type,
		unsigned char	value,
		unsigned	param = `10`
	)

PString::PString	(	ConversionType	type,
		signed char	value,
		unsigned	param = `10`
	)

PString::PString	(	ConversionType	type,
		double	value,
		unsigned	places
	)

Parameters

type	Type of data source for conversion.
value	Floating point value to convert.
places	Number of decimals in real number output.

PString::PString	(	int	dummy,
		const PString *	str
	)

protected

PString::PString	(	PContainerReference &	reference_,
		PINDEX	len
	)

inlineprotected

Member Function Documentation

template<typename T >

__inline T PString::As ( T t = T() ) const

Convert the string to any type that can be converted using a stream.

Returns: value for the string.

PInt64 PString::AsInt64 ( unsigned base = 10 ) const

Convert the string to an integer value using the specified number base.

All characters up to the first illegal character for the number base are converted. Case is not significant for bases greater than 10.

The number base may only be from 2 to 36 and the function will assert if it is not in this range.

This function uses the standard C library strtoq() or strtoul() function.

Returns: integer value for the string.

Parameters

base	Number base to convert the string in.

long PString::AsInteger ( unsigned base = 10 ) const

Convert the string to an integer value using the specified number base.

All characters up to the first illegal character for the number base are converted. Case is not significant for bases greater than 10.

The number base may only be from 2 to 36 and the function will assert if it is not in this range.

This function uses the standard C library strtol() function.

Returns: integer value for the string.

Parameters

base	Number base to convert the string in.

double PString::AsReal ( ) const

Convert the string to a floating point number.

This number may be in decimal or exponential form. All characters up to the first illegal character for a floting point number are converted.

This function uses the standard C library strtod() function.

Returns: floating point value for the string.

virtual void PString::AssignContents ( const PContainer & c )

protectedvirtual

Copy the container contents.

This copies the contents from one reference to another.

No duplication of contents occurs, for instance if the container is an array, the pointer to the array memory is copied, not the array memory block itself.

This function will get called by the base assignment operator.

Reimplemented from PContainer.

Reimplemented in PStringStream, PHTML, and PFilePath.

DWORD PString::AsUnsigned ( unsigned base = 10 ) const

Convert the string to an integer value using the specified number base.

All characters up to the first illegal character for the number base are converted. Case is not significant for bases greater than 10.

The number base may only be from 2 to 36 and the function will assert if it is not in this range.

This function uses the standard C library strtoul() function.

Returns: integer value for the string.

Parameters

base	Number base to convert the string in.

PUInt64 PString::AsUnsigned64 ( unsigned base = 10 ) const

Convert the string to an integer value using the specified number base.

All characters up to the first illegal character for the number base are converted. Case is not significant for bases greater than 10.

The number base may only be from 2 to 36 and the function will assert if it is not in this range.

This function uses the standard C library strtouq() or strtoul() function.

Returns: integer value for the string.

Parameters

base	Number base to convert the string in.

virtual PObject* PString::Clone ( ) const

virtual

Make a complete duplicate of the string.

Note that the data in the array of characters is duplicated as well and the new object is a unique reference to that data.

Reimplemented from PCharArray.

Reimplemented in PCaselessString.

virtual Comparison PString::Compare ( const PObject & obj ) const

virtual

Get the relative rank of the two strings.

The system standard function, eg strcmp(), is used.

Returns: comparison of the two objects, EqualTo for same, LessThan for obj logically less than the object and GreaterThan for obj logically greater than the object.

Parameters

obj	Other PString to compare against.

Reimplemented from PAbstractArray.

PString& PString::Delete	(	PINDEX	start,
		PINDEX	len
	)

Remove the substring from the string.

Note that this function will break the current instance from multiple references to the string. A new string buffer is allocated and the data from the old string buffer copied to it.

Parameters

start	Position in string to remove.
len	Number of characters to delete.

static const PString& PString::Empty ( )

static

Return an empty string.

Referenced by PHTTPClientAuthentication::GetAuthRealm(), and XMPP::BareJID::GetResource().

PINDEX PString::Find	(	char	ch,
		PINDEX	offset = `0`
	)		const

Locate the position within the string of the character.

Parameters

ch	Character to search for in string.
offset	Offset into string to begin search.

PINDEX PString::Find	(	const PString &	str,
		PINDEX	offset = `0`
	)		const

Locate the position within the string of the substring.

Parameters

str	String to search for in string.
offset	Offset into string to begin search.

PINDEX PString::Find	(	const char *	cstr,
		PINDEX	offset = `0`
	)		const

Parameters

cstr	C string to search for in string.
offset	Offset into string to begin search.

PINDEX PString::FindLast	(	char	ch,
		PINDEX	offset = `P_MAX_INDEX`
	)		const

Locate the position of the last matching character.

Parameters

ch	Character to search for in string.
offset	Offset into string to begin search.

PINDEX PString::FindLast	(	const PString &	str,
		PINDEX	offset = `P_MAX_INDEX`
	)		const

Locate the position of the last matching substring.

Parameters

str	String to search for in string.
offset	Offset into string to begin search.

PINDEX PString::FindLast	(	const char *	cstr,
		PINDEX	offset = `P_MAX_INDEX`
	)		const

Locate the position of the last matching substring.

Locate the position within the string of the last matching character or substring. The search will begin at the character offset provided, moving backward through the string.

If offset is beyond the length of the string, then the search begins at the end of the string. If offset is zero then the function always returns P_MAX_INDEX.

The matching will be for identical character or string. If a search ignoring case is required then the string should be converted to a PCaselessString before the search is made.

Returns: position of character or substring in the string, or P_MAX_INDEX if the character or substring is not in the string.

Parameters

cstr	C string to search for in string.
offset	Offset into string to begin search.

PINDEX PString::FindOneOf	(	const PString &	set,
		PINDEX	offset = `0`
	)		const

Locate the position of one of the characters in the set.

Parameters

set	String of characters to search for in string.
offset	Offset into string to begin search.

PINDEX PString::FindOneOf	(	const char *	cset,
		PINDEX	offset = `0`
	)		const

Locate the position of one of the characters in the set.

The search will begin at the character offset provided.

If offset is beyond the length of the string, then the function will always return P_MAX_INDEX.

The matching will be for identical character or string. If a search ignoring case is required then the string should be converted to a PCaselessString before the search is made.

Returns: position of character in the string, or P_MAX_INDEX if no characters from the set are in the string.

Parameters

cset	C string of characters to search for in string.
offset	Offset into string to begin search.

PINDEX PString::FindRegEx	(	const PRegularExpression &	regex,
		PINDEX	offset = `0`
	)		const

Locate the position within the string of one of the regular expression.

The search will begin at the character offset provided.

If offset is beyond the length of the string, then the function will always return P_MAX_INDEX.

Returns: position of regular expression in the string, or P_MAX_INDEX if no characters from the set are in the string.

Parameters

regex	regular expression to find
offset	Offset into string to begin search.

PBoolean PString::FindRegEx	(	const PRegularExpression &	regex,
		PINDEX &	pos,
		PINDEX &	len,
		PINDEX	offset = `0`,
		PINDEX	maxPos = `P_MAX_INDEX`
	)		const

Locate the position within the string of one of the regular expression.

The search will begin at the character offset provided.

If offset is beyond the length of the string, then the function will always return P_MAX_INDEX.

Returns: position of regular expression in the string, or P_MAX_INDEX if no characters from the set are in the string.

Parameters

regex	regular expression to find
pos	Position of matched expression
len	Length of matched expression
offset	Offset into string to begin search.
maxPos	Maximum offset into string

PINDEX PString::FindSpan	(	const PString &	set,
		PINDEX	offset = `0`
	)		const

Locate the position of character not in the set.

Parameters

set	String of characters to search for in string.
offset	Offset into string to begin search.

PINDEX PString::FindSpan	(	const char *	cset,
		PINDEX	offset = `0`
	)		const

Locate the position of character not in the set.

The search will begin at the character offset provided.

If offset is beyond the length of the string, or every character in the string is a member of the set, then the function will always return P_MAX_INDEX.

The matching will be for identical character or string. If a search ignoring case is required then the string should be converted to a PCaselessString before the search is made.

Returns: position of character not in the set, or P_MAX_INDEX if all characters from the string are in the set.

Parameters

cset	C string of characters to search for in string.
offset	Offset into string to begin search.

PString PString::FromLiteral ( PINDEX & offset ) const

Parse a C literal string format as for PString::ToLiteral().

The offset is the initial position is str and will be updated to the final position in the string for the literal. If the string starts with an opening quote, this will be the one past final enclosing quote. If no opening quote is present this will be PString::GetLength().

virtual PINDEX PString::GetLength ( ) const

inlinevirtual

Determine the length of the null terminated string.

This is different from PContainer::GetSize() which returns the amount of memory allocated to the string. This is often, though no necessarily, one larger than the length of the string.

Returns: length of the null terminated string.

Reimplemented in PStringStream.

References m_length.

Referenced by PHMACTemplate< hash_class >::PHMACTemplate(), PSHA1Context::Process(), and PSHA1Context::Update().

virtual const char* PString::GetPointer ( PINDEX = 0 ) const

inlinevirtual

Get a const pointer to the buffer contents This function overrides the ancestor function that returns a char *.

char* PString::GetPointerAndSetLength ( PINDEX len )

Get a pointer to the buffer and set the length of the string.

Note the caller may require the actual length to be less than the len parameter, in which case the MakeMinimumSize() function should be called immediately afterward.

Example 1: PString str; memcpy(str.GetPointerAndSetLength(len), someData, len);

Example 2: PString str; str.SetMinSize(1000); str.MakeMinimumSize(SomeFunction(str.GetPointerAndSetLength(0), str.GetSize()));

Note the old GetPointer() is deliberately made private to assure the new semantics are used.

Parameters

len	New Length

virtual PINDEX PString::HashFunction ( ) const

virtual

Calculate a hash value for use in sets and dictionaries.

The hash function for strings will produce a value based on the sum of the first three characters of the string. This is a fairly basic function and make no assumptions about the string contents. A user may descend from PString and override the hash function if they can take advantage of the types of strings being used, eg if all strings start with the letter 'A' followed by 'B or 'C' then the current hash function will not perform very well.

Returns: hash value for string.

Reimplemented from PObject.

virtual Comparison PString::InternalCompare	(	PINDEX	offset,
		char	c
	)		const

protectedvirtual

Reimplemented in PCaselessString.

virtual Comparison PString::InternalCompare	(	PINDEX	offset,
		PINDEX	length,
		const char *	cstr
	)		const

protectedvirtual

Reimplemented in PCaselessString.

virtual PBoolean PString::IsEmpty ( ) const

virtual

Determine if the string is empty.

This is semantically slightly different from the usual PContainer::IsEmpty() function. It does not test for PContainer::GetSize() equal to zero, it tests for GetLength() equal to zero.

Returns: true if no non-null characters in string.

Reimplemented from PContainer.

Referenced by PSystemLogToFile::RotateInfo::CanRotate(), PPluginManager::CreatePluginsDeviceByName(), PArgList::GetOptionAs(), XMPP::JID::IsBare(), PURL::IsEmpty(), and PDNS::Lookup().

PString PString::Left ( PINDEX len ) const

Extract a portion of the string into a new string.

The original string is not changed and a new unique reference to a string is returned.

A substring from the beginning of the string for the number of characters specified is extracted.

If len is greater than the length of the string then all characters to the end of the string are returned.

If len is zero then an empty string is returned.

Returns: substring of the source string.

Parameters

len	Number of characters to extract.

PString PString::LeftTrim ( ) const

Create a string consisting of all characters from the source string except all spaces at the beginning of the string.

The original string is not changed and a new unique reference to a string is returned.

Returns: string with leading spaces removed.

PStringArray PString::Lines ( ) const

Split the string into individual lines.

The line delimiters may be a carriage return ('\r'), a line feed ('\n') or a carriage return and line feed pair ("\\r\\n"). A line feed and carriage return pair ("\\n\\r") would yield a blank line. between the characters.

The Tokenise() function should not be used to split a string into lines as a #"\\r\\n"# pair consitutes a single line ending. The Tokenise() function would produce a blank line in between them.

Returns: string array with a substring for each line in the string.

virtual PString& PString::MakeEmpty ( )

virtual

Make the current string empty.

Reimplemented in PStringStream.

Referenced by PSASLString::operator=().

bool PString::MakeMinimumSize ( PINDEX newLength = 0 )

Set the actual memory block array size to the minimum required to hold the current string contents.

Note that this function will break the current instance from multiple references to the string. A new string buffer is allocated and the data from the old string buffer copied to it.

Also, this will ignore the m_length variable and redetermine the length of teh string using strlen(), resetting the m_length.

Returns: true if new memory block successfully re-allocated.

Parameters

newLength New length for string, if zero strlen is used

virtual PBoolean PString::MakeUnique ( )

virtual

Make this instance to be the one and only reference to the container contents.

This implicitly does a clone of the contents of the container to make a unique reference. If the instance was already unique then the function does nothing.

Returns: true if the instance was already unique.

Reimplemented from PContainer.

PBoolean PString::MatchesRegEx ( const PRegularExpression & regex ) const

Return true if the entire string matches the regular expression.

Parameters

regex regular expression to match

PString PString::Mid	(	PINDEX	start,
		PINDEX	len = `P_MAX_INDEX`
	)		const

Extract a portion of the string into a new string.

The original string is not changed and a new unique reference to a string is returned.

A substring from the start position for the number of characters specified is extracted.

If len is greater than the length of the string from the start position then all characters to the end of the string are returned.

If start is greater than the length of the string or len is zero then an empty string is returned.

Returns: substring of the source string.

Parameters

start	Starting position of the substring.
len	Number of characters to extract.

Comparison PString::NumCompare	(	const PString &	str,
		PINDEX	count = `P_MAX_INDEX`,
		PINDEX	offset = `0`
	)		const

Compare a string against a substring of the object.

This will compare at most count characters of the string, starting at the specified offset, against that many characters of the str parameter. If count greater than the length of the str parameter then the actual length of str is used. If count and the length of str are greater than the length of the string remaining from the offset then false is returned.

Returns: true if str is a substring of .

Parameters

str	PString object to compare against.
count	Number of chacracters in str to compare
offset	Offset into string to compare

Comparison PString::NumCompare	(	const char *	cstr,
		PINDEX	count = `P_MAX_INDEX`,
		PINDEX	offset = `0`
	)		const

Compare a string against a substring of the object.

This will compare at most count characters of the string, starting at the specified offset, against that many characters of the str parameter. If count greater than the length of the str parameter then the actual length of str is used. If count and the length of str are greater than the length of the string remaining from the offset then false is returned.

Returns: true if str is a substring of .

Parameters

cstr	C string object to compare against.
count	Number of chacracters in str to compare
offset	Offset into string to compare

PString::operator const unsigned char * ( ) const

Get the internal buffer as a pointer to unsigned characters.

The standard "operator const char *" function is provided by the PCharArray ancestor class.

Returns: pointer to character buffer.

PString::operator std::string ( ) const

inline

Cast the PString to a std::string.

References PAbstractArray::theArray.

bool PString::operator! ( ) const

Determine if the string is NOT empty.

This is semantically identical to executing !IsEmpty() on the string.

Returns: true if non-null characters in string.

bool PString::operator!= ( const PString & str ) const

Compare two strings using the PObject::Compare() function.

This is identical to the PObject class function but is necessary due to other overloaded versions.

Returns: true if not equal.

Parameters

str	PString object to compare against.

bool PString::operator!= ( const char * cstr ) const

Compare a PString to a C string using the PObject::Compare() function.

The cstr parameter is typically a literal string, eg:


          if (myStr != "fred")

Returns: true if not equal.

Parameters

cstr	C string to compare against.

PString PString::operator& ( const PString & str ) const

Concatenate two strings to produce a third.

The original strings are not modified, an entirely new unique reference to a string is created.

Returns: new string with concatenation of the object and parameter.

Parameters

str	String to concatenate.

PString PString::operator& ( const char * cstr ) const

Concatenate a C string to a PString to produce a third.

The original string is not modified, an entirely new unique reference to a string is created. The cstr parameter is typically a literal string, eg:


          myStr = aStr & "fred";

   This function differes from operator+ in that it assures there is at
   least one space between the strings. Exactly one space is added if
   there is not a space at the end of the first or beggining of the last
   string.

Returns: new string with concatenation of the object and parameter.

Parameters

cstr	C string to concatenate.

PString PString::operator& ( char ch ) const

Concatenate a single character to a PString to produce a third.

The original string is not modified, an entirely new unique reference to a string is created. The ch parameter is typically a literal, eg:


          myStr = aStr & '!';

   This function differes from operator+ in that it assures there is at
   least one space between the strings. Exactly one space is added if
   there is not a space at the end of the first or beggining of the last
   string.

Returns: new string with concatenation of the object and parameter.

Parameters

ch	Character to concatenate.

PString& PString::operator&= ( const PString & str )

Concatenate a string to another string, modifiying that string.

Returns: reference to string that was concatenated to.

Parameters

str	String to concatenate.

PString& PString::operator&= ( const char * cstr )

Concatenate a C string to a PString, modifiying that string.

The cstr parameter is typically a literal string, eg:


          myStr &= "fred";

   This function differes from operator+ in that it assures there is at
   least one space between the strings. Exactly one space is added if
   there is not a space at the end of the first or beggining of the last
   string.

Returns: reference to string that was concatenated to.

Parameters

cstr	C string to concatenate.

PString& PString::operator&= ( char ch )

Concatenate a character to a PString, modifiying that string.

The ch parameter is typically a literal string, eg:


          myStr &= '!';

   This function differes from operator+ in that it assures there is at
   least one space between the strings. Exactly one space is added if
   there is not a space at the end of the first or beggining of the last
   string.

Returns: reference to string that was concatenated to.

Parameters

ch	Character to concatenate.

PString PString::operator()	(	PINDEX	start,
		PINDEX	end
	)		const

Extract a portion of the string into a new string.

The original string is not changed and a new unique reference to a string is returned.

The substring is returned inclusive of the characters at the start and end positions.

If the end position is greater than the length of the string then all characters from the start up to the end of the string are returned.

If start is greater than the length of the string or end is before start then an empty string is returned.

Returns: substring of the source string.

Parameters

start	Starting position of the substring.
end	Ending position of the substring.

bool PString::operator*= ( const PString & str ) const

Compare two strings using case insensitive comparison.

Returns: true if equal.

Parameters

str	PString object to compare against.

bool PString::operator*= ( const char * cstr ) const

Compare a PString to a C string using a case insensitive compare function.

The cstr parameter is typically a literal string, eg:


          if (myStr *= "fred")

Returns: true if equal.

Parameters

cstr	C string to compare against.

PString PString::operator+ ( const PString & str ) const

Concatenate two strings to produce a third.

The original strings are not modified, an entirely new unique reference to a string is created.

Returns: new string with concatenation of the object and parameter.

Parameters

str	String to concatenate.

PString PString::operator+ ( const char * cstr ) const

Concatenate a C string to a PString to produce a third.

The original string is not modified, an entirely new unique reference to a string is created. The cstr parameter is typically a literal string, eg:


          myStr = aStr + "fred";

Returns: new string with concatenation of the object and parameter.

Parameters

cstr	C string to concatenate.

PString PString::operator+ ( char ch ) const

Concatenate a single character to a PString to produce a third.

The original string is not modified, an entirely new unique reference to a string is created. The ch parameter is typically a literal, eg:


          myStr = aStr + '!';

Returns: new string with concatenation of the object and parameter.

Parameters

ch	Character to concatenate.

PString& PString::operator+= ( const PString & str )

Concatenate a string to another string, modifiying that string.

Returns: reference to string that was concatenated to.

Parameters

str	String to concatenate.

PString& PString::operator+= ( const char * cstr )

Concatenate a C string to a PString, modifiying that string.

The cstr parameter is typically a literal string, eg:


          myStr += "fred";

Returns: reference to string that was concatenated to.

Parameters

cstr	C string to concatenate.

PString& PString::operator+= ( char ch )

Concatenate a single character to a PString.

The ch parameter is typically a literal, eg:


          myStr += '!';

Returns: new string with concatenation of the object and parameter.

Parameters

ch	Character to concatenate.

bool PString::operator< ( const PString & str ) const

Compare two strings using the PObject::Compare() function.

This is identical to the PObject class function but is necessary due to other overloaded versions.

Returns: true if less than.

Parameters

str	PString object to compare against.

bool PString::operator< ( const char * cstr ) const

Compare a PString to a C string using the PObject::Compare() function.

The cstr parameter is typically a literal string, eg:


          if (myStr < "fred")

Returns: true if less than.

Parameters

cstr	C string to compare against.

bool PString::operator<= ( const PString & str ) const

Compare two strings using the PObject::Compare() function.

This is identical to the PObject class function but is necessary due to other overloaded versions.

Returns: true if less than or equal.

Parameters

str	PString object to compare against.

bool PString::operator<= ( const char * cstr ) const

Compare a PString to a C string using the PObject::Compare() function.

The cstr parameter is typically a literal string, eg:


          if (myStr <= "fred")

Returns: true if less than or equal.

Parameters

cstr	C string to compare against.

PString& PString::operator= ( const PString & str )

Assign the string to the current object.

The current instance then becomes another reference to the same string in the str parameter.

Returns: reference to the current PString object.

Parameters

str	New string to assign.

Referenced by PSASLString::operator+=(), and PSASLString::operator=().

PString& PString::operator= ( const std::string & str )

inline

Assign the string to the current object.

The current instance then becomes another reference to the same string in the str parameter.

Returns: reference to the current PString object.

Parameters

str	New string to assign.

References operator=().

Referenced by operator=().

PString& PString::operator= ( const char * cstr )

Assign the C string to the current object.

The current instance then becomes a unique reference to a copy of the cstr parameter. The cstr parameter is typically a literal string, eg:


          myStr = "fred";

Returns: reference to the current PString object.

Parameters

cstr	C string to assign.

PString& PString::operator= ( char ch )

Assign the character to the current object.

The current instance then becomes a unique reference to a copy of the character parameter. eg:


          myStr = 'A';

Returns: reference to the current PString object.

Parameters

ch	Character to assign.

PString& PString::operator= ( short n )

Assign a string from the integer type.

This will create a simple base 10, shortest length conversion of the integer (with sign character if appropriate) into the string.

Parameters

n	Integer to convert

PString& PString::operator= ( unsigned short n )

Assign a string from the integer type.

This will create a simple base 10, shortest length conversion of the integer (with sign character if appropriate) into the string.

Parameters

n	Integer to convert

PString& PString::operator= ( int n )

Assign a string from the integer type.

This will create a simple base 10, shortest length conversion of the integer (with sign character if appropriate) into the string.

Parameters

n	Integer to convert

PString& PString::operator= ( unsigned int n )

Assign a string from the integer type.

This will create a simple base 10, shortest length conversion of the integer (with sign character if appropriate) into the string.

Parameters

n	Integer to convert

PString& PString::operator= ( long n )

Assign a string from the integer type.

This will create a simple base 10, shortest length conversion of the integer (with sign character if appropriate) into the string.

Parameters

n	Integer to convert

PString& PString::operator= ( unsigned long n )

Assign a string from the integer type.

This will create a simple base 10, shortest length conversion of the integer (with sign character if appropriate) into the string.

Parameters

n	Integer to convert

bool PString::operator== ( const PString & str ) const

Compare two strings using the PObject::Compare() function.

This is identical to the PObject class function but is necessary due to other overloaded versions.

Returns: true if equal.

Parameters

str	PString object to compare against.

bool PString::operator== ( const char * cstr ) const

Compare a PString to a C string using the Compare() function.

The cstr parameter is typically a literal string, eg:


          if (myStr == "fred")

Returns: true if equal.

Parameters

cstr	C string to compare against.

bool PString::operator> ( const PString & str ) const

Compare two strings using the PObject::Compare() function.

This is identical to the PObject class function but is necessary due to other overloaded versions.

Returns: true if greater than.

Parameters

str	PString object to compare against.

bool PString::operator> ( const char * cstr ) const

Compare a PString to a C string using the PObject::Compare() function.

The cstr parameter is typically a literal string, eg:


          if (myStr > "fred")

Returns: true if greater than.

Parameters

cstr	C string to compare against.

bool PString::operator>= ( const PString & str ) const

Compare two strings using the PObject::Compare() function.

This is identical to the PObject class function but is necessary due to other overloaded versions.

Returns: true if greater than or equal.

Parameters

str	PString object to compare against.

bool PString::operator>= ( const char * cstr ) const

Compare a PString to a C string using the PObject::Compare() function.

The cstr parameter is typically a literal string, eg:


          if (myStr >= "fred")

Returns: true if greater than or equal.

Parameters

cstr	C string to compare against.

virtual void PString::PrintOn ( ostream & strm ) const

virtual

Output the string to the specified stream.

Parameters

strm	I/O stream to output to.

virtual void PString::ReadFrom ( istream & strm )

virtual

Input the string from the specified stream.

This will read all characters until a end of line is reached. The end of line itself is not placed in the string, however it is removed from the stream.

Parameters

strm	I/O stream to input from.

PString& PString::Replace	(	const PString &	target,
		const PString &	subs,
		PBoolean	all = `false`,
		PINDEX	offset = `0`
	)

Locate the substring within the string and replace it with the specifed substring.

The search will begin at the character offset provided.

If offset is beyond the length of the string, then the function will do nothing.

The matching will be for identical character or string. If a search ignoring case is required then the string should be converted to a PCaselessString before the search is made.

Parameters

target	Text to be removed.
subs	String to be inserted into the gaps created
all	Replace all occurrences of target text.
offset	Offset into string to begin search.

PString PString::Right ( PINDEX len ) const

Extract a portion of the string into a new string.

The original string is not changed and a new unique reference to a string is returned.

A substring from the end of the string for the number of characters specified is extracted.

If len is greater than the length of the string then all characters to the beginning of the string are returned.

If len is zero then an empty string is returned.

Returns: substring of the source string.

Parameters

len	Number of characters to extract.

PString PString::RightTrim ( ) const

Create a string consisting of all characters from the source string except all spaces at the end of the string.

The original string is not changed and a new unique reference to a string is returned.

Returns: string with trailing spaces removed.

virtual PBoolean PString::SetSize ( PINDEX newSize )

virtual

Set the size of the string.

A new string may be allocated to accomodate the new number of characters. If the string increases in size then the new characters are initialised to zero. If the string is made smaller then the data beyond the new size is lost.

Note that this function will break the current instance from multiple references to an array. A new array is allocated and the data from the old array copied to it.

Returns: true if the memory for the array was allocated successfully.

Parameters

newSize New size of the array in elements.

Reimplemented from PAbstractArray.

PString& PString::Splice	(	const PString &	str,
		PINDEX	pos,
		PINDEX	len = `0`
	)

Splice the string into the current string at the specified position.

The specified number of bytes are removed from the string.

Note that this function will break the current instance from multiple references to the string. A new string buffer is allocated and the data from the old string buffer copied to it.

Parameters

str	Substring to insert.
pos	Position in string to insert the substring.
len	Length of section to remove.

PString& PString::Splice	(	const char *	cstr,
		PINDEX	pos,
		PINDEX	len = `0`
	)

Splice the string into the current string at the specified position.

The specified number of bytes are removed from the string.

Note that this function will break the current instance from multiple references to the string. A new string buffer is allocated and the data from the old string buffer copied to it.

Parameters

cstr	Substring to insert.
pos	Position in string to insert the substring.
len	Length of section to remove.

bool PString::Split	(	char	delimiter,
		PString &	before,
		PString &	after,
		bool	trim = `true`
	)		const

Split the string into two substrings around delimiter.

Returns: false if the delimiter not present.

Parameters

delimiter	Delimiter around which tom plit the substrings
before	Substring before delimiter
after	Substring after delimiter
trim	Substrings to be trimmed of whitespace

PString& PString::sprintf	(	const char *	cfmt,
			...
	)

Concatenate a formatted output to the string.

This is identical to the standard C library sprintf() function, but appends its output to the string.

This function makes the assumption that there is less the 1000 characters of formatted output. The function will assert if this occurs.

Note that this function will break the current instance from multiple references to the string. A new string buffer is allocated and the data from the old string buffer copied to it.

Returns: reference to the current string object.

Parameters

cfmt	C string for output format.

PStringArray PString::Tokenise	(	const PString &	separators,
		PBoolean	onePerSeparator = `true`
	)		const

Split the string into an array of substrings.

Parameters

separators	A string for the set of separator characters that delimit tokens.
onePerSeparator	Flag for if there are empty tokens between consecutive separators.

PStringArray PString::Tokenise	(	const char *	cseparators,
		PBoolean	onePerSeparator = `true`
	)		const

Split the string into an array of substrings.

Divide the string into an array of substrings delimited by characters from the specified set.

There are two options for the tokenisation, the first is where the onePerSeparator is true. This form will produce a token for each delimiter found in the set. Thus the string ",two,three,,five" would be split into 5 substrings; "", "two", "three", "" and "five".

The second form where onePerSeparator is false is used where consecutive delimiters do not constitute a empty token. In this case the string " a list of words " would be split into 5 substrings; "a", "list", "of", "words" and "".

There is an important distinction when there are delimiters at the beginning or end of the source string. In the first case there will be empty strings at the end of the array. In the second case delimeters at the beginning of the source string are ignored and if there are one or more trailing delimeters, they will yeild a single empty string at the end of the array.

Returns: an array of substring for each token in the string.

Parameters

cseparators	A C string for the set of separator characters that delimit tokens.
onePerSeparator	Flag for if there are empty tokens between consecutive separators.

PString PString::ToLiteral ( ) const

Convert the string to C literal string format.

This will convert non printable characters to the \nnn form or for standard control characters such as line feed, to \n form. Any '"' characters are also escaped with a \ character and the entire string is enclosed in '"' characters.

Returns: string converted to a C language literal form.

PString PString::ToLower ( ) const

Create a string consisting of all characters from the source string with all upper case letters converted to lower case.

The original string is not changed and a new unique reference to a string is returned.

Returns: string with upper case converted to lower case.

PBYTEArray PString::ToPascal ( ) const

Convert a standard null terminated string to a "pascal" style string.

This consists of a songle byte for the length of the string and then the string characters following it.

This function will assert if the string is greater than 255 characters in length.

Returns: byte array containing the "pascal" style string.

PString PString::ToUpper ( ) const

Create a string consisting of all characters from the source string with all lower case letters converted to upper case.

The original string is not changed and a new unique reference to a string is returned.

Returns: string with lower case converted to upper case.

PString PString::Trim ( ) const

Create a string consisting of all characters from the source string except all spaces at the beginning and end of the string.

The original string is not changed and a new unique reference to a string is returned.

Returns: string with leading and trailing spaces removed.

PString& PString::vsprintf	(	const PString &	fmt,
		va_list	args
	)

Concatenate a formatted output to the string.

Parameters

fmt	String for output format.
args	Extra parameters for `sprintf()` call.

PString& PString::vsprintf	(	const char *	cfmt,
		va_list	args
	)

Concatenate a formatted output to the string.

This is identical to the standard C library vsprintf() function, but appends its output to the string.

This function makes the assumption that there is less the 1000 characters of formatted output. The function will assert if this occurs.

Note that this function will break the current instance from multiple references to the string. A new string buffer is allocated and the data from the old string buffer copied to it.

Returns: reference to the current string object.

Parameters

cfmt	C string for output format.
args	Extra parameters for `sprintf()` call.

Friends And Related Function Documentation

bool operator!=	(	const char *	cstr,
		const PString &	str
	)

friend

Compare a PString to a C string using the PObject::Compare() function.

The cstr parameter is typically a literal string, eg:


          if ("fred" != myStr)

Returns: true if not equal.

Parameters

cstr	C string to compare against.
str	String to compare against

PString operator&	(	const char *	cstr,
		const PString &	str
	)

friend

Concatenate a PString to a C string to produce a third.

The original string is not modified, an entirely new unique reference to a string is created. The cstr parameter is typically a literal string, eg:


          myStr = "fred" & aStr;

   This function differes from operator+ in that it assures there is at
   least one space between the strings. Exactly one space is added if
   there is not a space at the end of the first or beggining of the last
   string.

Returns: new string with concatenation of the object and parameter.

Parameters

cstr	C string to be concatenated to.
str	String to concatenate.

PString operator&	(	char	ch,
		const PString &	str
	)

friend

Concatenate a PString to a single character to produce a third.

The original string is not modified, an entirely new unique reference to a string is created. The c parameter is typically a literal, eg:


          myStr = '!' & aStr;

   This function differs from <code>operator+</code> in that it assures there is at
   least one space between the strings. Exactly one space is added if
   there is not a space at the end of the first or beggining of the last
   string.

Returns: new string with concatenation of the object and parameter.

Parameters

ch	Character to be concatenated to.
str	String to concatenate.

bool operator*=	(	const char *	cstr,
		const PString &	str
	)

friend

Compare a PString to a C string using a case insensitive compare function.

The cstr parameter is typically a literal string, eg:


          if ("fred" *= myStr)

Returns: true if equal.

Parameters

cstr	C string to compare against.
str	String to compare against

PString operator+	(	const char *	cstr,
		const PString &	str
	)

friend

Concatenate a PString to a C string to produce a third.

The original string is not modified, an entirely new unique reference to a string is created. The cstr parameter is typically a literal string, eg:


          myStr = "fred" + aStr;

Returns: new string with concatenation of the object and parameter.

Parameters

cstr	C string to be concatenated to.
str	String to concatenate.

PString operator+	(	char	ch,
		const PString &	str
	)

friend

Concatenate a PString to a single character to produce a third.

The original string is not modified, an entirely new unique reference to a string is created. The ch parameter is typically a literal, eg:


          myStr = '!' + aStr;

Returns: new string with concatenation of the object and parameter.

Parameters

ch	Character to be concatenated to.
str	String to concatenate.

bool operator<	(	const char *	cstr,
		const PString &	str
	)

friend

Compare a PString to a C string using the PObject::Compare() function.

The cstr parameter is typically a literal string, eg:


          if ("fred" < myStr)

Returns: true if less than.

Parameters

cstr	C string to compare against.
str	String to compare against

bool operator<=	(	const char *	cstr,
		const PString &	str
	)

friend

Compare a PString to a C string using the PObject::Compare() function.

The cstr parameter is typically a literal string, eg:


          if ("fred" <= myStr)

Returns: true if less than or equal.

Parameters

cstr	C string to compare against.
str	String to compare against

bool operator==	(	const char *	cstr,
		const PString &	str
	)

friend

Compare a PString to a C string using the Compare() function.

The cstr parameter is typically a literal string, eg:


          if ("fred" == myStr)

Returns: true if equal.

Parameters

cstr	C string to compare against.
str	String to compare against

bool operator>	(	const char *	cstr,
		const PString &	str
	)

friend

Compare a PString to a C string using the PObject::Compare() function.

The cstr parameter is typically a literal string, eg:


          if ("fred" > myStr)

Returns: true if greater than.

Parameters

cstr	C string to compare against.
str	String to compare against

bool operator>=	(	const char *	cstr,
		const PString &	str
	)

friend

Compare a PString to a C string using the PObject::Compare() function.

The cstr parameter is typically a literal string, eg:


          if ("fred" >= myStr)

Returns: true if greater than or equal.

Parameters

cstr	C string to compare against.
str	String to compare against

PString psprintf	(	const char *	cfmt,
			...
	)

friend

Produce formatted output as a string.

This is identical to the standard C library sprintf() function, but sends its output to a PString.

This function makes the assumption that there is less the 1000 characters of formatted output. The function will assert if this occurs.

Note that this function will break the current instance from multiple references to the string. A new string buffer is allocated and the data from the old string buffer copied to it.

Returns: reference to the current string object.

Parameters

cfmt	C string for output format.

PString pvsprintf	(	const char *	cfmt,
		va_list	args
	)

friend

Produce formatted output as a string.

Parameters

cfmt	C string for output format.
args	Extra parameters for `sprintf()` call.

PString pvsprintf	(	const PString &	fmt,
		va_list	args
	)

friend

Produce formatted output as a string.

This is identical to the standard C library vsprintf() function, but sends its output to a PString.

This function makes the assumption that there is less the 1000 characters of formatted output. The function will assert if this occurs.

Note that this function will break the current instance from multiple references to the string. A new string buffer is allocated and the data from the old string buffer copied to it.

Returns: reference to the current string object.

Parameters

fmt	String for output format.
args	Extra parameters for `sprintf()` call.

Member Data Documentation

PINDEX PString::m_length

mutableprotected

Referenced by GetLength().

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

pstring.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Construction

Concatenation operators

Comparison operators

Conversion functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation