[Cocoa] Migrate WKSetPatternPhaseInUserSpace() and WKGetUserToBaseCTM() from WKSI
[WebKit-https.git] / Source / WebCore / platform / graphics / mac / GraphicsContextMac.mm
1 /*
2  * Copyright (C) 2003, 2004, 2005, 2006, 2010 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 #if USE(APPKIT)
33 #import <AppKit/AppKit.h>
34 #endif
35 #import <wtf/StdLibExtras.h>
36
37 #if PLATFORM(IOS)
38 #import "Color.h"
39 #import "WKGraphics.h"
40 #endif
41
42 #if !PLATFORM(IOS)
43 #import "LocalCurrentGraphicsContext.h"
44 #endif
45 #import "WebCoreSystemInterface.h"
46
47 @class NSColor;
48
49 // FIXME: More of this should use CoreGraphics instead of AppKit.
50 // FIXME: More of this should move into GraphicsContextCG.cpp.
51
52 namespace WebCore {
53
54 // NSColor, NSBezierPath, and NSGraphicsContext
55 // calls in this file are all exception-safe, so we don't block
56 // exceptions for those.
57
58 #if !PLATFORM(IOS)
59 static void drawFocusRingToContext(CGContextRef context, CGPathRef focusRingPath)
60 {
61     CGContextBeginPath(context);
62     CGContextAddPath(context, focusRingPath);
63     wkDrawFocusRing(context, nullptr, 0);
64 }
65
66 static bool drawFocusRingToContextAtTime(CGContextRef context, CGPathRef focusRingPath, double timeOffset)
67 {
68     UNUSED_PARAM(timeOffset);
69     CGContextBeginPath(context);
70     CGContextAddPath(context, focusRingPath);
71     return wkDrawFocusRingAtTime(context, std::numeric_limits<double>::max());
72 }
73 #endif // !PLATFORM(IOS)
74
75 void GraphicsContext::drawFocusRing(const Path& path, int /* width */, int /* offset */, const Color&)
76 {
77 #if PLATFORM(MAC)
78     if (paintingDisabled() || path.isNull())
79         return;
80
81     drawFocusRingToContext(platformContext(), path.platformPath());
82 #else
83     UNUSED_PARAM(path);
84 #endif
85 }
86
87 #if PLATFORM(MAC)
88 void GraphicsContext::drawFocusRing(const Vector<IntRect>& rects, int, int offset, double timeOffset, bool& needsRedraw)
89 {
90     if (paintingDisabled())
91         return;
92
93     RetainPtr<CGMutablePathRef> focusRingPath = adoptCF(CGPathCreateMutable());
94     for (auto& rect : rects)
95         CGPathAddRect(focusRingPath.get(), 0, CGRectInset(rect, -offset, -offset));
96
97     needsRedraw = drawFocusRingToContextAtTime(platformContext(), focusRingPath.get(), timeOffset);
98 }
99 #endif
100
101 void GraphicsContext::drawFocusRing(const Vector<IntRect>& rects, int, int offset, const Color&)
102 {
103 #if !PLATFORM(IOS)
104     if (paintingDisabled())
105         return;
106
107     RetainPtr<CGMutablePathRef> focusRingPath = adoptCF(CGPathCreateMutable());
108     for (auto& rect : rects)
109         CGPathAddRect(focusRingPath.get(), 0, CGRectInset(rect, -offset, -offset));
110
111     drawFocusRingToContext(platformContext(), focusRingPath.get());
112 #else
113     UNUSED_PARAM(rects);
114     UNUSED_PARAM(offset);
115 #endif
116 }
117
118 #if !PLATFORM(IOS)
119 static NSColor* makePatternColor(NSString* firstChoiceName, NSString* secondChoiceName, NSColor* defaultColor, bool& usingDot)
120 {
121     // Eventually we should be able to get rid of the secondChoiceName. For the time being we need both to keep
122     // this working on all platforms.
123     NSImage *image = [NSImage imageNamed:firstChoiceName];
124     if (!image)
125         image = [NSImage imageNamed:secondChoiceName];
126     ASSERT(image); // if image is not available, we want to know
127     NSColor *color = (image ? [NSColor colorWithPatternImage:image] : nil);
128     if (color)
129         usingDot = true;
130     else
131         color = defaultColor;
132     return color;
133 }
134 #else
135 static RetainPtr<CGPatternRef> createDotPattern(bool& usingDot, const char* resourceName)
136 {
137     RetainPtr<CGImageRef> image = adoptCF(WKGraphicsCreateImageFromBundleWithName(resourceName));
138     ASSERT(image); // if image is not available, we want to know
139     usingDot = true;
140     return adoptCF(WKCreatePatternFromCGImage(image.get()));
141 }
142 #endif // !PLATFORM(IOS)
143
144 static NSColor *spellingPatternColor = nullptr;
145 static NSColor *grammarPatternColor = nullptr;
146 static NSColor *correctionPatternColor = nullptr;
147
148 void GraphicsContext::updateDocumentMarkerResources()
149 {
150     [spellingPatternColor release];
151     spellingPatternColor = nullptr;
152     [grammarPatternColor release];
153     grammarPatternColor = nullptr;
154     [correctionPatternColor release];
155     correctionPatternColor = nullptr;
156 }
157
158 static inline void setPatternPhaseInUserSpace(CGContextRef context, CGPoint phasePoint)
159 {
160     CGAffineTransform userToBase = getUserToBaseCTM(context);
161     CGPoint phase = CGPointApplyAffineTransform(phasePoint, userToBase);
162
163     CGContextSetPatternPhase(context, CGSizeMake(phase.x, phase.y));
164 }
165
166 // WebKit on Mac is a standard platform component, so it must use the standard platform artwork for underline.
167 void GraphicsContext::drawLineForDocumentMarker(const FloatPoint& point, float width, DocumentMarkerLineStyle style)
168 {
169     if (paintingDisabled())
170         return;
171         
172     // These are the same for misspelling or bad grammar.
173     int patternHeight = cMisspellingLineThickness;
174     float patternWidth = cMisspellingLinePatternWidth;
175
176     bool usingDot;
177 #if !PLATFORM(IOS)
178     NSColor *patternColor;
179 #else
180     CGPatternRef dotPattern;
181 #endif
182     switch (style) {
183         case DocumentMarkerSpellingLineStyle:
184         {
185             // Constants for spelling pattern color.
186             static bool usingDotForSpelling = false;
187 #if !PLATFORM(IOS)
188             if (!spellingPatternColor)
189                 spellingPatternColor = [makePatternColor(@"NSSpellingDot", @"SpellingDot", [NSColor redColor], usingDotForSpelling) retain];
190             patternColor = spellingPatternColor;
191 #else
192             static CGPatternRef spellingPattern = createDotPattern(usingDotForSpelling, "SpellingDot").leakRef();
193             dotPattern = spellingPattern;
194 #endif
195             usingDot = usingDotForSpelling;
196             break;
197         }
198         case DocumentMarkerGrammarLineStyle:
199         {
200 #if !PLATFORM(IOS)
201             // Constants for grammar pattern color.
202             static bool usingDotForGrammar = false;
203             if (!grammarPatternColor)
204                 grammarPatternColor = [makePatternColor(@"NSGrammarDot", @"GrammarDot", [NSColor greenColor], usingDotForGrammar) retain];
205             usingDot = usingDotForGrammar;
206             patternColor = grammarPatternColor;
207             break;
208 #else
209             ASSERT_NOT_REACHED();
210             return;
211 #endif
212         }
213 #if PLATFORM(MAC)
214         // To support correction panel.
215         case DocumentMarkerAutocorrectionReplacementLineStyle:
216         case DocumentMarkerDictationAlternativesLineStyle:
217         {
218             // Constants for spelling pattern color.
219             static bool usingDotForSpelling = false;
220             if (!correctionPatternColor)
221                 correctionPatternColor = [makePatternColor(@"NSCorrectionDot", @"CorrectionDot", [NSColor blueColor], usingDotForSpelling) retain];
222             usingDot = usingDotForSpelling;
223             patternColor = correctionPatternColor;
224             break;
225         }
226 #endif
227 #if PLATFORM(IOS)
228         case TextCheckingDictationPhraseWithAlternativesLineStyle:
229         {
230             static bool usingDotForDictationPhraseWithAlternatives = false;
231             static CGPatternRef dictationPhraseWithAlternativesPattern = createDotPattern(usingDotForDictationPhraseWithAlternatives, "DictationPhraseWithAlternativesDot").leakRef();
232             dotPattern = dictationPhraseWithAlternativesPattern;
233             usingDot = usingDotForDictationPhraseWithAlternatives;
234             break;
235         }
236 #endif // PLATFORM(IOS)
237         default:
238 #if PLATFORM(IOS)
239             // FIXME: Should remove default case so we get compile-time errors.
240             ASSERT_NOT_REACHED();
241 #endif // PLATFORM(IOS)
242             return;
243     }
244     
245     FloatPoint offsetPoint = point;
246
247     // Make sure to draw only complete dots.
248     if (usingDot) {
249         // allow slightly more considering that the pattern ends with a transparent pixel
250         float widthMod = fmodf(width, patternWidth);
251         if (patternWidth - widthMod > cMisspellingLinePatternGapWidth) {
252             float gapIncludeWidth = 0;
253             if (width > patternWidth)
254                 gapIncludeWidth = cMisspellingLinePatternGapWidth;
255             offsetPoint.move(floor((widthMod + gapIncludeWidth) / 2), 0);
256             width -= widthMod;
257         }
258     }
259     
260     // FIXME: This code should not use NSGraphicsContext currentContext
261     // In order to remove this requirement we will need to use CGPattern instead of NSColor
262     // FIXME: This code should not be using setPatternPhaseInUserSpace, as this approach is wrong
263     // for transforms.
264
265     // Draw underline.
266 #if !PLATFORM(IOS)
267     LocalCurrentGraphicsContext localContext(*this);
268     NSGraphicsContext *currentContext = [NSGraphicsContext currentContext];
269     CGContextRef context = (CGContextRef)[currentContext graphicsPort];
270 #else
271     CGContextRef context = platformContext();
272 #endif
273     CGContextSaveGState(context);
274
275 #if !PLATFORM(IOS)
276     [patternColor set];
277 #else
278     WKSetPattern(context, dotPattern, YES, YES);
279 #endif
280
281     setPatternPhaseInUserSpace(context, offsetPoint);
282
283 #if !PLATFORM(IOS)
284     NSRectFillUsingOperation(NSMakeRect(offsetPoint.x(), offsetPoint.y(), width, patternHeight), NSCompositeSourceOver);
285 #else
286     WKRectFillUsingOperation(context, CGRectMake(offsetPoint.x(), offsetPoint.y(), width, patternHeight), kCGCompositeSover);
287 #endif
288     
289     CGContextRestoreGState(context);
290 }
291
292 #if !PLATFORM(IOS)
293 CGColorSpaceRef linearRGBColorSpaceRef()
294 {
295     static CGColorSpaceRef linearSRGBSpace = 0;
296
297     if (linearSRGBSpace)
298         return linearSRGBSpace;
299
300     RetainPtr<NSString> iccProfilePath = [[NSBundle bundleWithIdentifier:@"com.apple.WebCore"] pathForResource:@"linearSRGB" ofType:@"icc"];
301     RetainPtr<NSData> iccProfileData = adoptNS([[NSData alloc] initWithContentsOfFile:iccProfilePath.get()]);
302
303     if (iccProfileData)
304         linearSRGBSpace = CGColorSpaceCreateWithICCProfile((CFDataRef)iccProfileData.get());
305
306     // If we fail to load the linearized sRGB ICC profile, fall back to DeviceRGB.
307     if (!linearSRGBSpace)
308         return deviceRGBColorSpaceRef();
309
310     return linearSRGBSpace;
311 }
312 #endif
313
314 }