third_party/WebKit/Source/platform/graphics/StrokeData.cpp

// Copyright (C) 2013 Google Inc. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#include "platform/graphics/StrokeData.h"
#include <memory>
#include "platform/graphics/paint/PaintFlags.h"
#include "platform/wtf/PtrUtil.h"
#include "third_party/skia/include/effects/SkDashPathEffect.h"

namespace blink {

void StrokeData::SetLineDash(const DashArray& dashes, float dash_offset) {
  // FIXME: This is lifted directly off SkiaSupport, lines 49-74
  // so it is not guaranteed to work correctly.
  size_t dash_length = dashes.size();
  if (!dash_length) {
    // If no dash is set, revert to solid stroke
    // FIXME: do we need to set NoStroke in some cases?
    style_ = kSolidStroke;
    dash_.reset();
    return;
  }

  size_t count = !(dash_length % 2) ? dash_length : dash_length * 2;
  std::unique_ptr<SkScalar[]> intervals = WrapArrayUnique(new SkScalar[count]);

  for (unsigned i = 0; i < count; i++)
    intervals[i] = dashes[i % dash_length];

  dash_ = SkDashPathEffect::Make(intervals.get(), count, dash_offset);
}

void StrokeData::SetupPaint(PaintFlags* flags, int length) const {
  flags->setStyle(PaintFlags::kStroke_Style);
  flags->setStrokeWidth(SkFloatToScalar(thickness_));
  flags->setStrokeCap(line_cap_);
  flags->setStrokeJoin(line_join_);
  flags->setStrokeMiter(SkFloatToScalar(miter_limit_));

  SetupPaintDashPathEffect(flags, length);
}

void StrokeData::SetupPaintDashPathEffect(PaintFlags* flags, int length) const {
  if (dash_) {
    flags->setPathEffect(dash_);
  } else if (StrokeIsDashed(thickness_, style_)) {
    float dash_length = thickness_;
    float gap_length = dash_length;
    if (style_ == kDashedStroke) {
      dash_length *= StrokeData::DashLengthRatio(thickness_);
      gap_length *= StrokeData::DashGapRatio(thickness_);
    }
    // Account for modification to effective length in
    // GraphicsContext::adjustLineToPixelBoundaries
    length -= 2 * thickness_;
    if (length <= dash_length) {
      // No space for dashes
      flags->setPathEffect(0);
    } else if (length <= 2 * dash_length + gap_length) {
      // Exactly 2 dashes proportionally sized
      float multiplier = length / (2 * dash_length + gap_length);
      SkScalar intervals[2] = {dash_length * multiplier,
                               gap_length * multiplier};
      flags->setPathEffect(SkDashPathEffect::Make(intervals, 2, 0));
    } else {
      float gap = gap_length;
      if (style_ == kDashedStroke)
        gap = SelectBestDashGap(length, dash_length, gap_length);
      SkScalar intervals[2] = {dash_length, gap};
      flags->setPathEffect(SkDashPathEffect::Make(intervals, 2, 0));
    }
  } else if (style_ == kDottedStroke) {
    flags->setStrokeCap((PaintFlags::Cap)kRoundCap);
    // Adjust the width to get equal dot spacing as much as possible.
    float per_dot_length = thickness_ * 2;
    if (length < per_dot_length) {
      // Not enoguh space for 2 dots. Just draw 1 by giving a gap that is
      // bigger than the length.
      SkScalar intervals[2] = {0, per_dot_length};
      flags->setPathEffect(SkDashPathEffect::Make(intervals, 2, 0));
      return;
    }

    static const float kEpsilon = 1.0e-2f;
    float gap = SelectBestDashGap(length, thickness_, thickness_);
    SkScalar intervals[2] = {0, gap + thickness_ - kEpsilon};
    flags->setPathEffect(SkDashPathEffect::Make(intervals, 2, 0));
  } else {
    // TODO(schenney): WavyStroke https://crbug.com/229574
    flags->setPathEffect(0);
  }
}

bool StrokeData::StrokeIsDashed(float width, StrokeStyle style) {
  return style == kDashedStroke || (style == kDottedStroke && width <= 3);
}

float StrokeData::SelectBestDashGap(float stroke_length,
                                    float dash_length,
                                    float gap_length) {
  // Determine what number of dashes gives the minimum deviation from
  // gapLength between dashes. Set the gap to that width.
  float min_num_dashes =
      floorf((stroke_length + gap_length) / (dash_length + gap_length));
  float max_num_dashes = min_num_dashes + 1;
  float min_gap =
      (stroke_length - min_num_dashes * dash_length) / (min_num_dashes - 1);
  float max_gap =
      (stroke_length - max_num_dashes * dash_length) / (max_num_dashes - 1);
  return fabs(min_gap - gap_length) < fabs(max_gap - gap_length) ? min_gap
                                                                 : max_gap;
}

}  // namespace blink