This is a list collection class of PString objects. More...

#include <pstring.h>

Inheritance diagram for PStringList:

Collaboration diagram for PStringList:

Public Member Functions
Construction
__inline	PStringList ()
	Create an empty PStringList. More...

__inline	PStringList (const BaseClass &other)

	PStringList (PINDEX count, char const const strarr, PBoolean caseless=false)
	Create a PStringList from the array of C strings. More...

	PStringList (const PString &str)
	Create a PStringList of length one from the single string. More...

	PStringList (const char *cstr)
	Create a PStringList of length one from the single string. More...

	PStringList (const PStringArray &array)
	Create a PStringList from the array of strings. More...

	PStringList (const PSortedStringList &list)
	Create a PStringList from the sorted list of strings. More...

	PStringList (const PStringSet &set)
	Create a PStringList from the string set. More...

Overrides from class PObject
virtual void	ReadFrom (istream &strm)
	Input the contents of the object from the stream. More...

virtual PObject *	Clone () const
	Make a complete duplicate of the list. More...

Public Member Functions inherited from PList< PString >
	PList ()
	Create a new, empty, list. More...

PString &	operator[] (PINDEX index) const
	Retrieve a reference to the object in the list. More...

iterator	begin ()

const_iterator	begin () const

iterator	end ()

const_iterator	end () const

iterator	rbegin ()

const_iterator	rbegin () const

iterator	rend ()

const_iterator	rend () const

iterator	find (const value_type &obj)

const_iterator	find (const value_type &obj) const

void	insert (const iterator &pos, value_type *obj)

void	insert (const iterator &pos, const value_type &obj)

value_type &	front () const

value_type &	back () const

__inline void	erase (const iterator &it)

__inline void	erase (const const_iterator &it)

__inline void	push_front (const value_type &value)

__inline void	push_back (const value_type &value)

__inline void	pop_front ()

__inline void	pop_back ()

Public Member Functions inherited from PAbstractList
virtual Comparison	Compare (const PObject &obj) const
	Get the relative rank of the two lists. More...

PINLINE	PAbstractList ()
	Create a new, empty, list. More...

virtual PBoolean	SetSize (PINDEX newSize)
	This function is meaningless for lists. More...

virtual PINDEX	Append (PObject *obj)
	Append a new object to the collection. More...

virtual void	Prepend (PObject *obj)
	Append a new object to the collection. More...

virtual PINDEX	Insert (const PObject &before, PObject *obj)
	Insert a new object immediately before the specified object. More...

virtual P_DEPRECATED PINDEX	InsertAt (PINDEX index, PObject *obj)
	Insert a new object at the specified ordinal index. More...

virtual PBoolean	Remove (const PObject *obj)
	Remove the object from the collection. More...

virtual PObject *	RemoveHead ()
	Remove the head object from the list. More...

virtual PObject *	RemoveTail ()
	Remove the tail object from the list. More...

virtual P_DEPRECATED PObject *	RemoveAt (PINDEX index)
	Remove the object at the specified ordinal index from the collection. More...

virtual P_DEPRECATED PBoolean	SetAt (PINDEX index, PObject *val)
	Set the object at the specified ordinal position to the new value. More...

virtual P_DEPRECATED PBoolean	ReplaceAt (PINDEX index, PObject *val)
	Set the object at the specified ordinal position to the new value. More...

virtual P_DEPRECATED PObject *	GetAt (PINDEX index) const
	Get the object at the specified ordinal position. More...

virtual PINDEX	GetObjectsIndex (const PObject *obj) const
	Search the collection for the specific instance of the object. More...

virtual PINDEX	GetValuesIndex (const PObject &obj) const
	Search the collection for the specified value of the object. More...

Public Member Functions inherited from PCollection
	PCollection (PINDEX initialSize=0)
	Create a new collection. More...

virtual void	PrintOn (ostream &strm) const
	Print the collection on the stream. More...

__inline void	remove (const PObject *obj)

virtual void	RemoveAll ()
	Remove all of the elements in the collection. More...

__inline void	clear ()

PINLINE void	AllowDeleteObjects (PBoolean yes=true)
	Allow or disallow the deletion of the objects contained in the collection. More...

void	DisallowDeleteObjects ()
	Disallow the deletion of the objects contained in the collection. 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...

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

__inline bool	empty () const

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

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

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

__inline void	SetTraceContextIdentifier (unsigned id)

__inline void	SetTraceContextIdentifier (const PObject &obj)

__inline void	SetTraceContextIdentifier (const PObject *obj)

__inline void	CopyTraceContextIdentifier (PObject &obj) const

__inline void	CopyTraceContextIdentifier (PObject *obj) const

virtual	~PObject ()

__inline const char *	GetClass () const

__inline bool	IsClass (const char *name) const

__inline const PObject *	PTraceObjectInstance () const

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

virtual PINDEX	HashFunction () const
	This function yields a hash value required by the `PDictionary` class. More...

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...

virtual void	ReadFrom (istream &strm)
	Input the contents of the object from the stream. More...

Protected Member Functions
	PStringList (int dummy, const PStringList *c)

Protected Member Functions inherited from PList< PString >
	PList (int dummy, const PList *c)

Protected Member Functions inherited from PAbstractList
PINLINE PObject &	GetReferenceAt (PINDEX index) const

PListElement *	FindElement (PINDEX index) const

PListElement *	FindElement (const PObject &obj, PINDEX *index) const

void	InsertElement (PListElement element, PObject obj)

PObject *	RemoveElement (PListElement *element)

Protected Member Functions inherited from PCollection
PINLINE	PCollection (int dummy, const PCollection *coll)
	Constructor used in support of the Clone() function. More...

Protected Member Functions inherited from PContainer
	PContainer (int dummy, const PContainer *cont)
	Constructor used in support of the Clone() function. More...

	PContainer (PContainerReference &reference)
	Construct using static PContainerReference. More...

virtual void	DestroyContents ()=0
	Destroy the container contents. More...

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

void	CopyContents (const PContainer &c)
	Copy the container contents. More...

void	CloneContents (const PContainer *src)
	Create a duplicate of the container contents. More...

void	Destruct ()
	Internal function called from container destructors. More...

virtual void	DestroyReference ()
	Destroy the PContainerReference instance. More...

Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Operations
PINDEX	AppendString (const PString &str)
	Append a string to the list. More...

PINDEX	InsertString (const PString &before, const PString &str)
	Insert a string into the list. More...

PINDEX	GetStringsIndex (const PString &str) const
	Get the index of the string with the specified value. More...

PStringList &	operator+= (const PStringList &list)
	Concatenate a PString or PStringArray to the list. More...

PStringList &	operator+= (const PString &str)

PStringList &	operator+= (const char *cstr)

PStringList	operator+ (const PStringList &array)
	Create a new PStringList, and add PString or PStringList to it a new PStringList. More...

PStringList	operator+ (const PString &str)

template<typename stlContainer >
static PStringList	container (const stlContainer &vec)
	Create a PStringArray from an STL container. More...

Additional Inherited Members
Public Types inherited from PList< PString >
typedef PString	value_type

Public Types inherited from PObject
enum	Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
	Result of the comparison operation performed by the `Compare()` function. More...

Static Public Member Functions inherited from PObject
static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject &from)

static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject *from)

static __inline void	CopyTraceContextIdentifier (PObject *to, const PObject &from)

static __inline void	CopyTraceContextIdentifier (PObject to, const PObject from)

static __inline const char *	Class ()

static __inline const PObject *	PTraceObjectInstance (const char *)

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

template<typename T >
static Comparison	Compare2 (T v1, T v2)
	Compare two types, returning Comparison type. More...

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

Protected Types inherited from PAbstractList
typedef PListElement	Element

Protected Attributes inherited from PAbstractList
PListInfo *	m_info

Protected Attributes inherited from PContainer
PContainerReference *	reference

Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

Detailed Description

This is a list collection class of PString objects.

It has all the usual functions for a collection, with the object types set to PString pointers.

In addition some addition functions are added that take a const PString reference instead of a pointer as most standard collection functions do. This is more convenient for when string expressions are used as parameters to function in the collection.

See the PAbstractList and PList classes and PDECLARE_LIST macro for more information.

Constructor & Destructor Documentation

PStringList::PStringList	(	int	dummy,
		const PStringList *	c
	)

inlineprotected

__inline PStringList::PStringList ( )

inline

Create an empty PStringList.

Referenced by Clone().

__inline PStringList::PStringList ( const BaseClass & other )

inline

PStringList::PStringList	(	PINDEX	count,
		char const const	strarr,
		PBoolean	caseless = `false`
	)

Create a PStringList from the array of C strings.

Parameters

count	Count of strings in array
strarr	Array of C strings
caseless	New strings are to be PCaselessStrings

PStringList::PStringList ( const PString & str )

Create a PStringList of length one from the single string.

Parameters

str	Single string to convert to a list of one.

PStringList::PStringList ( const char * cstr )

Create a PStringList of length one from the single string.

Parameters

cstr	Single string to convert to a list of one.

PStringList::PStringList ( const PStringArray & array )

Create a PStringList from the array of strings.

Parameters

array Array of strings to convert to list

PStringList::PStringList ( const PSortedStringList & list )

Create a PStringList from the sorted list of strings.

Parameters

list	List of strings to convert to list.

PStringList::PStringList ( const PStringSet & set )

Create a PStringList from the string set.

Parameters

set	Set of strings to convert to array.

Member Function Documentation

PINDEX PStringList::AppendString ( const PString & str )

Append a string to the list.

Parameters

str	String to append.

Referenced by container(), and operator+=().

virtual PObject* PStringList::Clone ( ) const

inlinevirtual

Make a complete duplicate of the list.

Note that all objects in the array are also cloned, so this will make a complete copy of the list.

Reimplemented from PList< PString >.

References PStringList().

template<typename stlContainer >

static PStringList PStringList::container ( const stlContainer & vec )

inlinestatic

Create a PStringArray from an STL container.

References AppendString().

PINDEX PStringList::GetStringsIndex ( const PString & str ) const

Get the index of the string with the specified value.

A linear search of list is performed to find the string value.

Parameters

str	String value to search for.

PINDEX PStringList::InsertString	(	const PString &	before,
		const PString &	str
	)

Insert a string into the list.

Parameters

before	String to insert before.
str	String to insert.

PStringList PStringList::operator+ ( const PStringList & array )

Create a new PStringList, and add PString or PStringList to it a new PStringList.

Returns: A new PStringList with the additional elements(s)

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

PStringList& PStringList::operator+= ( const PStringList & list )

Concatenate a PString or PStringArray to the list.

Returns: The PStringArray with the new items appended

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

inline

References AppendString().

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

inline

References AppendString().

virtual void PStringList::ReadFrom ( istream & strm )

virtual

Input the contents of the object from the stream.

This is primarily used by the standard operator>> function.

The default behaviour reads '\n' separated strings until !strm.good().

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

pstring.h

Public Member Functions

Protected Member Functions

Operations

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation