Source code
Revision control
Copy as Markdown
Other Tools
/* -*- Mode: C++; tab-width: 20; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
#ifndef nsCocoaUtils_h_
#define nsCocoaUtils_h_
#import <Cocoa/Cocoa.h>
#include "InputData.h"
#include "nsRect.h"
#include "imgIContainer.h"
#include "nsTArray.h"
#include "Units.h"
// This must be the last include:
#include "nsObjCExceptions.h"
#include "mozilla/EventForwards.h"
#include "mozilla/MacStringHelpers.h"
#include "mozilla/StaticMutex.h"
#include "mozilla/StaticPtr.h"
#include "nsIWidget.h"
// Declare the backingScaleFactor method that we want to call
// on NSView/Window/Screen objects, if they recognize it.
@interface NSObject (BackingScaleFactorCategory)
- (CGFloat)backingScaleFactor;
@end
// Pasteborad types
extern NSString* const kPublicUrlPboardType;
extern NSString* const kPublicUrlNamePboardType;
extern NSString* const kPasteboardConcealedType;
extern NSString* const kUrlsWithTitlesPboardType;
extern NSString* const kMozWildcardPboardType;
extern NSString* const kMozCustomTypesPboardType;
extern NSString* const kMozFileUrlsPboardType;
@interface UTIHelper : NSObject
+ (NSString*)stringFromPboardType:(NSString*)aType;
@end
class nsITransferable;
class nsIWidget;
namespace mozilla {
class TimeStamp;
namespace gfx {
class SourceSurface;
} // namespace gfx
namespace dom {
class Promise;
} // namespace dom
} // namespace mozilla
using mozilla::StaticAutoPtr;
using mozilla::StaticMutex;
// Used to retain a Cocoa object for the remainder of a method's execution.
class nsAutoRetainCocoaObject {
public:
explicit nsAutoRetainCocoaObject(id anObject) {
NS_OBJC_BEGIN_TRY_IGNORE_BLOCK;
mObject = [anObject retain];
NS_OBJC_END_TRY_IGNORE_BLOCK;
}
~nsAutoRetainCocoaObject() {
NS_OBJC_BEGIN_TRY_IGNORE_BLOCK;
[mObject release];
NS_OBJC_END_TRY_IGNORE_BLOCK;
}
private:
id mObject; // [STRONG]
};
// Provide a local autorelease pool for the remainder of a method's execution.
class nsAutoreleasePool {
public:
nsAutoreleasePool() { mLocalPool = [[NSAutoreleasePool alloc] init]; }
~nsAutoreleasePool() { [mLocalPool release]; }
private:
NSAutoreleasePool* mLocalPool;
};
@interface NSApplication (Undocumented)
// Present in all versions of OS X from (at least) 10.2.8 through 10.5.
- (BOOL)_isRunningModal;
- (BOOL)_isRunningAppModal;
// Send an event to the current Cocoa app-modal session. Present in all
// versions of OS X from (at least) 10.2.8 through 10.5.
- (void)_modalSession:(NSModalSession)aSession sendEvent:(NSEvent*)theEvent;
@end
struct KeyBindingsCommand {
SEL selector;
id data;
};
@interface NativeKeyBindingsRecorder : NSResponder {
@private
nsTArray<KeyBindingsCommand>* mCommands;
}
- (void)startRecording:(nsTArray<KeyBindingsCommand>&)aCommands;
- (void)doCommandBySelector:(SEL)aSelector;
- (void)insertText:(id)aString;
@end // NativeKeyBindingsRecorder
class nsCocoaUtils {
typedef mozilla::gfx::SourceSurface SourceSurface;
typedef mozilla::LayoutDeviceIntPoint LayoutDeviceIntPoint;
typedef mozilla::LayoutDeviceIntRect LayoutDeviceIntRect;
typedef mozilla::dom::Promise Promise;
typedef StaticAutoPtr<nsTArray<RefPtr<Promise>>> PromiseArray;
public:
// Get the backing scale factor from an object that supports this selector
// (NSView/Window/Screen, on 10.7 or later), returning 1.0 if not supported
static CGFloat GetBackingScaleFactor(id aObject) {
if (HiDPIEnabled() &&
[aObject respondsToSelector:@selector(backingScaleFactor)]) {
return [aObject backingScaleFactor];
}
return 1.0;
}
// Conversions between Cocoa points and device pixels, given the backing
// scale factor from a view/window/screen.
static int32_t CocoaPointsToDevPixels(CGFloat aPts, CGFloat aBackingScale) {
return NSToIntRound(aPts * aBackingScale);
}
static LayoutDeviceIntPoint CocoaPointsToDevPixels(const NSPoint& aPt,
CGFloat aBackingScale) {
return LayoutDeviceIntPoint(NSToIntRound(aPt.x * aBackingScale),
NSToIntRound(aPt.y * aBackingScale));
}
static LayoutDeviceIntPoint CocoaPointsToDevPixelsRoundDown(
const NSPoint& aPt, CGFloat aBackingScale) {
return LayoutDeviceIntPoint(NSToIntFloor(aPt.x * aBackingScale),
NSToIntFloor(aPt.y * aBackingScale));
}
static LayoutDeviceIntRect CocoaPointsToDevPixels(const NSRect& aRect,
CGFloat aBackingScale) {
return LayoutDeviceIntRect(NSToIntRound(aRect.origin.x * aBackingScale),
NSToIntRound(aRect.origin.y * aBackingScale),
NSToIntRound(aRect.size.width * aBackingScale),
NSToIntRound(aRect.size.height * aBackingScale));
}
static CGFloat DevPixelsToCocoaPoints(int32_t aPixels,
CGFloat aBackingScale) {
return (CGFloat)aPixels / aBackingScale;
}
static NSPoint DevPixelsToCocoaPoints(
const mozilla::LayoutDeviceIntPoint& aPt, CGFloat aBackingScale) {
return NSMakePoint((CGFloat)aPt.x / aBackingScale,
(CGFloat)aPt.y / aBackingScale);
}
// Implements an NSPoint equivalent of -[NSWindow convertRectFromScreen:].
static NSPoint ConvertPointFromScreen(NSWindow* aWindow, const NSPoint& aPt) {
return
[aWindow convertRectFromScreen:NSMakeRect(aPt.x, aPt.y, 0, 0)].origin;
}
// Implements an NSPoint equivalent of -[NSWindow convertRectToScreen:].
static NSPoint ConvertPointToScreen(NSWindow* aWindow, const NSPoint& aPt) {
return [aWindow convertRectToScreen:NSMakeRect(aPt.x, aPt.y, 0, 0)].origin;
}
static NSRect DevPixelsToCocoaPoints(const LayoutDeviceIntRect& aRect,
CGFloat aBackingScale) {
return NSMakeRect((CGFloat)aRect.X() / aBackingScale,
(CGFloat)aRect.Y() / aBackingScale,
(CGFloat)aRect.Width() / aBackingScale,
(CGFloat)aRect.Height() / aBackingScale);
}
// Returns the given y coordinate, which must be in screen coordinates,
// flipped from Gecko to Cocoa or Cocoa to Gecko.
static float FlippedScreenY(float y);
// The following functions come in "DevPix" variants that work with
// backing-store (device pixel) coordinates, as well as the original
// versions that expect coordinates in Cocoa points/CSS pixels.
// The difference becomes important in HiDPI display modes, where Cocoa
// points and backing-store pixels are no longer 1:1.
// Gecko rects (nsRect) contain an origin (x,y) in a coordinate
// system with (0,0) in the top-left of the primary screen. Cocoa rects
// (NSRect) contain an origin (x,y) in a coordinate system with (0,0)
// in the bottom-left of the primary screen. Both nsRect and NSRect
// contain width/height info, with no difference in their use.
// This function does no scaling, so the Gecko coordinates are
// expected to be desktop pixels, which are equal to Cocoa points
// (by definition).
static NSRect GeckoRectToCocoaRect(const mozilla::DesktopIntRect& geckoRect);
static NSPoint GeckoPointToCocoaPoint(const mozilla::DesktopPoint& aPoint);
// Converts aGeckoRect in dev pixels to points in Cocoa coordinates
static NSRect GeckoRectToCocoaRectDevPix(
const mozilla::LayoutDeviceIntRect& aGeckoRect, CGFloat aBackingScale);
// See explanation for geckoRectToCocoaRect, guess what this does...
static mozilla::DesktopIntRect CocoaRectToGeckoRect(const NSRect& cocoaRect);
static mozilla::LayoutDeviceIntRect CocoaRectToGeckoRectDevPix(
const NSRect& aCocoaRect, CGFloat aBackingScale);
// Gives the location for the event in screen coordinates. Do not call this
// unless the window the event was originally targeted at is still alive!
// anEvent may be nil -- in that case the current mouse location is returned.
static NSPoint ScreenLocationForEvent(NSEvent* anEvent);
// Determines if an event happened over a window, whether or not the event
// is for the window. Does not take window z-order into account.
static BOOL IsEventOverWindow(NSEvent* anEvent, NSWindow* aWindow);
// Events are set up so that their coordinates refer to the window to which
// they were originally sent. If we reroute the event somewhere else, we'll
// have to get the window coordinates this way. Do not call this unless the
// window the event was originally targeted at is still alive!
static NSPoint EventLocationForWindow(NSEvent* anEvent, NSWindow* aWindow);
static BOOL IsMomentumScrollEvent(NSEvent* aEvent);
static BOOL EventHasPhaseInformation(NSEvent* aEvent);
// Hides the Menu bar and the Dock. Multiple hide/show requests can be nested.
static void HideOSChromeOnScreen(bool aShouldHide);
static nsIWidget* GetHiddenWindowWidget();
/**
* Should the application restore its state because it was launched by the OS
* at login?
*/
static BOOL ShouldRestoreStateDueToLaunchAtLogin();
static void PrepareForNativeAppModalDialog();
static void CleanUpAfterNativeAppModalDialog();
// 3 utility functions to go from a frame of imgIContainer to CGImage and then
// to NSImage Convert imgIContainer -> CGImageRef, caller owns result
/** Creates a <code>CGImageRef</code> from a frame contained in an
<code>imgIContainer</code>. Copies the pixel data from the indicated frame
of the <code>imgIContainer</code> into a new <code>CGImageRef</code>. The
caller owns the <code>CGImageRef</code>.
@param aFrame the frame to convert
@param aResult the resulting CGImageRef
@param aIsEntirelyBlack an outparam that, if non-null, will be set to a
bool that indicates whether the RGB values on all
pixels are zero
@return NS_OK if the conversion worked, NS_ERROR_FAILURE otherwise
*/
static nsresult CreateCGImageFromSurface(SourceSurface* aSurface,
CGImageRef* aResult,
bool* aIsEntirelyBlack = nullptr);
/** Creates a Cocoa <code>NSImage</code> from a <code>CGImageRef</code>.
Copies the pixel data from the <code>CGImageRef</code> into a new
<code>NSImage</code>. The caller owns the <code>NSImage</code>.
@param aInputImage the image to convert
@param aResult the resulting NSImage
@return NS_OK if the conversion worked, NS_ERROR_FAILURE otherwise
*/
static nsresult CreateNSImageFromCGImage(CGImageRef aInputImage,
NSImage** aResult);
/** Creates a Cocoa <code>NSImage</code> from a frame of an
<code>imgIContainer</code>. Combines the two methods above. The caller owns
the <code>NSImage</code>.
@param aImage the image to extract a frame from
@param aWhichFrame the frame to extract (see imgIContainer FRAME_*)
@param aComputedStyle the ComputedStyle of the element that the image is
for, to support SVG context paint properties, can be null
@param aResult the resulting NSImage
@param scaleFactor the desired scale factor of the NSImage (2 for a retina
display)
@param aIsEntirelyBlack an outparam that, if non-null, will be set to a
bool that indicates whether the RGB values on all
pixels are zero
@return NS_OK if the conversion worked, NS_ERROR_FAILURE otherwise
*/
static nsresult CreateNSImageFromImageContainer(
imgIContainer* aImage, uint32_t aWhichFrame,
const nsPresContext* aPresContext,
const mozilla::ComputedStyle* aComputedStyle,
const NSSize& aPreferredSize, NSImage** aResult, CGFloat scaleFactor,
bool* aIsEntirelyBlack = nullptr);
/** Creates a Cocoa <code>NSImage</code> from a frame of an
<code>imgIContainer</code>. The new <code>NSImage</code> will have both a
regular and HiDPI representation. The caller owns the <code>NSImage</code>.
@param aImage the image to extract a frame from
@param aWhichFrame the frame to extract (see imgIContainer FRAME_*)
@param aComputedStyle the ComputedStyle of the element that the image is
for, to support SVG context paint properties, can be null
@param aResult the resulting NSImage
@param aIsEntirelyBlack an outparam that, if non-null, will be set to a
bool that indicates whether the RGB values on all
pixels are zero
@return NS_OK if the conversion worked, NS_ERROR_FAILURE otherwise
*/
static nsresult CreateDualRepresentationNSImageFromImageContainer(
imgIContainer* aImage, uint32_t aWhichFrame,
const nsPresContext* aPresContext,
const mozilla::ComputedStyle* aComputedStyle,
const NSSize& aPreferredSize, NSImage** aResult,
bool* aIsEntirelyBlack = nullptr);
/**
* Returns nsAString for aSrc.
*/
static void GetStringForNSString(const NSString* aSrc, nsAString& aDist) {
mozilla::CopyNSStringToXPCOMString(aSrc, aDist);
}
/**
* Makes NSString instance for aString.
*/
static NSString* ToNSString(const nsAString& aString) {
return mozilla::XPCOMStringToNSString(aString);
}
/**
* Returns an NSURL instance for the provided string.
*/
static NSURL* ToNSURL(const nsAString& aURLString);
/**
* Makes NSString instance for aCString.
*/
static NSString* ToNSString(const nsACString& aCString) {
return mozilla::XPCOMStringToNSString(aCString);
}
/**
* Returns NSRect for aGeckoRect.
* Just copies values between the two types; it does no coordinate-system
* conversion, so both rects must have the same coordinate origin/direction.
*/
static void GeckoRectToNSRect(const nsIntRect& aGeckoRect,
NSRect& aOutCocoaRect);
/**
* Returns Gecko rect for aCocoaRect.
* Just copies values between the two types; it does no coordinate-system
* conversion, so both rects must have the same coordinate origin/direction.
*/
static void NSRectToGeckoRect(const NSRect& aCocoaRect,
nsIntRect& aOutGeckoRect);
/**
* Makes NSEvent instance for aEventTytpe and aEvent.
*/
static NSEvent* MakeNewCocoaEventWithType(NSEventType aEventType,
NSEvent* aEvent);
/**
* Makes a cocoa event from a widget keyboard event.
*/
static NSEvent* MakeNewCococaEventFromWidgetEvent(
const mozilla::WidgetKeyboardEvent& aKeyEvent, NSInteger aWindowNumber,
NSGraphicsContext* aContext);
/**
* Initializes WidgetInputEvent for aNativeEvent or aModifiers.
*/
static void InitInputEvent(mozilla::WidgetInputEvent& aInputEvent,
NSEvent* aNativeEvent);
/**
* Converts the native modifiers from aNativeEvent into WidgetMouseEvent
* Modifiers. aNativeEvent can be null.
*/
static mozilla::Modifiers ModifiersForEvent(NSEvent* aNativeEvent);
/**
* ConvertToCarbonModifier() returns carbon modifier flags for the cocoa
* modifier flags.
* NOTE: The result never includes right*Key.
*/
static UInt32 ConvertToCarbonModifier(NSUInteger aCocoaModifier);
/**
* Whether to support HiDPI rendering. For testing purposes, to be removed
* once we're comfortable with the HiDPI behavior.
*/
static bool HiDPIEnabled();
/**
* Keys can optionally be bound by system or user key bindings to one or more
* commands based on selectors. This collects any such commands in the
* provided array.
*/
static void GetCommandsFromKeyEvent(NSEvent* aEvent,
nsTArray<KeyBindingsCommand>& aCommands);
/**
* Converts the string name of a Gecko key (like "VK_HOME") to the
* corresponding Cocoa Unicode character.
*/
static uint32_t ConvertGeckoNameToMacCharCode(const nsAString& aKeyCodeName);
/**
* Converts a Gecko key code (like NS_VK_HOME) to the corresponding Cocoa
* Unicode character.
*/
static uint32_t ConvertGeckoKeyCodeToMacCharCode(uint32_t aKeyCode);
/**
* Converts Gecko native modifier flags for `nsIWidget::SynthesizeNative*()`
* to native modifier flags of macOS.
*/
static NSEventModifierFlags ConvertWidgetModifiersToMacModifierFlags(
nsIWidget::Modifiers aNativeModifiers);
/**
* Get the mouse button, which depends on the event's type and buttonNumber.
* Returns MouseButton::ePrimary for non-mouse events.
*/
static mozilla::MouseButton ButtonForEvent(NSEvent* aEvent);
/**
* Convert string with font attribute to NSMutableAttributedString
*/
static NSMutableAttributedString* GetNSMutableAttributedString(
const nsAString& aText, const nsTArray<mozilla::FontRange>& aFontRanges,
const bool aIsVertical, const CGFloat aBackingScaleFactor);
/**
* Compute TimeStamp from an event's timestamp.
* If aEventTime is 0, this returns current timestamp.
*/
static mozilla::TimeStamp GetEventTimeStamp(NSTimeInterval aEventTime);
/**
* Check whether double clicking on the titlebar should cause the window to
* zoom (maximize).
*/
static bool ShouldZoomOnTitlebarDoubleClick();
/**
* Check whether double clicking on the titlebar should cause the window to
* minimize.
*/
static bool ShouldMinimizeOnTitlebarDoubleClick();
/**
* Get the current video capture permission status.
* Returns NS_ERROR_NOT_IMPLEMENTED on 10.13 and earlier macOS versions.
*/
static nsresult GetVideoCapturePermissionState(uint16_t& aPermissionState);
/**
* Get the current audio capture permission status.
* Returns NS_ERROR_NOT_IMPLEMENTED on 10.13 and earlier macOS versions.
*/
static nsresult GetAudioCapturePermissionState(uint16_t& aPermissionState);
/**
* Get the current screen capture permission status.
* Returns NS_ERROR_NOT_IMPLEMENTED on 10.14 and earlier macOS versions.
*/
static nsresult GetScreenCapturePermissionState(uint16_t& aPermissionState);
/**
* Request video capture permission from the OS. Caller must be running
* on the main thread and the promise will be resolved on the main thread.
* Returns NS_ERROR_NOT_IMPLEMENTED on 10.13 and earlier macOS versions.
*/
static nsresult RequestVideoCapturePermission(RefPtr<Promise>& aPromise);
/**
* Request audio capture permission from the OS. Caller must be running
* on the main thread and the promise will be resolved on the main thread.
* Returns NS_ERROR_NOT_IMPLEMENTED on 10.13 and earlier macOS versions.
*/
static nsresult RequestAudioCapturePermission(RefPtr<Promise>& aPromise);
/**
* Request screen capture permission from the OS using an unreliable method.
*/
static nsresult MaybeRequestScreenCapturePermission();
static void InvalidateHiDPIState();
static mozilla::PanGestureInput CreatePanGestureEvent(
NSEvent* aNativeEvent, mozilla::TimeStamp aTimeStamp,
const mozilla::ScreenPoint& aPanStartPoint,
const mozilla::ScreenPoint& aPreciseDelta,
const mozilla::gfx::IntPoint& aLineOrPageDelta,
mozilla::Modifiers aModifiers);
/**
* Return true if aAvailableType is a vaild NSPasteboard type.
*/
static bool IsValidPasteboardType(NSString* aAvailableType,
bool aAllowFileURL);
/**
* Set data for specific type from NSPasteboardItem to Transferable.
*/
static void SetTransferDataForTypeFromPasteboardItem(
nsITransferable* aTransferable, const nsCString& aFlavor,
NSPasteboardItem* aItem);
private:
/**
* Completion handlers used as an argument to the macOS API to
* request media capture permission. These are called asynchronously
* on an arbitrary dispatch queue.
*/
static void (^AudioCompletionHandler)(BOOL);
static void (^VideoCompletionHandler)(BOOL);
/**
* Called from the audio and video completion handlers in order to
* dispatch the handling back to the main thread.
*/
static void ResolveAudioCapturePromises(bool aGranted);
static void ResolveVideoCapturePromises(bool aGranted);
/**
* Main implementation for Request{Audio,Video}CapturePermission.
* @param aType the AVMediaType to request capture permission for
* @param aPromise the Promise to resolve when capture permission
* is either allowed or denied
* @param aPromiseList the array of promises to save |aPromise| in
* @param aHandler the block function (either ResolveAudioCapturePromises
* or ResolveVideoCapturePromises) to be used as
* the requestAccessForMediaType callback.
*/
static nsresult RequestCapturePermission(NSString* aType,
RefPtr<Promise>& aPromise,
PromiseArray& aPromiseList,
void (^aHandler)(BOOL granted));
/**
* Resolves the pending promises that are waiting for a response
* to a request video or audio capture permission.
*/
static void ResolveMediaCapturePromises(bool aGranted,
PromiseArray& aPromiseList);
/**
* Get string data for a specific type from NSPasteboardItem.
*/
static NSString* GetStringForTypeFromPasteboardItem(
NSPasteboardItem* aItem, const NSString* aType,
bool aAllowFileURL = false);
/**
* Get the file path from NSPasteboardItem.
*/
static NSString* GetFilePathFromPasteboardItem(NSPasteboardItem* aItem);
/**
* Get the title for URL from NSPasteboardItem.
*/
static NSString* GetTitleForURLFromPasteboardItem(NSPasteboardItem* item);
/**
* Did the OS launch the application at login?
*/
static BOOL WasLaunchedAtLogin();
/**
* Should the application restore its state because it was launched by the OS
* at login?
*/
static BOOL ShouldRestoreStateDueToLaunchAtLoginImpl();
/**
* Array of promises waiting to be resolved due to a video capture request.
*/
static PromiseArray sVideoCapturePromises;
/**
* Array of promises waiting to be resolved due to an audio capture request.
*/
static PromiseArray sAudioCapturePromises;
/**
* Lock protecting |sVideoCapturePromises| and |sAudioCapturePromises|.
*/
static StaticMutex sMediaCaptureMutex MOZ_UNANNOTATED;
};
#endif // nsCocoaUtils_h_