Move URL from WebCore to WTF
[WebKit-https.git] / Source / WebCore / platform / mac / DragImageMac.mm
1 /*
2  * Copyright (C) 2007, 2009, 2012 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 "DragImage.h"
28
29 #if ENABLE(DRAG_SUPPORT) && PLATFORM(MAC)
30
31 #import "BitmapImage.h"
32 #import "ColorMac.h"
33 #import "Element.h"
34 #import "FloatRoundedRect.h"
35 #import "FontCascade.h"
36 #import "FontDescription.h"
37 #import "FontSelector.h"
38 #import "GraphicsContext.h"
39 #import "Image.h"
40 #import "LocalDefaultSystemAppearance.h"
41 #import "Page.h"
42 #import "StringTruncator.h"
43 #import "TextIndicator.h"
44 #import "WebKitNSImageExtras.h"
45 #import <pal/spi/cg/CoreGraphicsSPI.h>
46 #import <pal/spi/cocoa/CoreTextSPI.h>
47 #import <pal/spi/cocoa/URLFormattingSPI.h>
48 #import <wtf/SoftLinking.h>
49 #import <wtf/URL.h>
50
51 #if !HAVE(URL_FORMATTING) && __MAC_OS_X_VERSION_MIN_REQUIRED >= 101300
52 SOFT_LINK_PRIVATE_FRAMEWORK_OPTIONAL(LinkPresentation)
53 #endif
54
55 namespace WebCore {
56
57 IntSize dragImageSize(RetainPtr<NSImage> image)
58 {
59     return (IntSize)[image size];
60 }
61
62 void deleteDragImage(RetainPtr<NSImage>)
63 {
64     // Since this is a RetainPtr, there's nothing additional we need to do to
65     // delete it. It will be released when it falls out of scope.
66 }
67
68 RetainPtr<NSImage> scaleDragImage(RetainPtr<NSImage> image, FloatSize scale)
69 {
70     NSSize originalSize = [image size];
71     NSSize newSize = NSMakeSize((originalSize.width * scale.width()), (originalSize.height * scale.height()));
72     newSize.width = roundf(newSize.width);
73     newSize.height = roundf(newSize.height);
74     ALLOW_DEPRECATED_DECLARATIONS_BEGIN
75     [image setScalesWhenResized:YES];
76     ALLOW_DEPRECATED_DECLARATIONS_END
77     [image setSize:newSize];
78     return image;
79 }
80     
81 RetainPtr<NSImage> dissolveDragImageToFraction(RetainPtr<NSImage> image, float delta)
82 {
83     if (!image)
84         return nil;
85
86     RetainPtr<NSImage> dissolvedImage = adoptNS([[NSImage alloc] initWithSize:[image size]]);
87     
88     [dissolvedImage lockFocus];
89     [image drawAtPoint:NSZeroPoint fromRect:NSMakeRect(0, 0, [image size].width, [image size].height) operation:NSCompositingOperationCopy fraction:delta];
90     [dissolvedImage unlockFocus];
91
92     return dissolvedImage;
93 }
94         
95 RetainPtr<NSImage> createDragImageFromImage(Image* image, ImageOrientationDescription description)
96 {
97     FloatSize size = image->size();
98
99     if (is<BitmapImage>(*image)) {
100         ImageOrientation orientation;
101         BitmapImage& bitmapImage = downcast<BitmapImage>(*image);
102         IntSize sizeRespectingOrientation = bitmapImage.sizeRespectingOrientation();
103
104         if (description.respectImageOrientation() == RespectImageOrientation)
105             orientation = bitmapImage.orientationForCurrentFrame();
106
107         if (orientation != DefaultImageOrientation) {
108             // Construct a correctly-rotated copy of the image to use as the drag image.
109             FloatRect destRect(FloatPoint(), sizeRespectingOrientation);
110
111             RetainPtr<NSImage> rotatedDragImage = adoptNS([[NSImage alloc] initWithSize:(NSSize)(sizeRespectingOrientation)]);
112             [rotatedDragImage lockFocus];
113
114             // ImageOrientation uses top-left coordinates, need to flip to bottom-left, apply...
115             CGAffineTransform transform = CGAffineTransformMakeTranslation(0, destRect.height());
116             transform = CGAffineTransformScale(transform, 1, -1);
117             transform = CGAffineTransformConcat(orientation.transformFromDefault(sizeRespectingOrientation), transform);
118
119             if (orientation.usesWidthAsHeight())
120                 destRect = FloatRect(destRect.x(), destRect.y(), destRect.height(), destRect.width());
121
122             // ...and flip back.
123             transform = CGAffineTransformTranslate(transform, 0, destRect.height());
124             transform = CGAffineTransformScale(transform, 1, -1);
125
126             RetainPtr<NSAffineTransform> cocoaTransform = adoptNS([[NSAffineTransform alloc] init]);
127             [cocoaTransform setTransformStruct:*(NSAffineTransformStruct*)&transform];
128             [cocoaTransform concat];
129
130             [image->snapshotNSImage() drawInRect:destRect fromRect:NSMakeRect(0, 0, size.width(), size.height()) operation:NSCompositingOperationSourceOver fraction:1.0];
131
132             [rotatedDragImage unlockFocus];
133
134             return rotatedDragImage;
135         }
136     }
137
138     auto dragImage = image->snapshotNSImage();
139     [dragImage setSize:(NSSize)size];
140     return dragImage;
141 }
142     
143 RetainPtr<NSImage> createDragImageIconForCachedImageFilename(const String& filename)
144 {
145     NSString *extension = nil;
146     size_t dotIndex = filename.reverseFind('.');
147     
148     if (dotIndex != notFound && dotIndex < (filename.length() - 1)) // require that a . exists after the first character and before the last
149         extension = filename.substring(dotIndex + 1);
150     else {
151         // It might be worth doing a further lookup to pull the extension from the MIME type.
152         extension = @"";
153     }
154     
155     return [[NSWorkspace sharedWorkspace] iconForFileType:extension];
156 }
157
158 const CGFloat linkImagePadding = 10;
159 const CGFloat linkImageDomainBaselineToTitleBaseline = 18;
160 const CGFloat linkImageCornerRadius = 5;
161 const CGFloat linkImageMaximumWidth = 400;
162 const CGFloat linkImageFontSize = 11;
163 const CFIndex linkImageTitleMaximumLineCount = 2;
164 #if __MAC_OS_X_VERSION_MIN_REQUIRED >= 101300
165 const int linkImageShadowRadius = 0;
166 const int linkImageShadowOffsetY = 0;
167 #else
168 const int linkImageShadowRadius = 9;
169 const int linkImageShadowOffsetY = -3;
170 #endif
171 const int linkImageDragCornerOutsetX = 6 - linkImageShadowRadius;
172 const int linkImageDragCornerOutsetY = 10 - linkImageShadowRadius + linkImageShadowOffsetY;
173
174 IntPoint dragOffsetForLinkDragImage(DragImageRef dragImage)
175 {
176     IntSize size = dragImageSize(dragImage);
177     return { linkImageDragCornerOutsetX, size.height() + linkImageDragCornerOutsetY };
178 }
179
180 FloatPoint anchorPointForLinkDragImage(DragImageRef dragImage)
181 {
182     IntSize size = dragImageSize(dragImage);
183     return { -static_cast<float>(linkImageDragCornerOutsetX) / size.width(), -static_cast<float>(linkImageDragCornerOutsetY) / size.height() };
184 }
185
186 struct LinkImageLayout {
187     LinkImageLayout(URL&, const String& title);
188
189     struct Label {
190         FloatPoint origin;
191         RetainPtr<CTFrameRef> frame;
192     };
193     Vector<Label> labels;
194
195     FloatRect boundingRect;
196 };
197
198 LinkImageLayout::LinkImageLayout(URL& url, const String& titleString)
199 {
200     NSString *title = nsStringNilIfEmpty(titleString);
201     NSURL *cocoaURL = url;
202     NSString *absoluteURLString = [cocoaURL absoluteString];
203
204     NSString *domain = absoluteURLString;
205 #if HAVE(URL_FORMATTING)
206     domain = [cocoaURL _lp_simplifiedDisplayString];
207 #elif __MAC_OS_X_VERSION_MIN_REQUIRED >= 101300
208     if (LinkPresentationLibrary())
209         domain = [cocoaURL _lp_simplifiedDisplayString];
210 #endif
211
212     if ([title isEqualToString:absoluteURLString])
213         title = nil;
214
215     NSFont *titleFont = [NSFont boldSystemFontOfSize:linkImageFontSize];
216     NSFont *domainFont = [NSFont systemFontOfSize:linkImageFontSize];
217
218     NSColor *titleColor = [NSColor labelColor];
219     NSColor *domainColor = [NSColor secondaryLabelColor];
220
221     CGFloat maximumAvailableWidth = linkImageMaximumWidth - linkImagePadding * 2;
222
223     CGFloat currentY = linkImagePadding;
224     CGFloat maximumUsedTextWidth = 0;
225
226     auto buildLines = [this, maximumAvailableWidth, &maximumUsedTextWidth, &currentY] (NSString *text, NSColor *color, NSFont *font, CFIndex maximumLines, CTLineBreakMode lineBreakMode) {
227         CTParagraphStyleSetting paragraphStyleSettings[1];
228         paragraphStyleSettings[0].spec = kCTParagraphStyleSpecifierLineBreakMode;
229         paragraphStyleSettings[0].valueSize = sizeof(CTLineBreakMode);
230         paragraphStyleSettings[0].value = &lineBreakMode;
231         RetainPtr<CTParagraphStyleRef> paragraphStyle = adoptCF(CTParagraphStyleCreate(paragraphStyleSettings, 1));
232
233         NSDictionary *textAttributes = @{
234             (id)kCTFontAttributeName: font,
235             (id)kCTForegroundColorAttributeName: color,
236             (id)kCTParagraphStyleAttributeName: (id)paragraphStyle.get()
237         };
238         NSDictionary *frameAttributes = @{
239             (id)kCTFrameMaximumNumberOfLinesAttributeName: @(maximumLines)
240         };
241
242         RetainPtr<NSAttributedString> attributedText = adoptNS([[NSAttributedString alloc] initWithString:text attributes:textAttributes]);
243         RetainPtr<CTFramesetterRef> textFramesetter = adoptCF(CTFramesetterCreateWithAttributedString((CFAttributedStringRef)attributedText.get()));
244
245         CFRange fitRange;
246         CGSize textSize = CTFramesetterSuggestFrameSizeWithConstraints(textFramesetter.get(), CFRangeMake(0, 0), (CFDictionaryRef)frameAttributes, CGSizeMake(maximumAvailableWidth, CGFLOAT_MAX), &fitRange);
247
248         RetainPtr<CGPathRef> textPath = adoptCF(CGPathCreateWithRect(CGRectMake(0, 0, textSize.width, textSize.height), nullptr));
249         RetainPtr<CTFrameRef> textFrame = adoptCF(CTFramesetterCreateFrame(textFramesetter.get(), fitRange, textPath.get(), (CFDictionaryRef)frameAttributes));
250
251         CFArrayRef ctLines = CTFrameGetLines(textFrame.get());
252         CFIndex lineCount = CFArrayGetCount(ctLines);
253         if (!lineCount)
254             return;
255
256         Vector<CGPoint> origins(lineCount);
257         CGRect lineBounds;
258         CGFloat height = 0;
259         CTFrameGetLineOrigins(textFrame.get(), CFRangeMake(0, 0), origins.data());
260         for (CFIndex lineIndex = 0; lineIndex < lineCount; ++lineIndex) {
261             CTLineRef line = (CTLineRef)CFArrayGetValueAtIndex(ctLines, lineIndex);
262
263             lineBounds = CTLineGetBoundsWithOptions(line, 0);
264             CGFloat trailingWhitespaceWidth = CTLineGetTrailingWhitespaceWidth(line);
265             CGFloat lineWidthIgnoringTrailingWhitespace = lineBounds.size.width - trailingWhitespaceWidth;
266             maximumUsedTextWidth = std::max(maximumUsedTextWidth, lineWidthIgnoringTrailingWhitespace);
267
268             if (lineIndex)
269                 height += origins[lineIndex - 1].y - origins[lineIndex].y;
270         }
271
272         LinkImageLayout::Label label;
273         label.frame = textFrame;
274         label.origin = FloatPoint(linkImagePadding, currentY + origins[0].y);
275         labels.append(label);
276
277         currentY += height + lineBounds.size.height;
278     };
279
280     if (title)
281         buildLines(title, titleColor, titleFont, linkImageTitleMaximumLineCount, kCTLineBreakByTruncatingTail);
282
283     if (title && domain)
284         currentY += linkImageDomainBaselineToTitleBaseline - (domainFont.ascender - domainFont.descender);
285
286     if (domain)
287         buildLines(domain, domainColor, domainFont, 1, kCTLineBreakByTruncatingMiddle);
288
289     currentY += linkImagePadding;
290
291     boundingRect = FloatRect(0, 0, maximumUsedTextWidth + linkImagePadding * 2, currentY);
292
293     // To work around blurry drag images on 1x displays, make the width and height a multiple of 2.
294     // FIXME: remove this workaround when <rdar://problem/33059739> is fixed.
295     boundingRect.setWidth((static_cast<int>(boundingRect.width()) / 2) * 2);
296     boundingRect.setHeight((static_cast<int>(boundingRect.height() / 2) * 2));
297 }
298
299 DragImageRef createDragImageForLink(Element& element, URL& url, const String& title, TextIndicatorData&, FontRenderingMode, float deviceScaleFactor)
300 {
301     LinkImageLayout layout(url, title);
302
303     LocalDefaultSystemAppearance localAppearance(element.document().useDarkAppearance(element.computedStyle()));
304
305     auto imageSize = layout.boundingRect.size();
306 #if __MAC_OS_X_VERSION_MIN_REQUIRED < 101300
307     imageSize.expand(2 * linkImageShadowRadius, 2 * linkImageShadowRadius - linkImageShadowOffsetY);
308 #endif
309     RetainPtr<NSImage> dragImage = adoptNS([[NSImage alloc] initWithSize:imageSize]);
310     [dragImage _web_lockFocusWithDeviceScaleFactor:deviceScaleFactor];
311
312     ALLOW_DEPRECATED_DECLARATIONS_BEGIN
313     GraphicsContext context((CGContextRef)[NSGraphicsContext currentContext].graphicsPort);
314     ALLOW_DEPRECATED_DECLARATIONS_END
315
316 #if __MAC_OS_X_VERSION_MIN_REQUIRED < 101300
317     context.translate(linkImageShadowRadius, linkImageShadowRadius - linkImageShadowOffsetY);
318     context.setShadow({ 0, linkImageShadowOffsetY }, linkImageShadowRadius, { 0.f, 0.f, 0.f, .25 });
319 #endif
320     context.fillRoundedRect(FloatRoundedRect(layout.boundingRect, FloatRoundedRect::Radii(linkImageCornerRadius)), colorFromNSColor([NSColor controlBackgroundColor]));
321 #if __MAC_OS_X_VERSION_MIN_REQUIRED < 101300
322     context.clearShadow();
323 #endif
324
325     for (const auto& label : layout.labels) {
326         GraphicsContextStateSaver saver(context);
327         context.translate(label.origin.x(), layout.boundingRect.height() - label.origin.y() - linkImagePadding);
328         CTFrameDraw(label.frame.get(), context.platformContext());
329     }
330
331     [dragImage unlockFocus];
332
333     return dragImage;
334 }
335
336 DragImageRef createDragImageForColor(const Color& color, const FloatRect&, float, Path&)
337 {
338     auto dragImage = adoptNS([[NSImage alloc] initWithSize:NSMakeSize(ColorSwatchWidth, ColorSwatchWidth)]);
339
340     [dragImage lockFocus];
341
342     NSBezierPath *path = [NSBezierPath bezierPathWithRoundedRect:NSMakeRect(0, 0, ColorSwatchWidth, ColorSwatchWidth) xRadius:ColorSwatchCornerRadius yRadius:ColorSwatchCornerRadius];
343     [path setLineWidth:ColorSwatchStrokeSize];
344
345     [nsColor(color) setFill];
346     [path fill];
347
348     [[NSColor quaternaryLabelColor] setStroke];
349     [path stroke];
350
351     [dragImage unlockFocus];
352
353     return dragImage;
354 }
355    
356 } // namespace WebCore
357
358 #endif // ENABLE(DRAG_SUPPORT) && PLATFORM(MAC)