0e7437ac967c4dc7d4cc61cb14aa8b8de5ebcbb8
[WebKit-https.git] / Source / WebCore / rendering / SimpleLineLayoutTextFragmentIterator.cpp
1 /*
2  * Copyright (C) 2015 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "SimpleLineLayoutTextFragmentIterator.h"
28
29 #include "RenderBlockFlow.h"
30 #include "RenderChildIterator.h"
31 #include "SimpleLineLayoutFlowContents.h"
32
33 namespace WebCore {
34 namespace SimpleLineLayout {
35
36 TextFragmentIterator::Style::Style(const RenderStyle& style)
37     : font(style.fontCascade())
38     , textAlign(style.textAlign())
39     , collapseWhitespace(style.collapseWhiteSpace())
40     , preserveNewline(style.preserveNewline())
41     , wrapLines(style.autoWrap())
42     , breakWordOnOverflow(style.overflowWrap() == BreakOverflowWrap && (wrapLines || preserveNewline))
43     , spaceWidth(font.width(TextRun(&space, 1)))
44     , tabWidth(collapseWhitespace ? 0 : style.tabSize())
45     , locale(style.locale())
46 {
47 }
48
49 TextFragmentIterator::TextFragmentIterator(const RenderBlockFlow& flow)
50     : m_flowContents(flow)
51     , m_currentSegment(m_flowContents.begin())
52     , m_lineBreakIterator(m_currentSegment->text, flow.style().locale())
53     , m_style(flow.style())
54 {
55 }
56
57 TextFragmentIterator::TextFragment TextFragmentIterator::nextTextFragment(float xPosition)
58 {
59     // A fragment can either be
60     // 1. new line character when preserveNewline is on (not considered as whitespace) or
61     // 2. whitespace (collasped, non-collapsed multi or single) or
62     // 3. non-whitespace characters.
63     // 4. empty, indicating content end.
64     ASSERT(m_currentSegment != m_flowContents.end());
65     if (m_position == m_currentSegment->end)
66         ++m_currentSegment;
67     // Is it content end?
68     if (m_currentSegment == m_flowContents.end())
69         return TextFragment(m_position, m_position, 0, TextFragment::ContentEnd);
70     unsigned segmentEndPosition = m_currentSegment->end;
71     unsigned startPosition = m_position;
72     if (isLineBreak(m_position)) {
73         unsigned endPosition = ++m_position;
74         return TextFragment(startPosition, endPosition, 0, TextFragment::LineBreak);
75     }
76     float width = 0;
77     bool overlappingFragment = false;
78     unsigned endPosition = skipToNextPosition(PositionType::NonWhitespace, startPosition, width, xPosition, overlappingFragment);
79     ASSERT(startPosition <= endPosition);
80     if (startPosition < endPosition) {
81         bool multipleWhitespace = startPosition + 1 < endPosition;
82         bool isCollapsed = multipleWhitespace && m_style.collapseWhitespace;
83         bool isBreakable = !isCollapsed && multipleWhitespace;
84         m_position = endPosition;
85         return TextFragment(startPosition, endPosition, width, TextFragment::Whitespace, endPosition == segmentEndPosition, false, isCollapsed, m_style.collapseWhitespace, isBreakable);
86     }
87     endPosition = skipToNextPosition(PositionType::Breakable, startPosition, width, xPosition, overlappingFragment);
88     m_position = endPosition;
89     return TextFragment(startPosition, endPosition, width, TextFragment::NonWhitespace, endPosition == segmentEndPosition, overlappingFragment, false, false, m_style.breakWordOnOverflow);
90 }
91
92 void TextFragmentIterator::revertToFragment(const TextFragment& fragment)
93 {
94     ASSERT(m_position >= fragment.end());
95     ASSERT(fragment.start() >= 0);
96     // Revert segment first.
97     while (m_currentSegment->start > fragment.start())
98         --m_currentSegment;
99     // TODO: It reverts to the last fragment on the same position, but that's ok for now as we don't need to
100     // differentiate multiple renderers on the same position.
101     m_position = fragment.start();
102 }
103
104 template <typename CharacterType>
105 unsigned TextFragmentIterator::nextBreakablePosition(const FlowContents::Segment& segment, unsigned startPosition)
106 {
107     ASSERT(startPosition < segment.end);
108     if (segment.text.impl() != m_lineBreakIterator.string().impl()) {
109         const String& currentText = m_lineBreakIterator.string();
110         unsigned textLength = currentText.length();
111         UChar lastCharacter = textLength > 0 ? currentText[textLength - 1] : 0;
112         UChar secondToLastCharacter = textLength > 1 ? currentText[textLength - 2] : 0;
113         m_lineBreakIterator.setPriorContext(lastCharacter, secondToLastCharacter);
114         m_lineBreakIterator.resetStringAndReleaseIterator(segment.text, m_style.locale, LineBreakIteratorModeUAX14);
115     }
116     const auto* characters = segment.text.characters<CharacterType>();
117     unsigned segmentLength = segment.end - segment.start;
118     unsigned segmentPosition = startPosition - segment.start;
119     return segment.start + nextBreakablePositionNonLoosely<CharacterType, NBSPBehavior::IgnoreNBSP>(m_lineBreakIterator, characters, segmentLength, segmentPosition);
120 }
121
122 template <typename CharacterType>
123 unsigned TextFragmentIterator::nextNonWhitespacePosition(const FlowContents::Segment& segment, unsigned startPosition)
124 {
125     ASSERT(startPosition < segment.end);
126     const auto* text = segment.text.characters<CharacterType>();
127     unsigned position = startPosition;
128     for (; position < segment.end; ++position) {
129         auto character = text[position - segment.start];
130         bool isWhitespace = character == ' ' || character == '\t' || (!m_style.preserveNewline && character == '\n');
131         if (!isWhitespace)
132             return position;
133     }
134     return position;
135 }
136
137 float TextFragmentIterator::textWidth(unsigned from, unsigned to, float xPosition) const
138 {
139     auto& segment = *m_currentSegment;
140     ASSERT(segment.start <= from && from <= segment.end && segment.start <= to && to <= segment.end);
141     ASSERT(is<RenderText>(segment.renderer));
142     if (m_style.font.isFixedPitch() || (from == segment.start && to == segment.end))
143         return downcast<RenderText>(segment.renderer).width(from - segment.start, to - from, m_style.font, xPosition, nullptr, nullptr);
144     return segment.text.is8Bit() ? runWidth<LChar>(segment, from, to, xPosition) : runWidth<UChar>(segment, from, to, xPosition);
145 }
146
147 unsigned TextFragmentIterator::skipToNextPosition(PositionType positionType, unsigned startPosition, float& width, float xPosition, bool& overlappingFragment)
148 {
149     overlappingFragment = false;
150     unsigned currentPosition = startPosition;
151     unsigned nextPosition = currentPosition;
152     // Collapsed whitespace has constant width. Do not measure it.
153     if (positionType == NonWhitespace)
154         nextPosition = m_currentSegment->text.is8Bit() ? nextNonWhitespacePosition<LChar>(*m_currentSegment, currentPosition) : nextNonWhitespacePosition<UChar>(*m_currentSegment, currentPosition);
155     else if (positionType == Breakable) {
156         // nextBreakablePosition returns the same position for certain characters such as hyphens. Call next again with modified position unless it's the end of the segment.
157         nextPosition = m_currentSegment->text.is8Bit() ? nextBreakablePosition<LChar>(*m_currentSegment, currentPosition) : nextBreakablePosition<UChar>(*m_currentSegment, currentPosition);
158         // We need to know whether the word actually finishes at the end of this renderer or not.
159         if (nextPosition == m_currentSegment->end) {
160             auto nextSegment = m_currentSegment;
161             ++nextSegment;
162             if (nextSegment != m_flowContents.end())
163                 overlappingFragment = nextPosition < (nextSegment->text.is8Bit() ? nextBreakablePosition<LChar>(*nextSegment, nextPosition) : nextBreakablePosition<UChar>(*nextSegment, nextPosition));
164         } else if (nextPosition == currentPosition) {
165             if (++nextPosition < m_currentSegment->end)
166                 nextPosition = m_currentSegment->text.is8Bit() ? nextBreakablePosition<LChar>(*m_currentSegment, currentPosition + 1) : nextBreakablePosition<UChar>(*m_currentSegment, currentPosition + 1);
167         }
168     }
169     width = 0;
170     if (nextPosition == currentPosition)
171         return currentPosition;
172     bool measureText = positionType != NonWhitespace || !m_style.collapseWhitespace;
173     if (measureText) {
174         float textWidth = this->textWidth(currentPosition, nextPosition, xPosition);
175         xPosition += textWidth;
176         width += textWidth;
177     } else if (startPosition < nextPosition)
178         width = m_style.spaceWidth;
179     return nextPosition;
180 }
181
182 template <typename CharacterType>
183 float TextFragmentIterator::runWidth(const FlowContents::Segment& segment, unsigned startPosition, unsigned endPosition, float xPosition) const
184 {
185     ASSERT(startPosition <= endPosition);
186     if (startPosition == endPosition)
187         return 0;
188     unsigned segmentFrom = startPosition - segment.start;
189     unsigned segmentTo = endPosition - segment.start;
190     bool measureWithEndSpace = m_style.collapseWhitespace && segmentTo < segment.text.length() && segment.text[segmentTo] == ' ';
191     if (measureWithEndSpace)
192         ++segmentTo;
193     TextRun run(segment.text.characters<CharacterType>() + segmentFrom, segmentTo - segmentFrom);
194     run.setXPos(xPosition);
195     run.setTabSize(!!m_style.tabWidth, m_style.tabWidth);
196     float width = m_style.font.width(run);
197     if (measureWithEndSpace)
198         width -= m_style.spaceWidth;
199     return width;
200 }
201
202 }
203 }