csStringArray Class Reference

An array of strings. More...

#include <csutil/stringarray.h>

Inheritance diagram for csStringArray:


Public Types
enum	ConsecutiveDelimiterMode { delimSplitEach, delimIgnore, delimIgnoreDifferent }
	Mode how SplitString() treats consecutive occurance of delimiters. More...
	delimIgnore
	Ignore consecutive delimiters (except the first).
	delimIgnoreDifferent
	Only ignore consecutive delimiters if they're different.
	delimSplitEach
	Split at each different delimiter.
Public Member Functions
size_t	Contains (const char *str, bool case_sensitive=true) const
	Alias for Find() and FindCaseInsensitive().
	csStringArray (size_t limit=0, size_t threshold=0)
	Initialize object to hold initially `limit` elements, and increase storage by `threshold` each time the upper bound is exceeded.
size_t	Find (const char *str) const
	Find a string, case-sensitive.
size_t	FindCaseInsensitive (const char *str) const
	Find a string, case-insensitive.
size_t	FindSortedKey (char const key, bool case_sensitive=true, size_t candidate=0) const
	Find an element.
size_t	FindSortedKey (csArrayCmp< char const , char const > comparekey, size_t *candidate=0) const
	Find an element based on some key, using a comparison function.
size_t	InsertSorted (const char item, bool case_sensitive=true, size_t equal_index=0)
	Insert an element at a sorted position.
char *	Pop ()
	Pop an element from tail end of array.
void	Sort (bool case_sensitive=true)
	Sort array.
void	Sort (int(compare)(char const const &, char const *const &))
	Sort array based on comparison function.
size_t	SplitString (const char str, const char delimiters, ConsecutiveDelimiterMode delimMode=delimSplitEach)
	Add a number of strings to this array by splitting str at characters from delimiters.
Static Public Member Functions
static int	CaseInsensitiveCompare (const char const &item1, const char const &item2)
	Case-insensitive comparision function for strings.
static int	CaseSensitiveCompare (const char const &item1, const char const &item2)
	Case-sensitive comparision function for strings.

Detailed Description

An array of strings.

This array will properly make copies of the strings and later delete those copies via delete[].

Definition at line 56 of file stringarray.h.

Member Enumeration Documentation

enum csStringArray::ConsecutiveDelimiterMode

Mode how SplitString() treats consecutive occurance of delimiters.

Enumerator:

delimSplitEach	Split at each different delimiter.
delimIgnore	Ignore consecutive delimiters (except the first). In other words, any number of consecutive delimiters is treated like there was only one delimiter.
delimIgnoreDifferent	Only ignore consecutive delimiters if they're different.

Definition at line 205 of file stringarray.h.

Constructor & Destructor Documentation

csStringArray::csStringArray	(	size_t	limit = `0`,
		size_t	threshold = `0`
	)			`[inline]`

Initialize object to hold initially limit elements, and increase storage by threshold each time the upper bound is exceeded.

Definition at line 66 of file stringarray.h.

Member Function Documentation

static int csStringArray::CaseInsensitiveCompare	(	const char *const &	item1,
		const char *const &	item2
	)			`[inline, static]`

Case-insensitive comparision function for strings.

Definition at line 79 of file stringarray.h.

References csStrCaseCmp().

Referenced by FindSortedKey(), InsertSorted(), and Sort().

static int csStringArray::CaseSensitiveCompare	(	const char *const &	item1,
		const char *const &	item2
	)			`[inline, static]`

Case-sensitive comparision function for strings.

Definition at line 72 of file stringarray.h.

Referenced by FindSortedKey(), InsertSorted(), and Sort().

size_t csStringArray::Contains	(	const char *	str,
		bool	case_sensitive = `true`
	)			const `[inline]`

Alias for Find() and FindCaseInsensitive().

Parameters:

	str	String to look for in array.
	case_sensitive	If true, consider case when performing comparison. (default: yes)

Returns:: csArrayItemNotFound if not found, else item index.

Remarks:: Works with sorted and unsorted arrays, but FindSortedKey() is faster on sorted arrays.
Some people find Contains() more idiomatic than Find().

Definition at line 197 of file stringarray.h.

References Find(), and FindCaseInsensitive().

Referenced by scfStringArray::Contains().

size_t csStringArray::Find ( const char * str ) const [inline]

Find a string, case-sensitive.