c4900328edb9262b50fd60f4781ef029c218abbf
[WebKit-https.git] / Source / WebCore / rendering / InlineTextBox.cpp
1 /*
2  * (C) 1999 Lars Knoll (knoll@kde.org)
3  * (C) 2000 Dirk Mueller (mueller@kde.org)
4  * Copyright (C) 2004-2017 Apple 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 #include "config.h"
24 #include "InlineTextBox.h"
25
26 #include "BreakLines.h"
27 #include "DashArray.h"
28 #include "Document.h"
29 #include "DocumentMarkerController.h"
30 #include "Editor.h"
31 #include "EllipsisBox.h"
32 #include "Frame.h"
33 #include "GraphicsContext.h"
34 #include "HitTestResult.h"
35 #include "ImageBuffer.h"
36 #include "InlineTextBoxStyle.h"
37 #include "MarkerSubrange.h"
38 #include "Page.h"
39 #include "PaintInfo.h"
40 #include "RenderBlock.h"
41 #include "RenderCombineText.h"
42 #include "RenderLineBreak.h"
43 #include "RenderRubyRun.h"
44 #include "RenderRubyText.h"
45 #include "RenderTheme.h"
46 #include "RenderView.h"
47 #include "RenderedDocumentMarker.h"
48 #include "Text.h"
49 #include "TextDecorationPainter.h"
50 #include "TextPaintStyle.h"
51 #include "TextPainter.h"
52 #include <stdio.h>
53 #include <wtf/IsoMallocInlines.h>
54 #include <wtf/text/CString.h>
55 #include <wtf/text/TextStream.h>
56
57 namespace WebCore {
58
59 WTF_MAKE_ISO_ALLOCATED_IMPL(InlineTextBox);
60
61 struct SameSizeAsInlineTextBox : public InlineBox {
62     unsigned variables[1];
63     unsigned short variables2[2];
64     void* pointers[2];
65 };
66
67 COMPILE_ASSERT(sizeof(InlineTextBox) == sizeof(SameSizeAsInlineTextBox), InlineTextBox_should_stay_small);
68
69 typedef WTF::HashMap<const InlineTextBox*, LayoutRect> InlineTextBoxOverflowMap;
70 static InlineTextBoxOverflowMap* gTextBoxesWithOverflow;
71
72 InlineTextBox::~InlineTextBox()
73 {
74     if (!knownToHaveNoOverflow() && gTextBoxesWithOverflow)
75         gTextBoxesWithOverflow->remove(this);
76 }
77
78 void InlineTextBox::markDirty(bool dirty)
79 {
80     if (dirty) {
81         m_len = 0;
82         m_start = 0;
83     }
84     InlineBox::markDirty(dirty);
85 }
86
87 LayoutRect InlineTextBox::logicalOverflowRect() const
88 {
89     if (knownToHaveNoOverflow() || !gTextBoxesWithOverflow)
90         return enclosingIntRect(logicalFrameRect());
91     return gTextBoxesWithOverflow->get(this);
92 }
93
94 void InlineTextBox::setLogicalOverflowRect(const LayoutRect& rect)
95 {
96     ASSERT(!knownToHaveNoOverflow());
97     if (!gTextBoxesWithOverflow)
98         gTextBoxesWithOverflow = new InlineTextBoxOverflowMap;
99     gTextBoxesWithOverflow->add(this, rect);
100 }
101
102 int InlineTextBox::baselinePosition(FontBaseline baselineType) const
103 {
104     if (!parent())
105         return 0;
106     if (&parent()->renderer() == renderer().parent())
107         return parent()->baselinePosition(baselineType);
108     return downcast<RenderBoxModelObject>(*renderer().parent()).baselinePosition(baselineType, isFirstLine(), isHorizontal() ? HorizontalLine : VerticalLine, PositionOnContainingLine);
109 }
110
111 LayoutUnit InlineTextBox::lineHeight() const
112 {
113     if (!renderer().parent())
114         return 0;
115     if (&parent()->renderer() == renderer().parent())
116         return parent()->lineHeight();
117     return downcast<RenderBoxModelObject>(*renderer().parent()).lineHeight(isFirstLine(), isHorizontal() ? HorizontalLine : VerticalLine, PositionOnContainingLine);
118 }
119
120 LayoutUnit InlineTextBox::selectionTop() const
121 {
122     return root().selectionTop();
123 }
124
125 LayoutUnit InlineTextBox::selectionBottom() const
126 {
127     return root().selectionBottom();
128 }
129
130 LayoutUnit InlineTextBox::selectionHeight() const
131 {
132     return root().selectionHeight();
133 }
134
135 bool InlineTextBox::isSelected(unsigned startPosition, unsigned endPosition) const
136 {
137     return clampedOffset(startPosition) < clampedOffset(endPosition);
138 }
139
140 RenderObject::SelectionState InlineTextBox::selectionState()
141 {
142     RenderObject::SelectionState state = renderer().selectionState();
143     if (state == RenderObject::SelectionStart || state == RenderObject::SelectionEnd || state == RenderObject::SelectionBoth) {
144         auto& selection = renderer().view().selection();
145         auto startPos = selection.startPosition();
146         auto endPos = selection.endPosition();
147         // The position after a hard line break is considered to be past its end.
148         ASSERT(start() + len() >= (isLineBreak() ? 1 : 0));
149         unsigned lastSelectable = start() + len() - (isLineBreak() ? 1 : 0);
150
151         bool start = (state != RenderObject::SelectionEnd && startPos >= m_start && startPos < m_start + m_len);
152         bool end = (state != RenderObject::SelectionStart && endPos > m_start && endPos <= lastSelectable);
153         if (start && end)
154             state = RenderObject::SelectionBoth;
155         else if (start)
156             state = RenderObject::SelectionStart;
157         else if (end)
158             state = RenderObject::SelectionEnd;
159         else if ((state == RenderObject::SelectionEnd || startPos < m_start) &&
160                  (state == RenderObject::SelectionStart || endPos > lastSelectable))
161             state = RenderObject::SelectionInside;
162         else if (state == RenderObject::SelectionBoth)
163             state = RenderObject::SelectionNone;
164     }
165
166     // If there are ellipsis following, make sure their selection is updated.
167     if (m_truncation != cNoTruncation && root().ellipsisBox()) {
168         EllipsisBox* ellipsis = root().ellipsisBox();
169         if (state != RenderObject::SelectionNone) {
170             unsigned selectionStart;
171             unsigned selectionEnd;
172             std::tie(selectionStart, selectionEnd) = selectionStartEnd();
173             // The ellipsis should be considered to be selected if the end of
174             // the selection is past the beginning of the truncation and the
175             // beginning of the selection is before or at the beginning of the
176             // truncation.
177             ellipsis->setSelectionState(selectionEnd >= m_truncation && selectionStart <= m_truncation ?
178                 RenderObject::SelectionInside : RenderObject::SelectionNone);
179         } else
180             ellipsis->setSelectionState(RenderObject::SelectionNone);
181     }
182
183     return state;
184 }
185
186 inline const FontCascade& InlineTextBox::lineFont() const
187 {
188     return combinedText() ? combinedText()->textCombineFont() : lineStyle().fontCascade();
189 }
190
191 // FIXME: Share more code with paintTextSubrangeBackground().
192 LayoutRect InlineTextBox::localSelectionRect(unsigned startPos, unsigned endPos) const
193 {
194     unsigned sPos = clampedOffset(startPos);
195     unsigned ePos = clampedOffset(endPos);
196
197     if (sPos >= ePos && !(startPos == endPos && startPos >= start() && startPos <= (start() + len())))
198         return { };
199
200     LayoutUnit selectionTop = this->selectionTop();
201     LayoutUnit selectionHeight = this->selectionHeight();
202
203     auto text = this->text();
204     TextRun textRun = createTextRun(text);
205
206     LayoutRect selectionRect = LayoutRect(LayoutPoint(logicalLeft(), selectionTop), LayoutSize(m_logicalWidth, selectionHeight));
207     // Avoid measuring the text when the entire line box is selected as an optimization.
208     if (sPos || ePos != textRun.length())
209         lineFont().adjustSelectionRectForText(textRun, selectionRect, sPos, ePos);
210     // FIXME: The computation of the snapped selection rect differs from the computation of this rect
211     // in paintTextSubrangeBackground(). See <https://bugs.webkit.org/show_bug.cgi?id=138913>.
212     IntRect snappedSelectionRect = enclosingIntRect(selectionRect);
213     LayoutUnit logicalWidth = snappedSelectionRect.width();
214     if (snappedSelectionRect.x() > logicalRight())
215         logicalWidth  = 0;
216     else if (snappedSelectionRect.maxX() > logicalRight())
217         logicalWidth = logicalRight() - snappedSelectionRect.x();
218
219     LayoutPoint topPoint = isHorizontal() ? LayoutPoint(snappedSelectionRect.x(), selectionTop) : LayoutPoint(selectionTop, snappedSelectionRect.x());
220     LayoutUnit width = isHorizontal() ? logicalWidth : selectionHeight;
221     LayoutUnit height = isHorizontal() ? selectionHeight : logicalWidth;
222
223     return LayoutRect(topPoint, LayoutSize(width, height));
224 }
225
226 void InlineTextBox::deleteLine()
227 {
228     renderer().removeTextBox(*this);
229     delete this;
230 }
231
232 void InlineTextBox::extractLine()
233 {
234     if (extracted())
235         return;
236
237     renderer().extractTextBox(*this);
238 }
239
240 void InlineTextBox::attachLine()
241 {
242     if (!extracted())
243         return;
244     
245     renderer().attachTextBox(*this);
246 }
247
248 float InlineTextBox::placeEllipsisBox(bool flowIsLTR, float visibleLeftEdge, float visibleRightEdge, float ellipsisWidth, float &truncatedWidth, bool& foundBox)
249 {
250     if (foundBox) {
251         m_truncation = cFullTruncation;
252         return -1;
253     }
254
255     // For LTR this is the left edge of the box, for RTL, the right edge in parent coordinates.
256     float ellipsisX = flowIsLTR ? visibleRightEdge - ellipsisWidth : visibleLeftEdge + ellipsisWidth;
257     
258     // Criteria for full truncation:
259     // LTR: the left edge of the ellipsis is to the left of our text run.
260     // RTL: the right edge of the ellipsis is to the right of our text run.
261     bool ltrFullTruncation = flowIsLTR && ellipsisX <= left();
262     bool rtlFullTruncation = !flowIsLTR && ellipsisX >= left() + logicalWidth();
263     if (ltrFullTruncation || rtlFullTruncation) {
264         // Too far.  Just set full truncation, but return -1 and let the ellipsis just be placed at the edge of the box.
265         m_truncation = cFullTruncation;
266         foundBox = true;
267         return -1;
268     }
269
270     bool ltrEllipsisWithinBox = flowIsLTR && (ellipsisX < right());
271     bool rtlEllipsisWithinBox = !flowIsLTR && (ellipsisX > left());
272     if (ltrEllipsisWithinBox || rtlEllipsisWithinBox) {
273         foundBox = true;
274
275         // The inline box may have different directionality than it's parent.  Since truncation
276         // behavior depends both on both the parent and the inline block's directionality, we
277         // must keep track of these separately.
278         bool ltr = isLeftToRightDirection();
279         if (ltr != flowIsLTR) {
280           // Width in pixels of the visible portion of the box, excluding the ellipsis.
281           int visibleBoxWidth = visibleRightEdge - visibleLeftEdge  - ellipsisWidth;
282           ellipsisX = ltr ? left() + visibleBoxWidth : right() - visibleBoxWidth;
283         }
284
285         int offset = offsetForPosition(ellipsisX, false);
286         if (offset == 0) {
287             // No characters should be rendered.  Set ourselves to full truncation and place the ellipsis at the min of our start
288             // and the ellipsis edge.
289             m_truncation = cFullTruncation;
290             truncatedWidth += ellipsisWidth;
291             return flowIsLTR ? std::min(ellipsisX, x()) : std::max(ellipsisX, right() - ellipsisWidth);
292         }
293
294         // Set the truncation index on the text run.
295         m_truncation = offset;
296
297         // If we got here that means that we were only partially truncated and we need to return the pixel offset at which
298         // to place the ellipsis.
299         float widthOfVisibleText = renderer().width(m_start, offset, textPos(), isFirstLine());
300
301         // The ellipsis needs to be placed just after the last visible character.
302         // Where "after" is defined by the flow directionality, not the inline
303         // box directionality.
304         // e.g. In the case of an LTR inline box truncated in an RTL flow then we can
305         // have a situation such as |Hello| -> |...He|
306         truncatedWidth += widthOfVisibleText + ellipsisWidth;
307         if (flowIsLTR)
308             return left() + widthOfVisibleText;
309         else
310             return right() - widthOfVisibleText - ellipsisWidth;
311     }
312     truncatedWidth += logicalWidth();
313     return -1;
314 }
315
316
317
318 bool InlineTextBox::isLineBreak() const
319 {
320     return renderer().style().preserveNewline() && len() == 1 && renderer().text()[start()] == '\n';
321 }
322
323 bool InlineTextBox::nodeAtPoint(const HitTestRequest& request, HitTestResult& result, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, LayoutUnit /* lineTop */, LayoutUnit /*lineBottom*/,
324     HitTestAction /*hitTestAction*/)
325 {
326     if (!visibleToHitTesting())
327         return false;
328
329     if (isLineBreak())
330         return false;
331
332     if (m_truncation == cFullTruncation)
333         return false;
334
335     FloatRect rect(locationIncludingFlipping(), size());
336     // Make sure truncated text is ignored while hittesting.
337     if (m_truncation != cNoTruncation) {
338         LayoutUnit widthOfVisibleText = renderer().width(m_start, m_truncation, textPos(), isFirstLine());
339
340         if (isHorizontal())
341             renderer().style().isLeftToRightDirection() ? rect.setWidth(widthOfVisibleText) : rect.shiftXEdgeTo(right() - widthOfVisibleText);
342         else
343             rect.setHeight(widthOfVisibleText);
344     }
345
346     rect.moveBy(accumulatedOffset);
347
348     if (locationInContainer.intersects(rect)) {
349         renderer().updateHitTestResult(result, flipForWritingMode(locationInContainer.point() - toLayoutSize(accumulatedOffset)));
350         if (result.addNodeToListBasedTestResult(renderer().textNode(), request, locationInContainer, rect) == HitTestProgress::Stop)
351             return true;
352     }
353     return false;
354 }
355
356 static inline bool emphasisPositionHasNeitherLeftNorRight(TextEmphasisPosition emphasisPosition)
357 {
358     return !(emphasisPosition & TextEmphasisPositionLeft) && !(emphasisPosition & TextEmphasisPositionRight);
359 }
360
361 bool InlineTextBox::emphasisMarkExistsAndIsAbove(const RenderStyle& style, bool& above) const
362 {
363     // This function returns true if there are text emphasis marks and they are suppressed by ruby text.
364     if (style.textEmphasisMark() == TextEmphasisMarkNone)
365         return false;
366
367     TextEmphasisPosition emphasisPosition = style.textEmphasisPosition();
368     ASSERT(!((emphasisPosition & TextEmphasisPositionOver) && (emphasisPosition & TextEmphasisPositionUnder)));
369     ASSERT(!((emphasisPosition & TextEmphasisPositionLeft) && (emphasisPosition & TextEmphasisPositionRight)));
370     
371     if (emphasisPositionHasNeitherLeftNorRight(emphasisPosition))
372         above = emphasisPosition & TextEmphasisPositionOver;
373     else if (style.isHorizontalWritingMode())
374         above = emphasisPosition & TextEmphasisPositionOver;
375     else
376         above = emphasisPosition & TextEmphasisPositionRight;
377     
378     if ((style.isHorizontalWritingMode() && (emphasisPosition & TextEmphasisPositionUnder))
379         || (!style.isHorizontalWritingMode() && (emphasisPosition & TextEmphasisPositionLeft)))
380         return true; // Ruby text is always over, so it cannot suppress emphasis marks under.
381
382     RenderBlock* containingBlock = renderer().containingBlock();
383     if (!containingBlock->isRubyBase())
384         return true; // This text is not inside a ruby base, so it does not have ruby text over it.
385
386     if (!is<RenderRubyRun>(*containingBlock->parent()))
387         return true; // Cannot get the ruby text.
388
389     RenderRubyText* rubyText = downcast<RenderRubyRun>(*containingBlock->parent()).rubyText();
390
391     // The emphasis marks over are suppressed only if there is a ruby text box and it not empty.
392     return !rubyText || !rubyText->hasLines();
393 }
394
395 struct InlineTextBox::MarkerSubrangeStyle {
396     bool operator==(const MarkerSubrangeStyle& other) const
397     {
398         return backgroundColor == other.backgroundColor && textStyles == other.textStyles
399             && textDecorationStyles == other.textDecorationStyles && textShadow == other.textShadow
400             && alpha == other.alpha;
401     }
402     bool operator!=(const MarkerSubrangeStyle& other) const { return !(*this == other); }
403
404     Color backgroundColor;
405     TextPaintStyle textStyles;
406     TextDecorationPainter::Styles textDecorationStyles;
407     const ShadowData* textShadow;
408     float alpha;
409 };
410
411 struct InlineTextBox::StyledMarkerSubrange : MarkerSubrange {
412     StyledMarkerSubrange(const MarkerSubrange& marker)
413         : MarkerSubrange { marker }
414     {
415     }
416
417     MarkerSubrangeStyle style;
418 };
419
420 static MarkerSubrange createMarkerSubrangeFromSelectionInBox(const InlineTextBox& box)
421 {
422     unsigned selectionStart;
423     unsigned selectionEnd;
424     std::tie(selectionStart, selectionEnd) = box.selectionStartEnd();
425     if (selectionStart < selectionEnd)
426         return { selectionStart, selectionEnd, MarkerSubrange::Selection };
427     return { };
428 }
429
430 void InlineTextBox::paint(PaintInfo& paintInfo, const LayoutPoint& paintOffset, LayoutUnit /*lineTop*/, LayoutUnit /*lineBottom*/)
431 {
432     if (isLineBreak() || !paintInfo.shouldPaintWithinRoot(renderer()) || renderer().style().visibility() != VISIBLE
433         || m_truncation == cFullTruncation || paintInfo.phase == PaintPhaseOutline || !m_len)
434         return;
435
436     ASSERT(paintInfo.phase != PaintPhaseSelfOutline && paintInfo.phase != PaintPhaseChildOutlines);
437
438     LayoutUnit logicalLeftSide = logicalLeftVisualOverflow();
439     LayoutUnit logicalRightSide = logicalRightVisualOverflow();
440     LayoutUnit logicalStart = logicalLeftSide + (isHorizontal() ? paintOffset.x() : paintOffset.y());
441     LayoutUnit logicalExtent = logicalRightSide - logicalLeftSide;
442     
443     LayoutUnit paintEnd = isHorizontal() ? paintInfo.rect.maxX() : paintInfo.rect.maxY();
444     LayoutUnit paintStart = isHorizontal() ? paintInfo.rect.x() : paintInfo.rect.y();
445     
446     FloatPoint localPaintOffset(paintOffset);
447     
448     if (logicalStart >= paintEnd || logicalStart + logicalExtent <= paintStart)
449         return;
450
451     bool isPrinting = renderer().document().printing();
452     
453     // Determine whether or not we're selected.
454     bool haveSelection = !isPrinting && paintInfo.phase != PaintPhaseTextClip && selectionState() != RenderObject::SelectionNone;
455     if (!haveSelection && paintInfo.phase == PaintPhaseSelection)
456         // When only painting the selection, don't bother to paint if there is none.
457         return;
458
459     if (m_truncation != cNoTruncation) {
460         if (renderer().containingBlock()->style().isLeftToRightDirection() != isLeftToRightDirection()) {
461             // Make the visible fragment of text hug the edge closest to the rest of the run by moving the origin
462             // at which we start drawing text.
463             // e.g. In the case of LTR text truncated in an RTL Context, the correct behavior is:
464             // |Hello|CBA| -> |...He|CBA|
465             // In order to draw the fragment "He" aligned to the right edge of it's box, we need to start drawing
466             // farther to the right.
467             // NOTE: WebKit's behavior differs from that of IE which appears to just overlay the ellipsis on top of the
468             // truncated string i.e.  |Hello|CBA| -> |...lo|CBA|
469             LayoutUnit widthOfVisibleText = renderer().width(m_start, m_truncation, textPos(), isFirstLine());
470             LayoutUnit widthOfHiddenText = m_logicalWidth - widthOfVisibleText;
471             LayoutSize truncationOffset(isLeftToRightDirection() ? widthOfHiddenText : -widthOfHiddenText, 0);
472             localPaintOffset.move(isHorizontal() ? truncationOffset : truncationOffset.transposedSize());
473         }
474     }
475
476     GraphicsContext& context = paintInfo.context();
477
478     const RenderStyle& lineStyle = this->lineStyle();
479     
480     localPaintOffset.move(0, lineStyle.isHorizontalWritingMode() ? 0 : -logicalHeight());
481
482     FloatPoint boxOrigin = locationIncludingFlipping();
483     boxOrigin.moveBy(localPaintOffset);
484     FloatRect boxRect(boxOrigin, FloatSize(logicalWidth(), logicalHeight()));
485
486     auto* combinedText = this->combinedText();
487
488     bool shouldRotate = !isHorizontal() && !combinedText;
489     if (shouldRotate)
490         context.concatCTM(rotation(boxRect, Clockwise));
491
492     // Determine whether or not we have composition underlines to draw.
493     bool containsComposition = renderer().textNode() && renderer().frame().editor().compositionNode() == renderer().textNode();
494     bool useCustomUnderlines = containsComposition && renderer().frame().editor().compositionUsesCustomUnderlines();
495
496     MarkerSubrangeStyle unmarkedStyle = computeStyleForUnmarkedMarkerSubrange(paintInfo);
497
498     // 1. Paint backgrounds behind text if needed. Examples of such backgrounds include selection
499     // and composition underlines.
500     if (paintInfo.phase != PaintPhaseSelection && paintInfo.phase != PaintPhaseTextClip && !isPrinting) {
501         if (containsComposition && !useCustomUnderlines)
502             paintCompositionBackground(context, boxOrigin);
503
504         Vector<MarkerSubrange> subranges = collectSubrangesForDocumentMarkers(TextPaintPhase::Background);
505 #if ENABLE(TEXT_SELECTION)
506         if (haveSelection && !useCustomUnderlines && !context.paintingDisabled()) {
507             auto selectionSubrange = createMarkerSubrangeFromSelectionInBox(*this);
508             if (!selectionSubrange.isEmpty())
509                 subranges.append(WTFMove(selectionSubrange));
510         }
511 #endif
512         auto styledSubranges = subdivideAndResolveStyle(subranges, unmarkedStyle, paintInfo);
513         paintMarkerSubranges(context, TextPaintPhase::Background, boxRect, styledSubranges);
514     }
515
516     // FIXME: Right now, InlineTextBoxes never call addRelevantUnpaintedObject() even though they might
517     // legitimately be unpainted if they are waiting on a slow-loading web font. We should fix that, and
518     // when we do, we will have to account for the fact the InlineTextBoxes do not always have unique
519     // renderers and Page currently relies on each unpainted object having a unique renderer.
520     if (paintInfo.phase == PaintPhaseForeground)
521         renderer().page().addRelevantRepaintedObject(&renderer(), IntRect(boxOrigin.x(), boxOrigin.y(), logicalWidth(), logicalHeight()));
522
523     // 2. Now paint the foreground, including text and decorations like underline/overline (in quirks mode only).
524     bool shouldPaintSelectionForeground = haveSelection && !useCustomUnderlines;
525     Vector<MarkerSubrange> subranges;
526     if (paintInfo.phase != PaintPhaseSelection) {
527         // The subranges for the gaps between document markers and selection are implicitly created by subdividing the entire line.
528         subranges.append({ clampedOffset(m_start), clampedOffset(end() + 1), MarkerSubrange::Unmarked });
529         if (!isPrinting) {
530             subranges.appendVector(collectSubrangesForDocumentMarkers(TextPaintPhase::Foreground));
531
532             bool shouldPaintDraggedContent = !(paintInfo.paintBehavior & PaintBehaviorExcludeSelection);
533             if (shouldPaintDraggedContent) {
534                 auto subrangesForDraggedContent = collectSubrangesForDraggedContent();
535                 if (!subrangesForDraggedContent.isEmpty()) {
536                     shouldPaintSelectionForeground = false;
537                     subranges.appendVector(subrangesForDraggedContent);
538                 }
539             }
540         }
541     }
542     // The selection subrange acts as a placeholder when computing the subranges for the gaps...
543     if (shouldPaintSelectionForeground) {
544         ASSERT(!isPrinting);
545         auto selectionSubrange = createMarkerSubrangeFromSelectionInBox(*this);
546         if (!selectionSubrange.isEmpty())
547             subranges.append(WTFMove(selectionSubrange));
548     }
549
550     auto styledSubranges = subdivideAndResolveStyle(subranges, unmarkedStyle, paintInfo);
551
552     // ... now remove the selection subrange if we are excluding selection.
553     if (!isPrinting && paintInfo.paintBehavior & PaintBehaviorExcludeSelection)
554         styledSubranges.removeAllMatching([] (const StyledMarkerSubrange& subrange) { return subrange.type == MarkerSubrange::Selection; });
555
556     paintMarkerSubranges(context, TextPaintPhase::Foreground, boxRect, styledSubranges);
557
558     // Paint decorations
559     TextDecoration textDecorations = lineStyle.textDecorationsInEffect();
560     if (textDecorations != TextDecorationNone && paintInfo.phase != PaintPhaseSelection) {
561         auto text = this->text();
562         TextRun textRun = createTextRun(text);
563         unsigned length = textRun.length();
564         if (m_truncation != cNoTruncation)
565             length = m_truncation;
566         unsigned selectionStart = 0;
567         unsigned selectionEnd = 0;
568         if (haveSelection)
569             std::tie(selectionStart, selectionEnd) = selectionStartEnd();
570
571         FloatRect textDecorationSelectionClipOutRect;
572         if ((paintInfo.paintBehavior & PaintBehaviorExcludeSelection) && selectionStart < selectionEnd && selectionEnd <= length) {
573             textDecorationSelectionClipOutRect = logicalOverflowRect();
574             textDecorationSelectionClipOutRect.moveBy(localPaintOffset);
575             float logicalWidthBeforeRange;
576             float logicalWidthAfterRange;
577             float logicalSelectionWidth = lineFont().widthOfTextRange(textRun, selectionStart, selectionEnd, nullptr, &logicalWidthBeforeRange, &logicalWidthAfterRange);
578             // FIXME: Do we need to handle vertical bottom to top text?
579             if (!isHorizontal()) {
580                 textDecorationSelectionClipOutRect.move(0, logicalWidthBeforeRange);
581                 textDecorationSelectionClipOutRect.setHeight(logicalSelectionWidth);
582             } else if (direction() == RTL) {
583                 textDecorationSelectionClipOutRect.move(logicalWidthAfterRange, 0);
584                 textDecorationSelectionClipOutRect.setWidth(logicalSelectionWidth);
585             } else {
586                 textDecorationSelectionClipOutRect.move(logicalWidthBeforeRange, 0);
587                 textDecorationSelectionClipOutRect.setWidth(logicalSelectionWidth);
588             }
589         }
590         paintMarkerSubranges(context, TextPaintPhase::Decoration, boxRect, styledSubranges, textDecorationSelectionClipOutRect);
591     }
592
593     // 3. Paint fancy decorations, including composition underlines and platform-specific underlines for spelling errors, grammar errors, et cetera.
594     if (paintInfo.phase == PaintPhaseForeground) {
595         paintPlatformDocumentMarkers(context, boxOrigin);
596
597         if (useCustomUnderlines)
598             paintCompositionUnderlines(context, boxOrigin);
599     }
600     
601     if (shouldRotate)
602         context.concatCTM(rotation(boxRect, Counterclockwise));
603 }
604
605 unsigned InlineTextBox::clampedOffset(unsigned x) const
606 {
607     unsigned offset = std::max(std::min(x, m_start + m_len), m_start) - m_start;
608     if (m_truncation == cFullTruncation)
609         return offset;
610     if (m_truncation != cNoTruncation)
611         offset = std::min<unsigned>(offset, m_truncation);
612     else if (offset == m_len) {
613         // Fix up the offset if we are combined text or have a hyphen because we manage these embellishments.
614         // That is, they are not reflected in renderer().text(). We treat combined text as a single unit.
615         // We also treat the last codepoint in this box and the hyphen as a single unit.
616         if (auto* combinedText = this->combinedText())
617             offset = combinedText->combinedStringForRendering().length();
618         else if (hasHyphen())
619             offset += lineStyle().hyphenString().length();
620     }
621     return offset;
622 }
623
624 std::pair<unsigned, unsigned> InlineTextBox::selectionStartEnd() const
625 {
626     auto selectionState = renderer().selectionState();
627     if (selectionState == RenderObject::SelectionInside)
628         return { 0, clampedOffset(m_start + m_len) };
629     
630     auto start = renderer().view().selection().startPosition();
631     auto end = renderer().view().selection().endPosition();
632     if (selectionState == RenderObject::SelectionStart)
633         end = renderer().text().length();
634     else if (selectionState == RenderObject::SelectionEnd)
635         start = 0;
636     return { clampedOffset(start), clampedOffset(end) };
637 }
638
639 void InlineTextBox::paintPlatformDocumentMarkers(GraphicsContext& context, const FloatPoint& boxOrigin)
640 {
641     for (auto& subrange : subdivide(collectSubrangesForDocumentMarkers(TextPaintPhase::Foreground), OverlapStrategy::Frontmost))
642         paintPlatformDocumentMarker(context, boxOrigin, subrange);
643 }
644
645 void InlineTextBox::paintPlatformDocumentMarker(GraphicsContext& context, const FloatPoint& boxOrigin, const MarkerSubrange& subrange)
646 {
647     // Never print spelling/grammar markers (5327887)
648     if (renderer().document().printing())
649         return;
650
651     if (m_truncation == cFullTruncation)
652         return;
653
654     float start = 0; // start of line to draw, relative to tx
655     float width = m_logicalWidth; // how much line to draw
656
657     // Avoid measuring the text when the entire line box is selected as an optimization.
658     if (subrange.startOffset || subrange.endOffset != clampedOffset(end() + 1)) {
659         // Calculate start & width
660         int deltaY = renderer().style().isFlippedLinesWritingMode() ? selectionBottom() - logicalBottom() : logicalTop() - selectionTop();
661         int selHeight = selectionHeight();
662         FloatPoint startPoint(boxOrigin.x(), boxOrigin.y() - deltaY);
663         auto text = this->text();
664         TextRun run = createTextRun(text);
665
666         LayoutRect selectionRect = LayoutRect(startPoint, FloatSize(0, selHeight));
667         lineFont().adjustSelectionRectForText(run, selectionRect, subrange.startOffset, subrange.endOffset);
668         IntRect markerRect = enclosingIntRect(selectionRect);
669         start = markerRect.x() - startPoint.x();
670         width = markerRect.width();
671     }
672
673     auto lineStyleForSubrangeType = [] (MarkerSubrange::Type type) {
674         switch (type) {
675         case MarkerSubrange::SpellingError:
676             return GraphicsContext::DocumentMarkerSpellingLineStyle;
677         case MarkerSubrange::GrammarError:
678             return GraphicsContext::DocumentMarkerGrammarLineStyle;
679         case MarkerSubrange::Correction:
680             return GraphicsContext::DocumentMarkerAutocorrectionReplacementLineStyle;
681         case MarkerSubrange::DictationAlternatives:
682             return GraphicsContext::DocumentMarkerDictationAlternativesLineStyle;
683 #if PLATFORM(IOS)
684         case MarkerSubrange::DictationPhraseWithAlternatives:
685             // FIXME: Rename TextCheckingDictationPhraseWithAlternativesLineStyle and remove the PLATFORM(IOS)-guard.
686             return GraphicsContext::TextCheckingDictationPhraseWithAlternativesLineStyle;
687 #endif
688         default:
689             ASSERT_NOT_REACHED();
690             return GraphicsContext::DocumentMarkerSpellingLineStyle;
691         }
692     };
693
694     // IMPORTANT: The misspelling underline is not considered when calculating the text bounds, so we have to
695     // make sure to fit within those bounds.  This means the top pixel(s) of the underline will overlap the
696     // bottom pixel(s) of the glyphs in smaller font sizes.  The alternatives are to increase the line spacing (bad!!)
697     // or decrease the underline thickness.  The overlap is actually the most useful, and matches what AppKit does.
698     // So, we generally place the underline at the bottom of the text, but in larger fonts that's not so good so
699     // we pin to two pixels under the baseline.
700     int lineThickness = cMisspellingLineThickness;
701     int baseline = lineStyle().fontMetrics().ascent();
702     int descent = logicalHeight() - baseline;
703     int underlineOffset;
704     if (descent <= (2 + lineThickness)) {
705         // Place the underline at the very bottom of the text in small/medium fonts.
706         underlineOffset = logicalHeight() - lineThickness;
707     } else {
708         // In larger fonts, though, place the underline up near the baseline to prevent a big gap.
709         underlineOffset = baseline + 2;
710     }
711     context.drawLineForDocumentMarker(FloatPoint(boxOrigin.x() + start, boxOrigin.y() + underlineOffset), width, lineStyleForSubrangeType(subrange.type));
712 }
713
714 auto InlineTextBox::computeStyleForUnmarkedMarkerSubrange(const PaintInfo& paintInfo) const -> MarkerSubrangeStyle
715 {
716     auto& lineStyle = this->lineStyle();
717
718     MarkerSubrangeStyle style;
719     style.textDecorationStyles = TextDecorationPainter::stylesForRenderer(renderer(), lineStyle.textDecorationsInEffect(), isFirstLine());
720     style.textStyles = computeTextPaintStyle(renderer().frame(), lineStyle, paintInfo);
721     style.textShadow = paintInfo.forceTextColor() ? nullptr : lineStyle.textShadow();
722     style.alpha = 1;
723     return style;
724 }
725
726 auto InlineTextBox::resolveStyleForSubrange(const MarkerSubrange& subrange, const MarkerSubrangeStyle& baseStyle, const PaintInfo& paintInfo) -> StyledMarkerSubrange
727 {
728     MarkerSubrangeStyle style = baseStyle;
729     switch (subrange.type) {
730     case MarkerSubrange::Correction:
731     case MarkerSubrange::DictationAlternatives:
732 #if PLATFORM(IOS)
733     // FIXME: See <rdar://problem/8933352>. Also, remove the PLATFORM(IOS)-guard.
734     case MarkerSubrange::DictationPhraseWithAlternatives:
735 #endif
736     case MarkerSubrange::GrammarError:
737     case MarkerSubrange::SpellingError:
738     case MarkerSubrange::Unmarked:
739         break;
740     case MarkerSubrange::DraggedContent:
741         style.alpha = 0.25;
742         break;
743     case MarkerSubrange::Selection: {
744         const ShadowData* selectionShadow = nullptr;
745         style.textStyles = computeTextSelectionPaintStyle(style.textStyles, renderer(), lineStyle(), paintInfo, selectionShadow);
746         style.textShadow = selectionShadow;
747
748         Color selectionBackgroundColor = renderer().selectionBackgroundColor();
749         style.backgroundColor = selectionBackgroundColor;
750         if (selectionBackgroundColor.isValid() && selectionBackgroundColor.alpha() && style.textStyles.fillColor == selectionBackgroundColor)
751             style.backgroundColor = { 0xff - selectionBackgroundColor.red(), 0xff - selectionBackgroundColor.green(), 0xff - selectionBackgroundColor.blue() };
752         break;
753     }
754     case MarkerSubrange::TextMatch:
755         style.backgroundColor = subrange.marker->isActiveMatch() ? renderer().theme().platformActiveTextSearchHighlightColor() : renderer().theme().platformInactiveTextSearchHighlightColor();
756         break;
757     }
758     StyledMarkerSubrange styledSubrange = subrange;
759     styledSubrange.style = WTFMove(style);
760     return styledSubrange;
761 }
762
763 auto InlineTextBox::subdivideAndResolveStyle(const Vector<MarkerSubrange>& subrangesToSubdivide, const MarkerSubrangeStyle& baseStyle, const PaintInfo& paintInfo) -> Vector<StyledMarkerSubrange>
764 {
765     if (subrangesToSubdivide.isEmpty())
766         return { };
767
768     auto areAdjacentSubrangesWithSameStyle = [] (const StyledMarkerSubrange& a, const StyledMarkerSubrange& b) {
769         return a.endOffset == b.startOffset && a.style == b.style;
770     };
771
772     auto subranges = subdivide(subrangesToSubdivide, OverlapStrategy::FrontmostWithLongestEffectiveRange);
773
774     // Coallesce styles of adjacent subranges to minimize the number of drawing commands.
775     Vector<StyledMarkerSubrange> styledSubranges;
776     styledSubranges.reserveInitialCapacity(subranges.size());
777     styledSubranges.uncheckedAppend(resolveStyleForSubrange(subranges[0], baseStyle, paintInfo));
778     for (auto it = subranges.begin() + 1, end = subranges.end(); it != end; ++it) {
779         StyledMarkerSubrange& previousStyledSubrange = styledSubranges.last();
780         auto currentStyledSubrange = resolveStyleForSubrange(*it, baseStyle, paintInfo);
781         if (areAdjacentSubrangesWithSameStyle(previousStyledSubrange, currentStyledSubrange)) {
782             previousStyledSubrange.endOffset = currentStyledSubrange.endOffset;
783             continue;
784         }
785         styledSubranges.uncheckedAppend(currentStyledSubrange);
786     }
787     return styledSubranges;
788 }
789
790 Vector<MarkerSubrange> InlineTextBox::collectSubrangesForDraggedContent()
791 {
792     using DraggendContentRange = std::pair<unsigned, unsigned>;
793     auto draggedContentRanges = renderer().draggedContentRangesBetweenOffsets(m_start, m_start + m_len);
794     Vector<MarkerSubrange> result = draggedContentRanges.map([this] (const DraggendContentRange& range) -> MarkerSubrange {
795         return { clampedOffset(range.first), clampedOffset(range.second), MarkerSubrange::DraggedContent };
796     });
797     return result;
798 }
799
800 Vector<MarkerSubrange> InlineTextBox::collectSubrangesForDocumentMarkers(TextPaintPhase phase)
801 {
802     ASSERT(phase == TextPaintPhase::Background || phase == TextPaintPhase::Foreground);
803     if (!renderer().textNode())
804         return { };
805
806     Vector<RenderedDocumentMarker*> markers = renderer().document().markers().markersFor(renderer().textNode());
807
808     auto markerTypeForSubrangeType = [] (DocumentMarker::MarkerType type) {
809         switch (type) {
810         case DocumentMarker::Spelling:
811             return MarkerSubrange::SpellingError;
812         case DocumentMarker::Grammar:
813             return MarkerSubrange::GrammarError;
814         case DocumentMarker::CorrectionIndicator:
815             return MarkerSubrange::Correction;
816         case DocumentMarker::TextMatch:
817             return MarkerSubrange::TextMatch;
818         case DocumentMarker::DictationAlternatives:
819             return MarkerSubrange::DictationAlternatives;
820 #if PLATFORM(IOS)
821         case DocumentMarker::DictationPhraseWithAlternatives:
822             return MarkerSubrange::DictationPhraseWithAlternatives;
823 #endif
824         default:
825             return MarkerSubrange::Unmarked;
826         }
827     };
828
829     Vector<MarkerSubrange> subranges;
830     subranges.reserveInitialCapacity(markers.size());
831
832     // Give any document markers that touch this run a chance to draw before the text has been drawn.
833     // Note end() points at the last char, not one past it like endOffset and ranges do.
834     for (auto* marker : markers) {
835         // Collect either the background markers or the foreground markers, but not both
836         switch (marker->type()) {
837         case DocumentMarker::Grammar:
838         case DocumentMarker::Spelling:
839         case DocumentMarker::CorrectionIndicator:
840         case DocumentMarker::Replacement:
841         case DocumentMarker::DictationAlternatives:
842 #if PLATFORM(IOS)
843         // FIXME: Remove the PLATFORM(IOS)-guard.
844         case DocumentMarker::DictationPhraseWithAlternatives:
845 #endif
846             if (phase == TextPaintPhase::Background)
847                 continue;
848             break;
849         case DocumentMarker::TextMatch:
850             if (!renderer().frame().editor().markedTextMatchesAreHighlighted())
851                 continue;
852 #if ENABLE(TELEPHONE_NUMBER_DETECTION)
853             FALLTHROUGH;
854         case DocumentMarker::TelephoneNumber:
855 #endif
856             if (phase == TextPaintPhase::Foreground)
857                 continue;
858             break;
859         default:
860             continue;
861         }
862
863         if (marker->endOffset() <= start()) {
864             // Marker is completely before this run. This might be a marker that sits before the
865             // first run we draw, or markers that were within runs we skipped due to truncation.
866             continue;
867         }
868
869         if (marker->startOffset() > end()) {
870             // Marker is completely after this run, bail. A later run will paint it.
871             break;
872         }
873
874         // Marker intersects this run. Collect it.
875         switch (marker->type()) {
876         case DocumentMarker::Spelling:
877         case DocumentMarker::CorrectionIndicator:
878         case DocumentMarker::DictationAlternatives:
879         case DocumentMarker::Grammar:
880 #if PLATFORM(IOS)
881         // FIXME: See <rdar://problem/8933352>. Also, remove the PLATFORM(IOS)-guard.
882         case DocumentMarker::DictationPhraseWithAlternatives:
883 #endif
884         case DocumentMarker::TextMatch:
885             subranges.uncheckedAppend({ clampedOffset(marker->startOffset()), clampedOffset(marker->endOffset()), markerTypeForSubrangeType(marker->type()), marker });
886             break;
887         case DocumentMarker::Replacement:
888             break;
889 #if ENABLE(TELEPHONE_NUMBER_DETECTION)
890         case DocumentMarker::TelephoneNumber:
891             break;
892 #endif
893         default:
894             ASSERT_NOT_REACHED();
895         }
896     }
897     return subranges;
898 }
899
900 FloatPoint InlineTextBox::textOriginFromBoxRect(const FloatRect& boxRect) const
901 {
902     FloatPoint textOrigin { boxRect.x(), boxRect.y() + lineFont().fontMetrics().ascent() };
903     if (auto* combinedText = this->combinedText()) {
904         if (auto newOrigin = combinedText->computeTextOrigin(boxRect))
905             textOrigin = newOrigin.value();
906     }
907     if (isHorizontal())
908         textOrigin.setY(roundToDevicePixel(LayoutUnit { textOrigin.y() }, renderer().document().deviceScaleFactor()));
909     else
910         textOrigin.setX(roundToDevicePixel(LayoutUnit { textOrigin.x() }, renderer().document().deviceScaleFactor()));
911     return textOrigin;
912 }
913
914 void InlineTextBox::paintMarkerSubranges(GraphicsContext& context, TextPaintPhase phase, const FloatRect& boxRect, const Vector<StyledMarkerSubrange>& subranges, const FloatRect& decorationClipOutRect)
915 {
916     switch (phase) {
917     case TextPaintPhase::Background:
918         for (auto& subrange : subranges)
919             paintTextSubrangeBackground(context, boxRect.location(), subrange.style.backgroundColor, subrange.startOffset, subrange.endOffset);
920         return;
921     case TextPaintPhase::Foreground:
922         for (auto& subrange : subranges)
923             paintTextSubrangeForeground(context, boxRect, subrange);
924         return;
925     case TextPaintPhase::Decoration:
926         for (auto& subrange : subranges)
927             paintTextSubrangeDecoration(context, boxRect, decorationClipOutRect, subrange);
928         return;
929     }
930 }
931
932 void InlineTextBox::paintTextSubrangeBackground(GraphicsContext& context, const FloatPoint& boxOrigin, const Color& color, unsigned clampedStartOffset, unsigned clampedEndOffset)
933 {
934     if (clampedStartOffset >= clampedEndOffset)
935         return;
936
937     GraphicsContextStateSaver stateSaver { context };
938     updateGraphicsContext(context, TextPaintStyle { color }); // Don't draw text at all!
939
940     // Note that if the text is truncated, we let the thing being painted in the truncation
941     // draw its own highlight.
942     auto text = this->text();
943     TextRun textRun = createTextRun(text);
944
945     const RootInlineBox& rootBox = root();
946     LayoutUnit selectionBottom = rootBox.selectionBottom();
947     LayoutUnit selectionTop = rootBox.selectionTopAdjustedForPrecedingBlock();
948
949     // Use same y positioning and height as for selection, so that when the selection and this subrange are on
950     // the same word there are no pieces sticking out.
951     LayoutUnit deltaY = renderer().style().isFlippedLinesWritingMode() ? selectionBottom - logicalBottom() : logicalTop() - selectionTop;
952     LayoutUnit selectionHeight = std::max<LayoutUnit>(0, selectionBottom - selectionTop);
953
954     LayoutRect selectionRect = LayoutRect(boxOrigin.x(), boxOrigin.y() - deltaY, m_logicalWidth, selectionHeight);
955     lineFont().adjustSelectionRectForText(textRun, selectionRect, clampedStartOffset, clampedEndOffset);
956
957     // FIXME: Support painting combined text. See <https://bugs.webkit.org/show_bug.cgi?id=180993>.
958     context.fillRect(snapRectToDevicePixelsWithWritingDirection(selectionRect, renderer().document().deviceScaleFactor(), textRun.ltr()), color);
959 }
960
961 void InlineTextBox::paintTextSubrangeForeground(GraphicsContext& context, const FloatRect& boxRect, const StyledMarkerSubrange& subrange)
962 {
963     if (subrange.startOffset >= subrange.endOffset)
964         return;
965
966     const FontCascade& font = lineFont();
967     const RenderStyle& lineStyle = this->lineStyle();
968
969     float emphasisMarkOffset = 0;
970     bool emphasisMarkAbove;
971     bool hasTextEmphasis = emphasisMarkExistsAndIsAbove(lineStyle, emphasisMarkAbove);
972     const AtomicString& emphasisMark = hasTextEmphasis ? lineStyle.textEmphasisMarkString() : nullAtom();
973     if (!emphasisMark.isEmpty())
974         emphasisMarkOffset = emphasisMarkAbove ? -font.fontMetrics().ascent() - font.emphasisMarkDescent(emphasisMark) : font.fontMetrics().descent() + font.emphasisMarkAscent(emphasisMark);
975
976     TextPainter textPainter { context };
977     textPainter.setFont(font);
978     textPainter.setStyle(subrange.style.textStyles);
979     textPainter.setIsHorizontal(isHorizontal());
980     textPainter.setShadow(subrange.style.textShadow);
981     textPainter.setEmphasisMark(emphasisMark, emphasisMarkOffset, combinedText());
982
983     GraphicsContextStateSaver stateSaver { context, false };
984     if (subrange.type == MarkerSubrange::DraggedContent) {
985         stateSaver.save();
986         context.setAlpha(subrange.style.alpha);
987     }
988     // TextPainter wants the box rectangle and text origin of the entire line box.
989     auto text = this->text();
990     textPainter.paintRange(createTextRun(text), boxRect, textOriginFromBoxRect(boxRect), subrange.startOffset, subrange.endOffset);
991 }
992
993 void InlineTextBox::paintTextSubrangeDecoration(GraphicsContext& context, const FloatRect& boxRect, const FloatRect& clipOutRect, const StyledMarkerSubrange& subrange)
994 {
995     if (m_truncation == cFullTruncation)
996         return;
997
998     updateGraphicsContext(context, subrange.style.textStyles);
999
1000     bool isCombinedText = combinedText();
1001     if (isCombinedText)
1002         context.concatCTM(rotation(boxRect, Clockwise));
1003
1004     // 1. Compute text selection
1005     unsigned startOffset = subrange.startOffset;
1006     unsigned endOffset = subrange.endOffset;
1007     if (startOffset >= endOffset)
1008         return;
1009
1010     // Note that if the text is truncated, we let the thing being painted in the truncation
1011     // draw its own decoration.
1012     auto text = this->text();
1013     TextRun textRun = createTextRun(text);
1014
1015     // Avoid measuring the text when the entire line box is selected as an optimization.
1016     FloatRect snappedSelectionRect = boxRect;
1017     if (startOffset || endOffset != textRun.length()) {
1018         LayoutRect selectionRect = { boxRect.x(), boxRect.y(), boxRect.width(), boxRect.height() };
1019         lineFont().adjustSelectionRectForText(textRun, selectionRect, startOffset, endOffset);
1020         snappedSelectionRect = snapRectToDevicePixelsWithWritingDirection(selectionRect, renderer().document().deviceScaleFactor(), textRun.ltr());
1021     }
1022
1023     // 2. Paint
1024     TextDecorationPainter decorationPainter { context, static_cast<unsigned>(lineStyle().textDecorationsInEffect()), renderer(), isFirstLine(), subrange.style.textDecorationStyles };
1025     decorationPainter.setInlineTextBox(this);
1026     decorationPainter.setFont(lineFont());
1027     decorationPainter.setWidth(snappedSelectionRect.width());
1028     decorationPainter.setBaseline(lineStyle().fontMetrics().ascent());
1029     decorationPainter.setIsHorizontal(isHorizontal());
1030     decorationPainter.addTextShadow(subrange.style.textShadow);
1031
1032     {
1033         GraphicsContextStateSaver stateSaver { context, false };
1034         if (!clipOutRect.isEmpty()) {
1035             stateSaver.save();
1036             context.clipOut(clipOutRect);
1037         }
1038         decorationPainter.paintTextDecoration(textRun.subRun(startOffset, endOffset - startOffset), textOriginFromBoxRect(snappedSelectionRect), snappedSelectionRect.location());
1039     }
1040
1041     if (isCombinedText)
1042         context.concatCTM(rotation(boxRect, Counterclockwise));
1043 }
1044
1045 void InlineTextBox::paintCompositionBackground(GraphicsContext& context, const FloatPoint& boxOrigin)
1046 {
1047     paintTextSubrangeBackground(context, boxOrigin, Color::compositionFill, clampedOffset(renderer().frame().editor().compositionStart()), clampedOffset(renderer().frame().editor().compositionEnd()));
1048 }
1049
1050 void InlineTextBox::paintCompositionUnderlines(GraphicsContext& context, const FloatPoint& boxOrigin) const
1051 {
1052     if (m_truncation == cFullTruncation)
1053         return;
1054
1055     for (auto& underline : renderer().frame().editor().customCompositionUnderlines()) {
1056         if (underline.endOffset <= m_start) {
1057             // Underline is completely before this run. This might be an underline that sits
1058             // before the first run we draw, or underlines that were within runs we skipped
1059             // due to truncation.
1060             continue;
1061         }
1062
1063         if (underline.startOffset > end())
1064             break; // Underline is completely after this run, bail. A later run will paint it.
1065
1066         // Underline intersects this run. Paint it.
1067         paintCompositionUnderline(context, boxOrigin, underline);
1068
1069         if (underline.endOffset > end() + 1)
1070             break; // Underline also runs into the next run. Bail now, no more marker advancement.
1071     }
1072 }
1073
1074 static inline void mirrorRTLSegment(float logicalWidth, TextDirection direction, float& start, float width)
1075 {
1076     if (direction == LTR)
1077         return;
1078     start = logicalWidth - width - start;
1079 }
1080
1081 void InlineTextBox::paintCompositionUnderline(GraphicsContext& context, const FloatPoint& boxOrigin, const CompositionUnderline& underline) const
1082 {
1083     if (m_truncation == cFullTruncation)
1084         return;
1085     
1086     float start = 0; // start of line to draw, relative to tx
1087     float width = m_logicalWidth; // how much line to draw
1088     bool useWholeWidth = true;
1089     unsigned paintStart = m_start;
1090     unsigned paintEnd = end() + 1; // end points at the last char, not past it
1091     if (paintStart <= underline.startOffset) {
1092         paintStart = underline.startOffset;
1093         useWholeWidth = false;
1094         start = renderer().width(m_start, paintStart - m_start, textPos(), isFirstLine());
1095     }
1096     if (paintEnd != underline.endOffset) {      // end points at the last char, not past it
1097         paintEnd = std::min(paintEnd, (unsigned)underline.endOffset);
1098         useWholeWidth = false;
1099     }
1100     if (m_truncation != cNoTruncation) {
1101         paintEnd = std::min(paintEnd, (unsigned)m_start + m_truncation);
1102         useWholeWidth = false;
1103     }
1104     if (!useWholeWidth) {
1105         width = renderer().width(paintStart, paintEnd - paintStart, textPos() + start, isFirstLine());
1106         mirrorRTLSegment(m_logicalWidth, direction(), start, width);
1107     }
1108
1109     // Thick marked text underlines are 2px thick as long as there is room for the 2px line under the baseline.
1110     // All other marked text underlines are 1px thick.
1111     // If there's not enough space the underline will touch or overlap characters.
1112     int lineThickness = 1;
1113     int baseline = lineStyle().fontMetrics().ascent();
1114     if (underline.thick && logicalHeight() - baseline >= 2)
1115         lineThickness = 2;
1116
1117     // We need to have some space between underlines of subsequent clauses, because some input methods do not use different underline styles for those.
1118     // We make each line shorter, which has a harmless side effect of shortening the first and last clauses, too.
1119     start += 1;
1120     width -= 2;
1121
1122     context.setStrokeColor(underline.compositionUnderlineColor == CompositionUnderlineColor::TextColor ? renderer().style().visitedDependentColor(CSSPropertyWebkitTextFillColor) : underline.color);
1123     context.setStrokeThickness(lineThickness);
1124     context.drawLineForText(FloatPoint(boxOrigin.x() + start, boxOrigin.y() + logicalHeight() - lineThickness), width, renderer().document().printing());
1125 }
1126
1127 int InlineTextBox::caretMinOffset() const
1128 {
1129     return m_start;
1130 }
1131
1132 int InlineTextBox::caretMaxOffset() const
1133 {
1134     return m_start + m_len;
1135 }
1136
1137 float InlineTextBox::textPos() const
1138 {
1139     // When computing the width of a text run, RenderBlock::computeInlineDirectionPositionsForLine() doesn't include the actual offset
1140     // from the containing block edge in its measurement. textPos() should be consistent so the text are rendered in the same width.
1141     if (logicalLeft() == 0)
1142         return 0;
1143     return logicalLeft() - root().logicalLeft();
1144 }
1145
1146 int InlineTextBox::offsetForPosition(float lineOffset, bool includePartialGlyphs) const
1147 {
1148     if (isLineBreak())
1149         return 0;
1150     if (lineOffset - logicalLeft() > logicalWidth())
1151         return isLeftToRightDirection() ? len() : 0;
1152     if (lineOffset - logicalLeft() < 0)
1153         return isLeftToRightDirection() ? 0 : len();
1154     bool ignoreCombinedText = true;
1155     bool ignoreHyphen = true;
1156     auto text = this->text(ignoreCombinedText, ignoreHyphen);
1157     return lineFont().offsetForPosition(createTextRun(text), lineOffset - logicalLeft(), includePartialGlyphs);
1158 }
1159
1160 float InlineTextBox::positionForOffset(unsigned offset) const
1161 {
1162     ASSERT(offset >= m_start);
1163     ASSERT(offset <= m_start + len());
1164
1165     if (isLineBreak())
1166         return logicalLeft();
1167
1168     unsigned startOffset;
1169     unsigned endOffset;
1170     if (isLeftToRightDirection()) {
1171         startOffset = 0;
1172         endOffset = clampedOffset(offset);
1173     } else {
1174         startOffset = clampedOffset(offset);
1175         endOffset = m_len;
1176     }
1177
1178     // FIXME: Do we need to add rightBearing here?
1179     LayoutRect selectionRect = LayoutRect(logicalLeft(), 0, 0, 0);
1180     bool ignoreCombinedText = true;
1181     bool ignoreHyphen = true;
1182     auto text = this->text(ignoreCombinedText, ignoreHyphen);
1183     TextRun textRun = createTextRun(text);
1184     lineFont().adjustSelectionRectForText(textRun, selectionRect, startOffset, endOffset);
1185     return snapRectToDevicePixelsWithWritingDirection(selectionRect, renderer().document().deviceScaleFactor(), textRun.ltr()).maxX();
1186 }
1187
1188 TextRun InlineTextBox::createTextRun(String& string) const
1189 {
1190     const auto& style = lineStyle();
1191     TextRun textRun { string, textPos(), expansion(), expansionBehavior(), direction(), dirOverride() || style.rtlOrdering() == VisualOrder, !renderer().canUseSimpleFontCodePath() };
1192     textRun.setTabSize(!style.collapseWhiteSpace(), style.tabSize());
1193     return textRun;
1194 }
1195
1196 String InlineTextBox::text(bool ignoreCombinedText, bool ignoreHyphen) const
1197 {
1198     if (auto* combinedText = this->combinedText()) {
1199         if (ignoreCombinedText)
1200             return renderer().text().substring(m_start, m_len);
1201         return combinedText->combinedStringForRendering();
1202     }
1203     if (hasHyphen()) {
1204         if (ignoreHyphen)
1205             return renderer().text().substring(m_start, m_len);
1206         return makeString(StringView(renderer().text()).substring(m_start, m_len), lineStyle().hyphenString());
1207     }
1208     return renderer().text().substring(m_start, m_len);
1209 }
1210
1211 inline const RenderCombineText* InlineTextBox::combinedText() const
1212 {
1213     return lineStyle().hasTextCombine() && is<RenderCombineText>(renderer()) && downcast<RenderCombineText>(renderer()).isCombined() ? &downcast<RenderCombineText>(renderer()) : nullptr;
1214 }
1215
1216 ExpansionBehavior InlineTextBox::expansionBehavior() const
1217 {
1218     ExpansionBehavior leadingBehavior;
1219     if (forceLeadingExpansion())
1220         leadingBehavior = ForceLeadingExpansion;
1221     else if (canHaveLeadingExpansion())
1222         leadingBehavior = AllowLeadingExpansion;
1223     else
1224         leadingBehavior = ForbidLeadingExpansion;
1225
1226     ExpansionBehavior trailingBehavior;
1227     if (forceTrailingExpansion())
1228         trailingBehavior = ForceTrailingExpansion;
1229     else if (expansion() && nextLeafChild() && !nextLeafChild()->isLineBreak())
1230         trailingBehavior = AllowTrailingExpansion;
1231     else
1232         trailingBehavior = ForbidTrailingExpansion;
1233
1234     return leadingBehavior | trailingBehavior;
1235 }
1236
1237 #if ENABLE(TREE_DEBUGGING)
1238
1239 const char* InlineTextBox::boxName() const
1240 {
1241     return "InlineTextBox";
1242 }
1243
1244 void InlineTextBox::outputLineBox(TextStream& stream, bool mark, int depth) const
1245 {
1246     stream << "-------- " << (isDirty() ? "D" : "-") << "-";
1247
1248     int printedCharacters = 0;
1249     if (mark) {
1250         stream << "*";
1251         ++printedCharacters;
1252     }
1253     while (++printedCharacters <= depth * 2)
1254         stream << " ";
1255
1256     String value = renderer().text();
1257     value = value.substring(start(), len());
1258     value.replaceWithLiteral('\\', "\\\\");
1259     value.replaceWithLiteral('\n', "\\n");
1260     stream << boxName() << " " << FloatRect(x(), y(), width(), height()) << " (" << this << ") renderer->(" << &renderer() << ") run(" << start() << ", " << start() + len() << ") \"" << value.utf8().data() << "\"";
1261     stream.nextLine();
1262 }
1263
1264 #endif
1265
1266 } // namespace WebCore