| /* |
| * (C) 1999 Lars Knoll (knoll@kde.org) |
| * (C) 2000 Dirk Mueller (mueller@kde.org) |
| * Copyright (C) 2004-2017 Apple Inc. All rights reserved. |
| * |
| * This library is free software; you can redistribute it and/or |
| * modify it under the terms of the GNU Library General Public |
| * License as published by the Free Software Foundation; either |
| * version 2 of the License, or (at your option) any later version. |
| * |
| * This library is distributed in the hope that it will be useful, |
| * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| * Library General Public License for more details. |
| * |
| * You should have received a copy of the GNU Library General Public License |
| * along with this library; see the file COPYING.LIB. If not, write to |
| * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
| * Boston, MA 02110-1301, USA. |
| * |
| */ |
| |
| #include "config.h" |
| #include "TextDecorationPainter.h" |
| |
| #include "FilterOperations.h" |
| #include "FontCascade.h" |
| #include "GraphicsContext.h" |
| #include "HTMLAnchorElement.h" |
| #include "HTMLFontElement.h" |
| #include "InlineTextBoxStyle.h" |
| #include "RenderBlock.h" |
| #include "RenderStyle.h" |
| #include "RenderText.h" |
| #include "ShadowData.h" |
| #include "TextRun.h" |
| |
| namespace WebCore { |
| |
| /* |
| * Draw one cubic Bezier curve and repeat the same pattern long the the decoration's axis. |
| * The start point (p1), controlPoint1, controlPoint2 and end point (p2) of the Bezier curve |
| * form a diamond shape: |
| * |
| * step |
| * |-----------| |
| * |
| * controlPoint1 |
| * + |
| * |
| * |
| * . . |
| * . . |
| * . . |
| * (x1, y1) p1 + . + p2 (x2, y2) - <--- Decoration's axis |
| * . . | |
| * . . | |
| * . . | controlPointDistance |
| * | |
| * | |
| * + - |
| * controlPoint2 |
| * |
| * |-----------| |
| * step |
| */ |
| static void strokeWavyTextDecoration(GraphicsContext& context, const FloatRect& rect, float fontSize) |
| { |
| auto wavyStrokeParameters = getWavyStrokeParameters(fontSize); |
| |
| FloatPoint p1 = rect.minXMinYCorner(); |
| FloatPoint p2 = rect.maxXMinYCorner(); |
| |
| // Extent the wavy line before and after the text so it can cover the whole length. |
| p1.setX(p1.x() - 2 * wavyStrokeParameters.step); |
| p2.setX(p2.x() + 2 * wavyStrokeParameters.step); |
| |
| auto bounds = rect; |
| // Offset the bounds and set extra height to ensure the whole wavy line is covered. |
| bounds.setY(bounds.y() - wavyStrokeParameters.controlPointDistance); |
| bounds.setHeight(bounds.height() + 2 * wavyStrokeParameters.controlPointDistance); |
| // Clip the extra wavy line added before |
| GraphicsContextStateSaver stateSaver(context); |
| context.clip(bounds); |
| |
| context.adjustLineToPixelBoundaries(p1, p2, rect.height(), context.strokeStyle()); |
| |
| Path path; |
| path.moveTo(p1); |
| |
| ASSERT(p1.y() == p2.y()); |
| |
| float yAxis = p1.y(); |
| float x1 = std::min(p1.x(), p2.x()); |
| float x2 = std::max(p1.x(), p2.x()); |
| |
| FloatPoint controlPoint1(0, yAxis + wavyStrokeParameters.controlPointDistance); |
| FloatPoint controlPoint2(0, yAxis - wavyStrokeParameters.controlPointDistance); |
| |
| for (float x = x1; x + 2 * wavyStrokeParameters.step <= x2;) { |
| controlPoint1.setX(x + wavyStrokeParameters.step); |
| controlPoint2.setX(x + wavyStrokeParameters.step); |
| x += 2 * wavyStrokeParameters.step; |
| path.addBezierCurveTo(controlPoint1, controlPoint2, FloatPoint(x, yAxis)); |
| } |
| |
| context.setShouldAntialias(true); |
| context.setStrokeThickness(rect.height()); |
| context.strokePath(path); |
| } |
| |
| static bool compareTuples(std::pair<float, float> l, std::pair<float, float> r) |
| { |
| return l.first < r.first; |
| } |
| |
| static DashArray translateIntersectionPointsToSkipInkBoundaries(const DashArray& intersections, float dilationAmount, float totalWidth) |
| { |
| ASSERT(!(intersections.size() % 2)); |
| |
| // Step 1: Make pairs so we can sort based on range starting-point. We dilate the ranges in this step as well. |
| Vector<std::pair<float, float>> tuples; |
| for (auto i = intersections.begin(); i != intersections.end(); i++, i++) |
| tuples.append(std::make_pair(*i - dilationAmount, *(i + 1) + dilationAmount)); |
| std::sort(tuples.begin(), tuples.end(), &compareTuples); |
| |
| // Step 2: Deal with intersecting ranges. |
| Vector<std::pair<float, float>> intermediateTuples; |
| if (tuples.size() >= 2) { |
| intermediateTuples.append(*tuples.begin()); |
| for (auto i = tuples.begin() + 1; i != tuples.end(); i++) { |
| float& firstEnd = intermediateTuples.last().second; |
| float secondStart = i->first; |
| float secondEnd = i->second; |
| if (secondStart <= firstEnd && secondEnd <= firstEnd) { |
| // Ignore this range completely |
| } else if (secondStart <= firstEnd) |
| firstEnd = secondEnd; |
| else |
| intermediateTuples.append(*i); |
| } |
| } else |
| intermediateTuples = tuples; |
| |
| // Step 3: Output the space between the ranges, but only if the space warrants an underline. |
| float previous = 0; |
| DashArray result; |
| for (const auto& tuple : intermediateTuples) { |
| if (tuple.first - previous > dilationAmount) { |
| result.append(previous); |
| result.append(tuple.first); |
| } |
| previous = tuple.second; |
| } |
| if (totalWidth - previous > dilationAmount) { |
| result.append(previous); |
| result.append(totalWidth); |
| } |
| |
| return result; |
| } |
| |
| static StrokeStyle textDecorationStyleToStrokeStyle(TextDecorationStyle decorationStyle) |
| { |
| StrokeStyle strokeStyle = SolidStroke; |
| switch (decorationStyle) { |
| case TextDecorationStyle::Solid: |
| strokeStyle = SolidStroke; |
| break; |
| case TextDecorationStyle::Double: |
| strokeStyle = DoubleStroke; |
| break; |
| case TextDecorationStyle::Dotted: |
| strokeStyle = DottedStroke; |
| break; |
| case TextDecorationStyle::Dashed: |
| strokeStyle = DashedStroke; |
| break; |
| case TextDecorationStyle::Wavy: |
| strokeStyle = WavyStroke; |
| break; |
| } |
| |
| return strokeStyle; |
| } |
| |
| bool TextDecorationPainter::Styles::operator==(const Styles& other) const |
| { |
| return underlineColor == other.underlineColor && overlineColor == other.overlineColor && linethroughColor == other.linethroughColor |
| && underlineStyle == other.underlineStyle && overlineStyle == other.overlineStyle && linethroughStyle == other.linethroughStyle; |
| } |
| |
| TextDecorationPainter::TextDecorationPainter(GraphicsContext& context, OptionSet<TextDecorationLine> decorations, const RenderText& renderer, bool isFirstLine, const FontCascade& font, std::optional<Styles> styles) |
| : m_context { context } |
| , m_decorations { decorations } |
| , m_wavyOffset { wavyOffsetFromDecoration() } |
| , m_isPrinting { renderer.document().printing() } |
| , m_font { font } |
| , m_styles { styles ? *WTFMove(styles) : stylesForRenderer(renderer, decorations, isFirstLine, PseudoId::None) } |
| , m_lineStyle { isFirstLine ? renderer.firstLineStyle() : renderer.style() } |
| { |
| } |
| |
| // Paint text-shadow, underline, overline |
| void TextDecorationPainter::paintBackgroundDecorations(const TextRun& textRun, const FloatPoint& textOrigin, const FloatPoint& boxOrigin) |
| { |
| const auto& fontMetrics = m_lineStyle.fontMetrics(); |
| float textDecorationThickness = m_lineStyle.textDecorationThickness().resolve(m_lineStyle.computedFontSize(), fontMetrics); |
| FloatPoint localOrigin = boxOrigin; |
| |
| auto paintDecoration = [&] (TextDecorationLine decoration, TextDecorationStyle style, const Color& color, const FloatRect& rect) { |
| m_context.setStrokeColor(color); |
| |
| auto strokeStyle = textDecorationStyleToStrokeStyle(style); |
| |
| if (style == TextDecorationStyle::Wavy) |
| strokeWavyTextDecoration(m_context, rect, m_lineStyle.computedFontPixelSize()); |
| else if (decoration == TextDecorationLine::Underline || decoration == TextDecorationLine::Overline) { |
| if ((m_lineStyle.textDecorationSkipInk() == TextDecorationSkipInk::Auto || m_lineStyle.textDecorationSkipInk() == TextDecorationSkipInk::All) && m_isHorizontal) { |
| if (!m_context.paintingDisabled()) { |
| FloatRect underlineBoundingBox = m_context.computeUnderlineBoundsForText(rect, m_isPrinting); |
| DashArray intersections = m_font.dashesForIntersectionsWithRect(textRun, textOrigin, underlineBoundingBox); |
| DashArray boundaries = translateIntersectionPointsToSkipInkBoundaries(intersections, underlineBoundingBox.height(), rect.width()); |
| ASSERT(!(boundaries.size() % 2)); |
| // We don't use underlineBoundingBox here because drawLinesForText() will run computeUnderlineBoundsForText() internally. |
| m_context.drawLinesForText(rect.location(), rect.height(), boundaries, m_isPrinting, style == TextDecorationStyle::Double, strokeStyle); |
| } |
| } else { |
| // FIXME: Need to support text-decoration-skip: none. |
| m_context.drawLineForText(rect, m_isPrinting, style == TextDecorationStyle::Double, strokeStyle); |
| } |
| } else |
| ASSERT_NOT_REACHED(); |
| }; |
| |
| bool areLinesOpaque = !m_isPrinting && (!m_decorations.contains(TextDecorationLine::Underline) || m_styles.underlineColor.isOpaque()) |
| && (!m_decorations.contains(TextDecorationLine::Overline) || m_styles.overlineColor.isOpaque()) |
| && (!m_decorations.contains(TextDecorationLine::LineThrough) || m_styles.linethroughColor.isOpaque()); |
| |
| float extraOffset = 0; |
| bool clipping = !areLinesOpaque && m_shadow && m_shadow->next(); |
| if (clipping) { |
| FloatRect clipRect(localOrigin, FloatSize(m_width, fontMetrics.ascent() + 2)); |
| for (const ShadowData* shadow = m_shadow; shadow; shadow = shadow->next()) { |
| int shadowExtent = shadow->paintingExtent(); |
| FloatRect shadowRect(localOrigin, FloatSize(m_width, fontMetrics.ascent() + 2)); |
| shadowRect.inflate(shadowExtent); |
| float shadowX = LayoutUnit(m_isHorizontal ? shadow->x().value() : shadow->y().value()); |
| float shadowY = LayoutUnit(m_isHorizontal ? shadow->y().value() : -shadow->x().value()); |
| shadowRect.move(shadowX, shadowY); |
| clipRect.unite(shadowRect); |
| extraOffset = std::max(extraOffset, std::max(0.f, shadowY) + shadowExtent); |
| } |
| m_context.save(); |
| m_context.clip(clipRect); |
| extraOffset += fontMetrics.ascent() + 2; |
| localOrigin.move(0, extraOffset); |
| } |
| |
| const ShadowData* shadow = m_shadow; |
| do { |
| if (shadow) { |
| if (!shadow->next()) { |
| // The last set of lines paints normally inside the clip. |
| localOrigin.move(0, -extraOffset); |
| extraOffset = 0; |
| } |
| float shadowX = LayoutUnit(m_isHorizontal ? shadow->x().value() : shadow->y().value()); |
| float shadowY = LayoutUnit(m_isHorizontal ? shadow->y().value() : -shadow->x().value()); |
| |
| Color shadowColor = shadow->color(); |
| if (m_shadowColorFilter) |
| m_shadowColorFilter->transformColor(shadowColor); |
| m_context.setShadow(FloatSize(shadowX, shadowY - extraOffset), shadow->radius().value(), shadowColor); |
| shadow = shadow->next(); |
| } |
| |
| // These decorations should match the visual overflows computed in visualOverflowForDecorations(). |
| if (m_decorations.contains(TextDecorationLine::Underline)) { |
| float textDecorationBaseFontSize = 16; |
| auto defaultGap = m_lineStyle.computedFontSize() / textDecorationBaseFontSize; |
| float offset = computeUnderlineOffset(m_lineStyle.textUnderlinePosition(), m_lineStyle.textUnderlineOffset(), m_lineStyle.fontMetrics(), m_textBox, defaultGap); |
| float wavyOffset = m_styles.underlineStyle == TextDecorationStyle::Wavy ? m_wavyOffset : 0; |
| FloatRect rect(localOrigin, FloatSize(m_width, textDecorationThickness)); |
| rect.move(0, offset + wavyOffset); |
| paintDecoration(TextDecorationLine::Underline, m_styles.underlineStyle, m_styles.underlineColor, rect); |
| } |
| if (m_decorations.contains(TextDecorationLine::Overline)) { |
| float wavyOffset = m_styles.overlineStyle == TextDecorationStyle::Wavy ? m_wavyOffset : 0; |
| FloatRect rect(localOrigin, FloatSize(m_width, textDecorationThickness)); |
| float autoTextDecorationThickness = TextDecorationThickness::createWithAuto().resolve(m_lineStyle.computedFontSize(), fontMetrics); |
| rect.move(0, autoTextDecorationThickness - textDecorationThickness - wavyOffset); |
| paintDecoration(TextDecorationLine::Overline, m_styles.overlineStyle, m_styles.overlineColor, rect); |
| } |
| |
| // We only want to paint the shadow, hence the transparent color, not the actual line-through, |
| // which will be painted in paintForegroundDecorations(). |
| if (shadow && m_decorations.contains(TextDecorationLine::LineThrough)) |
| paintLineThrough(Color::transparentBlack, textDecorationThickness, localOrigin); |
| } while (shadow); |
| |
| if (clipping) |
| m_context.restore(); |
| else if (m_shadow) |
| m_context.clearShadow(); |
| } |
| |
| void TextDecorationPainter::paintForegroundDecorations(const FloatPoint& boxOrigin) |
| { |
| if (!m_decorations.contains(TextDecorationLine::LineThrough)) |
| return; |
| |
| float textDecorationThickness = m_lineStyle.textDecorationThickness().resolve(m_lineStyle.computedFontSize(), m_lineStyle.fontMetrics()); |
| paintLineThrough(m_styles.linethroughColor, textDecorationThickness, boxOrigin); |
| } |
| |
| void TextDecorationPainter::paintLineThrough(const Color& color, float thickness, const FloatPoint& localOrigin) |
| { |
| const auto& fontMetrics = m_lineStyle.fontMetrics(); |
| FloatRect rect(localOrigin, FloatSize(m_width, thickness)); |
| float autoTextDecorationThickness = TextDecorationThickness::createWithAuto().resolve(m_lineStyle.computedFontSize(), fontMetrics); |
| auto center = 2 * fontMetrics.floatAscent() / 3 + autoTextDecorationThickness / 2; |
| rect.move(0, center - thickness / 2); |
| |
| m_context.setStrokeColor(color); |
| |
| TextDecorationStyle style = m_styles.linethroughStyle; |
| auto strokeStyle = textDecorationStyleToStrokeStyle(style); |
| |
| if (style == TextDecorationStyle::Wavy) |
| strokeWavyTextDecoration(m_context, rect, m_lineStyle.computedFontPixelSize()); |
| else |
| m_context.drawLineForText(rect, m_isPrinting, style == TextDecorationStyle::Double, strokeStyle); |
| } |
| |
| static void collectStylesForRenderer(TextDecorationPainter::Styles& result, const RenderObject& renderer, OptionSet<TextDecorationLine> remainingDecorations, bool firstLineStyle, PseudoId pseudoId) |
| { |
| auto extractDecorations = [&] (const RenderStyle& style, OptionSet<TextDecorationLine> decorations) { |
| auto color = TextDecorationPainter::decorationColor(style); |
| auto decorationStyle = style.textDecorationStyle(); |
| |
| if (decorations.contains(TextDecorationLine::Underline)) { |
| remainingDecorations.remove(TextDecorationLine::Underline); |
| result.underlineColor = color; |
| result.underlineStyle = decorationStyle; |
| } |
| if (decorations.contains(TextDecorationLine::Overline)) { |
| remainingDecorations.remove(TextDecorationLine::Overline); |
| result.overlineColor = color; |
| result.overlineStyle = decorationStyle; |
| } |
| if (decorations.contains(TextDecorationLine::LineThrough)) { |
| remainingDecorations.remove(TextDecorationLine::LineThrough); |
| result.linethroughColor = color; |
| result.linethroughStyle = decorationStyle; |
| } |
| |
| }; |
| |
| auto styleForRenderer = [&] (const RenderObject& renderer) -> const RenderStyle& { |
| if (pseudoId != PseudoId::None && renderer.style().hasPseudoStyle(pseudoId)) { |
| if (is<RenderText>(renderer)) |
| return *downcast<RenderText>(renderer).getCachedPseudoStyle(pseudoId); |
| return *downcast<RenderElement>(renderer).getCachedPseudoStyle(pseudoId); |
| } |
| return firstLineStyle ? renderer.firstLineStyle() : renderer.style(); |
| }; |
| |
| auto* current = &renderer; |
| do { |
| const auto& style = styleForRenderer(*current); |
| extractDecorations(style, style.textDecoration()); |
| |
| if (current->isRubyText()) |
| return; |
| |
| current = current->parent(); |
| if (current && current->isAnonymousBlock() && downcast<RenderBlock>(*current).continuation()) |
| current = downcast<RenderBlock>(*current).continuation(); |
| |
| if (remainingDecorations.isEmpty()) |
| break; |
| |
| } while (current && !is<HTMLAnchorElement>(current->node()) && !is<HTMLFontElement>(current->node())); |
| |
| // If we bailed out, use the element we bailed out at (typically a <font> or <a> element). |
| if (!remainingDecorations.isEmpty() && current) |
| extractDecorations(styleForRenderer(*current), remainingDecorations); |
| } |
| |
| Color TextDecorationPainter::decorationColor(const RenderStyle& style) |
| { |
| return style.visitedDependentColorWithColorFilter(CSSPropertyTextDecorationColor); |
| } |
| |
| OptionSet<TextDecorationLine> TextDecorationPainter::textDecorationsInEffectForStyle(const TextDecorationPainter::Styles& style) |
| { |
| OptionSet<TextDecorationLine> decorations; |
| if (style.underlineColor.isValid()) |
| decorations.add(TextDecorationLine::Underline); |
| if (style.overlineColor.isValid()) |
| decorations.add(TextDecorationLine::Overline); |
| if (style.linethroughColor.isValid()) |
| decorations.add(TextDecorationLine::LineThrough); |
| return decorations; |
| }; |
| |
| auto TextDecorationPainter::stylesForRenderer(const RenderObject& renderer, OptionSet<TextDecorationLine> requestedDecorations, bool firstLineStyle, PseudoId pseudoId) -> Styles |
| { |
| Styles result; |
| collectStylesForRenderer(result, renderer, requestedDecorations, false, pseudoId); |
| if (firstLineStyle) |
| collectStylesForRenderer(result, renderer, requestedDecorations, true, pseudoId); |
| return result; |
| } |
| |
| } // namespace WebCore |
