blob: b2cf102563fb10857ad26e36ba0221bd7679b9da (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
//
// TextIterator.h
//
// Library: Foundation
// Package: Text
// Module: TextIterator
//
// Definition of the TextIterator class.
//
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// SPDX-License-Identifier: BSL-1.0
//
#ifndef Foundation_TextIterator_INCLUDED
#define Foundation_TextIterator_INCLUDED
#include "Poco/Foundation.h"
namespace Poco {
class TextEncoding;
class Foundation_API TextIterator
/// An unidirectional iterator for iterating over characters in a string.
/// The TextIterator uses a TextEncoding object to
/// work with multi-byte character encodings like UTF-8.
/// Characters are reported in Unicode.
///
/// Example: Count the number of UTF-8 characters in a string.
///
/// UTF8Encoding utf8Encoding;
/// std::string utf8String("....");
/// TextIterator it(utf8String, utf8Encoding);
/// TextIterator end(utf8String);
/// int n = 0;
/// while (it != end) { ++n; ++it; }
///
/// NOTE: When an UTF-16 encoding is used, surrogate pairs will be
/// reported as two separate characters, due to restrictions of
/// the TextEncoding class.
///
/// For iterating over char buffers, see the TextBufferIterator class.
{
public:
TextIterator();
/// Creates an uninitialized TextIterator.
TextIterator(const std::string& str, const TextEncoding& encoding);
/// Creates a TextIterator for the given string.
/// The encoding object must not be deleted as long as the iterator
/// is in use.
TextIterator(const std::string::const_iterator& begin, const std::string::const_iterator& end, const TextEncoding& encoding);
/// Creates a TextIterator for the given range.
/// The encoding object must not be deleted as long as the iterator
/// is in use.
TextIterator(const std::string& str);
/// Creates an end TextIterator for the given string.
TextIterator(const std::string::const_iterator& end);
/// Creates an end TextIterator.
~TextIterator();
/// Destroys the TextIterator.
TextIterator(const TextIterator& it);
/// Copy constructor.
TextIterator& operator = (const TextIterator& it);
/// Assignment operator.
void swap(TextIterator& it);
/// Swaps the iterator with another one.
int operator * () const;
/// Returns the Unicode value of the current character.
/// If there is no valid character at the current position,
/// -1 is returned.
TextIterator& operator ++ ();
/// Prefix increment operator.
TextIterator operator ++ (int);
/// Postfix increment operator.
bool operator == (const TextIterator& it) const;
/// Compares two iterators for equality.
bool operator != (const TextIterator& it) const;
/// Compares two iterators for inequality.
TextIterator end() const;
/// Returns the end iterator for the range handled
/// by the iterator.
private:
const TextEncoding* _pEncoding;
std::string::const_iterator _it;
std::string::const_iterator _end;
};
//
// inlines
//
inline bool TextIterator::operator == (const TextIterator& it) const
{
return _it == it._it;
}
inline bool TextIterator::operator != (const TextIterator& it) const
{
return _it != it._it;
}
inline void swap(TextIterator& it1, TextIterator& it2)
{
it1.swap(it2);
}
inline TextIterator TextIterator::end() const
{
return TextIterator(_end);
}
} // namespace Poco
#endif // Foundation_TextIterator_INCLUDED
|
