---

string_tokeniser Class Template Reference
[String Library (STLSoft)]

String tokeniser. More...

#include <stlsoft_string_tokeniser.h>

List of all members.

Public Types
typedef string_tokeniser< S, D, B, V, T, P >	class_type
	The current parameterisation of the type.
typedef string_tokeniser< S, D, B, V, T, P >	tokeniser_type
	This tokeniser parameterisation.
typedef S	string_type
	The sequence string type.
typedef D	delimiter_type
	The delimiter type.
typedef B	ignore_blanks_type
	The ignore-blanks type.
typedef V	value_type
	The value type.
typedef T	traits_type
	The traits type.
typedef P	comparator_type
	The tokeniser comparator type.
typedef traits_type::value_type	char_type
	The char type.
typedef traits_type::size_type	size_type
	The size type.
typedef traits_type::difference_type	difference_type
	The difference type.
typedef const value_type	const_reference
	The const_reference type.
Public Methods
	string_tokeniser (string_type const &str, delimiter_type const &delimiter)
	Tokenise the given string with the given delimiter.
	string_tokeniser (char_type const *psz, delimiter_type const &delimiter)
	Tokenise the given string with the given delimiter.
template<typename S1>	string_tokeniser (S1 const &s, delimiter_type const &delimiter)
	Commence a search according to the given search pattern and flags, relative to directory.
	string_tokeniser (char_type const *psz, size_type cch, delimiter_type const &delimiter)
	Tokenise the specified length of the given string with the given delimiter.
	string_tokeniser (char_type const *from, char_type const *to, delimiter_type const &delimiter)
	Tokenise the given range with the given delimiter.
template<typename I>	string_tokeniser (I from, I to, delimiter_type const &delimiter)
	Tokenise the given range with the given delimiter.
const_iterator	begin () const
	Begins the iteration.
const_iterator	end () const
	Ends the iteration.
size_type	size () const
	Returns the number of elements in the sequence.
ss_bool_t	empty () const
	Indicates whether the search sequence is empty.

---

Detailed Description

template<typename S, typename D, typename B = string_tokeniser_ignore_blanks<true>, typename V = S, typename T = string_tokeniser_type_traits<S, V>, typename P = string_tokeniser_comparator<D, S, T>>
class stlsoft::string_tokeniser< S, D, B, V, T, P >

String tokeniser.

This class takes a string, and a delimiter, and fashions a sequence from the given string, with each element determined with respect to the delimiter

Parameters:

S	The string type
D	The delimiter type (can be a string type or a character type)
B	The ignore-blanks type
T	The string type traits type
P	The tokeniser comparator type
V	The value type (the string type that will be used for the values)

---

Member Typedef Documentation

typedef traits_type::value_type char_type

The char type.

typedef string_tokeniser<S, D, B, V, T, P> class_type

The current parameterisation of the type.

typedef P comparator_type

The tokeniser comparator type.

typedef const value_type const_reference

The const_reference type.

typedef D delimiter_type

The delimiter type.

typedef traits_type::difference_type difference_type

The difference type.

typedef B ignore_blanks_type

The ignore-blanks type.

typedef traits_type::size_type size_type

The size type.

typedef S string_type

The sequence string type.

typedef string_tokeniser<S, D, B, V, T, P> tokeniser_type

This tokeniser parameterisation.

typedef T traits_type

The traits type.

typedef V value_type

The value type.

---

Constructor & Destructor Documentation

string_tokeniser (  string_type const &    str, delimiter_type const &    delimiter )  [inline]

Tokenise the given string with the given delimiter.

string_tokeniser (  char_type const *    psz, delimiter_type const &    delimiter )  [inline]

Tokenise the given string with the given delimiter.

string_tokeniser (  S1 const &    s, delimiter_type const &    delimiter )  [inline]

Commence a search according to the given search pattern and flags, relative to directory.

string_tokeniser (  char_type const *    psz, size_type    cch, delimiter_type const &    delimiter )  [inline]

Tokenise the specified length of the given string with the given delimiter.

string_tokeniser (  char_type const *    from, char_type const *    to, delimiter_type const &    delimiter )  [inline]

Tokenise the given range with the given delimiter. Parameters: from  The start of the asymmetric range to tokenise to  The start of the asymmetric range to tokenise delimiter  The delimiter to use

string_tokeniser (  I    from, I    to, delimiter_type const &    delimiter )  [inline]

Tokenise the given range with the given delimiter. Parameters: from  The start of the asymmetric range to tokenise to  The start of the asymmetric range to tokenise delimiter  The delimiter to use

---

Member Function Documentation

const_iterator begin (    )  const [inline]

Begins the iteration. Returns: An iterator representing the start of the sequence

ss_bool_t empty (    )  const [inline]

Indicates whether the search sequence is empty.

const_iterator end (    )  const [inline]

Ends the iteration. Returns: An iterator representing the end of the sequence

size_type size (    )  const [inline]

Returns the number of elements in the sequence.

---

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

• stlsoft_string_tokeniser.h

STLSoft Libraries documentation © Synesis Software Pty Ltd, 2001-2004