Remove WebCoreSystemInterface
[WebKit-https.git] / Source / WebCore / platform / graphics / cocoa / GraphicsContextCocoa.mm
1 /*
2  * Copyright (C) 2003-2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #import "config.h"
27 #import "GraphicsContext.h"
28
29 #import "GraphicsContextCG.h"
30 #import "GraphicsContextPlatformPrivateCG.h"
31 #import "IntRect.h"
32 #import <pal/spi/cg/CoreGraphicsSPI.h>
33 #import <pal/spi/mac/NSGraphicsSPI.h>
34 #import <wtf/StdLibExtras.h>
35
36 #if USE(APPKIT)
37 #import <AppKit/AppKit.h>
38 #endif
39
40 #if PLATFORM(IOS)
41 #import "Color.h"
42 #import "WKGraphics.h"
43 #import "WKGraphicsInternal.h"
44 #endif
45
46 #if !PLATFORM(IOS)
47 #import "LocalCurrentGraphicsContext.h"
48 #endif
49
50 @class NSColor;
51
52 // FIXME: More of this should use CoreGraphics instead of AppKit.
53 // FIXME: More of this should move into GraphicsContextCG.cpp.
54
55 namespace WebCore {
56
57 // NSColor, NSBezierPath, and NSGraphicsContext
58 // calls in this file are all exception-safe, so we don't block
59 // exceptions for those.
60
61 #if !PLATFORM(IOS)
62 CGColorRef GraphicsContext::focusRingColor()
63 {
64     static CGColorRef color;
65     if (!color) {
66         CGFloat colorComponents[] = { 0.5, 0.75, 1.0, 1.0 };
67         auto colorSpace = adoptCF(CGColorSpaceCreateWithName(kCGColorSpaceSRGB));
68         color = CGColorCreate(colorSpace.get(), colorComponents);
69     }
70
71     return color;
72 }
73
74 static bool drawFocusRingAtTime(CGContextRef context, NSTimeInterval timeOffset)
75 {
76     CGFocusRingStyle focusRingStyle;
77     BOOL needsRepaint = NSInitializeCGFocusRingStyleForTime(NSFocusRingOnly, &focusRingStyle, timeOffset);
78
79     // We want to respect the CGContext clipping and also not overpaint any
80     // existing focus ring. The way to do this is set accumulate to
81     // -1. According to CoreGraphics, the reasoning for this behavior has been
82     // lost in time.
83     focusRingStyle.accumulate = -1;
84     auto style = adoptCF(CGStyleCreateFocusRingWithColor(&focusRingStyle, GraphicsContext::focusRingColor()));
85
86     CGContextSaveGState(context);
87     CGContextSetStyle(context, style.get());
88     CGContextFillPath(context);
89     CGContextRestoreGState(context);
90
91     return needsRepaint;
92 }
93
94 static void drawFocusRing(CGContextRef context)
95 {
96     drawFocusRingAtTime(context, std::numeric_limits<double>::max());
97 }
98
99 static void drawFocusRingToContext(CGContextRef context, CGPathRef focusRingPath)
100 {
101     CGContextBeginPath(context);
102     CGContextAddPath(context, focusRingPath);
103     drawFocusRing(context);
104 }
105
106 static bool drawFocusRingToContextAtTime(CGContextRef context, CGPathRef focusRingPath, double timeOffset)
107 {
108     UNUSED_PARAM(timeOffset);
109     CGContextBeginPath(context);
110     CGContextAddPath(context, focusRingPath);
111     return drawFocusRingAtTime(context, std::numeric_limits<double>::max());
112 }
113 #endif // !PLATFORM(IOS)
114
115 void GraphicsContext::drawFocusRing(const Path& path, float /* width */, float /* offset */, const Color&)
116 {
117 #if PLATFORM(MAC)
118     if (paintingDisabled() || path.isNull())
119         return;
120
121     drawFocusRingToContext(platformContext(), path.platformPath());
122 #else
123     UNUSED_PARAM(path);
124 #endif
125 }
126
127 #if PLATFORM(MAC)
128 void GraphicsContext::drawFocusRing(const Path& path, double timeOffset, bool& needsRedraw)
129 {
130     if (paintingDisabled() || path.isNull())
131         return;
132     
133     needsRedraw = drawFocusRingToContextAtTime(platformContext(), path.platformPath(), timeOffset);
134 }
135
136 void GraphicsContext::drawFocusRing(const Vector<FloatRect>& rects, double timeOffset, bool& needsRedraw)
137 {
138     if (paintingDisabled())
139         return;
140
141     RetainPtr<CGMutablePathRef> focusRingPath = adoptCF(CGPathCreateMutable());
142     for (const auto& rect : rects)
143         CGPathAddRect(focusRingPath.get(), 0, CGRect(rect));
144
145     needsRedraw = drawFocusRingToContextAtTime(platformContext(), focusRingPath.get(), timeOffset);
146 }
147 #endif
148
149 void GraphicsContext::drawFocusRing(const Vector<FloatRect>& rects, float, float offset, const Color&)
150 {
151 #if !PLATFORM(IOS)
152     if (paintingDisabled())
153         return;
154
155     RetainPtr<CGMutablePathRef> focusRingPath = adoptCF(CGPathCreateMutable());
156     for (auto& rect : rects)
157         CGPathAddRect(focusRingPath.get(), 0, CGRectInset(rect, -offset, -offset));
158
159     drawFocusRingToContext(platformContext(), focusRingPath.get());
160 #else
161     UNUSED_PARAM(rects);
162     UNUSED_PARAM(offset);
163 #endif
164 }
165
166 #if PLATFORM(MAC)
167 static NSImage *findImage(NSString* firstChoiceName, NSString* secondChoiceName, bool& usingDot)
168 {
169     // Eventually we should be able to get rid of the secondChoiceName. For the time being we need both to keep
170     // this working on all platforms.
171     NSImage *image = [NSImage imageNamed:firstChoiceName];
172     if (!image)
173         image = [NSImage imageNamed:secondChoiceName];
174     ASSERT(image); // if image is not available, we want to know
175     usingDot = image;
176     return image;
177 }
178 static NSImage *spellingImage = nullptr;
179 static NSImage *grammarImage = nullptr;
180 static NSImage *correctionImage = nullptr;
181 #else
182 static RetainPtr<CGPatternRef> createDotPattern(bool& usingDot, const char* resourceName)
183 {
184     RetainPtr<CGImageRef> image = adoptCF(WKGraphicsCreateImageFromBundleWithName(resourceName));
185     ASSERT(image); // if image is not available, we want to know
186     usingDot = true;
187     return adoptCF(WKCreatePatternFromCGImage(image.get()));
188 }
189 #endif // PLATFORM(MAC)
190
191 void GraphicsContext::updateDocumentMarkerResources()
192 {
193 #if PLATFORM(MAC)
194     [spellingImage release];
195     spellingImage = nullptr;
196     [grammarImage release];
197     grammarImage = nullptr;
198     [correctionImage release];
199     correctionImage = nullptr;
200 #endif
201 }
202
203 static inline void setPatternPhaseInUserSpace(CGContextRef context, CGPoint phasePoint)
204 {
205     CGAffineTransform userToBase = getUserToBaseCTM(context);
206     CGPoint phase = CGPointApplyAffineTransform(phasePoint, userToBase);
207
208     CGContextSetPatternPhase(context, CGSizeMake(phase.x, phase.y));
209 }
210
211 // WebKit on Mac is a standard platform component, so it must use the standard platform artwork for underline.
212 void GraphicsContext::drawLineForDocumentMarker(const FloatPoint& point, float width, DocumentMarkerLineStyle style)
213 {
214     if (paintingDisabled())
215         return;
216
217     // These are the same for misspelling or bad grammar.
218     int patternHeight = cMisspellingLineThickness;
219     float patternWidth = cMisspellingLinePatternWidth;
220
221     bool usingDot;
222 #if !PLATFORM(IOS)
223     NSImage *image;
224     NSColor *fallbackColor;
225 #else
226     CGPatternRef dotPattern;
227 #endif
228     switch (style) {
229     case DocumentMarkerSpellingLineStyle: {
230         // Constants for spelling pattern color.
231         static bool usingDotForSpelling = false;
232 #if !PLATFORM(IOS)
233         if (!spellingImage)
234             spellingImage = [findImage(@"NSSpellingDot", @"SpellingDot", usingDotForSpelling) retain];
235         image = spellingImage;
236         fallbackColor = [NSColor redColor];
237 #else
238         static CGPatternRef spellingPattern = createDotPattern(usingDotForSpelling, "SpellingDot").leakRef();
239         dotPattern = spellingPattern;
240 #endif
241         usingDot = usingDotForSpelling;
242         break;
243     }
244     case DocumentMarkerGrammarLineStyle: {
245 #if !PLATFORM(IOS)
246         // Constants for grammar pattern color.
247         static bool usingDotForGrammar = false;
248         if (!grammarImage)
249             grammarImage = [findImage(@"NSGrammarDot", @"GrammarDot", usingDotForGrammar) retain];
250         usingDot = grammarImage;
251         image = grammarImage;
252         fallbackColor = [NSColor greenColor];
253         break;
254 #else
255         ASSERT_NOT_REACHED();
256         return;
257 #endif
258     }
259 #if PLATFORM(MAC)
260     // To support correction panel.
261     case DocumentMarkerAutocorrectionReplacementLineStyle:
262     case DocumentMarkerDictationAlternativesLineStyle: {
263         // Constants for spelling pattern color.
264         static bool usingDotForSpelling = false;
265         if (!correctionImage)
266             correctionImage = [findImage(@"NSCorrectionDot", @"CorrectionDot", usingDotForSpelling) retain];
267         usingDot = usingDotForSpelling;
268         image = correctionImage;
269         fallbackColor = [NSColor blueColor];
270         break;
271     }
272 #endif
273 #if PLATFORM(IOS)
274     case TextCheckingDictationPhraseWithAlternativesLineStyle: {
275         static bool usingDotForDictationPhraseWithAlternatives = false;
276         static CGPatternRef dictationPhraseWithAlternativesPattern = createDotPattern(usingDotForDictationPhraseWithAlternatives, "DictationPhraseWithAlternativesDot").leakRef();
277         dotPattern = dictationPhraseWithAlternativesPattern;
278         usingDot = usingDotForDictationPhraseWithAlternatives;
279         break;
280     }
281 #endif // PLATFORM(IOS)
282     default:
283 #if PLATFORM(IOS)
284         // FIXME: Should remove default case so we get compile-time errors.
285         ASSERT_NOT_REACHED();
286 #endif // PLATFORM(IOS)
287         return;
288     }
289     
290     FloatPoint offsetPoint = point;
291
292     // Make sure to draw only complete dots.
293     if (usingDot) {
294         // allow slightly more considering that the pattern ends with a transparent pixel
295         float widthMod = fmodf(width, patternWidth);
296         if (patternWidth - widthMod > cMisspellingLinePatternGapWidth) {
297             float gapIncludeWidth = 0;
298             if (width > patternWidth)
299                 gapIncludeWidth = cMisspellingLinePatternGapWidth;
300             offsetPoint.move(floor((widthMod + gapIncludeWidth) / 2), 0);
301             width -= widthMod;
302         }
303     }
304     
305     // FIXME: This code should not use NSGraphicsContext currentContext
306     // In order to remove this requirement we will need to use CGPattern instead of NSColor
307     // FIXME: This code should not be using setPatternPhaseInUserSpace, as this approach is wrong
308     // for transforms.
309
310     // Draw underline.
311     CGContextRef context = platformContext();
312     CGContextStateSaver stateSaver { context };
313
314 #if PLATFORM(IOS)
315     WKSetPattern(context, dotPattern, YES, YES);
316 #endif
317
318     setPatternPhaseInUserSpace(context, offsetPoint);
319
320     CGRect destinationRect = CGRectMake(offsetPoint.x(), offsetPoint.y(), width, patternHeight);
321 #if !PLATFORM(IOS)
322     if (image) {
323         CGContextClipToRect(context, destinationRect);
324
325         // We explicitly flip coordinates so as to ensure we paint the image right-side up. We do this because
326         // -[NSImage CGImageForProposedRect:context:hints:] does not guarantee that the returned image will respect
327         // any transforms applied to the context or any specified hints.
328         CGContextTranslateCTM(context, 0, patternHeight);
329         CGContextScaleCTM(context, 1, -1);
330
331         NSRect dotRect = NSMakeRect(offsetPoint.x(), patternHeight - offsetPoint.y(), patternWidth, patternHeight); // Adjust y position as we flipped coordinates.
332
333         // FIXME: Rather than getting the NSImage and then picking the CGImage from it, we should do what iOS does and
334         // just load the CGImage in the first place.
335         CGImageRef cgImage = [image CGImageForProposedRect:&dotRect context:[NSGraphicsContext graphicsContextWithGraphicsPort:context flipped:NO] hints:nullptr];
336         CGContextDrawTiledImage(context, NSRectToCGRect(dotRect), cgImage);
337     } else {
338         CGContextSetFillColorWithColor(context, [fallbackColor CGColor]);
339         CGContextFillRect(context, destinationRect);
340     }
341 #else
342     WKRectFillUsingOperation(context, destinationRect, kCGCompositeSover);
343 #endif
344 }
345
346 CGColorSpaceRef linearRGBColorSpaceRef()
347 {
348     static CGColorSpaceRef linearSRGBSpace = nullptr;
349
350     if (linearSRGBSpace)
351         return linearSRGBSpace;
352
353     RetainPtr<NSString> iccProfilePath = [[NSBundle bundleWithIdentifier:@"com.apple.WebCore"] pathForResource:@"linearSRGB" ofType:@"icc"];
354     RetainPtr<NSData> iccProfileData = adoptNS([[NSData alloc] initWithContentsOfFile:iccProfilePath.get()]);
355
356     if (iccProfileData)
357 #pragma clang diagnostic push
358 #pragma clang diagnostic ignored "-Wdeprecated-declarations"
359         linearSRGBSpace = CGColorSpaceCreateWithICCProfile((CFDataRef)iccProfileData.get());
360 #pragma clang diagnostic pop
361
362     // If we fail to load the linearized sRGB ICC profile, fall back to sRGB.
363     if (!linearSRGBSpace)
364         return sRGBColorSpaceRef();
365
366     return linearSRGBSpace;
367 }
368
369 }