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