← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/poco/gutsy

« back to all changes in this revision

Viewing changes to Foundation/include/Poco/StringTokenizer.h

  • Committer: Bazaar Package Importer
  • Author(s): Krzysztof Burghardt
  • Date: 2007-04-27 18:33:48 UTC
  • Revision ID: james.westby@ubuntu.com-20070427183348-xgnpct0qd6a2ip34
Tags: upstream-1.2.9
Import upstream version 1.2.9

Show diffs side-by-side

added added

removed removed

Lines of Context:
Foundation/include/Poco/StringTokenizer.h
 
1
//
 
2
// StringTokenizer.h
 
3
//
 
4
// $Id: //poco/1.2/Foundation/include/Poco/StringTokenizer.h#2 $
 
5
//
 
6
// Library: Foundation
 
7
// Package: Core
 
8
// Module:  StringTokenizer
 
9
//
 
10
// Definition of the StringTokenizer class.
 
11
//
 
12
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
 
13
// and Contributors.
 
14
//
 
15
// Permission is hereby granted, free of charge, to any person or organization
 
16
// obtaining a copy of the software and accompanying documentation covered by
 
17
// this license (the "Software") to use, reproduce, display, distribute,
 
18
// execute, and transmit the Software, and to prepare derivative works of the
 
19
// Software, and to permit third-parties to whom the Software is furnished to
 
20
// do so, all subject to the following:
 
21
// 
 
22
// The copyright notices in the Software and this entire statement, including
 
23
// the above license grant, this restriction and the following disclaimer,
 
24
// must be included in all copies of the Software, in whole or in part, and
 
25
// all derivative works of the Software, unless such copies or derivative
 
26
// works are solely in the form of machine-executable object code generated by
 
27
// a source language processor.
 
28
// 
 
29
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 
30
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 
31
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
 
32
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
 
33
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
 
34
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 
35
// DEALINGS IN THE SOFTWARE.
 
36
//
 
37
 
 
38
 
 
39
#ifndef Foundation_StringTokenizer_INCLUDED
 
40
#define Foundation_StringTokenizer_INCLUDED
 
41
 
 
42
 
 
43
#include "Poco/Foundation.h"
 
44
#include "Poco/Exception.h"
 
45
#include <vector>
 
46
#include <cstddef>
 
47
 
 
48
 
 
49
namespace Poco {
 
50
 
 
51
 
 
52
class Foundation_API StringTokenizer
 
53
        /// A simple tokenizer that splits a string into
 
54
        /// tokens, which are separated by separator characters.
 
55
        /// An iterator is used to iterate over all tokens.
 
56
{
 
57
public:
 
58
        enum Options
 
59
        {
 
60
                TOK_IGNORE_EMPTY = 1, /// ignore empty tokens
 
61
                TOK_TRIM         = 2  /// remove leading and trailing whitespace from tokens
 
62
        };
 
63
        
 
64
        typedef std::vector<std::string>::const_iterator Iterator;
 
65
        
 
66
        StringTokenizer(const std::string& str, const std::string& separators, int options = 0);
 
67
                /// Splits the given string into tokens. The tokens are expected to be
 
68
                /// separated by one of the separator characters given in separators.
 
69
                /// Additionally, options can be specified:
 
70
                ///   * TOK_IGNORE_EMPTY: empty tokens are ignored
 
71
                ///   * TOK_TRIM: trailing and leading whitespace is removed from tokens.
 
72
                /// An empty token at the end of str is always ignored. For example,
 
73
                /// a StringTokenizer with the following arguments:
 
74
                ///     StringTokenizer(",ab,cd,", ",");
 
75
                /// will produce three tokens, "", "ab" and "cd".
 
76
 
 
77
        ~StringTokenizer();
 
78
                /// Destroys the tokenizer.
 
79
        
 
80
        Iterator begin() const;
 
81
        Iterator end() const;
 
82
        
 
83
        const std::string& operator [] (std::size_t index) const;
 
84
                /// Returns the index'th token.
 
85
                /// Throws a RangeException if the index is out of range.
 
86
                
 
87
        std::size_t count() const;
 
88
                /// Returns the number of tokens.
 
89
 
 
90
private:
 
91
        StringTokenizer(const StringTokenizer&);
 
92
        StringTokenizer& operator = (const StringTokenizer&);
 
93
        
 
94
        std::vector<std::string> _tokens;
 
95
};
 
96
 
 
97
 
 
98
//
 
99
// inlines
 
100
//
 
101
 
 
102
 
 
103
inline StringTokenizer::Iterator StringTokenizer::begin() const
 
104
{
 
105
        return _tokens.begin();
 
106
}
 
107
 
 
108
 
 
109
inline StringTokenizer::Iterator StringTokenizer::end() const
 
110
{
 
111
        return _tokens.end();
 
112
}
 
113
 
 
114
 
 
115
inline const std::string& StringTokenizer::operator [] (std::size_t index) const
 
116
{
 
117
        if (index >= _tokens.size()) throw RangeException();
 
118
        return _tokens[index];
 
119
}
 
120
 
 
121
 
 
122
inline std::size_t StringTokenizer::count() const
 
123
{
 
124
        return _tokens.size();
 
125
}
 
126
 
 
127
 
 
128
} // namespace Poco
 
129
 
 
130
 
 
131
#endif // Foundation_StringTokenizer_INCLUDED