topical media & game development
lib-of-vs-libs-Poco-include-Poco-StringTokenizer.h / h
//
// StringTokenizer.h
//
//
//
// Library: Foundation
// Package: Core
// Module: StringTokenizer
//
// Definition of the StringTokenizer class.
//
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// Permission is hereby granted, free of charge, to any person or organization
// obtaining a copy of the software and accompanying documentation covered by
// this license (the "Software") to use, reproduce, display, distribute,
// execute, and transmit the Software, and to prepare derivative works of the
// Software, and to permit third-parties to whom the Software is furnished to
// do so, all subject to the following:
//
// The copyright notices in the Software and this entire statement, including
// the above license grant, this restriction and the following disclaimer,
// must be included in all copies of the Software, in whole or in part, and
// all derivative works of the Software, unless such copies or derivative
// works are solely in the form of machine-executable object code generated by
// a source language processor.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
ifndef Foundation_StringTokenizer_INCLUDED
define Foundation_StringTokenizer_INCLUDED
include "Poco/Foundation.h"
include "Poco/Exception.h"
include <vector>
include <cstddef>
namespace Poco {
class Foundation_API StringTokenizer
A simple tokenizer that splits a string into
tokens, which are separated by separator characters.
An iterator is used to iterate over all tokens.
{
public:
enum Options
{
TOK_IGNORE_EMPTY = 1,
ignore empty tokens
TOK_TRIM = 2
remove leading and trailing whitespace from tokens
};
typedef std::vector
<std::string>::const_iterator Iterator;
StringTokenizer(const std::string& str, const std::string& separators, int options = 0);
Splits the given string into tokens. The tokens are expected to be
separated by one of the separator characters given in separators.
Additionally, options can be specified:
* TOK_IGNORE_EMPTY: empty tokens are ignored
* TOK_TRIM: trailing and leading whitespace is removed from tokens.
An empty token at the end of str is always ignored. For example,
a StringTokenizer with the following arguments:
StringTokenizer(",ab,cd,", ",");
will produce three tokens, "", "ab" and "cd".
~StringTokenizer();
Destroys the tokenizer.
Iterator begin() const;
Iterator end() const;
const std::string& operator [] (std::size_t index) const;
Returns the index'th token.
Throws a RangeException if the index is out of range.
std::size_t count() const;
Returns the number of tokens.
private:
StringTokenizer(const StringTokenizer&);
StringTokenizer& operator = (const StringTokenizer&);
std::vector<std::string> _tokens;
};
//
// inlines
//
inline StringTokenizer::Iterator StringTokenizer::begin() const
{
return _tokens.begin();
}
inline StringTokenizer::Iterator StringTokenizer::end() const
{
return _tokens.end();
}
inline const std::string& StringTokenizer::operator [] (std::size_t index) const
{
if (index >= _tokens.size()) throw RangeException();
return _tokens[index];
}
inline std::size_t StringTokenizer::count() const
{
return _tokens.size();
}
} // namespace Poco
endif // Foundation_StringTokenizer_INCLUDED
(C) Æliens
04/09/2009
You may not copy or print any of this material without explicit permission of the author or the publisher.
In case of other copyright issues, contact the author.
