skparagraph/src/Decorations.cpp

// Copyright 2020 Google LLC.
#ifdef ENABLE_TEXT_ENHANCE
#include <map>
#endif
#include "include/core/SkPathBuilder.h"
#include "modules/skparagraph/src/Decorations.h"

using namespace skia_private;

namespace skia {
namespace textlayout {
#ifdef ENABLE_TEXT_ENHANCE
static const std::map<SkPaint::Style, RSDrawing::Paint::PaintStyle> PAINT_STYLE = {
    {SkPaint::kFill_Style, RSDrawing::Paint::PaintStyle::PAINT_FILL},
    {SkPaint::kStroke_Style, RSDrawing::Paint::PaintStyle::PAINT_STROKE},
    {SkPaint::kStrokeAndFill_Style, RSDrawing::Paint::PaintStyle::PAINT_FILL_STROKE},
};
#endif
namespace {
void draw_line_as_rect(ParagraphPainter* painter, SkScalar x, SkScalar y, SkScalar width,
                       const ParagraphPainter::DecorationStyle& decorStyle) {
    SkASSERT(decorStyle.skPaint().getPathEffect() == nullptr);
    SkASSERT(decorStyle.skPaint().getStrokeCap() == SkPaint::kButt_Cap);
    SkASSERT(decorStyle.skPaint().getStrokeWidth() > 0);   // this trick won't work for hairlines

    float radius = decorStyle.getStrokeWidth() * 0.5f;
    painter->drawFilledRect({x, y - radius, x + width, y + radius}, decorStyle);
}

const float kDoubleDecorationSpacing = 3.0f;
}  // namespace

#ifdef ENABLE_TEXT_ENHANCE
void Decorations::updateDecorationPosition(TextDecoration decorationMode, SkScalar baselineShift,
    const TextLine::ClipContext& context, SkScalar& positionY) {
    switch (getVerticalAlignment()) {
        case TextVerticalAlign::TOP:
            if (decorationMode == TextDecoration::kOverline) {
                positionY = context.run->getTopInGroup() - baselineShift;
            }
            break;
        case TextVerticalAlign::CENTER:
            if (decorationMode == TextDecoration::kLineThrough) {
                // Position the line-through decoration at the vertical center of the line
                // The division by 2 places it in the middle between the line
                positionY = fDecorationContext.lineHeight / 2 - baselineShift;
            }
            break;
        case TextVerticalAlign::BOTTOM:
            if (decorationMode == TextDecoration::kUnderline) {
                positionY = fDecorationContext.lineHeight - baselineShift;
            }
            break;
        default:
            break;
    }
}

SkScalar Decorations::calculateThickness(const TextStyle& textStyle, const TextLine::ClipContext& context) {
    calculateThickness(textStyle, const_cast<RSFont&>(context.run->font()).GetTypeface());
    return fThickness;
}

void Decorations::paint(ParagraphPainter* painter, const TextStyle& textStyle, const TextLine::ClipContext& context, SkScalar baseline) {
    if (textStyle.getDecorationType() == TextDecoration::kNoDecoration) {
        return;
    }

    // Get thickness and position
    calculateThickness(textStyle, const_cast<RSFont&>(context.run->font()).GetTypeface());

    for (auto decoration : AllTextDecorations) {
        if ((textStyle.getDecorationType() & decoration) == 0) {
            continue;
        }

        SkScalar textBaselineShift = 0.0f;
        if (getVerticalAlignment() == TextVerticalAlign::BASELINE) {
            textBaselineShift = textStyle.getTotalVerticalShift();
        } else {
            textBaselineShift = context.run->baselineShift();
        }
        calculatePosition(decoration,
                          decoration == TextDecoration::kOverline
                          ? context.run->correctAscent() - context.run->ascent()
                          : context.run->correctAscent(),
                          textStyle, textBaselineShift, *context.run);

        calculatePaint(textStyle);

        auto width = context.clip.width();
        if (context.fIsTrimTrailingSpaceWidth) {
            width = std::max(width - context.fTrailingSpaceWidth, 0.0f);
        }

        SkScalar x = context.clip.left();
        SkScalar y = (TextDecoration::kUnderline == decoration) ?
            fPosition : (context.clip.top() + fPosition);
        updateDecorationPosition(decoration, textBaselineShift, context, y);
        baseline += context.run->getVerticalAlignShift();
        bool drawGaps = textStyle.getDecorationMode() == TextDecorationMode::kGaps &&
                        textStyle.getDecorationType() == TextDecoration::kUnderline;

        switch (textStyle.getDecorationStyle()) {
          case TextDecorationStyle::kWavy: {
              if (drawGaps) {
                  calculateAvoidanceWaves(textStyle, context.clip);
                  fPath.Offset(x, y);
                  painter->drawPath(fPath, fDecorStyle);
                  break;
              }
              calculateWaves(textStyle, context.clip);
              fPath.Offset(x, y);
              painter->drawPath(fPath, fDecorStyle);
              break;
          }
          case TextDecorationStyle::kDouble: {
              SkScalar bottom = y + kDoubleDecorationSpacing * fThickness / 2.0;
              if (drawGaps) {
                  SkScalar left = x - context.fTextShift;
                  painter->translate(context.fTextShift, 0);
                  calculateGaps(context, SkRect::MakeXYWH(left, y, width, fThickness), baseline, fThickness, textStyle);
                  painter->drawPath(fPath, fDecorStyle);
                  calculateGaps(context, SkRect::MakeXYWH(left, bottom, width, fThickness), baseline,
                      fThickness, textStyle);
                  painter->drawPath(fPath, fDecorStyle);
              } else {
                  draw_line_as_rect(painter, x,      y, width, fDecorStyle);
                  draw_line_as_rect(painter, x, bottom, width, fDecorStyle);
              }
              break;
          }
          case TextDecorationStyle::kDashed:
          case TextDecorationStyle::kDotted:
              if (drawGaps) {
                  SkScalar left = x - context.fTextShift;
                  painter->translate(context.fTextShift, 0);
                  calculateGaps(context, SkRect::MakeXYWH(left, y, width, fThickness), baseline, fThickness, textStyle);
                  painter->drawPath(fPath, fDecorStyle);
              } else {
                  painter->drawLine(x, y, x + width, y, fDecorStyle);
              }
              break;
          case TextDecorationStyle::kSolid:
              if (drawGaps) {
                  SkScalar left = x - context.fTextShift;
                  painter->translate(context.fTextShift, 0);
                  SkRect rect = SkRect::MakeXYWH(left, y, width, fThickness);
                  calculateGaps(context, rect, baseline, fThickness, textStyle);
                  painter->drawPath(fPath, fDecorStyle);
              } else {
                  draw_line_as_rect(painter, x, y, width, fDecorStyle);
              }
              break;
          default:break;
        }
    }
}

static RSDrawing::Paint::PaintStyle ConvertDrawingStyle(SkPaint::Style skStyle) {
    if (PAINT_STYLE.find(skStyle) != PAINT_STYLE.end()) {
        return PAINT_STYLE.at(skStyle);
    } else {
        return RSDrawing::Paint::PaintStyle::PAINT_NONE;
    }
}

static RSDrawing::Paint ConvertDecorStyle(const ParagraphPainter::DecorationStyle& decorStyle) {
    const SkPaint& decorPaint = decorStyle.skPaint();
    RSDrawing::Paint paint;
    paint.SetStyle(ConvertDrawingStyle(decorPaint.getStyle()));
    paint.SetAntiAlias(decorPaint.isAntiAlias());
    paint.SetColor(decorPaint.getColor());
    paint.SetWidth(decorPaint.getStrokeWidth());
    if (decorStyle.getDashPathEffect().has_value()) {
        auto dashPathEffect = decorStyle.getDashPathEffect().value();
        RSDrawing::scalar intervals[] = {dashPathEffect.fOnLength, dashPathEffect.fOffLength,
            dashPathEffect.fOnLength, dashPathEffect.fOffLength};
        size_t count = sizeof(intervals) / sizeof(intervals[0]);
        auto pathEffect1 = RSDrawing::PathEffect::CreateDashPathEffect(intervals, count, 0.0f);
        auto pathEffect2 = RSDrawing::PathEffect::CreateDiscretePathEffect(0, 0);
        auto pathEffect = RSDrawing::PathEffect::CreateComposePathEffect(*pathEffect1.get(), *pathEffect2.get());
        paint.SetPathEffect(pathEffect);
    }
    return paint;
}

void Decorations::calculateGaps(const TextLine::ClipContext& context, const SkRect& rect,
    SkScalar baseline, SkScalar halo, const TextStyle& textStyle) {
    // Create a special text blob for decorations
    RSTextBlobBuilder builder;
    context.run->copyTo(builder, SkToU32(context.pos), context.size);
    auto blob = builder.Make();
    if (!blob) {
        // There is no text really
        return;
    }
    SkScalar top = textStyle.getHeight() != 0 ? this->fDecorationContext.textBlobTop + baseline : rect.fTop;
    // Since we do not shift down the text by {baseline}
    // (it now happens on drawTextBlob but we do not draw text here)
    // we have to shift up the bounds to compensate
    // This baseline thing ends with getIntercepts
    const SkScalar bounds[2] = {top - baseline, top + halo - baseline};
    RSDrawing::Paint paint = ConvertDecorStyle(fDecorStyle);
    auto count = blob->GetIntercepts(bounds, nullptr, &paint);
    skia_private::TArray<SkScalar> intersections(count);
    intersections.resize(count);
    blob->GetIntercepts(bounds, intersections.data(), &paint);

    RSPath path;
    auto start = rect.fLeft;
    path.MoveTo(rect.fLeft, rect.fTop);
    for (int i = 0; i < intersections.size(); i += 2) {
        auto end = intersections[i] - halo;
        if (end - start >= halo) {
            start = intersections[i + 1] + halo;
            path.LineTo(end, rect.fTop);
            path.MoveTo(start, rect.fTop);
        } else {
            start = intersections[i + 1] + halo;
            path.MoveTo(start, rect.fTop);
        }
    }
    if (!intersections.empty() && (rect.fRight - start > halo)) {
        path.LineTo(rect.fRight, rect.fTop);
    }

    if (intersections.empty()) {
        path.LineTo(rect.fRight, rect.fTop);
    }
    fPath = path;
}

void Decorations::calculateAvoidanceWaves(const TextStyle& textStyle, SkRect clip) {
    fPath.Reset();
    int wave_count = 0;
    const int step = 2;
    const float zer = 0.01;
    SkScalar x_start = 0;
    SkScalar quarterWave = fThickness;
    if (quarterWave <= zer) {
        return;
    }
    fPath.MoveTo(0, 0);
    while (x_start + quarterWave * step < clip.width()) {
        fPath.RQuadTo(quarterWave,
            wave_count % step != 0 ? quarterWave : -quarterWave,
            quarterWave * step, 0);
        x_start += quarterWave * step;
        ++wave_count;
    }

    // The rest of the wave
    auto remaining = clip.width() - x_start;
    if (remaining > 0) {
        double x1 = remaining / step;
        double y1 = remaining / step * (wave_count % step == 0 ? -1 : 1);
        double x2 = remaining;
        double y2 = (remaining - remaining * remaining / (quarterWave * step)) *
                    (wave_count % step == 0 ? -1 : 1);
        fPath.RQuadTo(x1, y1, x2, y2);
    }
}

void Decorations::calculateThickness(TextStyle textStyle, std::shared_ptr<RSTypeface> typeface) {
    textStyle.setTypeface(std::move(typeface));
    textStyle.getFontMetrics(&fFontMetrics);
    if (textStyle.getDecoration().fType == TextDecoration::kUnderline &&
        !SkScalarNearlyZero(fThickness)) {
        return;
    }

    fThickness = textStyle.getFontSize() * UNDER_LINE_THICKNESS_RATIO;
    fThickness *= textStyle.getDecorationThicknessMultiplier();
}

void Decorations::calculatePosition(TextDecoration decoration, SkScalar ascent,
    const TextStyle& textStyle, SkScalar textBaselineShift, const Run& run) {
    switch (decoration) {
        case TextDecoration::kUnderline:
            fPosition = fDecorationContext.underlinePosition + run.getVerticalAlignShift();
            break;
        case TextDecoration::kOverline:
            fPosition = (textStyle.getDecorationStyle() == TextDecorationStyle::kWavy ?
                fThickness : fThickness / 2.0f) - ascent;
            break;
        case TextDecoration::kLineThrough:
            fPosition = LINE_THROUGH_TOP * textStyle.getCorrectFontSize() - ascent + textBaselineShift;
            break;
        default:
            break;
    }
}

void Decorations::calculateWaves(const TextStyle& textStyle, SkRect clip) {
    if (SkScalarNearlyZero(fThickness) || fThickness < 0) {
        return;
    }
    fPath.Reset();
    int wave_count = 0;
    SkScalar x_start = 0;
    SkScalar quarterWave = fThickness;
    fPath.MoveTo(0, 0);

    while (x_start + quarterWave * 2 < clip.width()) {
        fPath.RQuadTo(quarterWave,
                     wave_count % 2 != 0 ? quarterWave : -quarterWave,
                     quarterWave * 2,
                     0);
        x_start += quarterWave * 2;
        ++wave_count;
    }

    // The rest of the wave
    auto remaining = clip.width() - x_start;
    if (remaining > 0) {
        double x1 = remaining / 2;
        double y1 = remaining / 2 * (wave_count % 2 == 0 ? -1 : 1);
        double x2 = remaining;
        double y2 = (remaining - remaining * remaining / (quarterWave * 2)) *
                    (wave_count % 2 == 0 ? -1 : 1);
        fPath.RQuadTo(x1, y1, x2, y2);
    }
}
#else
void Decorations::paint(ParagraphPainter* painter, const TextStyle& textStyle, const TextLine::ClipContext& context, SkScalar baseline) {
    if (textStyle.getDecorationType() == TextDecoration::kNoDecoration) {
        return;
    }

    // Get thickness and position
    calculateThickness(textStyle, context.run->font().refTypeface());

    for (auto decoration : AllTextDecorations) {
        if ((textStyle.getDecorationType() & decoration) == 0) {
            continue;
        }

        calculatePosition(decoration,
                          decoration == TextDecoration::kOverline
                          ? context.run->correctAscent() - context.run->ascent()
                          : context.run->correctAscent());

        calculatePaint(textStyle);

        auto width = context.clip.width();
        SkScalar x = context.clip.left();
        SkScalar y = context.clip.top() + fPosition;

        bool drawGaps = textStyle.getDecorationMode() == TextDecorationMode::kGaps &&
                        textStyle.getDecorationType() == TextDecoration::kUnderline;

        switch (textStyle.getDecorationStyle()) {
          case TextDecorationStyle::kWavy: {
              calculateWaves(textStyle, context.clip);
              fPath.offset(x, y);
              painter->drawPath(fPath, fDecorStyle);
              break;
          }
          case TextDecorationStyle::kDouble: {
              SkScalar bottom = y + kDoubleDecorationSpacing;
              if (drawGaps) {
                  SkScalar left = x - context.fTextShift;
                  painter->translate(context.fTextShift, 0);
                  calculateGaps(context, SkRect::MakeXYWH(left, y, width, fThickness), baseline, fThickness);
                  painter->drawPath(fPath, fDecorStyle);
                  calculateGaps(context, SkRect::MakeXYWH(left, bottom, width, fThickness), baseline, fThickness);
                  painter->drawPath(fPath, fDecorStyle);
              } else {
                  draw_line_as_rect(painter, x,      y, width, fDecorStyle);
                  draw_line_as_rect(painter, x, bottom, width, fDecorStyle);
              }
              break;
          }
          case TextDecorationStyle::kDashed:
          case TextDecorationStyle::kDotted:
              if (drawGaps) {
                  SkScalar left = x - context.fTextShift;
                  painter->translate(context.fTextShift, 0);
                  calculateGaps(context, SkRect::MakeXYWH(left, y, width, fThickness), baseline, 0);
                  painter->drawPath(fPath, fDecorStyle);
              } else {
                  painter->drawLine(x, y, x + width, y, fDecorStyle);
              }
              break;
          case TextDecorationStyle::kSolid:
              if (drawGaps) {
                  SkScalar left = x - context.fTextShift;
                  painter->translate(context.fTextShift, 0);
                  calculateGaps(context, SkRect::MakeXYWH(left, y, width, fThickness), baseline, fThickness);
                  painter->drawPath(fPath, fDecorStyle);
              } else {
                  draw_line_as_rect(painter, x, y, width, fDecorStyle);
              }
              break;
          default:break;
        }
    }
}

void Decorations::calculateGaps(const TextLine::ClipContext& context, const SkRect& rect,
                                SkScalar baseline, SkScalar halo) {
    // Create a special text blob for decorations
    SkTextBlobBuilder builder;
    context.run->copyTo(builder,
                      SkToU32(context.pos),
                      context.size);
    sk_sp<SkTextBlob> blob = builder.make();
    if (!blob) {
        // There is no text really
        return;
    }
    // Since we do not shift down the text by {baseline}
    // (it now happens on drawTextBlob but we do not draw text here)
    // we have to shift up the bounds to compensate
    // This baseline thing ends with getIntercepts
    const SkScalar bounds[2] = {rect.fTop - baseline, rect.fBottom - baseline};
    const SkPaint& decorPaint = fDecorStyle.skPaint();
    auto count = blob->getIntercepts(bounds, nullptr, &decorPaint);
    TArray<SkScalar> intersections(count);
    intersections.resize(count);
    blob->getIntercepts(bounds, intersections.data(), &decorPaint);

    SkPathBuilder path;
    auto start = rect.fLeft;
    path.moveTo(rect.fLeft, rect.fTop);
    for (int i = 0; i < intersections.size(); i += 2) {
        auto end = intersections[i] - halo;
        if (end - start >= halo) {
            start = intersections[i + 1] + halo;
            path.lineTo(end, rect.fTop).moveTo(start, rect.fTop);
        }
    }
    if (!intersections.empty() && (rect.fRight - start > halo)) {
        path.lineTo(rect.fRight, rect.fTop);
    }
    fPath = path.detach();
}

void Decorations::calculateThickness(TextStyle textStyle, sk_sp<SkTypeface> typeface) {

    textStyle.setTypeface(std::move(typeface));
    textStyle.getFontMetrics(&fFontMetrics);

    fThickness = textStyle.getFontSize() / 14.0f;

    if ((fFontMetrics.fFlags & SkFontMetrics::FontMetricsFlags::kUnderlineThicknessIsValid_Flag) &&
         fFontMetrics.fUnderlineThickness > 0) {
        fThickness = fFontMetrics.fUnderlineThickness;
    }

    if (textStyle.getDecorationType() == TextDecoration::kLineThrough) {
        if ((fFontMetrics.fFlags & SkFontMetrics::FontMetricsFlags::kStrikeoutThicknessIsValid_Flag) &&
             fFontMetrics.fStrikeoutThickness > 0) {
            fThickness = fFontMetrics.fStrikeoutThickness;
        }
    }
    fThickness *= textStyle.getDecorationThicknessMultiplier();
}

void Decorations::calculatePosition(TextDecoration decoration, SkScalar ascent) {
    switch (decoration) {
      case TextDecoration::kUnderline:
          if ((fFontMetrics.fFlags & SkFontMetrics::FontMetricsFlags::kUnderlinePositionIsValid_Flag) &&
               fFontMetrics.fUnderlinePosition > 0) {
            fPosition  = fFontMetrics.fUnderlinePosition;
          } else {
            fPosition = fThickness;
          }
          fPosition -= ascent;
          break;
      case TextDecoration::kOverline:
          fPosition = - ascent;
        break;
      case TextDecoration::kLineThrough: {
          fPosition = (fFontMetrics.fFlags & SkFontMetrics::FontMetricsFlags::kStrikeoutPositionIsValid_Flag)
                     ? fFontMetrics.fStrikeoutPosition
                     : fFontMetrics.fXHeight / -2;
          fPosition -= ascent;
          break;
      }
      default:SkASSERT(false);
          break;
    }
}

void Decorations::calculateWaves(const TextStyle& textStyle, SkRect clip) {
    fPath.reset();
    int wave_count = 0;
    SkScalar x_start = 0;
    SkScalar quarterWave = fThickness;
    fPath.moveTo(0, 0);
    while (x_start + quarterWave * 2 < clip.width()) {
        fPath.rQuadTo(quarterWave,
                     wave_count % 2 != 0 ? quarterWave : -quarterWave,
                     quarterWave * 2,
                     0);
        x_start += quarterWave * 2;
        ++wave_count;
    }

    // The rest of the wave
    auto remaining = clip.width() - x_start;
    if (remaining > 0) {
        double x1 = remaining / 2;
        double y1 = remaining / 2 * (wave_count % 2 == 0 ? -1 : 1);
        double x2 = remaining;
        double y2 = (remaining - remaining * remaining / (quarterWave * 2)) *
                    (wave_count % 2 == 0 ? -1 : 1);
        fPath.rQuadTo(x1, y1, x2, y2);
    }
}
#endif

void Decorations::calculatePaint(const TextStyle& textStyle) {
    std::optional<ParagraphPainter::DashPathEffect> dashPathEffect;
    SkScalar scaleFactor = textStyle.getFontSize() / 14.f;
    switch (textStyle.getDecorationStyle()) {
            // Note: the intervals are scaled by the thickness of the line, so it is
            // possible to change spacing by changing the decoration_thickness
            // property of TextStyle.
        case TextDecorationStyle::kDotted: {
            dashPathEffect.emplace(1.0f * scaleFactor, 1.5f * scaleFactor);
            break;
        }
            // Note: the intervals are scaled by the thickness of the line, so it is
            // possible to change spacing by changing the decoration_thickness
            // property of TextStyle.
        case TextDecorationStyle::kDashed: {
            dashPathEffect.emplace(4.0f * scaleFactor, 2.0f * scaleFactor);
            break;
        }
        default: break;
    }

    SkColor color = (textStyle.getDecorationColor() == SK_ColorTRANSPARENT)
        ? textStyle.getColor()
        : textStyle.getDecorationColor();

    fDecorStyle = ParagraphPainter::DecorationStyle(color, fThickness, dashPathEffect);
}

}  // namespace textlayout
}  // namespace skia