3d1d5f1c0ee957db12304de79017949848fc8781
[WebKit-https.git] / Source / WebCore / platform / graphics / cg / PathCG.cpp
1 /*
2  * Copyright (C) 2003, 2006 Apple Inc.  All rights reserved.
3  *                     2006, 2008 Rob Buis <buis@kde.org>
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #include "config.h"
28 #include "Path.h"
29
30 #if USE(CG)
31
32 #include "AffineTransform.h"
33 #include "FloatRect.h"
34 #include "GraphicsContext.h"
35 #include "IntRect.h"
36 #include "StrokeStyleApplier.h"
37 #include <CoreGraphics/CoreGraphics.h>
38 #include <pal/spi/cg/CoreGraphicsSPI.h>
39 #include <wtf/MathExtras.h>
40 #include <wtf/RetainPtr.h>
41 #include <wtf/text/WTFString.h>
42
43 namespace WebCore {
44
45 static size_t putBytesNowhere(void*, const void*, size_t count)
46 {
47     return count;
48 }
49
50 static CGContextRef createScratchContext()
51 {
52     CGDataConsumerCallbacks callbacks = { putBytesNowhere, 0 };
53     RetainPtr<CGDataConsumerRef> consumer = adoptCF(CGDataConsumerCreate(0, &callbacks));
54     CGContextRef context = CGPDFContextCreate(consumer.get(), 0, 0);
55
56     CGFloat black[4] = { 0, 0, 0, 1 };
57     CGContextSetFillColor(context, black);
58     CGContextSetStrokeColor(context, black);
59
60     return context;
61 }
62
63 static inline CGContextRef scratchContext()
64 {
65     static CGContextRef context = createScratchContext();
66     return context;
67 }
68
69 Path Path::polygonPathFromPoints(const Vector<FloatPoint>& points)
70 {
71     Path path;
72     if (points.size() < 2)
73         return path;
74
75     Vector<CGPoint, 32> cgPoints;
76     cgPoints.reserveInitialCapacity(points.size());
77     for (size_t i = 0; i < points.size(); ++i)
78         cgPoints.uncheckedAppend(points[i]);
79
80     CGPathAddLines(path.ensurePlatformPath(), nullptr, cgPoints.data(), cgPoints.size());
81     path.closeSubpath();
82     return path;
83 }
84
85 Path::Path()
86     : m_path(nullptr)
87 {
88 }
89
90 Path::Path(RetainPtr<CGMutablePathRef> p)
91     : m_path(p.leakRef())
92 {
93 }
94
95 Path::~Path()
96 {
97     if (m_path)
98         CGPathRelease(m_path);
99 }
100
101 PlatformPathPtr Path::ensurePlatformPath()
102 {
103     if (!m_path)
104         m_path = CGPathCreateMutable();
105     return m_path;
106 }
107
108 Path::Path(const Path& other)
109 {
110     m_path = other.m_path ? CGPathCreateMutableCopy(other.m_path) : 0;
111 }
112
113 Path::Path(Path&& other)
114 {
115     m_path = other.m_path;
116     other.m_path = nullptr;
117 }
118     
119 Path& Path::operator=(const Path& other)
120 {
121     if (this == &other)
122         return *this;
123     if (m_path)
124         CGPathRelease(m_path);
125     m_path = other.m_path ? CGPathCreateMutableCopy(other.m_path) : nullptr;
126     return *this;
127 }
128
129 Path& Path::operator=(Path&& other)
130 {
131     if (this == &other)
132         return *this;
133     if (m_path)
134         CGPathRelease(m_path);
135     m_path = other.m_path;
136     other.m_path = nullptr;
137     return *this;
138 }
139
140 static void copyClosingSubpathsApplierFunction(void* info, const CGPathElement* element)
141 {
142     CGMutablePathRef path = static_cast<CGMutablePathRef>(info);
143     CGPoint* points = element->points;
144     
145     switch (element->type) {
146     case kCGPathElementMoveToPoint:
147         if (!CGPathIsEmpty(path)) // to silence a warning when trying to close an empty path
148             CGPathCloseSubpath(path); // This is the only change from CGPathCreateMutableCopy
149         CGPathMoveToPoint(path, 0, points[0].x, points[0].y);
150         break;
151     case kCGPathElementAddLineToPoint:
152         CGPathAddLineToPoint(path, 0, points[0].x, points[0].y);
153         break;
154     case kCGPathElementAddQuadCurveToPoint:
155         CGPathAddQuadCurveToPoint(path, 0, points[0].x, points[0].y, points[1].x, points[1].y);
156         break;
157     case kCGPathElementAddCurveToPoint:
158         CGPathAddCurveToPoint(path, 0, points[0].x, points[0].y, points[1].x, points[1].y, points[2].x, points[2].y);
159         break;
160     case kCGPathElementCloseSubpath:
161         CGPathCloseSubpath(path);
162         break;
163     }
164 }
165
166 static CGMutablePathRef copyCGPathClosingSubpaths(CGPathRef originalPath)
167 {
168     CGMutablePathRef path = CGPathCreateMutable();
169     CGPathApply(originalPath, path, copyClosingSubpathsApplierFunction);
170     CGPathCloseSubpath(path);
171     return path;
172 }
173
174 bool Path::contains(const FloatPoint &point, WindRule rule) const
175 {
176     if (isNull())
177         return false;
178
179     if (!fastBoundingRect().contains(point))
180         return false;
181
182     // CGPathContainsPoint returns false for non-closed paths, as a work-around, we copy and close the path first.  Radar 4758998 asks for a better CG API to use
183     RetainPtr<CGMutablePathRef> path = adoptCF(copyCGPathClosingSubpaths(m_path));
184     bool ret = CGPathContainsPoint(path.get(), 0, point, rule == WindRule::EvenOdd ? true : false);
185     return ret;
186 }
187
188 bool Path::strokeContains(StrokeStyleApplier& applier, const FloatPoint& point) const
189 {
190     if (isNull())
191         return false;
192
193     CGContextRef context = scratchContext();
194
195     CGContextSaveGState(context);
196     CGContextBeginPath(context);
197     CGContextAddPath(context, platformPath());
198
199     GraphicsContext graphicsContext(context);
200     applier.strokeStyle(&graphicsContext);
201
202     bool hitSuccess = CGContextPathContainsPoint(context, point, kCGPathStroke);
203     CGContextRestoreGState(context);
204     
205     return hitSuccess;
206 }
207
208 void Path::translate(const FloatSize& size)
209 {
210     transform(AffineTransform(1, 0, 0, 1, size.width(), size.height()));
211 }
212
213 void Path::transform(const AffineTransform& transform)
214 {
215     if (transform.isIdentity() || isEmpty())
216         return;
217
218     CGAffineTransform transformCG = transform;
219 #if PLATFORM(WIN)
220     CGMutablePathRef path = CGPathCreateMutable();
221     CGPathAddPath(path, &transformCG, m_path);
222 #else
223     CGMutablePathRef path = CGPathCreateMutableCopyByTransformingPath(m_path, &transformCG);
224 #endif
225     CGPathRelease(m_path);
226     m_path = path;
227 }
228
229 FloatRect Path::boundingRect() const
230 {
231     if (isNull())
232         return CGRectZero;
233
234     // CGPathGetBoundingBox includes the path's control points, CGPathGetPathBoundingBox does not.
235
236     CGRect bound = CGPathGetPathBoundingBox(m_path);
237     return CGRectIsNull(bound) ? CGRectZero : bound;
238 }
239
240 FloatRect Path::fastBoundingRect() const
241 {
242     if (isNull())
243         return CGRectZero;
244     CGRect bound = CGPathGetBoundingBox(m_path);
245     return CGRectIsNull(bound) ? CGRectZero : bound;
246 }
247
248 FloatRect Path::strokeBoundingRect(StrokeStyleApplier* applier) const
249 {
250     if (isNull())
251         return CGRectZero;
252
253     CGContextRef context = scratchContext();
254
255     CGContextSaveGState(context);
256     CGContextBeginPath(context);
257     CGContextAddPath(context, platformPath());
258
259     if (applier) {
260         GraphicsContext graphicsContext(context);
261         applier->strokeStyle(&graphicsContext);
262     }
263
264     CGContextReplacePathWithStrokedPath(context);
265     CGRect box = CGContextIsPathEmpty(context) ? CGRectZero : CGContextGetPathBoundingBox(context);
266     CGContextRestoreGState(context);
267
268     return CGRectIsNull(box) ? CGRectZero : box;
269 }
270
271 void Path::moveTo(const FloatPoint& point)
272 {
273     CGPathMoveToPoint(ensurePlatformPath(), nullptr, point.x(), point.y());
274 }
275
276 void Path::addLineTo(const FloatPoint& p)
277 {
278     CGPathAddLineToPoint(ensurePlatformPath(), nullptr, p.x(), p.y());
279 }
280
281 void Path::addQuadCurveTo(const FloatPoint& cp, const FloatPoint& p)
282 {
283     CGPathAddQuadCurveToPoint(ensurePlatformPath(), nullptr, cp.x(), cp.y(), p.x(), p.y());
284 }
285
286 void Path::addBezierCurveTo(const FloatPoint& cp1, const FloatPoint& cp2, const FloatPoint& p)
287 {
288     CGPathAddCurveToPoint(ensurePlatformPath(), nullptr, cp1.x(), cp1.y(), cp2.x(), cp2.y(), p.x(), p.y());
289 }
290
291 void Path::addArcTo(const FloatPoint& p1, const FloatPoint& p2, float radius)
292 {
293     CGPathAddArcToPoint(ensurePlatformPath(), nullptr, p1.x(), p1.y(), p2.x(), p2.y(), radius);
294 }
295
296 void Path::platformAddPathForRoundedRect(const FloatRect& rect, const FloatSize& topLeftRadius, const FloatSize& topRightRadius, const FloatSize& bottomLeftRadius, const FloatSize& bottomRightRadius)
297 {
298 #if PLATFORM(COCOA)
299     bool equalWidths = (topLeftRadius.width() == topRightRadius.width() && topRightRadius.width() == bottomLeftRadius.width() && bottomLeftRadius.width() == bottomRightRadius.width());
300     bool equalHeights = (topLeftRadius.height() == bottomLeftRadius.height() && bottomLeftRadius.height() == topRightRadius.height() && topRightRadius.height() == bottomRightRadius.height());
301
302     if (equalWidths && equalHeights) {
303         // Ensure that CG can render the rounded rect.
304         CGFloat radiusWidth = topLeftRadius.width();
305         CGFloat radiusHeight = topLeftRadius.height();
306         CGRect rectToDraw = rect;
307         CGFloat rectWidth = CGRectGetWidth(rectToDraw);
308         CGFloat rectHeight = CGRectGetHeight(rectToDraw);
309         if (2 * radiusWidth > rectWidth)
310             radiusWidth = rectWidth / 2 - std::numeric_limits<CGFloat>::epsilon();
311         if (2 * radiusHeight > rectHeight)
312             radiusHeight = rectHeight / 2 - std::numeric_limits<CGFloat>::epsilon();
313         CGPathAddRoundedRect(ensurePlatformPath(), nullptr, rectToDraw, radiusWidth, radiusHeight);
314         return;
315     }
316
317 #if (PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED >= 101400) || (PLATFORM(IOS_FAMILY) && __IPHONE_OS_VERSION_MIN_REQUIRED >= 120000)
318     CGRect rectToDraw = rect;
319     
320     enum Corners {
321         BottomLeft,
322         BottomRight,
323         TopRight,
324         TopLeft
325     };
326     CGSize corners[4] = { bottomLeftRadius, bottomRightRadius, topRightRadius, topLeftRadius };
327
328     CGFloat rectWidth = CGRectGetWidth(rectToDraw);
329     CGFloat rectHeight = CGRectGetHeight(rectToDraw);
330     
331     // Clamp the radii after conversion to CGFloats.
332     corners[TopRight].width = std::min(corners[TopRight].width, rectWidth - corners[TopLeft].width);
333     corners[BottomRight].width = std::min(corners[BottomRight].width, rectWidth - corners[BottomLeft].width);
334     corners[BottomLeft].height = std::min(corners[BottomLeft].height, rectHeight - corners[TopLeft].height);
335     corners[BottomRight].height = std::min(corners[BottomRight].height, rectHeight - corners[TopRight].height);
336
337     CGPathAddUnevenCornersRoundedRect(ensurePlatformPath(), nullptr, rectToDraw, corners);
338     return;
339 #endif
340 #endif
341
342     addBeziersForRoundedRect(rect, topLeftRadius, topRightRadius, bottomLeftRadius, bottomRightRadius);
343 }
344
345 void Path::closeSubpath()
346 {
347     // FIXME: Unclear if close commands should have meaning for a null path.
348     if (isNull())
349         return;
350
351     CGPathCloseSubpath(m_path);
352 }
353
354 void Path::addArc(const FloatPoint& p, float radius, float startAngle, float endAngle, bool clockwise)
355 {
356     // Workaround for <rdar://problem/5189233> CGPathAddArc hangs or crashes when passed inf as start or end angle
357     if (std::isfinite(startAngle) && std::isfinite(endAngle))
358         CGPathAddArc(ensurePlatformPath(), nullptr, p.x(), p.y(), radius, startAngle, endAngle, clockwise);
359 }
360
361 void Path::addRect(const FloatRect& r)
362 {
363     CGPathAddRect(ensurePlatformPath(), 0, r);
364 }
365
366 void Path::addEllipse(FloatPoint p, float radiusX, float radiusY, float rotation, float startAngle, float endAngle, bool anticlockwise)
367 {
368     AffineTransform transform;
369     transform.translate(p.x(), p.y()).rotate(rad2deg(rotation)).scale(radiusX, radiusY);
370
371     CGAffineTransform cgTransform = transform;
372     CGPathAddArc(ensurePlatformPath(), &cgTransform, 0, 0, 1, startAngle, endAngle, anticlockwise);
373 }
374
375 void Path::addEllipse(const FloatRect& r)
376 {
377     CGPathAddEllipseInRect(ensurePlatformPath(), 0, r);
378 }
379
380 void Path::addPath(const Path& path, const AffineTransform& transform)
381 {
382     if (!path.platformPath())
383         return;
384
385     if (!transform.isInvertible())
386         return;
387
388     CGAffineTransform transformCG = transform;
389     // CG doesn't allow adding a path to itself. Optimize for the common case
390     // and copy the path for the self referencing case.
391     if (ensurePlatformPath() != path.platformPath()) {
392         CGPathAddPath(ensurePlatformPath(), &transformCG, path.platformPath());
393         return;
394     }
395     CGPathRef pathCopy = CGPathCreateCopy(path.platformPath());
396     CGPathAddPath(ensurePlatformPath(), &transformCG, pathCopy);
397     CGPathRelease(pathCopy);
398 }
399
400
401 void Path::clear()
402 {
403     if (isNull())
404         return;
405
406     CGPathRelease(m_path);
407     m_path = CGPathCreateMutable();
408 }
409
410 bool Path::isEmpty() const
411 {
412     return isNull() || CGPathIsEmpty(m_path);
413 }
414
415 bool Path::hasCurrentPoint() const
416 {
417     return !isEmpty();
418 }
419     
420 FloatPoint Path::currentPoint() const 
421 {
422     if (isNull())
423         return FloatPoint();
424     return CGPathGetCurrentPoint(m_path);
425 }
426
427 static void CGPathApplierToPathApplier(void* info, const CGPathElement* element)
428 {
429     const PathApplierFunction& function = *(PathApplierFunction*)info;
430     PathElement pathElement;
431     pathElement.type = (PathElement::Type)element->type;
432     CGPoint* cgPoints = element->points;
433     switch (element->type) {
434     case kCGPathElementMoveToPoint:
435     case kCGPathElementAddLineToPoint:
436         pathElement.points[0] = cgPoints[0];
437         break;
438     case kCGPathElementAddQuadCurveToPoint:
439         pathElement.points[0] = cgPoints[0];
440         pathElement.points[1] = cgPoints[1];
441         break;
442     case kCGPathElementAddCurveToPoint:
443         pathElement.points[0] = cgPoints[0];
444         pathElement.points[1] = cgPoints[1];
445         pathElement.points[2] = cgPoints[2];
446         break;
447     case kCGPathElementCloseSubpath:
448         break;
449     }
450     function(pathElement);
451 }
452
453 void Path::apply(const PathApplierFunction& function) const
454 {
455     if (isNull())
456         return;
457
458     CGPathApply(m_path, (void*)&function, CGPathApplierToPathApplier);
459 }
460
461 }
462
463 #endif // USE(CG)