Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members

FXEX::FXStringTokenizer Class Reference

Tokenise a string by the seperators. More...

#include <FXStringTokenizer.h>

List of all members.

Public Methods

 FXStringTokenizer (const FXString &s="", const FXString &seps="\t\n\r", FXuint opts=TOKENIZER_NORMAL)
 FXStringTokenizer (const FXString &s, const FXchar *seps, FXuint opts=TOKENIZER_NORMAL)
 FXStringTokenizer (const FXString &s, const FXchar sep, FXuint opts=TOKENIZER_NORMAL)
FXint length ()
FXString next ()
FXbool hasNext ()
FXString prev ()
FXbool hasPrev ()
void reset ()
void resetEnd ()
FXString remaining () const
FXString begining () const
void setSeperator (const FXchar sep)
void setSeperator (const FXchar *seps)
void setSeperators (const FXString &seps)
void addSeperator (const FXchar sep)
void addSeperators (const FXchar *seps)
void addSeperators (const FXString &seps)
FXString getSeperators () const
void setText (const FXString &s)
FXString getText () const
FXStringTokenizer & operator= (const FXStringTokenizer &s)
FXStringTokenizer & operator= (const FXString &s)
FXchar & operator[] (FXint i)
const FXchar & operator[] (FXint i) const
virtual ~FXStringTokenizer ()

Friends

FXbool operator== (const FXStringTokenizer &s1, const FXStringTokenizer &s2)
FXbool operator== (const FXString &s1, const FXStringTokenizer &s2)
FXbool operator== (const FXStringTokenizer &s1, const FXString &s2)
FXbool operator!= (const FXStringTokenizer &s1, const FXStringTokenizer &s2)
FXbool operator!= (const FXString &s1, const FXStringTokenizer &s2)
FXbool operator!= (const FXStringTokenizer &s1, const FXString &s2)
FXStreamoperator<< (FXStream &store, const FXStringTokenizer &s)
FXStreamoperator>> (FXStream &store, FXStringTokenizer &s)


Detailed Description

Tokenise a string by the seperators.

Note: 1. The seperators are single characters such as tab, comma's. 2. You can use multiple seperators at any one time. 3. It will skip over multiple adjacent seperators, so as to retrieve the next/previous token. 4. You can enable single and/or double quoting mode so as to avoid seperating tokens within the single/double quotes. If a double quote occurs inside a pair of single quotes, then the double quote will be broken, since it occurs within a matched pair. This applies to the other case - a single quote will be broken if matched within a double quote pair. 5. Double/single quotes can be uses as the seperators of tokens, though it wont make sense when used with the TOKENIZER_QUOTE_xxx modes.

Definition at line 53 of file FXStringTokenizer.h.


Constructor & Destructor Documentation

FXEX::FXStringTokenizer::FXStringTokenizer const FXString & s = "",
const FXString & seps = " \t\n\r",
FXuint opts = TOKENIZER_NORMAL
 

constuctors.

FXEX::FXStringTokenizer::FXStringTokenizer const FXString & s,
const FXchar * seps,
FXuint opts = TOKENIZER_NORMAL
 

FXEX::FXStringTokenizer::FXStringTokenizer const FXString & s,
const FXchar sep,
FXuint opts = TOKENIZER_NORMAL
 

virtual FXEX::FXStringTokenizer::~FXStringTokenizer [virtual]
 

dtor.


Member Function Documentation

FXint FXEX::FXStringTokenizer::length [inline]
 

length of text.

Definition at line 61 of file FXStringTokenizer.h.

FXString FXEX::FXStringTokenizer::next
 

get the next token.

FXbool FXEX::FXStringTokenizer::hasNext
 

has more next tokens.

FXString FXEX::FXStringTokenizer::prev
 

get the previous token.

FXbool FXEX::FXStringTokenizer::hasPrev
 

has more previous tokens.

void FXEX::FXStringTokenizer::reset [inline]
 

reset the tokenizer to the start of the string.

Definition at line 76 of file FXStringTokenizer.h.

void FXEX::FXStringTokenizer::resetEnd [inline]
 

reset the tokenizer to the end of the string (so you can traverse backwards).

Definition at line 79 of file FXStringTokenizer.h.

FXString FXEX::FXStringTokenizer::remaining const [inline]
 

get the remaining text left at the end of the string.

Definition at line 82 of file FXStringTokenizer.h.

FXString FXEX::FXStringTokenizer::begining const [inline]
 

get the remaining text left at the start of the string.

Definition at line 85 of file FXStringTokenizer.h.

void FXEX::FXStringTokenizer::setSeperator const FXchar sep [inline]
 

set the seperators.

Definition at line 88 of file FXStringTokenizer.h.

void FXEX::FXStringTokenizer::setSeperator const FXchar * seps [inline]
 

Definition at line 89 of file FXStringTokenizer.h.

void FXEX::FXStringTokenizer::setSeperators const FXString & seps [inline]
 

Definition at line 90 of file FXStringTokenizer.h.

void FXEX::FXStringTokenizer::addSeperator const FXchar sep [inline]
 

add other seperators to the current set.

Definition at line 93 of file FXStringTokenizer.h.

void FXEX::FXStringTokenizer::addSeperators const FXchar * seps [inline]
 

Definition at line 94 of file FXStringTokenizer.h.

void FXEX::FXStringTokenizer::addSeperators const FXString & seps [inline]
 

Definition at line 95 of file FXStringTokenizer.h.

FXString FXEX::FXStringTokenizer::getSeperators const [inline]
 

get the current seperators.

Definition at line 98 of file FXStringTokenizer.h.

void FXEX::FXStringTokenizer::setText const FXString & s
 

set the tokenized string to a new string.

FXString FXEX::FXStringTokenizer::getText const [inline]
 

get the text.

Definition at line 104 of file FXStringTokenizer.h.

FXStringTokenizer& FXEX::FXStringTokenizer::operator= const FXStringTokenizer & s
 

set the tokenized string to a another tokenizer.

FXStringTokenizer& FXEX::FXStringTokenizer::operator= const FXString & s
 

set the tokenized string to a new string.

FXchar& FXEX::FXStringTokenizer::operator[] FXint i [inline]
 

Return a non-const reference to the ith character.

Definition at line 113 of file FXStringTokenizer.h.

const FXchar& FXEX::FXStringTokenizer::operator[] FXint i const [inline]
 

Return a const reference to the ith character.

Definition at line 116 of file FXStringTokenizer.h.


Friends And Related Function Documentation

FXbool operator== const FXStringTokenizer & s1,
const FXStringTokenizer & s2
[friend]
 

Comparison operators ==.

FXbool operator== const FXString & s1,
const FXStringTokenizer & s2
[friend]
 

FXbool operator== const FXStringTokenizer & s1,
const FXString & s2
[friend]
 

FXbool operator!= const FXStringTokenizer & s1,
const FXStringTokenizer & s2
[friend]
 

Comparison operators !=.

FXbool operator!= const FXString & s1,
const FXStringTokenizer & s2
[friend]
 

FXbool operator!= const FXStringTokenizer & s1,
const FXString & s2
[friend]
 

FXStream& operator<< FXStream & store,
const FXStringTokenizer & s
[friend]
 

Saving to a stream.

FXStream& operator>> FXStream & store,
FXStringTokenizer & s
[friend]
 

Load from a stream.