Use #pragma once in WebCore
[WebKit-https.git] / Source / WebCore / rendering / InlineIterator.h
1 /*
2  * Copyright (C) 2000 Lars Knoll (knoll@kde.org)
3  * Copyright (C) 2003, 2004, 2006, 2007, 2008, 2009, 2010 Apple Inc. All right reserved.
4  * Copyright (C) 2010 Google Inc. All rights reserved.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  *
21  */
22
23 #pragma once
24
25 #include "BidiRun.h"
26 #include "RenderBlockFlow.h"
27 #include "RenderChildIterator.h"
28 #include "RenderInline.h"
29 #include "RenderText.h"
30 #include <wtf/StdLibExtras.h>
31
32 namespace WebCore {
33
34 struct BidiIsolatedRun {
35     BidiIsolatedRun(RenderObject& object, unsigned position, RenderElement& root, BidiRun& runToReplace)
36         : object(object)
37         , root(root)
38         , runToReplace(runToReplace)
39         , position(position)
40     {
41     }
42
43     RenderObject& object;
44     RenderElement& root;
45     BidiRun& runToReplace;
46     unsigned position;
47 };
48
49 // This class is used to RenderInline subtrees, stepping by character within the
50 // text children. InlineIterator will use bidiNext to find the next RenderText
51 // optionally notifying a BidiResolver every time it steps into/out of a RenderInline.
52 class InlineIterator {
53 public:
54     InlineIterator()
55     {
56     }
57
58     InlineIterator(RenderElement* root, RenderObject* o, unsigned p)
59         : m_root(root)
60         , m_renderer(o)
61         , m_pos(p)
62         , m_refersToEndOfPreviousNode(false)
63     {
64     }
65
66     void clear()
67     {
68         setRenderer(nullptr);
69         setOffset(0);
70         setNextBreakablePosition(std::numeric_limits<unsigned>::max());
71     }
72     void moveToStartOf(RenderObject& object)
73     {
74         moveTo(object, 0);
75     }
76
77     void moveTo(RenderObject& object, unsigned offset, Optional<unsigned> nextBreak = Optional<unsigned>())
78     {
79         setRenderer(&object);
80         setOffset(offset);
81         setNextBreakablePosition(nextBreak);
82     }
83
84     RenderObject* renderer() const { return m_renderer; }
85     void setRenderer(RenderObject* renderer) { m_renderer = renderer; }
86     unsigned offset() const { return m_pos; }
87     void setOffset(unsigned position);
88     RenderElement* root() const { return m_root; }
89     Optional<unsigned> nextBreakablePosition() const { return m_nextBreakablePosition; }
90     void setNextBreakablePosition(Optional<unsigned> position) { m_nextBreakablePosition = position; }
91     bool refersToEndOfPreviousNode() const { return m_refersToEndOfPreviousNode; }
92     void setRefersToEndOfPreviousNode();
93
94     void fastIncrementInTextNode();
95     void increment(InlineBidiResolver* = nullptr);
96     void fastDecrement();
97     bool atEnd() const;
98
99     bool atTextParagraphSeparator() const
100     {
101         return is<RenderText>(m_renderer) && m_renderer->preservesNewline() && downcast<RenderText>(*m_renderer).characterAt(m_pos) == '\n';
102     }
103     
104     bool atParagraphSeparator() const
105     {
106         return (m_renderer && m_renderer->isBR()) || atTextParagraphSeparator();
107     }
108
109     UChar current() const;
110     UChar previousInSameNode() const;
111     ALWAYS_INLINE UCharDirection direction() const;
112
113 private:
114     UChar characterAt(unsigned) const;
115
116     UCharDirection surrogateTextDirection(UChar currentCodeUnit) const;
117
118     RenderElement* m_root { nullptr };
119     RenderObject* m_renderer { nullptr };
120
121     Optional<unsigned> m_nextBreakablePosition;
122     unsigned m_pos { 0 };
123
124     // There are a couple places where we want to decrement an InlineIterator.
125     // Usually this take the form of decrementing m_pos; however, m_pos might be 0.
126     // However, we shouldn't ever need to decrement an InlineIterator more than
127     // once, so rather than implementing a decrement() function which traverses
128     // nodes, we can simply keep track of this state and handle it.
129     bool m_refersToEndOfPreviousNode { false };
130 };
131
132 inline bool operator==(const InlineIterator& it1, const InlineIterator& it2)
133 {
134     return it1.offset() == it2.offset() && it1.renderer() == it2.renderer();
135 }
136
137 inline bool operator!=(const InlineIterator& it1, const InlineIterator& it2)
138 {
139     return it1.offset() != it2.offset() || it1.renderer() != it2.renderer();
140 }
141
142 static inline UCharDirection embedCharFromDirection(TextDirection direction, EUnicodeBidi unicodeBidi)
143 {
144     using namespace WTF::Unicode;
145     if (unicodeBidi == Embed)
146         return direction == RTL ? U_RIGHT_TO_LEFT_EMBEDDING : U_LEFT_TO_RIGHT_EMBEDDING;
147     return direction == RTL ? U_RIGHT_TO_LEFT_OVERRIDE : U_LEFT_TO_RIGHT_OVERRIDE;
148 }
149
150 template <class Observer>
151 static inline void notifyObserverEnteredObject(Observer* observer, RenderObject* object)
152 {
153     if (!observer || !object || !object->isRenderInline())
154         return;
155
156     const RenderStyle& style = object->style();
157     EUnicodeBidi unicodeBidi = style.unicodeBidi();
158     if (unicodeBidi == UBNormal) {
159         // http://dev.w3.org/csswg/css3-writing-modes/#unicode-bidi
160         // "The element does not open an additional level of embedding with respect to the bidirectional algorithm."
161         // Thus we ignore any possible dir= attribute on the span.
162         return;
163     }
164     if (isIsolated(unicodeBidi)) {
165         // Make sure that explicit embeddings are committed before we enter the isolated content.
166         observer->commitExplicitEmbedding();
167         observer->enterIsolate();
168         // Embedding/Override characters implied by dir= will be handled when
169         // we process the isolated span, not when laying out the "parent" run.
170         return;
171     }
172
173     if (!observer->inIsolate())
174         observer->embed(embedCharFromDirection(style.direction(), unicodeBidi), FromStyleOrDOM);
175 }
176
177 template <class Observer>
178 static inline void notifyObserverWillExitObject(Observer* observer, RenderObject* object)
179 {
180     if (!observer || !object || !object->isRenderInline())
181         return;
182
183     EUnicodeBidi unicodeBidi = object->style().unicodeBidi();
184     if (unicodeBidi == UBNormal)
185         return; // Nothing to do for unicode-bidi: normal
186     if (isIsolated(unicodeBidi)) {
187         observer->exitIsolate();
188         return;
189     }
190
191     // Otherwise we pop any embed/override character we added when we opened this tag.
192     if (!observer->inIsolate())
193         observer->embed(U_POP_DIRECTIONAL_FORMAT, FromStyleOrDOM);
194 }
195
196 static inline bool isIteratorTarget(RenderObject* object)
197 {
198     ASSERT(object); // The iterator will of course return 0, but its not an expected argument to this function.
199     return object->isTextOrLineBreak() || object->isFloating() || object->isOutOfFlowPositioned() || object->isReplaced();
200 }
201
202 // This enum is only used for bidiNextShared()
203 enum EmptyInlineBehavior {
204     SkipEmptyInlines,
205     IncludeEmptyInlines,
206 };
207
208 static bool isEmptyInline(const RenderInline& renderer)
209 {
210     for (auto& current : childrenOfType<RenderObject>(renderer)) {
211         if (current.isFloatingOrOutOfFlowPositioned())
212             continue;
213         if (is<RenderText>(current)) {
214             if (!downcast<RenderText>(current).isAllCollapsibleWhitespace())
215                 return false;
216             continue;
217         }
218         if (!is<RenderInline>(current) || !isEmptyInline(downcast<RenderInline>(current)))
219             return false;
220     }
221     return true;
222 }
223
224 // FIXME: This function is misleadingly named. It has little to do with bidi.
225 // This function will iterate over inlines within a block, optionally notifying
226 // a bidi resolver as it enters/exits inlines (so it can push/pop embedding levels).
227 template <class Observer>
228 static inline RenderObject* bidiNextShared(RenderElement& root, RenderObject* current, Observer* observer = nullptr, EmptyInlineBehavior emptyInlineBehavior = SkipEmptyInlines, bool* endOfInlinePtr = nullptr)
229 {
230     RenderObject* next = nullptr;
231     // oldEndOfInline denotes if when we last stopped iterating if we were at the end of an inline.
232     bool oldEndOfInline = endOfInlinePtr ? *endOfInlinePtr : false;
233     bool endOfInline = false;
234
235     while (current) {
236         next = nullptr;
237         if (!oldEndOfInline && !isIteratorTarget(current)) {
238             next = downcast<RenderElement>(*current).firstChild();
239             notifyObserverEnteredObject(observer, next);
240         }
241
242         // We hit this when either current has no children, or when current is not a renderer we care about.
243         if (!next) {
244             // If it is a renderer we care about, and we're doing our inline-walk, return it.
245             if (emptyInlineBehavior == IncludeEmptyInlines && !oldEndOfInline && is<RenderInline>(*current)) {
246                 next = current;
247                 endOfInline = true;
248                 break;
249             }
250
251             while (current && current != &root) {
252                 notifyObserverWillExitObject(observer, current);
253
254                 next = current->nextSibling();
255                 if (next) {
256                     notifyObserverEnteredObject(observer, next);
257                     break;
258                 }
259
260                 current = current->parent();
261                 if (emptyInlineBehavior == IncludeEmptyInlines && current && current != &root && is<RenderInline>(*current)) {
262                     next = current;
263                     endOfInline = true;
264                     break;
265                 }
266             }
267         }
268
269         if (!next)
270             break;
271
272         if (isIteratorTarget(next)
273             || (is<RenderInline>(*next) && (emptyInlineBehavior == IncludeEmptyInlines || isEmptyInline(downcast<RenderInline>(*next)))))
274             break;
275         current = next;
276     }
277
278     if (endOfInlinePtr)
279         *endOfInlinePtr = endOfInline;
280
281     return next;
282 }
283
284 template <class Observer>
285 static inline RenderObject* bidiNextSkippingEmptyInlines(RenderElement& root, RenderObject* current, Observer* observer)
286 {
287     // The SkipEmptyInlines callers never care about endOfInlinePtr.
288     return bidiNextShared(root, current, observer, SkipEmptyInlines);
289 }
290
291 // This makes callers cleaner as they don't have to specify a type for the observer when not providing one.
292 static inline RenderObject* bidiNextSkippingEmptyInlines(RenderElement& root, RenderObject* current)
293 {
294     InlineBidiResolver* observer = nullptr;
295     return bidiNextSkippingEmptyInlines(root, current, observer);
296 }
297
298 static inline RenderObject* bidiNextIncludingEmptyInlines(RenderElement& root, RenderObject* current, bool* endOfInlinePtr = nullptr)
299 {
300     InlineBidiResolver* observer = nullptr; // Callers who include empty inlines, never use an observer.
301     return bidiNextShared(root, current, observer, IncludeEmptyInlines, endOfInlinePtr);
302 }
303
304 static inline RenderObject* bidiFirstSkippingEmptyInlines(RenderElement& root, InlineBidiResolver* resolver = nullptr)
305 {
306     RenderObject* renderer = root.firstChild();
307     if (!renderer)
308         return nullptr;
309
310     if (is<RenderInline>(*renderer)) {
311         notifyObserverEnteredObject(resolver, renderer);
312         if (!isEmptyInline(downcast<RenderInline>(*renderer)))
313             renderer = bidiNextSkippingEmptyInlines(root, renderer, resolver);
314         else {
315             // Never skip empty inlines.
316             if (resolver)
317                 resolver->commitExplicitEmbedding();
318             return renderer;
319         }
320     }
321
322     // FIXME: Unify this with the bidiNext call above.
323     if (renderer && !isIteratorTarget(renderer))
324         renderer = bidiNextSkippingEmptyInlines(root, renderer, resolver);
325
326     if (resolver)
327         resolver->commitExplicitEmbedding();
328     return renderer;
329 }
330
331 // FIXME: This method needs to be renamed when bidiNext finds a good name.
332 static inline RenderObject* bidiFirstIncludingEmptyInlines(RenderElement& root)
333 {
334     RenderObject* o = root.firstChild();
335     // If either there are no children to walk, or the first one is correct
336     // then just return it.
337     if (!o || o->isRenderInline() || isIteratorTarget(o))
338         return o;
339
340     return bidiNextIncludingEmptyInlines(root, o);
341 }
342
343 inline void InlineIterator::fastIncrementInTextNode()
344 {
345     ASSERT(m_renderer);
346     ASSERT(m_pos <= downcast<RenderText>(*m_renderer).textLength());
347     ++m_pos;
348 }
349
350 inline void InlineIterator::setOffset(unsigned position)
351 {
352     ASSERT(position <= UINT_MAX - 10); // Sanity check
353     m_pos = position;
354 }
355
356 inline void InlineIterator::setRefersToEndOfPreviousNode()
357 {
358     ASSERT(!m_pos);
359     ASSERT(!m_refersToEndOfPreviousNode);
360     m_refersToEndOfPreviousNode = true;
361 }
362
363 // FIXME: This is used by RenderBlock for simplified layout, and has nothing to do with bidi
364 // it shouldn't use functions called bidiFirst and bidiNext.
365 class InlineWalker {
366 public:
367     InlineWalker(RenderElement& root)
368         : m_root(root)
369         , m_current(nullptr)
370         , m_atEndOfInline(false)
371     {
372         // FIXME: This class should be taught how to do the SkipEmptyInlines codepath as well.
373         m_current = bidiFirstIncludingEmptyInlines(m_root);
374     }
375
376     RenderElement& root() { return m_root; }
377     RenderObject* current() { return m_current; }
378
379     bool atEndOfInline() { return m_atEndOfInline; }
380     bool atEnd() const { return !m_current; }
381
382     RenderObject* advance()
383     {
384         // FIXME: Support SkipEmptyInlines and observer parameters.
385         m_current = bidiNextIncludingEmptyInlines(m_root, m_current, &m_atEndOfInline);
386         return m_current;
387     }
388 private:
389     RenderElement& m_root;
390     RenderObject* m_current;
391     bool m_atEndOfInline;
392 };
393
394 inline void InlineIterator::increment(InlineBidiResolver* resolver)
395 {
396     if (!m_renderer)
397         return;
398     if (is<RenderText>(*m_renderer)) {
399         fastIncrementInTextNode();
400         if (m_pos < downcast<RenderText>(*m_renderer).textLength())
401             return;
402     }
403     // bidiNext can return nullptr
404     RenderObject* bidiNext = bidiNextSkippingEmptyInlines(*m_root, m_renderer, resolver);
405     if (bidiNext)
406         moveToStartOf(*bidiNext);
407     else
408         clear();
409 }
410
411 inline void InlineIterator::fastDecrement()
412 {
413     ASSERT(!refersToEndOfPreviousNode());
414     if (m_pos)
415         setOffset(m_pos - 1);
416     else
417         setRefersToEndOfPreviousNode();
418 }
419
420 inline bool InlineIterator::atEnd() const
421 {
422     return !m_renderer;
423 }
424
425 inline UChar InlineIterator::characterAt(unsigned index) const
426 {
427     if (!is<RenderText>(m_renderer))
428         return 0;
429
430     return downcast<RenderText>(*m_renderer).characterAt(index);
431 }
432
433 inline UChar InlineIterator::current() const
434 {
435     return characterAt(m_pos);
436 }
437
438 inline UChar InlineIterator::previousInSameNode() const
439 {
440     return characterAt(m_pos - 1);
441 }
442
443 ALWAYS_INLINE UCharDirection InlineIterator::direction() const
444 {
445     if (UNLIKELY(!m_renderer))
446         return U_OTHER_NEUTRAL;
447
448     if (LIKELY(is<RenderText>(*m_renderer))) {
449         UChar codeUnit = downcast<RenderText>(*m_renderer).characterAt(m_pos);
450         if (LIKELY(U16_IS_SINGLE(codeUnit)))
451             return u_charDirection(codeUnit);
452         return surrogateTextDirection(codeUnit);
453     }
454
455     if (m_renderer->isListMarker())
456         return m_renderer->style().isLeftToRightDirection() ? U_LEFT_TO_RIGHT : U_RIGHT_TO_LEFT;
457
458     return U_OTHER_NEUTRAL;
459 }
460
461 template<>
462 inline void InlineBidiResolver::incrementInternal()
463 {
464     m_current.increment(this);
465 }
466
467 static inline bool isIsolatedInline(RenderObject& object)
468 {
469     return object.isRenderInline() && isIsolated(object.style().unicodeBidi());
470 }
471
472 static inline RenderObject* highestContainingIsolateWithinRoot(RenderObject& initialObject, RenderObject* root)
473 {
474     RenderObject* containingIsolateObject = nullptr;
475     for (RenderObject* object = &initialObject; object && object != root; object = object->parent()) {
476         if (isIsolatedInline(*object))
477             containingIsolateObject = object;
478     }
479     return containingIsolateObject;
480 }
481
482 static inline unsigned numberOfIsolateAncestors(const InlineIterator& iter)
483 {
484     unsigned count = 0;
485     typedef RenderObject* RenderObjectPtr;
486     for (RenderObjectPtr object = iter.renderer(), root = iter.root(); object && object != root; object = object->parent()) {
487         if (isIsolatedInline(*object))
488             count++;
489     }
490     return count;
491 }
492
493 // FIXME: This belongs on InlineBidiResolver, except it's a template specialization
494 // of BidiResolver which knows nothing about RenderObjects.
495 static inline void addPlaceholderRunForIsolatedInline(InlineBidiResolver& resolver, RenderObject& obj, unsigned pos, RenderElement& root)
496 {
497     std::unique_ptr<BidiRun> isolatedRun = std::make_unique<BidiRun>(pos, pos, obj, resolver.context(), resolver.dir());
498     // FIXME: isolatedRuns() could be a hash of object->run and then we could cheaply
499     // ASSERT here that we didn't create multiple objects for the same inline.
500     resolver.setWhitespaceCollapsingTransitionForIsolatedRun(*isolatedRun, resolver.whitespaceCollapsingState().currentTransition());
501     resolver.isolatedRuns().append(BidiIsolatedRun(obj, pos, root, *isolatedRun));
502     resolver.runs().appendRun(WTFMove(isolatedRun));
503 }
504
505 class IsolateTracker {
506 public:
507     explicit IsolateTracker(unsigned nestedIsolateCount)
508         : m_nestedIsolateCount(nestedIsolateCount)
509         , m_haveAddedFakeRunForRootIsolate(false)
510     {
511     }
512
513     void enterIsolate() { m_nestedIsolateCount++; }
514     void exitIsolate()
515     {
516         ASSERT(m_nestedIsolateCount >= 1);
517         m_nestedIsolateCount--;
518         if (!inIsolate())
519             m_haveAddedFakeRunForRootIsolate = false;
520     }
521     bool inIsolate() const { return m_nestedIsolateCount; }
522
523     // We don't care if we encounter bidi directional overrides.
524     void embed(UCharDirection, BidiEmbeddingSource) { }
525     void commitExplicitEmbedding() { }
526
527     void addFakeRunIfNecessary(RenderObject& obj, unsigned pos, unsigned end, RenderElement& root, InlineBidiResolver& resolver)
528     {
529         // We only need to add a fake run for a given isolated span once during each call to createBidiRunsForLine.
530         // We'll be called for every span inside the isolated span so we just ignore subsequent calls.
531         // We also avoid creating a fake run until we hit a child that warrants one, e.g. we skip floats.
532         if (RenderBlock::shouldSkipCreatingRunsForObject(obj))
533             return;
534         if (!m_haveAddedFakeRunForRootIsolate) {
535             // obj and pos together denote a single position in the inline, from which the parsing of the isolate will start.
536             // We don't need to mark the end of the run because this is implicit: it is either endOfLine or the end of the
537             // isolate, when we call createBidiRunsForLine it will stop at whichever comes first.
538             addPlaceholderRunForIsolatedInline(resolver, obj, pos, root);
539         }
540         m_haveAddedFakeRunForRootIsolate = true;
541         RenderBlockFlow::appendRunsForObject(nullptr, pos, end, obj, resolver);
542     }
543
544 private:
545     unsigned m_nestedIsolateCount;
546     bool m_haveAddedFakeRunForRootIsolate;
547 };
548
549 template<>
550 inline void InlineBidiResolver::appendRunInternal()
551 {
552     if (!m_emptyRun && !m_eor.atEnd() && !m_reachedEndOfLine) {
553         // Keep track of when we enter/leave "unicode-bidi: isolate" inlines.
554         // Initialize our state depending on if we're starting in the middle of such an inline.
555         // FIXME: Could this initialize from this->inIsolate() instead of walking up the render tree?
556         IsolateTracker isolateTracker(numberOfIsolateAncestors(m_sor));
557         int start = m_sor.offset();
558         RenderObject* obj = m_sor.renderer();
559         while (obj && obj != m_eor.renderer() && obj != endOfLine.renderer()) {
560             if (isolateTracker.inIsolate())
561                 isolateTracker.addFakeRunIfNecessary(*obj, start, obj->length(), *m_sor.root(), *this);
562             else
563                 RenderBlockFlow::appendRunsForObject(&m_runs, start, obj->length(), *obj, *this);
564             // FIXME: start/obj should be an InlineIterator instead of two separate variables.
565             start = 0;
566             obj = bidiNextSkippingEmptyInlines(*m_sor.root(), obj, &isolateTracker);
567         }
568         if (obj) {
569             unsigned pos = obj == m_eor.renderer() ? m_eor.offset() : UINT_MAX;
570             if (obj == endOfLine.renderer() && endOfLine.offset() <= pos) {
571                 m_reachedEndOfLine = true;
572                 pos = endOfLine.offset();
573             }
574             // It's OK to add runs for zero-length RenderObjects, just don't make the run larger than it should be
575             int end = obj->length() ? pos + 1 : 0;
576             if (isolateTracker.inIsolate())
577                 isolateTracker.addFakeRunIfNecessary(*obj, start, obj->length(), *m_sor.root(), *this);
578             else
579                 RenderBlockFlow::appendRunsForObject(&m_runs, start, end, *obj, *this);
580         }
581
582         m_eor.increment();
583         m_sor = m_eor;
584     }
585
586     m_direction = U_OTHER_NEUTRAL;
587     m_status.eor = U_OTHER_NEUTRAL;
588 }
589
590 } // namespace WebCore