Text decorations do not contribute to visual overflow
[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, 2005, 2006, 2007, 2008, 2009, 2010, 2011 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 "Chrome.h"
27 #include "ChromeClient.h"
28 #include "DashArray.h"
29 #include "Document.h"
30 #include "DocumentMarkerController.h"
31 #include "Editor.h"
32 #include "EllipsisBox.h"
33 #include "FontCache.h"
34 #include "Frame.h"
35 #include "GraphicsContext.h"
36 #include "HitTestResult.h"
37 #include "ImageBuffer.h"
38 #include "InlineTextBoxStyle.h"
39 #include "Page.h"
40 #include "PaintInfo.h"
41 #include "RenderedDocumentMarker.h"
42 #include "RenderBlock.h"
43 #include "RenderCombineText.h"
44 #include "RenderLineBreak.h"
45 #include "RenderRubyRun.h"
46 #include "RenderRubyText.h"
47 #include "RenderTheme.h"
48 #include "RenderView.h"
49 #include "Settings.h"
50 #include "SVGTextRunRenderingContext.h"
51 #include "Text.h"
52 #include "TextPaintStyle.h"
53 #include "TextPainter.h"
54 #include "break_lines.h"
55 #include <stdio.h>
56 #include <wtf/text/CString.h>
57
58 namespace WebCore {
59
60 struct SameSizeAsInlineTextBox : public InlineBox {
61     unsigned variables[1];
62     unsigned short variables2[2];
63     void* pointers[2];
64 };
65
66 COMPILE_ASSERT(sizeof(InlineTextBox) == sizeof(SameSizeAsInlineTextBox), InlineTextBox_should_stay_small);
67
68 typedef WTF::HashMap<const InlineTextBox*, LayoutRect> InlineTextBoxOverflowMap;
69 static InlineTextBoxOverflowMap* gTextBoxesWithOverflow;
70
71 #if ENABLE(CSS3_TEXT_DECORATION_SKIP_INK)
72 static bool compareTuples(std::pair<float, float> l, std::pair<float, float> r)
73 {
74     return l.first < r.first;
75 }
76
77 static DashArray translateIntersectionPointsToSkipInkBoundaries(const DashArray& intersections, float dilationAmount, float totalWidth)
78 {
79     ASSERT(!(intersections.size() % 2));
80     
81     // Step 1: Make pairs so we can sort based on range starting-point. We dilate the ranges in this step as well.
82     Vector<std::pair<float, float>> tuples;
83     for (auto i = intersections.begin(); i != intersections.end(); i++, i++)
84         tuples.append(std::make_pair(*i - dilationAmount, *(i + 1) + dilationAmount));
85     std::sort(tuples.begin(), tuples.end(), &compareTuples);
86
87     // Step 2: Deal with intersecting ranges.
88     Vector<std::pair<float, float>> intermediateTuples;
89     if (tuples.size() >= 2) {
90         intermediateTuples.append(*tuples.begin());
91         for (auto i = tuples.begin() + 1; i != tuples.end(); i++) {
92             float& firstEnd = intermediateTuples.last().second;
93             float secondStart = i->first;
94             float secondEnd = i->second;
95             if (secondStart <= firstEnd && secondEnd <= firstEnd) {
96                 // Ignore this range completely
97             } else if (secondStart <= firstEnd)
98                 firstEnd = secondEnd;
99             else
100                 intermediateTuples.append(*i);
101         }
102     } else
103         intermediateTuples = tuples;
104
105     // Step 3: Output the space between the ranges, but only if the space warrants an underline.
106     float previous = 0;
107     DashArray result;
108     for (const auto& tuple : intermediateTuples) {
109         if (tuple.first - previous > dilationAmount) {
110             result.append(previous);
111             result.append(tuple.first);
112         }
113         previous = tuple.second;
114     }
115     if (totalWidth - previous > dilationAmount) {
116         result.append(previous);
117         result.append(totalWidth);
118     }
119     
120     return result;
121 }
122
123 static void drawSkipInkUnderline(TextPainter& textPainter, GraphicsContext& context, FloatPoint localOrigin, float underlineOffset, float width, bool isPrinting, bool doubleLines)
124 {
125     FloatPoint adjustedLocalOrigin = localOrigin;
126     adjustedLocalOrigin.move(0, underlineOffset);
127     FloatRect underlineBoundingBox = context.computeLineBoundsForText(adjustedLocalOrigin, width, isPrinting);
128     DashArray intersections = textPainter.dashesForIntersectionsWithRect(underlineBoundingBox);
129     DashArray a = translateIntersectionPointsToSkipInkBoundaries(intersections, underlineBoundingBox.height(), width);
130
131     ASSERT(!(a.size() % 2));
132     context.drawLinesForText(adjustedLocalOrigin, a, isPrinting, doubleLines);
133 }
134 #endif
135
136 InlineTextBox::~InlineTextBox()
137 {
138     if (!knownToHaveNoOverflow() && gTextBoxesWithOverflow)
139         gTextBoxesWithOverflow->remove(this);
140 }
141
142 void InlineTextBox::markDirty(bool dirty)
143 {
144     if (dirty) {
145         m_len = 0;
146         m_start = 0;
147     }
148     InlineBox::markDirty(dirty);
149 }
150
151 LayoutRect InlineTextBox::logicalOverflowRect() const
152 {
153     if (knownToHaveNoOverflow() || !gTextBoxesWithOverflow)
154         return enclosingIntRect(logicalFrameRect());
155     return gTextBoxesWithOverflow->get(this);
156 }
157
158 void InlineTextBox::setLogicalOverflowRect(const LayoutRect& rect)
159 {
160     ASSERT(!knownToHaveNoOverflow());
161     if (!gTextBoxesWithOverflow)
162         gTextBoxesWithOverflow = new InlineTextBoxOverflowMap;
163     gTextBoxesWithOverflow->add(this, rect);
164 }
165
166 int InlineTextBox::baselinePosition(FontBaseline baselineType) const
167 {
168     if (!parent())
169         return 0;
170     if (&parent()->renderer() == renderer().parent())
171         return parent()->baselinePosition(baselineType);
172     return toRenderBoxModelObject(renderer().parent())->baselinePosition(baselineType, isFirstLine(), isHorizontal() ? HorizontalLine : VerticalLine, PositionOnContainingLine);
173 }
174
175 LayoutUnit InlineTextBox::lineHeight() const
176 {
177     if (!renderer().parent())
178         return 0;
179     if (&parent()->renderer() == renderer().parent())
180         return parent()->lineHeight();
181     return toRenderBoxModelObject(renderer().parent())->lineHeight(isFirstLine(), isHorizontal() ? HorizontalLine : VerticalLine, PositionOnContainingLine);
182 }
183
184 LayoutUnit InlineTextBox::selectionTop() const
185 {
186     return root().selectionTop();
187 }
188
189 LayoutUnit InlineTextBox::selectionBottom() const
190 {
191     return root().selectionBottom();
192 }
193
194 LayoutUnit InlineTextBox::selectionHeight() const
195 {
196     return root().selectionHeight();
197 }
198
199 bool InlineTextBox::isSelected(int startPos, int endPos) const
200 {
201     int sPos = std::max(startPos - m_start, 0);
202     int ePos = std::min(endPos - m_start, static_cast<int>(m_len));
203     return (sPos < ePos);
204 }
205
206 RenderObject::SelectionState InlineTextBox::selectionState()
207 {
208     RenderObject::SelectionState state = renderer().selectionState();
209     if (state == RenderObject::SelectionStart || state == RenderObject::SelectionEnd || state == RenderObject::SelectionBoth) {
210         int startPos, endPos;
211         renderer().selectionStartEnd(startPos, endPos);
212         // The position after a hard line break is considered to be past its end.
213         int lastSelectable = start() + len() - (isLineBreak() ? 1 : 0);
214
215         bool start = (state != RenderObject::SelectionEnd && startPos >= m_start && startPos < m_start + m_len);
216         bool end = (state != RenderObject::SelectionStart && endPos > m_start && endPos <= lastSelectable);
217         if (start && end)
218             state = RenderObject::SelectionBoth;
219         else if (start)
220             state = RenderObject::SelectionStart;
221         else if (end)
222             state = RenderObject::SelectionEnd;
223         else if ((state == RenderObject::SelectionEnd || startPos < m_start) &&
224                  (state == RenderObject::SelectionStart || endPos > lastSelectable))
225             state = RenderObject::SelectionInside;
226         else if (state == RenderObject::SelectionBoth)
227             state = RenderObject::SelectionNone;
228     }
229
230     // If there are ellipsis following, make sure their selection is updated.
231     if (m_truncation != cNoTruncation && root().ellipsisBox()) {
232         EllipsisBox* ellipsis = root().ellipsisBox();
233         if (state != RenderObject::SelectionNone) {
234             int start, end;
235             selectionStartEnd(start, end);
236             // The ellipsis should be considered to be selected if the end of
237             // the selection is past the beginning of the truncation and the
238             // beginning of the selection is before or at the beginning of the
239             // truncation.
240             ellipsis->setSelectionState(end >= m_truncation && start <= m_truncation ?
241                 RenderObject::SelectionInside : RenderObject::SelectionNone);
242         } else
243             ellipsis->setSelectionState(RenderObject::SelectionNone);
244     }
245
246     return state;
247 }
248
249 static void adjustCharactersAndLengthForHyphen(BufferForAppendingHyphen& charactersWithHyphen, const RenderStyle& style, String& string, int& length)
250 {
251     const AtomicString& hyphenString = style.hyphenString();
252     charactersWithHyphen.reserveCapacity(length + hyphenString.length());
253     charactersWithHyphen.append(string);
254     charactersWithHyphen.append(hyphenString);
255     string = charactersWithHyphen.toString();
256     length += hyphenString.length();
257 }
258
259 static const Font& fontToUse(const RenderStyle& style, const RenderText& renderer)
260 {
261     if (style.hasTextCombine() && renderer.isCombineText()) {
262         const RenderCombineText& textCombineRenderer = toRenderCombineText(renderer);
263         if (textCombineRenderer.isCombined())
264             return textCombineRenderer.textCombineFont();
265     }
266     return style.font();
267 }
268
269 LayoutRect InlineTextBox::localSelectionRect(int startPos, int endPos) const
270 {
271     int sPos = std::max(startPos - m_start, 0);
272     int ePos = std::min(endPos - m_start, (int)m_len);
273     
274     if (sPos > ePos)
275         return LayoutRect();
276
277     FontCachePurgePreventer fontCachePurgePreventer;
278
279     LayoutUnit selectionTop = this->selectionTop();
280     LayoutUnit selectionHeight = this->selectionHeight();
281     const RenderStyle& lineStyle = this->lineStyle();
282     const Font& font = fontToUse(lineStyle, renderer());
283
284     BufferForAppendingHyphen charactersWithHyphen;
285     bool respectHyphen = ePos == m_len && hasHyphen();
286     TextRun textRun = constructTextRun(lineStyle, font, respectHyphen ? &charactersWithHyphen : 0);
287     if (respectHyphen)
288         endPos = textRun.length();
289
290     LayoutRect selectionRect = LayoutRect(LayoutPoint(logicalLeft(), selectionTop), LayoutSize(m_logicalWidth, selectionHeight));
291     // Avoid computing the font width when the entire line box is selected as an optimization.
292     if (sPos || ePos != static_cast<int>(m_len))
293         font.adjustSelectionRectForText(textRun, selectionRect, sPos, ePos);
294     IntRect snappedSelectionRect = enclosingIntRect(selectionRect);
295     LayoutUnit logicalWidth = snappedSelectionRect.width();
296     if (snappedSelectionRect.x() > logicalRight())
297         logicalWidth  = 0;
298     else if (snappedSelectionRect.maxX() > logicalRight())
299         logicalWidth = logicalRight() - snappedSelectionRect.x();
300
301     LayoutPoint topPoint = isHorizontal() ? LayoutPoint(snappedSelectionRect.x(), selectionTop) : LayoutPoint(selectionTop, snappedSelectionRect.x());
302     LayoutUnit width = isHorizontal() ? logicalWidth : selectionHeight;
303     LayoutUnit height = isHorizontal() ? selectionHeight : logicalWidth;
304
305     return LayoutRect(topPoint, LayoutSize(width, height));
306 }
307
308 void InlineTextBox::deleteLine()
309 {
310     renderer().removeTextBox(*this);
311     delete this;
312 }
313
314 void InlineTextBox::extractLine()
315 {
316     if (extracted())
317         return;
318
319     renderer().extractTextBox(*this);
320 }
321
322 void InlineTextBox::attachLine()
323 {
324     if (!extracted())
325         return;
326     
327     renderer().attachTextBox(*this);
328 }
329
330 float InlineTextBox::placeEllipsisBox(bool flowIsLTR, float visibleLeftEdge, float visibleRightEdge, float ellipsisWidth, float &truncatedWidth, bool& foundBox)
331 {
332     if (foundBox) {
333         m_truncation = cFullTruncation;
334         return -1;
335     }
336
337     // For LTR this is the left edge of the box, for RTL, the right edge in parent coordinates.
338     float ellipsisX = flowIsLTR ? visibleRightEdge - ellipsisWidth : visibleLeftEdge + ellipsisWidth;
339     
340     // Criteria for full truncation:
341     // LTR: the left edge of the ellipsis is to the left of our text run.
342     // RTL: the right edge of the ellipsis is to the right of our text run.
343     bool ltrFullTruncation = flowIsLTR && ellipsisX <= left();
344     bool rtlFullTruncation = !flowIsLTR && ellipsisX >= left() + logicalWidth();
345     if (ltrFullTruncation || rtlFullTruncation) {
346         // Too far.  Just set full truncation, but return -1 and let the ellipsis just be placed at the edge of the box.
347         m_truncation = cFullTruncation;
348         foundBox = true;
349         return -1;
350     }
351
352     bool ltrEllipsisWithinBox = flowIsLTR && (ellipsisX < right());
353     bool rtlEllipsisWithinBox = !flowIsLTR && (ellipsisX > left());
354     if (ltrEllipsisWithinBox || rtlEllipsisWithinBox) {
355         foundBox = true;
356
357         // The inline box may have different directionality than it's parent.  Since truncation
358         // behavior depends both on both the parent and the inline block's directionality, we
359         // must keep track of these separately.
360         bool ltr = isLeftToRightDirection();
361         if (ltr != flowIsLTR) {
362           // Width in pixels of the visible portion of the box, excluding the ellipsis.
363           int visibleBoxWidth = visibleRightEdge - visibleLeftEdge  - ellipsisWidth;
364           ellipsisX = ltr ? left() + visibleBoxWidth : right() - visibleBoxWidth;
365         }
366
367         int offset = offsetForPosition(ellipsisX, false);
368         if (offset == 0) {
369             // No characters should be rendered.  Set ourselves to full truncation and place the ellipsis at the min of our start
370             // and the ellipsis edge.
371             m_truncation = cFullTruncation;
372             truncatedWidth += ellipsisWidth;
373             return flowIsLTR ? std::min(ellipsisX, x()) : std::max(ellipsisX, right() - ellipsisWidth);
374         }
375
376         // Set the truncation index on the text run.
377         m_truncation = offset;
378
379         // If we got here that means that we were only partially truncated and we need to return the pixel offset at which
380         // to place the ellipsis.
381         float widthOfVisibleText = renderer().width(m_start, offset, textPos(), isFirstLine());
382
383         // The ellipsis needs to be placed just after the last visible character.
384         // Where "after" is defined by the flow directionality, not the inline
385         // box directionality.
386         // e.g. In the case of an LTR inline box truncated in an RTL flow then we can
387         // have a situation such as |Hello| -> |...He|
388         truncatedWidth += widthOfVisibleText + ellipsisWidth;
389         if (flowIsLTR)
390             return left() + widthOfVisibleText;
391         else
392             return right() - widthOfVisibleText - ellipsisWidth;
393     }
394     truncatedWidth += logicalWidth();
395     return -1;
396 }
397
398
399
400 bool InlineTextBox::isLineBreak() const
401 {
402     return renderer().style().preserveNewline() && len() == 1 && (*renderer().text())[start()] == '\n';
403 }
404
405 bool InlineTextBox::nodeAtPoint(const HitTestRequest& request, HitTestResult& result, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, LayoutUnit /* lineTop */, LayoutUnit /*lineBottom*/)
406 {
407     if (!visibleToHitTesting())
408         return false;
409
410     if (isLineBreak())
411         return false;
412
413     if (m_truncation == cFullTruncation)
414         return false;
415
416     FloatRect rect(locationIncludingFlipping(), size());
417     // Make sure truncated text is ignored while hittesting.
418     if (m_truncation != cNoTruncation) {
419         LayoutUnit widthOfVisibleText = renderer().width(m_start, m_truncation, textPos(), isFirstLine());
420
421         if (isHorizontal())
422             renderer().style().isLeftToRightDirection() ? rect.setWidth(widthOfVisibleText) : rect.shiftXEdgeTo(right() - widthOfVisibleText);
423         else
424             rect.setHeight(widthOfVisibleText);
425     }
426
427     rect.moveBy(accumulatedOffset);
428
429     if (locationInContainer.intersects(rect)) {
430         renderer().updateHitTestResult(result, flipForWritingMode(locationInContainer.point() - toLayoutSize(accumulatedOffset)));
431         if (!result.addNodeToRectBasedTestResult(renderer().textNode(), request, locationInContainer, rect))
432             return true;
433     }
434     return false;
435 }
436
437 FloatSize InlineTextBox::applyShadowToGraphicsContext(GraphicsContext* context, const ShadowData* shadow, const FloatRect& textRect, bool stroked, bool opaque, bool horizontal)
438 {
439     if (!shadow)
440         return FloatSize();
441
442     FloatSize extraOffset;
443     int shadowX = horizontal ? shadow->x() : shadow->y();
444     int shadowY = horizontal ? shadow->y() : -shadow->x();
445     FloatSize shadowOffset(shadowX, shadowY);
446     int shadowRadius = shadow->radius();
447     const Color& shadowColor = shadow->color();
448
449     if (shadow->next() || stroked || !opaque) {
450         FloatRect shadowRect(textRect);
451         shadowRect.inflate(shadow->paintingExtent());
452         shadowRect.move(shadowOffset);
453         context->save();
454         context->clip(shadowRect);
455
456         extraOffset = FloatSize(0, 2 * textRect.height() + std::max(0.0f, shadowOffset.height()) + shadowRadius);
457         shadowOffset -= extraOffset;
458     }
459
460     context->setShadow(shadowOffset, shadowRadius, shadowColor, context->fillColorSpace());
461     return extraOffset;
462 }
463
464 static inline bool emphasisPositionHasNeitherLeftNorRight(TextEmphasisPosition emphasisPosition)
465 {
466     return !(emphasisPosition & TextEmphasisPositionLeft) && !(emphasisPosition & TextEmphasisPositionRight);
467 }
468
469 bool InlineTextBox::emphasisMarkExistsAndIsAbove(const RenderStyle& style, bool& above) const
470 {
471     // This function returns true if there are text emphasis marks and they are suppressed by ruby text.
472     if (style.textEmphasisMark() == TextEmphasisMarkNone)
473         return false;
474
475     TextEmphasisPosition emphasisPosition = style.textEmphasisPosition();
476     ASSERT(!((emphasisPosition & TextEmphasisPositionOver) && (emphasisPosition & TextEmphasisPositionUnder)));
477     ASSERT(!((emphasisPosition & TextEmphasisPositionLeft) && (emphasisPosition & TextEmphasisPositionRight)));
478     
479     if (emphasisPositionHasNeitherLeftNorRight(emphasisPosition))
480         above = emphasisPosition & TextEmphasisPositionOver;
481     else if (style.isHorizontalWritingMode())
482         above = emphasisPosition & TextEmphasisPositionOver;
483     else
484         above = emphasisPosition & TextEmphasisPositionRight;
485     
486     if ((style.isHorizontalWritingMode() && (emphasisPosition & TextEmphasisPositionUnder))
487         || (!style.isHorizontalWritingMode() && (emphasisPosition & TextEmphasisPositionLeft)))
488         return true; // Ruby text is always over, so it cannot suppress emphasis marks under.
489
490     RenderBlock* containingBlock = renderer().containingBlock();
491     if (!containingBlock->isRubyBase())
492         return true; // This text is not inside a ruby base, so it does not have ruby text over it.
493
494     if (!containingBlock->parent()->isRubyRun())
495         return true; // Cannot get the ruby text.
496
497     RenderRubyText* rubyText = toRenderRubyRun(containingBlock->parent())->rubyText();
498
499     // The emphasis marks over are suppressed only if there is a ruby text box and it not empty.
500     return !rubyText || !rubyText->hasLines();
501 }
502
503 void InlineTextBox::paint(PaintInfo& paintInfo, const LayoutPoint& paintOffset, LayoutUnit /*lineTop*/, LayoutUnit /*lineBottom*/)
504 {
505     if (isLineBreak() || !paintInfo.shouldPaintWithinRoot(renderer()) || renderer().style().visibility() != VISIBLE
506         || m_truncation == cFullTruncation || paintInfo.phase == PaintPhaseOutline || !m_len)
507         return;
508
509     ASSERT(paintInfo.phase != PaintPhaseSelfOutline && paintInfo.phase != PaintPhaseChildOutlines);
510
511     LayoutUnit logicalLeftSide = logicalLeftVisualOverflow();
512     LayoutUnit logicalRightSide = logicalRightVisualOverflow();
513     LayoutUnit logicalStart = logicalLeftSide + (isHorizontal() ? paintOffset.x() : paintOffset.y());
514     LayoutUnit logicalExtent = logicalRightSide - logicalLeftSide;
515     
516     LayoutUnit paintEnd = isHorizontal() ? paintInfo.rect.maxX() : paintInfo.rect.maxY();
517     LayoutUnit paintStart = isHorizontal() ? paintInfo.rect.x() : paintInfo.rect.y();
518     
519     FloatPoint adjustedPaintOffset = roundedForPainting(paintOffset, renderer().document().deviceScaleFactor());
520     
521     if (logicalStart >= paintEnd || logicalStart + logicalExtent <= paintStart)
522         return;
523
524     bool isPrinting = renderer().document().printing();
525     
526     // Determine whether or not we're selected.
527     bool haveSelection = !isPrinting && paintInfo.phase != PaintPhaseTextClip && selectionState() != RenderObject::SelectionNone;
528     if (!haveSelection && paintInfo.phase == PaintPhaseSelection)
529         // When only painting the selection, don't bother to paint if there is none.
530         return;
531
532     if (m_truncation != cNoTruncation) {
533         if (renderer().containingBlock()->style().isLeftToRightDirection() != isLeftToRightDirection()) {
534             // Make the visible fragment of text hug the edge closest to the rest of the run by moving the origin
535             // at which we start drawing text.
536             // e.g. In the case of LTR text truncated in an RTL Context, the correct behavior is:
537             // |Hello|CBA| -> |...He|CBA|
538             // In order to draw the fragment "He" aligned to the right edge of it's box, we need to start drawing
539             // farther to the right.
540             // NOTE: WebKit's behavior differs from that of IE which appears to just overlay the ellipsis on top of the
541             // truncated string i.e.  |Hello|CBA| -> |...lo|CBA|
542             LayoutUnit widthOfVisibleText = renderer().width(m_start, m_truncation, textPos(), isFirstLine());
543             LayoutUnit widthOfHiddenText = m_logicalWidth - widthOfVisibleText;
544             LayoutSize truncationOffset(isLeftToRightDirection() ? widthOfHiddenText : -widthOfHiddenText, 0);
545             adjustedPaintOffset.move(isHorizontal() ? truncationOffset : truncationOffset.transposedSize());
546         }
547     }
548
549     GraphicsContext* context = paintInfo.context;
550
551     const RenderStyle& lineStyle = this->lineStyle();
552     
553     adjustedPaintOffset.move(0, lineStyle.isHorizontalWritingMode() ? 0 : -logicalHeight());
554
555     FloatPoint boxOrigin = locationIncludingFlipping();
556     boxOrigin.move(adjustedPaintOffset.x(), adjustedPaintOffset.y());
557     FloatRect boxRect(boxOrigin, FloatSize(logicalWidth(), logicalHeight()));
558
559     RenderCombineText* combinedText = lineStyle.hasTextCombine() && renderer().isCombineText() && toRenderCombineText(renderer()).isCombined() ? &toRenderCombineText(renderer()) : 0;
560
561     bool shouldRotate = !isHorizontal() && !combinedText;
562     if (shouldRotate)
563         context->concatCTM(rotation(boxRect, Clockwise));
564
565     // Determine whether or not we have composition underlines to draw.
566     bool containsComposition = renderer().textNode() && renderer().frame().editor().compositionNode() == renderer().textNode();
567     bool useCustomUnderlines = containsComposition && renderer().frame().editor().compositionUsesCustomUnderlines();
568
569     // Determine the text colors and selection colors.
570     TextPaintStyle textPaintStyle = computeTextPaintStyle(renderer(), lineStyle, paintInfo);
571
572     bool paintSelectedTextOnly;
573     bool paintSelectedTextSeparately;
574     const ShadowData* selectionShadow;
575     TextPaintStyle selectionPaintStyle = computeTextSelectionPaintStyle(textPaintStyle, renderer(), lineStyle, paintInfo, paintSelectedTextOnly, paintSelectedTextSeparately, selectionShadow);
576
577     // Set our font.
578     const Font& font = fontToUse(lineStyle, renderer());
579
580     FloatPoint textOrigin = FloatPoint(boxOrigin.x(), boxOrigin.y() + font.fontMetrics().ascent());
581
582     if (combinedText)
583         combinedText->adjustTextOrigin(textOrigin, boxRect);
584
585     // 1. Paint backgrounds behind text if needed. Examples of such backgrounds include selection
586     // and composition underlines.
587     if (paintInfo.phase != PaintPhaseSelection && paintInfo.phase != PaintPhaseTextClip && !isPrinting) {
588         if (containsComposition && !useCustomUnderlines)
589             paintCompositionBackground(context, boxOrigin, lineStyle, font,
590                 renderer().frame().editor().compositionStart(),
591                 renderer().frame().editor().compositionEnd());
592
593         paintDocumentMarkers(context, boxOrigin, lineStyle, font, true);
594
595         if (haveSelection && !useCustomUnderlines)
596             paintSelection(context, boxOrigin, lineStyle, font, selectionPaintStyle.fillColor);
597     }
598
599     if (Page* page = renderer().frame().page()) {
600         // FIXME: Right now, InlineTextBoxes never call addRelevantUnpaintedObject() even though they might
601         // legitimately be unpainted if they are waiting on a slow-loading web font. We should fix that, and
602         // when we do, we will have to account for the fact the InlineTextBoxes do not always have unique
603         // renderers and Page currently relies on each unpainted object having a unique renderer.
604         if (paintInfo.phase == PaintPhaseForeground)
605             page->addRelevantRepaintedObject(&renderer(), IntRect(boxOrigin.x(), boxOrigin.y(), logicalWidth(), logicalHeight()));
606     }
607
608     // 2. Now paint the foreground, including text and decorations like underline/overline (in quirks mode only).
609     int length = m_len;
610     int maximumLength;
611     String string;
612     if (!combinedText) {
613         string = renderer().text();
614         if (static_cast<unsigned>(length) != string.length() || m_start) {
615             ASSERT_WITH_SECURITY_IMPLICATION(static_cast<unsigned>(m_start + length) <= string.length());
616             string = string.substringSharingImpl(m_start, length);
617         }
618         maximumLength = renderer().textLength() - m_start;
619     } else {
620         combinedText->getStringToRender(m_start, string, length);
621         maximumLength = length;
622     }
623
624     BufferForAppendingHyphen charactersWithHyphen;
625     TextRun textRun = constructTextRun(lineStyle, font, string, maximumLength, hasHyphen() ? &charactersWithHyphen : 0);
626     if (hasHyphen())
627         length = textRun.length();
628
629     int sPos = 0;
630     int ePos = 0;
631     if (haveSelection && (paintSelectedTextOnly || paintSelectedTextSeparately))
632         selectionStartEnd(sPos, ePos);
633
634     if (m_truncation != cNoTruncation) {
635         sPos = std::min<int>(sPos, m_truncation);
636         ePos = std::min<int>(ePos, m_truncation);
637         length = m_truncation;
638     }
639
640     int emphasisMarkOffset = 0;
641     bool emphasisMarkAbove;
642     bool hasTextEmphasis = emphasisMarkExistsAndIsAbove(lineStyle, emphasisMarkAbove);
643     const AtomicString& emphasisMark = hasTextEmphasis ? lineStyle.textEmphasisMarkString() : nullAtom;
644     if (!emphasisMark.isEmpty())
645         emphasisMarkOffset = emphasisMarkAbove ? -font.fontMetrics().ascent() - font.emphasisMarkDescent(emphasisMark) : font.fontMetrics().descent() + font.emphasisMarkAscent(emphasisMark);
646
647     const ShadowData* textShadow = paintInfo.forceBlackText() ? 0 : lineStyle.textShadow();
648
649     TextPainter textPainter(*context, paintSelectedTextOnly, paintSelectedTextSeparately, font, sPos, ePos, length, emphasisMark, combinedText, textRun, boxRect, textOrigin, emphasisMarkOffset, textShadow, selectionShadow, isHorizontal(), textPaintStyle, selectionPaintStyle);
650     textPainter.paintText();
651
652     // Paint decorations
653     TextDecoration textDecorations = lineStyle.textDecorationsInEffect();
654     if (textDecorations != TextDecorationNone && paintInfo.phase != PaintPhaseSelection) {
655         updateGraphicsContext(*context, textPaintStyle);
656         if (combinedText)
657             context->concatCTM(rotation(boxRect, Clockwise));
658         paintDecoration(*context, boxOrigin, textDecorations, lineStyle.textDecorationStyle(), textShadow, textPainter);
659         if (combinedText)
660             context->concatCTM(rotation(boxRect, Counterclockwise));
661     }
662
663     if (paintInfo.phase == PaintPhaseForeground) {
664         paintDocumentMarkers(context, boxOrigin, lineStyle, font, false);
665
666         if (useCustomUnderlines) {
667             const Vector<CompositionUnderline>& underlines = renderer().frame().editor().customCompositionUnderlines();
668             size_t numUnderlines = underlines.size();
669
670             for (size_t index = 0; index < numUnderlines; ++index) {
671                 const CompositionUnderline& underline = underlines[index];
672
673                 if (underline.endOffset <= start())
674                     // underline is completely before this run.  This might be an underline that sits
675                     // before the first run we draw, or underlines that were within runs we skipped 
676                     // due to truncation.
677                     continue;
678                 
679                 if (underline.startOffset <= end()) {
680                     // underline intersects this run.  Paint it.
681                     paintCompositionUnderline(context, boxOrigin, underline);
682                     if (underline.endOffset > end() + 1)
683                         // underline also runs into the next run. Bail now, no more marker advancement.
684                         break;
685                 } else
686                     // underline is completely after this run, bail.  A later run will paint it.
687                     break;
688             }
689         }
690     }
691     
692     if (shouldRotate)
693         context->concatCTM(rotation(boxRect, Counterclockwise));
694 }
695
696 void InlineTextBox::selectionStartEnd(int& sPos, int& ePos)
697 {
698     int startPos, endPos;
699     if (renderer().selectionState() == RenderObject::SelectionInside) {
700         startPos = 0;
701         endPos = renderer().textLength();
702     } else {
703         renderer().selectionStartEnd(startPos, endPos);
704         if (renderer().selectionState() == RenderObject::SelectionStart)
705             endPos = renderer().textLength();
706         else if (renderer().selectionState() == RenderObject::SelectionEnd)
707             startPos = 0;
708     }
709
710     sPos = std::max(startPos - m_start, 0);
711     ePos = std::min(endPos - m_start, (int)m_len);
712 }
713
714 void InlineTextBox::paintSelection(GraphicsContext* context, const FloatPoint& boxOrigin, const RenderStyle& style, const Font& font, Color textColor)
715 {
716 #if ENABLE(TEXT_SELECTION)
717     if (context->paintingDisabled())
718         return;
719
720     // See if we have a selection to paint at all.
721     int sPos, ePos;
722     selectionStartEnd(sPos, ePos);
723     if (sPos >= ePos)
724         return;
725
726     Color c = renderer().selectionBackgroundColor();
727     if (!c.isValid() || c.alpha() == 0)
728         return;
729
730     // If the text color ends up being the same as the selection background, invert the selection
731     // background.
732     if (textColor == c)
733         c = Color(0xff - c.red(), 0xff - c.green(), 0xff - c.blue());
734
735     GraphicsContextStateSaver stateSaver(*context);
736     updateGraphicsContext(*context, TextPaintStyle(c, style.colorSpace())); // Don't draw text at all!
737     
738     // If the text is truncated, let the thing being painted in the truncation
739     // draw its own highlight.
740     int length = m_truncation != cNoTruncation ? m_truncation : m_len;
741     String string = renderer().text();
742
743     if (string.length() != static_cast<unsigned>(length) || m_start) {
744         ASSERT_WITH_SECURITY_IMPLICATION(static_cast<unsigned>(m_start + length) <= string.length());
745         string = string.substringSharingImpl(m_start, length);
746     }
747
748     BufferForAppendingHyphen charactersWithHyphen;
749     bool respectHyphen = ePos == length && hasHyphen();
750     TextRun textRun = constructTextRun(style, font, string, renderer().textLength() - m_start, respectHyphen ? &charactersWithHyphen : 0);
751     if (respectHyphen)
752         ePos = textRun.length();
753
754     const RootInlineBox& rootBox = root();
755     LayoutUnit selectionBottom = rootBox.selectionBottom();
756     LayoutUnit selectionTop = rootBox.selectionTopAdjustedForPrecedingBlock();
757
758     LayoutUnit deltaY = renderer().style().isFlippedLinesWritingMode() ? selectionBottom - logicalBottom() : logicalTop() - selectionTop;
759     LayoutUnit selectionHeight = std::max<LayoutUnit>(0, selectionBottom - selectionTop);
760
761     LayoutRect selectionRect = LayoutRect(boxOrigin.x(), boxOrigin.y() - deltaY, m_logicalWidth, selectionHeight);
762     font.adjustSelectionRectForText(textRun, selectionRect, sPos, ePos);
763     context->fillRect(directionalPixelSnappedForPainting(selectionRect, renderer().document().deviceScaleFactor(), textRun.ltr()), c, style.colorSpace());
764 #else
765     UNUSED_PARAM(context);
766     UNUSED_PARAM(boxOrigin);
767     UNUSED_PARAM(style);
768     UNUSED_PARAM(font);
769     UNUSED_PARAM(textColor);
770 #endif
771 }
772
773 void InlineTextBox::paintCompositionBackground(GraphicsContext* context, const FloatPoint& boxOrigin, const RenderStyle& style, const Font& font, int startPos, int endPos)
774 {
775     int offset = m_start;
776     int sPos = std::max(startPos - offset, 0);
777     int ePos = std::min(endPos - offset, (int)m_len);
778
779     if (sPos >= ePos)
780         return;
781
782     GraphicsContextStateSaver stateSaver(*context);
783
784 #if !PLATFORM(IOS)
785     // FIXME: Is this color still applicable as of Mavericks? for non-Mac ports? We should
786     // be able to move this color information to RenderStyle.
787     Color c = Color(225, 221, 85);
788 #else
789     Color c = style.compositionFillColor();
790 #endif
791     
792     updateGraphicsContext(*context, TextPaintStyle(c, style.colorSpace())); // Don't draw text at all!
793
794     LayoutUnit deltaY = renderer().style().isFlippedLinesWritingMode() ? selectionBottom() - logicalBottom() : logicalTop() - selectionTop();
795     LayoutRect selectionRect = LayoutRect(boxOrigin.x(), boxOrigin.y() - deltaY, 0, selectionHeight());
796     TextRun textRun = constructTextRun(style, font);
797     font.adjustSelectionRectForText(textRun, selectionRect, sPos, ePos);
798     context->fillRect(directionalPixelSnappedForPainting(selectionRect, renderer().document().deviceScaleFactor(), textRun.ltr()), c, style.colorSpace());
799 }
800
801 static StrokeStyle textDecorationStyleToStrokeStyle(TextDecorationStyle decorationStyle)
802 {
803     StrokeStyle strokeStyle = SolidStroke;
804     switch (decorationStyle) {
805     case TextDecorationStyleSolid:
806         strokeStyle = SolidStroke;
807         break;
808     case TextDecorationStyleDouble:
809         strokeStyle = DoubleStroke;
810         break;
811     case TextDecorationStyleDotted:
812         strokeStyle = DottedStroke;
813         break;
814     case TextDecorationStyleDashed:
815         strokeStyle = DashedStroke;
816         break;
817     case TextDecorationStyleWavy:
818         strokeStyle = WavyStroke;
819         break;
820     }
821
822     return strokeStyle;
823 }
824
825 static void adjustStepToDecorationLength(float& step, float& controlPointDistance, float length)
826 {
827     ASSERT(step > 0);
828
829     if (length <= 0)
830         return;
831
832     unsigned stepCount = static_cast<unsigned>(length / step);
833
834     // Each Bezier curve starts at the same pixel that the previous one
835     // ended. We need to subtract (stepCount - 1) pixels when calculating the
836     // length covered to account for that.
837     float uncoveredLength = length - (stepCount * step - (stepCount - 1));
838     float adjustment = uncoveredLength / stepCount;
839     step += adjustment;
840     controlPointDistance += adjustment;
841 }
842
843 /*
844  * Draw one cubic Bezier curve and repeat the same pattern long the the decoration's axis.
845  * The start point (p1), controlPoint1, controlPoint2 and end point (p2) of the Bezier curve
846  * form a diamond shape:
847  *
848  *                              step
849  *                         |-----------|
850  *
851  *                   controlPoint1
852  *                         +
853  *
854  *
855  *                  . .
856  *                .     .
857  *              .         .
858  * (x1, y1) p1 +           .            + p2 (x2, y2) - <--- Decoration's axis
859  *                          .         .               |
860  *                            .     .                 |
861  *                              . .                   | controlPointDistance
862  *                                                    |
863  *                                                    |
864  *                         +                          -
865  *                   controlPoint2
866  *
867  *             |-----------|
868  *                 step
869  */
870 static void strokeWavyTextDecoration(GraphicsContext& context, FloatPoint& p1, FloatPoint& p2, float strokeThickness)
871 {
872     context.adjustLineToPixelBoundaries(p1, p2, strokeThickness, context.strokeStyle());
873
874     Path path;
875     path.moveTo(p1);
876
877     float controlPointDistance;
878     float step;
879     getWavyStrokeParameters(strokeThickness, controlPointDistance, step);
880
881     bool isVerticalLine = (p1.x() == p2.x());
882
883     if (isVerticalLine) {
884         ASSERT(p1.x() == p2.x());
885
886         float xAxis = p1.x();
887         float y1;
888         float y2;
889
890         if (p1.y() < p2.y()) {
891             y1 = p1.y();
892             y2 = p2.y();
893         } else {
894             y1 = p2.y();
895             y2 = p1.y();
896         }
897
898         adjustStepToDecorationLength(step, controlPointDistance, y2 - y1);
899         FloatPoint controlPoint1(xAxis + controlPointDistance, 0);
900         FloatPoint controlPoint2(xAxis - controlPointDistance, 0);
901
902         for (float y = y1; y + 2 * step <= y2;) {
903             controlPoint1.setY(y + step);
904             controlPoint2.setY(y + step);
905             y += 2 * step;
906             path.addBezierCurveTo(controlPoint1, controlPoint2, FloatPoint(xAxis, y));
907         }
908     } else {
909         ASSERT(p1.y() == p2.y());
910
911         float yAxis = p1.y();
912         float x1;
913         float x2;
914
915         if (p1.x() < p2.x()) {
916             x1 = p1.x();
917             x2 = p2.x();
918         } else {
919             x1 = p2.x();
920             x2 = p1.x();
921         }
922
923         adjustStepToDecorationLength(step, controlPointDistance, x2 - x1);
924         FloatPoint controlPoint1(0, yAxis + controlPointDistance);
925         FloatPoint controlPoint2(0, yAxis - controlPointDistance);
926
927         for (float x = x1; x + 2 * step <= x2;) {
928             controlPoint1.setX(x + step);
929             controlPoint2.setX(x + step);
930             x += 2 * step;
931             path.addBezierCurveTo(controlPoint1, controlPoint2, FloatPoint(x, yAxis));
932         }
933     }
934
935     context.setShouldAntialias(true);
936     context.strokePath(path);
937 }
938
939 void InlineTextBox::paintDecoration(GraphicsContext& context, const FloatPoint& boxOrigin, TextDecoration decoration, TextDecorationStyle decorationStyle, const ShadowData* shadow, TextPainter& textPainter)
940 {
941 #if !ENABLE(CSS3_TEXT_DECORATION_SKIP_INK)
942     UNUSED_PARAM(textPainter);
943 #endif
944
945     if (m_truncation == cFullTruncation)
946         return;
947
948     FloatPoint localOrigin = boxOrigin;
949
950     float width = m_logicalWidth;
951     if (m_truncation != cNoTruncation) {
952         width = renderer().width(m_start, m_truncation, textPos(), isFirstLine());
953         if (!isLeftToRightDirection())
954             localOrigin.move(m_logicalWidth - width, 0);
955     }
956     
957     // Get the text decoration colors.
958     Color underline, overline, linethrough;
959     renderer().getTextDecorationColors(decoration, underline, overline, linethrough, true);
960     if (isFirstLine())
961         renderer().getTextDecorationColors(decoration, underline, overline, linethrough, true, true);
962     
963     // Use a special function for underlines to get the positioning exactly right.
964     bool isPrinting = renderer().document().printing();
965
966     float textDecorationThickness = textDecorationStrokeThickness(renderer().style().fontSize());
967     context.setStrokeThickness(textDecorationThickness);
968
969     bool linesAreOpaque = !isPrinting && (!(decoration & TextDecorationUnderline) || underline.alpha() == 255) && (!(decoration & TextDecorationOverline) || overline.alpha() == 255) && (!(decoration & TextDecorationLineThrough) || linethrough.alpha() == 255);
970
971     const RenderStyle& lineStyle = this->lineStyle();
972     int baseline = lineStyle.fontMetrics().ascent();
973
974     bool setClip = false;
975     int extraOffset = 0;
976     if (!linesAreOpaque && shadow && shadow->next()) {
977         FloatRect clipRect(localOrigin, FloatSize(width, baseline + 2));
978         for (const ShadowData* s = shadow; s; s = s->next()) {
979             int shadowExtent = s->paintingExtent();
980             FloatRect shadowRect(localOrigin, FloatSize(width, baseline + 2));
981             shadowRect.inflate(shadowExtent);
982             int shadowX = isHorizontal() ? s->x() : s->y();
983             int shadowY = isHorizontal() ? s->y() : -s->x();
984             shadowRect.move(shadowX, shadowY);
985             clipRect.unite(shadowRect);
986             extraOffset = std::max(extraOffset, std::max(0, shadowY) + shadowExtent);
987         }
988         context.save();
989         context.clip(clipRect);
990         extraOffset += baseline + 2;
991         localOrigin.move(0, extraOffset);
992         setClip = true;
993     }
994
995     ColorSpace colorSpace = renderer().style().colorSpace();
996     bool setShadow = false;
997
998     do {
999         if (shadow) {
1000             if (!shadow->next()) {
1001                 // The last set of lines paints normally inside the clip.
1002                 localOrigin.move(0, -extraOffset);
1003                 extraOffset = 0;
1004             }
1005             int shadowX = isHorizontal() ? shadow->x() : shadow->y();
1006             int shadowY = isHorizontal() ? shadow->y() : -shadow->x();
1007             context.setShadow(FloatSize(shadowX, shadowY - extraOffset), shadow->radius(), shadow->color(), colorSpace);
1008             setShadow = true;
1009             shadow = shadow->next();
1010         }
1011         
1012         float wavyOffset = wavyOffsetFromDecoration();
1013
1014         context.setStrokeStyle(textDecorationStyleToStrokeStyle(decorationStyle));
1015         // These decorations should match the visual overflows computed in visualOverflowForDecorations()
1016         if (decoration & TextDecorationUnderline) {
1017             context.setStrokeColor(underline, colorSpace);
1018             const int underlineOffset = computeUnderlineOffset(lineStyle.textUnderlinePosition(), lineStyle.fontMetrics(), this, textDecorationThickness);
1019
1020             switch (decorationStyle) {
1021             case TextDecorationStyleWavy: {
1022                 FloatPoint start(localOrigin.x(), localOrigin.y() + underlineOffset + wavyOffset);
1023                 FloatPoint end(localOrigin.x() + width, localOrigin.y() + underlineOffset + wavyOffset);
1024                 strokeWavyTextDecoration(context, start, end, textDecorationThickness);
1025                 break;
1026             }
1027             default:
1028 #if ENABLE(CSS3_TEXT_DECORATION_SKIP_INK)
1029                 if ((lineStyle.textDecorationSkip() == TextDecorationSkipInk || lineStyle.textDecorationSkip() == TextDecorationSkipAuto) && isHorizontal()) {
1030                     if (!context.paintingDisabled()) {
1031                         drawSkipInkUnderline(textPainter, context, localOrigin, underlineOffset, width, isPrinting, decorationStyle == TextDecorationStyleDouble);
1032                     }
1033                 } else
1034                     // FIXME: Need to support text-decoration-skip: none.
1035 #endif // CSS3_TEXT_DECORATION_SKIP_INK
1036                     context.drawLineForText(FloatPoint(localOrigin.x(), localOrigin.y() + underlineOffset), width, isPrinting, decorationStyle == TextDecorationStyleDouble);
1037             }
1038         }
1039         if (decoration & TextDecorationOverline) {
1040             context.setStrokeColor(overline, colorSpace);
1041             switch (decorationStyle) {
1042             case TextDecorationStyleWavy: {
1043                 FloatPoint start(localOrigin.x(), localOrigin.y() - wavyOffset);
1044                 FloatPoint end(localOrigin.x() + width, localOrigin.y() - wavyOffset);
1045                 strokeWavyTextDecoration(context, start, end, textDecorationThickness);
1046                 break;
1047             }
1048             default:
1049 #if ENABLE(CSS3_TEXT_DECORATION_SKIP_INK)
1050                 if ((lineStyle.textDecorationSkip() == TextDecorationSkipInk || lineStyle.textDecorationSkip() == TextDecorationSkipAuto) && isHorizontal()) {
1051                     if (!context.paintingDisabled())
1052                         drawSkipInkUnderline(textPainter, context, localOrigin, 0, width, isPrinting, decorationStyle == TextDecorationStyleDouble);
1053                 } else
1054                     // FIXME: Need to support text-decoration-skip: none.
1055 #endif // CSS3_TEXT_DECORATION_SKIP_INK
1056                     context.drawLineForText(localOrigin, width, isPrinting, decorationStyle == TextDecorationStyleDouble);
1057             }
1058         }
1059         if (decoration & TextDecorationLineThrough) {
1060             context.setStrokeColor(linethrough, colorSpace);
1061             switch (decorationStyle) {
1062             case TextDecorationStyleWavy: {
1063                 FloatPoint start(localOrigin.x(), localOrigin.y() + 2 * baseline / 3);
1064                 FloatPoint end(localOrigin.x() + width, localOrigin.y() + 2 * baseline / 3);
1065                 strokeWavyTextDecoration(context, start, end, textDecorationThickness);
1066                 break;
1067             }
1068             default:
1069                 context.drawLineForText(FloatPoint(localOrigin.x(), localOrigin.y() + 2 * baseline / 3), width, isPrinting, decorationStyle == TextDecorationStyleDouble);
1070             }
1071         }
1072     } while (shadow);
1073
1074     if (setClip)
1075         context.restore();
1076     else if (setShadow)
1077         context.clearShadow();
1078 }
1079
1080 static GraphicsContext::DocumentMarkerLineStyle lineStyleForMarkerType(DocumentMarker::MarkerType markerType)
1081 {
1082     switch (markerType) {
1083     case DocumentMarker::Spelling:
1084         return GraphicsContext::DocumentMarkerSpellingLineStyle;
1085     case DocumentMarker::Grammar:
1086         return GraphicsContext::DocumentMarkerGrammarLineStyle;
1087     case DocumentMarker::CorrectionIndicator:
1088         return GraphicsContext::DocumentMarkerAutocorrectionReplacementLineStyle;
1089     case DocumentMarker::DictationAlternatives:
1090         return GraphicsContext::DocumentMarkerDictationAlternativesLineStyle;
1091 #if PLATFORM(IOS)
1092     case DocumentMarker::DictationPhraseWithAlternatives:
1093         // FIXME: Rename TextCheckingDictationPhraseWithAlternativesLineStyle and remove the PLATFORM(IOS)-guard.
1094         return GraphicsContext::TextCheckingDictationPhraseWithAlternativesLineStyle;
1095 #endif
1096     default:
1097         ASSERT_NOT_REACHED();
1098         return GraphicsContext::DocumentMarkerSpellingLineStyle;
1099     }
1100 }
1101
1102 void InlineTextBox::paintDocumentMarker(GraphicsContext* pt, const FloatPoint& boxOrigin, DocumentMarker* marker, const RenderStyle& style, const Font& font, bool grammar)
1103 {
1104     // Never print spelling/grammar markers (5327887)
1105     if (renderer().document().printing())
1106         return;
1107
1108     if (m_truncation == cFullTruncation)
1109         return;
1110
1111     float start = 0; // start of line to draw, relative to tx
1112     float width = m_logicalWidth; // how much line to draw
1113
1114     // Determine whether we need to measure text
1115     bool markerSpansWholeBox = true;
1116     if (m_start <= (int)marker->startOffset())
1117         markerSpansWholeBox = false;
1118     if ((end() + 1) != marker->endOffset()) // end points at the last char, not past it
1119         markerSpansWholeBox = false;
1120     if (m_truncation != cNoTruncation)
1121         markerSpansWholeBox = false;
1122
1123     bool isDictationMarker = marker->type() == DocumentMarker::DictationAlternatives;
1124     if (!markerSpansWholeBox || grammar || isDictationMarker) {
1125         int startPosition = std::max<int>(marker->startOffset() - m_start, 0);
1126         int endPosition = std::min<int>(marker->endOffset() - m_start, m_len);
1127         
1128         if (m_truncation != cNoTruncation)
1129             endPosition = std::min<int>(endPosition, m_truncation);
1130
1131         // Calculate start & width
1132         int deltaY = renderer().style().isFlippedLinesWritingMode() ? selectionBottom() - logicalBottom() : logicalTop() - selectionTop();
1133         int selHeight = selectionHeight();
1134         FloatPoint startPoint(boxOrigin.x(), boxOrigin.y() - deltaY);
1135         TextRun run = constructTextRun(style, font);
1136
1137         LayoutRect selectionRect = LayoutRect(startPoint, FloatSize(0, selHeight));
1138         font.adjustSelectionRectForText(run, selectionRect, startPosition, endPosition);
1139         IntRect markerRect = enclosingIntRect(selectionRect);
1140         start = markerRect.x() - startPoint.x();
1141         width = markerRect.width();
1142         
1143         // Store rendered rects for bad grammar markers, so we can hit-test against it elsewhere in order to
1144         // display a toolTip. We don't do this for misspelling markers.
1145         if (grammar || isDictationMarker) {
1146             markerRect.move(-boxOrigin.x(), -boxOrigin.y());
1147             markerRect = renderer().localToAbsoluteQuad(FloatRect(markerRect)).enclosingBoundingBox();
1148             toRenderedDocumentMarker(marker)->setRenderedRect(markerRect);
1149         }
1150     }
1151     
1152     // IMPORTANT: The misspelling underline is not considered when calculating the text bounds, so we have to
1153     // make sure to fit within those bounds.  This means the top pixel(s) of the underline will overlap the
1154     // bottom pixel(s) of the glyphs in smaller font sizes.  The alternatives are to increase the line spacing (bad!!)
1155     // or decrease the underline thickness.  The overlap is actually the most useful, and matches what AppKit does.
1156     // So, we generally place the underline at the bottom of the text, but in larger fonts that's not so good so
1157     // we pin to two pixels under the baseline.
1158     int lineThickness = cMisspellingLineThickness;
1159     int baseline = lineStyle().fontMetrics().ascent();
1160     int descent = logicalHeight() - baseline;
1161     int underlineOffset;
1162     if (descent <= (2 + lineThickness)) {
1163         // Place the underline at the very bottom of the text in small/medium fonts.
1164         underlineOffset = logicalHeight() - lineThickness;
1165     } else {
1166         // In larger fonts, though, place the underline up near the baseline to prevent a big gap.
1167         underlineOffset = baseline + 2;
1168     }
1169     pt->drawLineForDocumentMarker(FloatPoint(boxOrigin.x() + start, boxOrigin.y() + underlineOffset), width, lineStyleForMarkerType(marker->type()));
1170 }
1171
1172 void InlineTextBox::paintTextMatchMarker(GraphicsContext* context, const FloatPoint& boxOrigin, DocumentMarker* marker, const RenderStyle& style, const Font& font)
1173 {
1174     LayoutUnit selectionHeight = this->selectionHeight();
1175
1176     int sPos = std::max(marker->startOffset() - m_start, (unsigned)0);
1177     int ePos = std::min(marker->endOffset() - m_start, (unsigned)m_len);
1178     TextRun run = constructTextRun(style, font);
1179
1180     // Always compute and store the rect associated with this marker. The computed rect is in absolute coordinates.
1181     // FIXME: figure out how renderedRect and selectionRect are different.
1182     LayoutRect renderedRect = LayoutRect(LayoutPoint(x(), selectionTop()), FloatSize(0, selectionHeight));
1183     font.adjustSelectionRectForText(run, renderedRect, sPos, ePos);
1184     IntRect markerRect = enclosingIntRect(renderedRect);
1185     markerRect = renderer().localToAbsoluteQuad(FloatQuad(markerRect)).enclosingBoundingBox();
1186     toRenderedDocumentMarker(marker)->setRenderedRect(markerRect);
1187     
1188     // Optionally highlight the text
1189     if (renderer().frame().editor().markedTextMatchesAreHighlighted()) {
1190         Color color = marker->activeMatch() ? renderer().theme().platformActiveTextSearchHighlightColor() : renderer().theme().platformInactiveTextSearchHighlightColor();
1191         GraphicsContextStateSaver stateSaver(*context);
1192         updateGraphicsContext(*context, TextPaintStyle(color, style.colorSpace())); // Don't draw text at all!
1193
1194         // Use same y positioning and height as for selection, so that when the selection and this highlight are on
1195         // the same word there are no pieces sticking out.
1196         LayoutUnit deltaY = renderer().style().isFlippedLinesWritingMode() ? selectionBottom() - logicalBottom() : logicalTop() - selectionTop();
1197         LayoutRect selectionRect = LayoutRect(boxOrigin.x(), boxOrigin.y() - deltaY, 0, selectionHeight);
1198         font.adjustSelectionRectForText(run, selectionRect, sPos, ePos);
1199         context->fillRect(directionalPixelSnappedForPainting(selectionRect, renderer().document().deviceScaleFactor(), run.ltr()), color, style.colorSpace());
1200     }
1201 }
1202
1203 void InlineTextBox::computeRectForReplacementMarker(DocumentMarker* marker, const RenderStyle& style, const Font& font)
1204 {
1205     // Replacement markers are not actually drawn, but their rects need to be computed for hit testing.
1206     LayoutUnit top = selectionTop();
1207     LayoutUnit h = selectionHeight();
1208     
1209     int sPos = std::max(marker->startOffset() - m_start, (unsigned)0);
1210     int ePos = std::min(marker->endOffset() - m_start, (unsigned)m_len);
1211     TextRun run = constructTextRun(style, font);
1212
1213     // Compute and store the rect associated with this marker.
1214     LayoutRect selectionRect = LayoutRect(LayoutPoint(x(), top), LayoutSize(0, h));
1215     font.adjustSelectionRectForText(run, selectionRect, sPos, ePos);
1216     IntRect markerRect = enclosingIntRect(selectionRect);
1217     markerRect = renderer().localToAbsoluteQuad(FloatRect(markerRect)).enclosingBoundingBox();
1218     toRenderedDocumentMarker(marker)->setRenderedRect(markerRect);
1219 }
1220     
1221 void InlineTextBox::paintDocumentMarkers(GraphicsContext* pt, const FloatPoint& boxOrigin, const RenderStyle& style, const Font& font, bool background)
1222 {
1223     if (!renderer().textNode())
1224         return;
1225
1226     Vector<DocumentMarker*> markers = renderer().document().markers().markersFor(renderer().textNode());
1227     Vector<DocumentMarker*>::const_iterator markerIt = markers.begin();
1228
1229     // Give any document markers that touch this run a chance to draw before the text has been drawn.
1230     // Note end() points at the last char, not one past it like endOffset and ranges do.
1231     for ( ; markerIt != markers.end(); ++markerIt) {
1232         DocumentMarker* marker = *markerIt;
1233         
1234         // Paint either the background markers or the foreground markers, but not both
1235         switch (marker->type()) {
1236             case DocumentMarker::Grammar:
1237             case DocumentMarker::Spelling:
1238             case DocumentMarker::CorrectionIndicator:
1239             case DocumentMarker::Replacement:
1240             case DocumentMarker::DictationAlternatives:
1241 #if PLATFORM(IOS)
1242             // FIXME: Remove the PLATFORM(IOS)-guard.
1243             case DocumentMarker::DictationPhraseWithAlternatives:
1244 #endif
1245                 if (background)
1246                     continue;
1247                 break;
1248             case DocumentMarker::TextMatch:
1249 #if ENABLE(TELEPHONE_NUMBER_DETECTION)
1250             case DocumentMarker::TelephoneNumber:
1251 #endif
1252                 if (!background)
1253                     continue;
1254                 break;
1255             default:
1256                 continue;
1257         }
1258
1259         if (marker->endOffset() <= start())
1260             // marker is completely before this run.  This might be a marker that sits before the
1261             // first run we draw, or markers that were within runs we skipped due to truncation.
1262             continue;
1263         
1264         if (marker->startOffset() > end())
1265             // marker is completely after this run, bail.  A later run will paint it.
1266             break;
1267         
1268         // marker intersects this run.  Paint it.
1269         switch (marker->type()) {
1270             case DocumentMarker::Spelling:
1271             case DocumentMarker::CorrectionIndicator:
1272             case DocumentMarker::DictationAlternatives:
1273                 paintDocumentMarker(pt, boxOrigin, marker, style, font, false);
1274                 break;
1275             case DocumentMarker::Grammar:
1276                 paintDocumentMarker(pt, boxOrigin, marker, style, font, true);
1277                 break;
1278 #if PLATFORM(IOS)
1279             // FIXME: See <rdar://problem/8933352>. Also, remove the PLATFORM(IOS)-guard.
1280             case DocumentMarker::DictationPhraseWithAlternatives:
1281                 paintDocumentMarker(pt, boxOrigin, marker, style, font, true);
1282                 break;
1283 #endif
1284             case DocumentMarker::TextMatch:
1285                 paintTextMatchMarker(pt, boxOrigin, marker, style, font);
1286                 break;
1287             case DocumentMarker::Replacement:
1288                 computeRectForReplacementMarker(marker, style, font);
1289                 break;
1290 #if ENABLE(TELEPHONE_NUMBER_DETECTION)
1291             case DocumentMarker::TelephoneNumber:
1292                 break;
1293 #endif
1294             default:
1295                 ASSERT_NOT_REACHED();
1296         }
1297
1298     }
1299 }
1300
1301 void InlineTextBox::paintCompositionUnderline(GraphicsContext* ctx, const FloatPoint& boxOrigin, const CompositionUnderline& underline)
1302 {
1303     if (m_truncation == cFullTruncation)
1304         return;
1305     
1306     float start = 0; // start of line to draw, relative to tx
1307     float width = m_logicalWidth; // how much line to draw
1308     bool useWholeWidth = true;
1309     unsigned paintStart = m_start;
1310     unsigned paintEnd = end() + 1; // end points at the last char, not past it
1311     if (paintStart <= underline.startOffset) {
1312         paintStart = underline.startOffset;
1313         useWholeWidth = false;
1314         start = renderer().width(m_start, paintStart - m_start, textPos(), isFirstLine());
1315     }
1316     if (paintEnd != underline.endOffset) {      // end points at the last char, not past it
1317         paintEnd = std::min(paintEnd, (unsigned)underline.endOffset);
1318         useWholeWidth = false;
1319     }
1320     if (m_truncation != cNoTruncation) {
1321         paintEnd = std::min(paintEnd, (unsigned)m_start + m_truncation);
1322         useWholeWidth = false;
1323     }
1324     if (!useWholeWidth) {
1325         width = renderer().width(paintStart, paintEnd - paintStart, textPos() + start, isFirstLine());
1326     }
1327
1328     // Thick marked text underlines are 2px thick as long as there is room for the 2px line under the baseline.
1329     // All other marked text underlines are 1px thick.
1330     // If there's not enough space the underline will touch or overlap characters.
1331     int lineThickness = 1;
1332     int baseline = lineStyle().fontMetrics().ascent();
1333     if (underline.thick && logicalHeight() - baseline >= 2)
1334         lineThickness = 2;
1335
1336     // We need to have some space between underlines of subsequent clauses, because some input methods do not use different underline styles for those.
1337     // We make each line shorter, which has a harmless side effect of shortening the first and last clauses, too.
1338     start += 1;
1339     width -= 2;
1340
1341     ctx->setStrokeColor(underline.color, renderer().style().colorSpace());
1342     ctx->setStrokeThickness(lineThickness);
1343     ctx->drawLineForText(FloatPoint(boxOrigin.x() + start, boxOrigin.y() + logicalHeight() - lineThickness), width, renderer().document().printing());
1344 }
1345
1346 int InlineTextBox::caretMinOffset() const
1347 {
1348     return m_start;
1349 }
1350
1351 int InlineTextBox::caretMaxOffset() const
1352 {
1353     return m_start + m_len;
1354 }
1355
1356 float InlineTextBox::textPos() const
1357 {
1358     // When computing the width of a text run, RenderBlock::computeInlineDirectionPositionsForLine() doesn't include the actual offset
1359     // from the containing block edge in its measurement. textPos() should be consistent so the text are rendered in the same width.
1360     if (logicalLeft() == 0)
1361         return 0;
1362     return logicalLeft() - root().logicalLeft();
1363 }
1364
1365 int InlineTextBox::offsetForPosition(float lineOffset, bool includePartialGlyphs) const
1366 {
1367     if (isLineBreak())
1368         return 0;
1369
1370     if (lineOffset - logicalLeft() > logicalWidth())
1371         return isLeftToRightDirection() ? len() : 0;
1372     if (lineOffset - logicalLeft() < 0)
1373         return isLeftToRightDirection() ? 0 : len();
1374
1375     FontCachePurgePreventer fontCachePurgePreventer;
1376
1377     const RenderStyle& lineStyle = this->lineStyle();
1378     const Font& font = fontToUse(lineStyle, renderer());
1379     return font.offsetForPosition(constructTextRun(lineStyle, font), lineOffset - logicalLeft(), includePartialGlyphs);
1380 }
1381
1382 float InlineTextBox::positionForOffset(int offset) const
1383 {
1384     ASSERT(offset >= m_start);
1385     ASSERT(offset <= m_start + m_len);
1386
1387     if (isLineBreak())
1388         return logicalLeft();
1389
1390     FontCachePurgePreventer fontCachePurgePreventer;
1391
1392     const RenderStyle& lineStyle = this->lineStyle();
1393     const Font& font = fontToUse(lineStyle, renderer());
1394     int from = !isLeftToRightDirection() ? offset - m_start : 0;
1395     int to = !isLeftToRightDirection() ? m_len : offset - m_start;
1396     // FIXME: Do we need to add rightBearing here?
1397     LayoutRect selectionRect = LayoutRect(logicalLeft(), 0, 0, 0);
1398     TextRun run = constructTextRun(lineStyle, font);
1399     font.adjustSelectionRectForText(run, selectionRect, from, to);
1400     return directionalPixelSnappedForPainting(selectionRect, renderer().document().deviceScaleFactor(), run.ltr()).maxX();
1401 }
1402
1403 TextRun InlineTextBox::constructTextRun(const RenderStyle& style, const Font& font, BufferForAppendingHyphen* charactersWithHyphen) const
1404 {
1405     ASSERT(renderer().text());
1406
1407     String string = renderer().text();
1408     unsigned startPos = start();
1409     unsigned length = len();
1410
1411     if (string.length() != length || startPos)
1412         string = string.substringSharingImpl(startPos, length);
1413
1414     return constructTextRun(style, font, string, renderer().textLength() - startPos, charactersWithHyphen);
1415 }
1416
1417 TextRun InlineTextBox::constructTextRun(const RenderStyle& style, const Font& font, String string, int maximumLength, BufferForAppendingHyphen* charactersWithHyphen) const
1418 {
1419     int length = string.length();
1420
1421     if (charactersWithHyphen) {
1422         adjustCharactersAndLengthForHyphen(*charactersWithHyphen, style, string, length);
1423         maximumLength = length;
1424     }
1425
1426     ASSERT(maximumLength >= length);
1427
1428     TextRun run(string, textPos(), expansion(), expansionBehavior(), direction(), dirOverride() || style.rtlOrdering() == VisualOrder, !renderer().canUseSimpleFontCodePath());
1429     run.setTabSize(!style.collapseWhiteSpace(), style.tabSize());
1430     if (font.isSVGFont())
1431         run.setRenderingContext(SVGTextRunRenderingContext::create(renderer()));
1432
1433     // Propagate the maximum length of the characters buffer to the TextRun, even when we're only processing a substring.
1434     run.setCharactersLength(maximumLength);
1435     ASSERT(run.charactersLength() >= run.length());
1436     return run;
1437 }
1438
1439 #ifndef NDEBUG
1440
1441 const char* InlineTextBox::boxName() const
1442 {
1443     return "InlineTextBox";
1444 }
1445
1446 void InlineTextBox::showBox(int printedCharacters) const
1447 {
1448     String value = renderer().text();
1449     value = value.substring(start(), len());
1450     value.replaceWithLiteral('\\', "\\\\");
1451     value.replaceWithLiteral('\n', "\\n");
1452     printedCharacters += fprintf(stderr, "%s\t%p", boxName(), this);
1453     for (; printedCharacters < showTreeCharacterOffset; printedCharacters++)
1454         fputc(' ', stderr);
1455     printedCharacters = fprintf(stderr, "\t%s %p", renderer().renderName(), &renderer());
1456     const int rendererCharacterOffset = 24;
1457     for (; printedCharacters < rendererCharacterOffset; printedCharacters++)
1458         fputc(' ', stderr);
1459     fprintf(stderr, "(%d,%d) \"%s\"\n", start(), start() + len(), value.utf8().data());
1460 }
1461
1462 #endif
1463
1464 } // namespace WebCore