2011-06-24 Nikolas Zimmermann <nzimmermann@rim.com>
[WebKit-https.git] / Source / WebCore / platform / graphics / SurrogatePairAwareTextIterator.h
1 /*
2  * Copyright (C) Research In Motion Limited 2011. All rights reserved.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public License
15  * along with this library; see the file COPYING.LIB.  If not, write to
16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  *
19  */
20
21 #ifndef SurrogatePairAwareTextIterator_h
22 #define SurrogatePairAwareTextIterator_h
23
24 #include <wtf/text/WTFString.h>
25
26 namespace WebCore {
27
28 class SurrogatePairAwareTextIterator {
29 public:
30     // The passed in UChar pointer starts at 'currentCharacter'. The iterator operatoes on the range [currentCharacter, lastCharacter].
31     // 'endCharacter' denotes the maximum length of the UChar array, which might exceed 'lastCharacter'.
32     SurrogatePairAwareTextIterator(const UChar*, int currentCharacter, int lastCharacter, int endCharacter);
33
34     bool consume(UChar32& character, unsigned& clusterLength);
35     void advance(unsigned advanceLength);
36
37     int currentCharacter() const { return m_currentCharacter; }
38     const UChar* characters() const { return m_characters; }
39
40 private:
41     UChar32 normalizeVoicingMarks();
42
43     const UChar* m_characters;
44     int m_currentCharacter;
45     int m_lastCharacter;
46     int m_endCharacter;
47 };
48
49 }
50
51 #endif