Unreviewed, rolling out r121572.
[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 COMPUTER, 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 COMPUTER, 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 "GraphicsContextPlatformPrivateCG.h"
30 #import <AppKit/AppKit.h>
31 #import <wtf/StdLibExtras.h>
32
33 #import "LocalCurrentGraphicsContext.h"
34 #import "WebCoreSystemInterface.h"
35
36 @class NSColor;
37
38 // FIXME: More of this should use CoreGraphics instead of AppKit.
39 // FIXME: More of this should move into GraphicsContextCG.cpp.
40
41 namespace WebCore {
42
43 // NSColor, NSBezierPath, and NSGraphicsContext
44 // calls in this file are all exception-safe, so we don't block
45 // exceptions for those.
46
47 static void drawFocusRingToContext(CGContextRef context, CGPathRef focusRingPath, CGColorRef color, int radius)
48 {
49     CGContextBeginPath(context);
50     CGContextAddPath(context, focusRingPath);
51     wkDrawFocusRing(context, color, radius);
52 }
53
54 void GraphicsContext::drawFocusRing(const Path& path, int width, int /*offset*/, const Color& color)
55 {
56     // FIXME: Use 'offset' for something? http://webkit.org/b/49909
57
58     if (paintingDisabled())
59         return;
60
61     int radius = (width - 1) / 2;
62     CGColorRef colorRef = color.isValid() ? cachedCGColor(color, ColorSpaceDeviceRGB) : 0;
63
64     drawFocusRingToContext(platformContext(), path.platformPath(), colorRef, radius);
65 }
66
67 void GraphicsContext::drawFocusRing(const Vector<IntRect>& rects, int width, int offset, const Color& color)
68 {
69     if (paintingDisabled())
70         return;
71
72     int radius = (width - 1) / 2;
73     offset += radius;
74     CGColorRef colorRef = color.isValid() ? cachedCGColor(color, ColorSpaceDeviceRGB) : 0;
75
76     RetainPtr<CGMutablePathRef> focusRingPath(AdoptCF, CGPathCreateMutable());
77     unsigned rectCount = rects.size();
78     for (unsigned i = 0; i < rectCount; i++)
79         CGPathAddRect(focusRingPath.get(), 0, CGRectInset(rects[i], -offset, -offset));
80
81     drawFocusRingToContext(platformContext(), focusRingPath.get(), colorRef, radius);
82 }
83
84
85 static NSColor* createPatternColor(NSString* firstChoiceName, NSString* secondChoiceName, NSColor* defaultColor, bool& usingDot)
86 {
87     // Eventually we should be able to get rid of the secondChoiceName. For the time being we need both to keep
88     // this working on all platforms.
89     NSImage *image = [NSImage imageNamed:firstChoiceName];
90     if (!image)
91         image = [NSImage imageNamed:secondChoiceName];
92     ASSERT(image); // if image is not available, we want to know
93     NSColor *color = (image ? [NSColor colorWithPatternImage:image] : nil);
94     if (color)
95         usingDot = true;
96     else
97         color = defaultColor;
98     return color;
99 }
100
101 // WebKit on Mac is a standard platform component, so it must use the standard platform artwork for underline.
102 void GraphicsContext::drawLineForDocumentMarker(const FloatPoint& point, float width, DocumentMarkerLineStyle style)
103 {
104     if (paintingDisabled())
105         return;
106         
107     // These are the same for misspelling or bad grammar.
108     int patternHeight = cMisspellingLineThickness;
109     float patternWidth = cMisspellingLinePatternWidth;
110
111     bool usingDot;
112     NSColor *patternColor;
113     switch (style) {
114         case DocumentMarkerSpellingLineStyle:
115         {
116             // Constants for spelling pattern color.
117             static bool usingDotForSpelling = false;
118             DEFINE_STATIC_LOCAL(RetainPtr<NSColor>, spellingPatternColor, (createPatternColor(@"NSSpellingDot", @"SpellingDot", [NSColor redColor], usingDotForSpelling)));
119             usingDot = usingDotForSpelling;
120             patternColor = spellingPatternColor.get();
121             break;
122         }
123         case DocumentMarkerGrammarLineStyle:
124         {
125             // Constants for grammar pattern color.
126             static bool usingDotForGrammar = false;
127             DEFINE_STATIC_LOCAL(RetainPtr<NSColor>, grammarPatternColor, (createPatternColor(@"NSGrammarDot", @"GrammarDot", [NSColor greenColor], usingDotForGrammar)));
128             usingDot = usingDotForGrammar;
129             patternColor = grammarPatternColor.get();
130             break;
131         }
132 #if PLATFORM(MAC) && !defined(BUILDING_ON_LEOPARD) && !defined(BUILDING_ON_SNOW_LEOPARD)
133         // To support correction panel.
134         case DocumentMarkerAutocorrectionReplacementLineStyle:
135         case DocumentMarkerDictationAlternativesLineStyle:
136         {
137             // Constants for spelling pattern color.
138             static bool usingDotForSpelling = false;
139             DEFINE_STATIC_LOCAL(RetainPtr<NSColor>, spellingPatternColor, (createPatternColor(@"NSCorrectionDot", @"CorrectionDot", [NSColor blueColor], usingDotForSpelling)));
140             usingDot = usingDotForSpelling;
141             patternColor = spellingPatternColor.get();
142             break;
143         }
144 #endif
145         default:
146             return;
147     }
148
149     // Make sure to draw only complete dots.
150     // NOTE: Code here used to shift the underline to the left and increase the width
151     // to make sure everything gets underlined, but that results in drawing out of
152     // bounds (e.g. when at the edge of a view) and could make it appear that the
153     // space between adjacent misspelled words was underlined.
154     if (usingDot) {
155         // allow slightly more considering that the pattern ends with a transparent pixel
156         float widthMod = fmodf(width, patternWidth);
157         if (patternWidth - widthMod > cMisspellingLinePatternGapWidth)
158             width -= widthMod;
159     }
160     
161     // FIXME: This code should not use NSGraphicsContext currentContext
162     // In order to remove this requirement we will need to use CGPattern instead of NSColor
163     // FIXME: This code should not be using wkSetPatternPhaseInUserSpace, as this approach is wrong
164     // for transforms.
165
166     // Draw underline.
167     LocalCurrentGraphicsContext localContext(this);
168     NSGraphicsContext *currentContext = [NSGraphicsContext currentContext];
169     CGContextRef context = (CGContextRef)[currentContext graphicsPort];
170     CGContextSaveGState(context);
171
172     [patternColor set];
173
174     wkSetPatternPhaseInUserSpace(context, point);
175
176     NSRectFillUsingOperation(NSMakeRect(point.x(), point.y(), width, patternHeight), NSCompositeSourceOver);
177     
178     CGContextRestoreGState(context);
179 }
180
181 }