The dragged image should be the current frame only of the animated image
[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)
30 #import "BitmapImage.h"
31 #import "CoreGraphicsSPI.h"
32 #import "FontCascade.h"
33 #import "FontDescription.h"
34 #import "FontSelector.h"
35 #import "GraphicsContext.h"
36 #import "Image.h"
37 #import "URL.h"
38 #import "ResourceResponse.h"
39 #import "StringTruncator.h"
40 #import "TextRun.h"
41 #import <wtf/NeverDestroyed.h>
42
43 namespace WebCore {
44
45 IntSize dragImageSize(RetainPtr<NSImage> image)
46 {
47     return (IntSize)[image.get() size];
48 }
49
50 void deleteDragImage(RetainPtr<NSImage>)
51 {
52     // Since this is a RetainPtr, there's nothing additional we need to do to
53     // delete it. It will be released when it falls out of scope.
54 }
55
56 RetainPtr<NSImage> scaleDragImage(RetainPtr<NSImage> image, FloatSize scale)
57 {
58     NSSize originalSize = [image.get() size];
59     NSSize newSize = NSMakeSize((originalSize.width * scale.width()), (originalSize.height * scale.height()));
60     newSize.width = roundf(newSize.width);
61     newSize.height = roundf(newSize.height);
62 #pragma clang diagnostic push
63 #pragma clang diagnostic ignored "-Wdeprecated-declarations"
64     [image.get() setScalesWhenResized:YES];
65 #pragma clang diagnostic pop
66     [image.get() setSize:newSize];
67     return image;
68 }
69     
70 RetainPtr<NSImage> dissolveDragImageToFraction(RetainPtr<NSImage> image, float delta)
71 {
72     if (!image)
73         return nil;
74
75     RetainPtr<NSImage> dissolvedImage = adoptNS([[NSImage alloc] initWithSize:[image.get() size]]);
76     
77     [dissolvedImage.get() lockFocus];
78 #pragma clang diagnostic push
79 #pragma clang diagnostic ignored "-Wdeprecated-declarations"
80     [image.get() drawAtPoint:NSZeroPoint fromRect:NSMakeRect(0, 0, [image size].width, [image size].height) operation:NSCompositeCopy fraction:delta];
81 #pragma clang diagnostic pop
82     [dissolvedImage.get() unlockFocus];
83
84     return dissolvedImage;
85 }
86         
87 RetainPtr<NSImage> createDragImageFromImage(Image* image, ImageOrientationDescription description)
88 {
89     FloatSize size = image->size();
90
91     if (is<BitmapImage>(*image)) {
92         ImageOrientation orientation;
93         BitmapImage& bitmapImage = downcast<BitmapImage>(*image);
94         IntSize sizeRespectingOrientation = bitmapImage.sizeRespectingOrientation();
95
96         if (description.respectImageOrientation() == RespectImageOrientation)
97             orientation = bitmapImage.orientationForCurrentFrame();
98
99         if (orientation != DefaultImageOrientation) {
100             // Construct a correctly-rotated copy of the image to use as the drag image.
101             FloatRect destRect(FloatPoint(), sizeRespectingOrientation);
102
103             RetainPtr<NSImage> rotatedDragImage = adoptNS([[NSImage alloc] initWithSize:(NSSize)(sizeRespectingOrientation)]);
104             [rotatedDragImage.get() lockFocus];
105
106             // ImageOrientation uses top-left coordinates, need to flip to bottom-left, apply...
107             CGAffineTransform transform = CGAffineTransformMakeTranslation(0, destRect.height());
108             transform = CGAffineTransformScale(transform, 1, -1);
109             transform = CGAffineTransformConcat(orientation.transformFromDefault(sizeRespectingOrientation), transform);
110
111             if (orientation.usesWidthAsHeight())
112                 destRect = FloatRect(destRect.x(), destRect.y(), destRect.height(), destRect.width());
113
114             // ...and flip back.
115             transform = CGAffineTransformTranslate(transform, 0, destRect.height());
116             transform = CGAffineTransformScale(transform, 1, -1);
117
118             RetainPtr<NSAffineTransform> cocoaTransform = adoptNS([[NSAffineTransform alloc] init]);
119             [cocoaTransform.get() setTransformStruct:*(NSAffineTransformStruct*)&transform];
120             [cocoaTransform.get() concat];
121
122 #pragma clang diagnostic push
123 #pragma clang diagnostic ignored "-Wdeprecated-declarations"
124             [image->currentFrameNSImage() drawInRect:destRect fromRect:NSMakeRect(0, 0, size.width(), size.height()) operation:NSCompositeSourceOver fraction:1.0];
125 #pragma clang diagnostic pop
126             [rotatedDragImage.get() unlockFocus];
127
128             return rotatedDragImage;
129         }
130     }
131
132     auto dragImage = image->currentFrameNSImage();
133     [dragImage.get() setSize:(NSSize)size];
134     return dragImage;
135 }
136     
137 RetainPtr<NSImage> createDragImageIconForCachedImageFilename(const String& filename)
138 {
139     NSString *extension = nil;
140     size_t dotIndex = filename.reverseFind('.');
141     
142     if (dotIndex != notFound && dotIndex < (filename.length() - 1)) // require that a . exists after the first character and before the last
143         extension = filename.substring(dotIndex + 1);
144     else {
145         // It might be worth doing a further lookup to pull the extension from the MIME type.
146         extension = @"";
147     }
148     
149     return [[NSWorkspace sharedWorkspace] iconForFileType:extension];
150 }
151
152
153 const float DragLabelBorderX = 4;
154 //Keep border_y in synch with DragController::LinkDragBorderInset
155 const float DragLabelBorderY = 2;
156 const float DragLabelRadius = 5;
157 const float LabelBorderYOffset = 2;
158
159 const float MinDragLabelWidthBeforeClip = 120;
160 const float MaxDragLabelWidth = 320;
161
162 const float DragLinkLabelFontsize = 11;
163 const float DragLinkUrlFontSize = 10;
164
165 // FIXME - we should move all the functionality of NSString extras to WebCore
166     
167 static FontCascade& fontFromNSFont(NSFont *font)
168 {
169     ASSERT(font);
170     static NSFont *currentFont;
171     static NeverDestroyed<FontCascade> currentRenderer;
172     
173     if ([font isEqual:currentFont])
174         return currentRenderer;
175     if (currentFont)
176         CFRelease(currentFont);
177     currentFont = font;
178     CFRetain(currentFont);
179     currentRenderer.get() = FontCascade(FontPlatformData(toCTFont(font), [font pointSize]));
180     return currentRenderer;
181 }
182
183 static bool canUseFastRenderer(const UniChar* buffer, unsigned length)
184 {
185     unsigned i;
186     for (i = 0; i < length; i++) {
187         UCharDirection direction = u_charDirection(buffer[i]);
188         if (direction == U_RIGHT_TO_LEFT || direction > U_OTHER_NEUTRAL)
189             return false;
190     }
191     return true;
192 }
193     
194 static float widthWithFont(NSString *string, NSFont *font)
195 {
196     if (!font)
197         return 0;
198
199     unsigned length = [string length];
200     Vector<UniChar, 2048> buffer(length);
201     
202     [string getCharacters:buffer.data()];
203     
204     if (canUseFastRenderer(buffer.data(), length)) {
205         FontCascade webCoreFont(FontPlatformData(toCTFont(font), [font pointSize]));
206         TextRun run(StringView(buffer.data(), length));
207         return webCoreFont.width(run);
208     }
209     
210     return [string sizeWithAttributes:[NSDictionary dictionaryWithObjectsAndKeys:font, NSFontAttributeName, nil]].width;
211 }
212     
213 static void drawAtPoint(NSString *string, NSPoint point, NSFont *font, NSColor *textColor)
214 {
215     if (!font)
216         return;
217
218     unsigned length = [string length];
219     Vector<UniChar, 2048> buffer(length);
220     
221     [string getCharacters:buffer.data()];
222     
223     if (canUseFastRenderer(buffer.data(), length)) {
224         // The following is a half-assed attempt to match AppKit's rounding rules for drawAtPoint.
225         // It's probably incorrect for high DPI.
226         // If you change this, be sure to test all the text drawn this way in Safari, including
227         // the status bar, bookmarks bar, tab bar, and activity window.
228         point.y = CGCeiling(point.y);
229         
230         NSGraphicsContext *nsContext = [NSGraphicsContext currentContext];
231         CGContextRef cgContext = static_cast<CGContextRef>([nsContext graphicsPort]);
232         GraphicsContext graphicsContext(cgContext);    
233         
234         // Safari doesn't flip the NSGraphicsContext before calling WebKit, yet WebCore requires a flipped graphics context.
235         BOOL flipped = [nsContext isFlipped];
236         if (!flipped)
237             CGContextScaleCTM(cgContext, 1, -1);
238
239         FontCascade webCoreFont(FontPlatformData(toCTFont(font), [font pointSize]), Antialiased);
240         TextRun run(StringView(buffer.data(), length));
241
242         CGFloat red;
243         CGFloat green;
244         CGFloat blue;
245         CGFloat alpha;
246         [[textColor colorUsingColorSpaceName:NSDeviceRGBColorSpace] getRed:&red green:&green blue:&blue alpha:&alpha];
247         graphicsContext.setFillColor(makeRGBA(red * 255, green * 255, blue * 255, alpha * 255));
248         
249         webCoreFont.drawText(graphicsContext, run, FloatPoint(point.x, (flipped ? point.y : (-1 * point.y))));
250         
251         if (!flipped)
252             CGContextScaleCTM(cgContext, 1, -1);
253     } else {
254         // The given point is on the baseline.
255         if ([[NSView focusView] isFlipped])
256             point.y -= [font ascender];
257         else
258             point.y += [font descender];
259                 
260         [string drawAtPoint:point withAttributes:[NSDictionary dictionaryWithObjectsAndKeys:font, NSFontAttributeName, textColor, NSForegroundColorAttributeName, nil]];
261     }
262 }
263     
264 static void drawDoubledAtPoint(NSString *string, NSPoint textPoint, NSColor *topColor, NSColor *bottomColor, NSFont *font)
265 {
266         // turn off font smoothing so translucent text draws correctly (Radar 3118455)
267         drawAtPoint(string, textPoint, font, bottomColor);
268         
269         textPoint.y += 1;
270         drawAtPoint(string, textPoint, font, topColor);
271 }
272
273 DragImageRef createDragImageForLink(URL& url, const String& title, FontRenderingMode)
274 {
275     NSString *label = nsStringNilIfEmpty(title);
276     NSURL *cocoaURL = url;
277     NSString *urlString = [cocoaURL absoluteString];
278
279     BOOL drawURLString = YES;
280     BOOL clipURLString = NO;
281     BOOL clipLabelString = NO;
282
283     if (!label) {
284         drawURLString = NO;
285         label = urlString;
286     }
287
288     NSFont *labelFont = [[NSFontManager sharedFontManager] convertFont:[NSFont systemFontOfSize:DragLinkLabelFontsize]
289                                                            toHaveTrait:NSBoldFontMask];
290     NSFont *urlFont = [NSFont systemFontOfSize:DragLinkUrlFontSize];
291
292     ASSERT(labelFont);
293     ASSERT(urlFont);
294
295     NSSize labelSize;
296     labelSize.width = widthWithFont(label, labelFont);
297     labelSize.height = [labelFont ascender] - [labelFont descender];
298     if (labelSize.width > MaxDragLabelWidth){
299         labelSize.width = MaxDragLabelWidth;
300         clipLabelString = YES;
301     }
302
303     NSSize imageSize;
304     imageSize.width = labelSize.width + DragLabelBorderX * 2;
305     imageSize.height = labelSize.height + DragLabelBorderY * 2;
306     if (drawURLString) {
307         NSSize urlStringSize;
308         urlStringSize.width = widthWithFont(urlString, urlFont);
309         urlStringSize.height = [urlFont ascender] - [urlFont descender];
310         imageSize.height += urlStringSize.height;
311         if (urlStringSize.width > MaxDragLabelWidth) {
312             imageSize.width = std::max(MaxDragLabelWidth + DragLabelBorderY * 2, MinDragLabelWidthBeforeClip);
313             clipURLString = YES;
314         } else
315             imageSize.width = std::max(labelSize.width + DragLabelBorderX * 2, urlStringSize.width + DragLabelBorderX * 2);
316     }
317     NSImage *dragImage = [[[NSImage alloc] initWithSize: imageSize] autorelease];
318     [dragImage lockFocus];
319
320     [[NSColor colorWithDeviceRed: 0.7f green: 0.7f blue: 0.7f alpha: 0.8f] set];
321
322     // Drag a rectangle with rounded corners
323     NSBezierPath *path = [NSBezierPath bezierPath];
324     [path appendBezierPathWithOvalInRect: NSMakeRect(0, 0, DragLabelRadius * 2, DragLabelRadius * 2)];
325     [path appendBezierPathWithOvalInRect: NSMakeRect(0, imageSize.height - DragLabelRadius * 2, DragLabelRadius * 2, DragLabelRadius * 2)];
326     [path appendBezierPathWithOvalInRect: NSMakeRect(imageSize.width - DragLabelRadius * 2, imageSize.height - DragLabelRadius * 2, DragLabelRadius * 2, DragLabelRadius * 2)];
327     [path appendBezierPathWithOvalInRect: NSMakeRect(imageSize.width - DragLabelRadius * 2, 0, DragLabelRadius * 2, DragLabelRadius * 2)];
328
329     [path appendBezierPathWithRect: NSMakeRect(DragLabelRadius, 0, imageSize.width - DragLabelRadius * 2, imageSize.height)];
330     [path appendBezierPathWithRect: NSMakeRect(0, DragLabelRadius, DragLabelRadius + 10, imageSize.height - 2 * DragLabelRadius)];
331     [path appendBezierPathWithRect: NSMakeRect(imageSize.width - DragLabelRadius - 20, DragLabelRadius, DragLabelRadius + 20, imageSize.height - 2 * DragLabelRadius)];
332     [path fill];
333
334     NSColor *topColor = [NSColor colorWithDeviceWhite:0.0f alpha:0.75f];
335     NSColor *bottomColor = [NSColor colorWithDeviceWhite:1.0f alpha:0.5f];
336     if (drawURLString && urlFont) {
337         if (clipURLString)
338             urlString = StringTruncator::centerTruncate(urlString, imageSize.width - (DragLabelBorderX * 2), fontFromNSFont(urlFont));
339
340        drawDoubledAtPoint(urlString, NSMakePoint(DragLabelBorderX, DragLabelBorderY - [urlFont descender]), topColor, bottomColor, urlFont);
341     }
342
343     if (labelFont) {
344         if (clipLabelString)
345             label = StringTruncator::rightTruncate(label, imageSize.width - (DragLabelBorderX * 2), fontFromNSFont(labelFont));
346         drawDoubledAtPoint(label, NSMakePoint(DragLabelBorderX, imageSize.height - LabelBorderYOffset - [labelFont pointSize]), topColor, bottomColor, labelFont);
347     }
348
349     [dragImage unlockFocus];
350
351     return dragImage;
352 }
353    
354 } // namespace WebCore
355
356 #endif // ENABLE(DRAG_SUPPORT)