Documento de molib

Idiomas disponible : English français

CLASS

moWords

NAME

Constructor - create an moWords object
Destructor - destroys an moWords object

VERSION

Version: 1.2.0

SYNOPSIS

moWords(void);
moWords(const moWCString& char_separators);
virtual ~moWords();

private:
void Init(void);

DESCRIPTION

Creates a list of words. Use the SetWords() to reset the current list of words. Or AddWords() to increase the number of words present in this object.

By default, words are not automatically clipped and empty words are discarded.

SEE ALSO

NoNewLine

COPYRIGHTS

This documentation and the code being documented is proprietary and cannot be duplicated without the express and written consent of Made to Order Software Coporation.

Copyright (c) 1999-2007 by Made to Order Software Corporation
All rights reserved.

AUTHORS

Alexis Wilke, Doug Barbieri

CLASS

moWords

NAME

AutoClip - whether words are automatically clipped

VERSION

Version: 1.2.0

SYNOPSIS

void AutoClip(bool status = true);

PARAMETERS

status - new value of the auto clip flag

DESCRIPTION

With this flag is set to 'true' then the resulting words are automatically clipped (starting and ending spaces are removed).

COPYRIGHTS

AUTHORS

Alexis Wilke, Doug Barbieri

CLASS

moWords

NAME

EmptyWords - whether empty words are accepted

VERSION

Version: 1.2.0

SYNOPSIS

void EmptyWords(bool status = true);

PARAMETERS

status - new value of the empty words flag

DESCRIPTION

When this flag is set to 'true', empty words are kept in the resulting list, otherwise (by default) they are discarded.

COPYRIGHTS

AUTHORS

Alexis Wilke, Doug Barbieri

CLASS

moWords

NAME

AllWords - returns a string with all the words

VERSION

Version: 1.2.0

SYNOPSIS

const moWCString& AllWords(void) const;

DESCRIPTION

Return a string with all the words present in this list of words.

RETURN VALUE

A string which can't be modified.

COPYRIGHTS

AUTHORS

Alexis Wilke, Doug Barbieri

CLASS

moWords

NAME

ClearSeparators - initialize a string object

VERSION

Version: 1.2.0

SYNOPSIS

void ClearSeparators(void);
void CharSeparators(const moWCString& seps);
void StringSeparators(const moWCString& separators);

PARAMETERS

seps - a list of character separators
separator - one string separator

DESCRIPTION

These functions are used to handle the separators.

Separators are of two categories:

1. characters 2. strings

When no strings are defined, then only characters are used. Otherwise string separators are tested first. The first match is the one used (not the longest).

When neither characters nor strings are defined, the internal default is used: spaces (any type).

The characters and strings can include the following backslashes:

\a bell \e escape \f form feed \n new line \r carriage return \s space (as isspace() defines) \t horizontal tab \v vertical tab \\ backslash

NOTES

Using CharSeparator() with an empty strings clears out all stand alone characters.

To use several string separators, call the StringSeparators() multiple times. Empty strings are ignored by StringSeparators(). Also, this function can be used to test stand alone characters, yet it is much slower than the other one.

SEE ALSO

SetWords, AddWords

COPYRIGHTS

AUTHORS

Alexis Wilke, Doug Barbieri

CLASS

moWords

NAME

Quotes - which quotes are accepted

VERSION

Version: 1.2.0

SYNOPSIS

void Quotes(const moWCString& quotes);

PARAMETERS

status - set to true by default; new value of the auto clip flag

DESCRIPTION

Setup the recognized set of quotes.

The 'quotes' string is composed of a list of starting and ending quotes. There is no default. If you want to understand C strings then quotes would be: "\"\""; C characters: "''"; if you want to understand both: "\"\"''"; other strings with brackets or lower & larger than signs can be defined: "[]{}<>"; etc.

If the C string includes "\\\\", then any quotes after that will also take in account escaped characters. Note that strings written between backslashes are therefore not available at this time.

ERRORS

the quotes string must have an even size; if this isn't the case an error is thrown

COPYRIGHTS

AUTHORS

Alexis Wilke, Doug Barbieri

CLASS

moWords

NAME

SetWords - replace current words with new once
AddWords - append new words

VERSION

Version: 1.2.0

SYNOPSIS

virtual unsigned long SetWords(const moWCString& words);
unsigned long AddWords(const moWCString& words);

PARAMETERS

words - the words to parse in a list of strings

DESCRIPTION

These functions parse the input parameter into a list of words using the parameters as defined so far.

ERRORS

When a string can't be allocated, this function will generate an MO_ERROR_MEMORY thrown with a long().

SEE ALSO

Empty, Quotes, AutoClip, CharSeparators, StringSeparators

COPYRIGHTS

AUTHORS

Alexis Wilke, Doug Barbieri

CLASS

moWords

NAME

Get -- get a word
operator [] -- get a word

VERSION

Version: 1.2.0

SYNOPSIS

const moWCString& Get(int index) const;
const moWCString& operator [] (int index) const;

PARAMETERS

index - the word to be returned

DESCRIPTION

The Get() function and the [] operator get the specified word and return a reference string to it.

Note that the reference is a constant and it should be copied if it needs to be modified.

This operator is an overload from the moList version of the same operator. Note that the operator is not virtual (it doesn't return the same data). It was created for practicallity since the moList returns an moBase reference and that's not as useful for a list of words.

SEE ALSO

moList::operator [] ()

BUGS

Note that the operator [] of the moList class actually returns a list item which can be used for reading and writing of the item. Since the moWords implementation doesn't really allow writing, it can just return a constant reference at this time. This may change in the future.

COPYRIGHTS

AUTHORS

Alexis Wilke, Doug Barbieri

Links:
molib
the sandbox