mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-12-12 00:50:40 +00:00
417 lines
13 KiB
Plaintext
417 lines
13 KiB
Plaintext
/* -*- Mode: C++; tab-width: 2; 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
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
/*
|
|
* Retrieves and displays icons in native menu items on Mac OS X.
|
|
*/
|
|
|
|
/* exception_defines.h defines 'try' to 'if (true)' which breaks objective-c
|
|
exceptions and produces errors like: error: unexpected '@' in program'.
|
|
If we define __EXCEPTIONS exception_defines.h will avoid doing this.
|
|
|
|
See bug 666609 for more information.
|
|
|
|
We use <limits> to get the libstdc++ version. */
|
|
#include <limits>
|
|
#if __GLIBCXX__ <= 20070719
|
|
#ifndef __EXCEPTIONS
|
|
#define __EXCEPTIONS
|
|
#endif
|
|
#endif
|
|
|
|
#include "nsMenuItemIconX.h"
|
|
#include "nsObjCExceptions.h"
|
|
#include "nsIContent.h"
|
|
#include "nsIDocument.h"
|
|
#include "nsNameSpaceManager.h"
|
|
#include "nsGkAtoms.h"
|
|
#include "nsThreadUtils.h"
|
|
#include "nsToolkit.h"
|
|
#include "nsNetUtil.h"
|
|
#include "imgLoader.h"
|
|
#include "imgRequestProxy.h"
|
|
#include "nsMenuItemX.h"
|
|
#include "gfxPlatform.h"
|
|
#include "imgIContainer.h"
|
|
#include "nsCocoaUtils.h"
|
|
#include "nsContentUtils.h"
|
|
#include "nsIContentPolicy.h"
|
|
#include "nsComputedDOMStyle.h"
|
|
|
|
using mozilla::dom::Element;
|
|
using mozilla::gfx::SourceSurface;
|
|
|
|
static const uint32_t kIconWidth = 16;
|
|
static const uint32_t kIconHeight = 16;
|
|
|
|
NS_IMPL_ISUPPORTS(nsMenuItemIconX, imgINotificationObserver)
|
|
|
|
nsMenuItemIconX::nsMenuItemIconX(nsMenuObjectX* aMenuItem,
|
|
nsIContent* aContent,
|
|
NSMenuItem* aNativeMenuItem)
|
|
: mContent(aContent)
|
|
, mTriggeringPrincipal(aContent->NodePrincipal())
|
|
, mContentType(nsIContentPolicy::TYPE_INTERNAL_IMAGE)
|
|
, mMenuObject(aMenuItem)
|
|
, mLoadedIcon(false)
|
|
, mSetIcon(false)
|
|
, mNativeMenuItem(aNativeMenuItem)
|
|
{
|
|
// printf("Creating icon for menu item %d, menu %d, native item is %d\n", aMenuItem, aMenu, aNativeMenuItem);
|
|
}
|
|
|
|
nsMenuItemIconX::~nsMenuItemIconX()
|
|
{
|
|
if (mIconRequest)
|
|
mIconRequest->CancelAndForgetObserver(NS_BINDING_ABORTED);
|
|
}
|
|
|
|
// Called from mMenuObjectX's destructor, to prevent us from outliving it
|
|
// (as might otherwise happen if calls to our imgINotificationObserver methods
|
|
// are still outstanding). mMenuObjectX owns our nNativeMenuItem.
|
|
void nsMenuItemIconX::Destroy()
|
|
{
|
|
if (mIconRequest) {
|
|
mIconRequest->CancelAndForgetObserver(NS_BINDING_ABORTED);
|
|
mIconRequest = nullptr;
|
|
}
|
|
mMenuObject = nullptr;
|
|
mNativeMenuItem = nil;
|
|
}
|
|
|
|
nsresult
|
|
nsMenuItemIconX::SetupIcon()
|
|
{
|
|
NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NSRESULT;
|
|
|
|
// Still don't have one, then something is wrong, get out of here.
|
|
if (!mNativeMenuItem) {
|
|
NS_ERROR("No native menu item");
|
|
return NS_ERROR_FAILURE;
|
|
}
|
|
|
|
nsCOMPtr<nsIURI> iconURI;
|
|
nsresult rv = GetIconURI(getter_AddRefs(iconURI));
|
|
if (NS_FAILED(rv)) {
|
|
// There is no icon for this menu item. An icon might have been set
|
|
// earlier. Clear it.
|
|
[mNativeMenuItem setImage:nil];
|
|
|
|
return NS_OK;
|
|
}
|
|
|
|
rv = LoadIcon(iconURI);
|
|
if (NS_FAILED(rv)) {
|
|
// There is no icon for this menu item, as an error occurred while loading it.
|
|
// An icon might have been set earlier or the place holder icon may have
|
|
// been set. Clear it.
|
|
[mNativeMenuItem setImage:nil];
|
|
}
|
|
return rv;
|
|
|
|
NS_OBJC_END_TRY_ABORT_BLOCK_NSRESULT;
|
|
}
|
|
|
|
nsresult
|
|
nsMenuItemIconX::GetIconURI(nsIURI** aIconURI)
|
|
{
|
|
if (!mMenuObject)
|
|
return NS_ERROR_FAILURE;
|
|
|
|
// Mac native menu items support having both a checkmark and an icon
|
|
// simultaneously, but this is unheard of in the cross-platform toolkit,
|
|
// seemingly because the win32 theme is unable to cope with both at once.
|
|
// The downside is that it's possible to get a menu item marked with a
|
|
// native checkmark and a checkmark for an icon. Head off that possibility
|
|
// by pretending that no icon exists if this is a checkable menu item.
|
|
if (mMenuObject->MenuObjectType() == eMenuItemObjectType) {
|
|
nsMenuItemX* menuItem = static_cast<nsMenuItemX*>(mMenuObject);
|
|
if (menuItem->GetMenuItemType() != eRegularMenuItemType)
|
|
return NS_ERROR_FAILURE;
|
|
}
|
|
|
|
if (!mContent)
|
|
return NS_ERROR_FAILURE;
|
|
|
|
// First, look at the content node's "image" attribute.
|
|
nsAutoString imageURIString;
|
|
bool hasImageAttr =
|
|
mContent->IsElement() &&
|
|
mContent->AsElement()->GetAttr(kNameSpaceID_None,
|
|
nsGkAtoms::image,
|
|
imageURIString);
|
|
|
|
nsresult rv;
|
|
RefPtr<ComputedStyle> sc;
|
|
nsCOMPtr<nsIURI> iconURI;
|
|
if (!hasImageAttr) {
|
|
// If the content node has no "image" attribute, get the
|
|
// "list-style-image" property from CSS.
|
|
nsCOMPtr<nsIDocument> document = mContent->GetComposedDoc();
|
|
if (!document || !mContent->IsElement()) {
|
|
return NS_ERROR_FAILURE;
|
|
}
|
|
|
|
sc = nsComputedDOMStyle::GetComputedStyle(mContent->AsElement(), nullptr);
|
|
if (!sc) {
|
|
return NS_ERROR_FAILURE;
|
|
}
|
|
|
|
iconURI = sc->StyleList()->GetListStyleImageURI();
|
|
if (!iconURI) {
|
|
return NS_ERROR_FAILURE;
|
|
}
|
|
} else {
|
|
uint64_t dummy = 0;
|
|
nsContentUtils::GetContentPolicyTypeForUIImageLoading(mContent,
|
|
getter_AddRefs(mTriggeringPrincipal),
|
|
mContentType,
|
|
&dummy);
|
|
|
|
// If this menu item shouldn't have an icon, the string will be empty,
|
|
// and NS_NewURI will fail.
|
|
rv = NS_NewURI(getter_AddRefs(iconURI), imageURIString);
|
|
if (NS_FAILED(rv)) return rv;
|
|
}
|
|
|
|
// Empty the mImageRegionRect initially as the image region CSS could
|
|
// have been changed and now have an error or have been removed since the
|
|
// last GetIconURI call.
|
|
mImageRegionRect.SetEmpty();
|
|
|
|
iconURI.forget(aIconURI);
|
|
|
|
if (!hasImageAttr) {
|
|
// Check if the icon has a specified image region so that it can be
|
|
// cropped appropriately before being displayed.
|
|
const nsRect& r = sc->StyleList()->mImageRegion;
|
|
|
|
// Return NS_ERROR_FAILURE if the image region is invalid so the image
|
|
// is not drawn, and behavior is similar to XUL menus.
|
|
if (r.X() < 0 || r.Y() < 0 || r.Width() < 0 || r.Height() < 0) {
|
|
return NS_ERROR_FAILURE;
|
|
}
|
|
|
|
// 'auto' is represented by a [0, 0, 0, 0] rect. Only set mImageRegionRect
|
|
// if we have some other value.
|
|
if (!r.IsEmpty()) {
|
|
mImageRegionRect = r.ToNearestPixels(mozilla::AppUnitsPerCSSPixel());
|
|
}
|
|
}
|
|
|
|
return NS_OK;
|
|
}
|
|
|
|
nsresult
|
|
nsMenuItemIconX::LoadIcon(nsIURI* aIconURI)
|
|
{
|
|
NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NSRESULT;
|
|
|
|
if (mIconRequest) {
|
|
// Another icon request is already in flight. Kill it.
|
|
mIconRequest->Cancel(NS_BINDING_ABORTED);
|
|
mIconRequest = nullptr;
|
|
}
|
|
|
|
mLoadedIcon = false;
|
|
|
|
if (!mContent) return NS_ERROR_FAILURE;
|
|
|
|
nsCOMPtr<nsIDocument> document = mContent->OwnerDoc();
|
|
|
|
nsCOMPtr<nsILoadGroup> loadGroup = document->GetDocumentLoadGroup();
|
|
if (!loadGroup) return NS_ERROR_FAILURE;
|
|
|
|
RefPtr<imgLoader> loader = nsContentUtils::GetImgLoaderForDocument(document);
|
|
if (!loader) return NS_ERROR_FAILURE;
|
|
|
|
if (!mSetIcon) {
|
|
// Set a completely transparent 16x16 image as the icon on this menu item
|
|
// as a placeholder. This keeps the menu item text displayed in the same
|
|
// position that it will be displayed when the real icon is loaded, and
|
|
// prevents it from jumping around or looking misaligned.
|
|
|
|
static bool sInitializedPlaceholder;
|
|
static NSImage* sPlaceholderIconImage;
|
|
if (!sInitializedPlaceholder) {
|
|
sInitializedPlaceholder = true;
|
|
|
|
// Note that we only create the one and reuse it forever, so this is not a leak.
|
|
sPlaceholderIconImage = [[NSImage alloc] initWithSize:NSMakeSize(kIconWidth, kIconHeight)];
|
|
}
|
|
|
|
if (!sPlaceholderIconImage) return NS_ERROR_FAILURE;
|
|
|
|
if (mNativeMenuItem)
|
|
[mNativeMenuItem setImage:sPlaceholderIconImage];
|
|
}
|
|
|
|
nsresult rv = loader->LoadImage(aIconURI, nullptr, nullptr,
|
|
mozilla::net::RP_Unset,
|
|
mTriggeringPrincipal, 0, loadGroup, this,
|
|
mContent, document, nsIRequest::LOAD_NORMAL, nullptr,
|
|
mContentType, EmptyString(),
|
|
/* aUseUrgentStartForChannel */ false,
|
|
getter_AddRefs(mIconRequest));
|
|
if (NS_FAILED(rv)) return rv;
|
|
|
|
return NS_OK;
|
|
|
|
NS_OBJC_END_TRY_ABORT_BLOCK_NSRESULT;
|
|
}
|
|
|
|
//
|
|
// imgINotificationObserver
|
|
//
|
|
|
|
NS_IMETHODIMP
|
|
nsMenuItemIconX::Notify(imgIRequest* aRequest,
|
|
int32_t aType,
|
|
const nsIntRect* aData)
|
|
{
|
|
if (aType == imgINotificationObserver::LOAD_COMPLETE) {
|
|
// Make sure the image loaded successfully.
|
|
uint32_t status = imgIRequest::STATUS_ERROR;
|
|
if (NS_FAILED(aRequest->GetImageStatus(&status)) ||
|
|
(status & imgIRequest::STATUS_ERROR)) {
|
|
mIconRequest->Cancel(NS_BINDING_ABORTED);
|
|
mIconRequest = nullptr;
|
|
return NS_ERROR_FAILURE;
|
|
}
|
|
|
|
nsCOMPtr<imgIContainer> image;
|
|
aRequest->GetImage(getter_AddRefs(image));
|
|
MOZ_ASSERT(image);
|
|
|
|
// Ask the image to decode at its intrinsic size.
|
|
int32_t width = 0, height = 0;
|
|
image->GetWidth(&width);
|
|
image->GetHeight(&height);
|
|
image->RequestDecodeForSize(nsIntSize(width, height), imgIContainer::FLAG_NONE);
|
|
}
|
|
|
|
if (aType == imgINotificationObserver::FRAME_COMPLETE) {
|
|
return OnFrameComplete(aRequest);
|
|
}
|
|
|
|
if (aType == imgINotificationObserver::DECODE_COMPLETE) {
|
|
if (mIconRequest && mIconRequest == aRequest) {
|
|
mIconRequest->Cancel(NS_BINDING_ABORTED);
|
|
mIconRequest = nullptr;
|
|
}
|
|
}
|
|
|
|
return NS_OK;
|
|
}
|
|
|
|
nsresult
|
|
nsMenuItemIconX::OnFrameComplete(imgIRequest* aRequest)
|
|
{
|
|
NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NSRESULT;
|
|
|
|
if (aRequest != mIconRequest)
|
|
return NS_ERROR_FAILURE;
|
|
|
|
// Only support one frame.
|
|
if (mLoadedIcon)
|
|
return NS_OK;
|
|
|
|
if (!mNativeMenuItem)
|
|
return NS_ERROR_FAILURE;
|
|
|
|
nsCOMPtr<imgIContainer> imageContainer;
|
|
aRequest->GetImage(getter_AddRefs(imageContainer));
|
|
if (!imageContainer) {
|
|
[mNativeMenuItem setImage:nil];
|
|
return NS_ERROR_FAILURE;
|
|
}
|
|
|
|
int32_t origWidth = 0, origHeight = 0;
|
|
imageContainer->GetWidth(&origWidth);
|
|
imageContainer->GetHeight(&origHeight);
|
|
|
|
// If the image region is invalid, don't draw the image to almost match
|
|
// the behavior of other platforms.
|
|
if (!mImageRegionRect.IsEmpty() &&
|
|
(mImageRegionRect.XMost() > origWidth ||
|
|
mImageRegionRect.YMost() > origHeight)) {
|
|
[mNativeMenuItem setImage:nil];
|
|
return NS_ERROR_FAILURE;
|
|
}
|
|
|
|
if (mImageRegionRect.IsEmpty()) {
|
|
mImageRegionRect.SetRect(0, 0, origWidth, origHeight);
|
|
}
|
|
|
|
RefPtr<SourceSurface> surface =
|
|
imageContainer->GetFrame(imgIContainer::FRAME_CURRENT,
|
|
imgIContainer::FLAG_SYNC_DECODE);
|
|
if (!surface) {
|
|
[mNativeMenuItem setImage:nil];
|
|
return NS_ERROR_FAILURE;
|
|
}
|
|
|
|
CGImageRef origImage = NULL;
|
|
bool isEntirelyBlack = false;
|
|
nsresult rv = nsCocoaUtils::CreateCGImageFromSurface(surface, &origImage,
|
|
&isEntirelyBlack);
|
|
if (NS_FAILED(rv) || !origImage) {
|
|
[mNativeMenuItem setImage:nil];
|
|
return NS_ERROR_FAILURE;
|
|
}
|
|
|
|
bool createSubImage = !(mImageRegionRect.x == 0 && mImageRegionRect.y == 0 &&
|
|
mImageRegionRect.width == origWidth && mImageRegionRect.height == origHeight);
|
|
|
|
CGImageRef finalImage = origImage;
|
|
if (createSubImage) {
|
|
// if mImageRegionRect is set using CSS, we need to slice a piece out of the overall
|
|
// image to use as the icon
|
|
finalImage = ::CGImageCreateWithImageInRect(origImage,
|
|
::CGRectMake(mImageRegionRect.x,
|
|
mImageRegionRect.y,
|
|
mImageRegionRect.width,
|
|
mImageRegionRect.height));
|
|
::CGImageRelease(origImage);
|
|
if (!finalImage) {
|
|
[mNativeMenuItem setImage:nil];
|
|
return NS_ERROR_FAILURE;
|
|
}
|
|
}
|
|
|
|
NSImage *newImage = nil;
|
|
rv = nsCocoaUtils::CreateNSImageFromCGImage(finalImage, &newImage);
|
|
if (NS_FAILED(rv) || !newImage) {
|
|
[mNativeMenuItem setImage:nil];
|
|
::CGImageRelease(finalImage);
|
|
return NS_ERROR_FAILURE;
|
|
}
|
|
|
|
// If all the color channels in the image are black, treat the image as a
|
|
// template. This will cause macOS to use the image's alpha channel as a mask
|
|
// and it will fill it with a color that looks good in the context that it's
|
|
// used in. For example, for regular menu items, the image will be black, but
|
|
// when the menu item is hovered (and its background is blue), it will be
|
|
// filled with white.
|
|
[newImage setTemplate:isEntirelyBlack];
|
|
|
|
[newImage setSize:NSMakeSize(kIconWidth, kIconHeight)];
|
|
[mNativeMenuItem setImage:newImage];
|
|
|
|
[newImage release];
|
|
::CGImageRelease(finalImage);
|
|
|
|
mLoadedIcon = true;
|
|
mSetIcon = true;
|
|
|
|
if (mMenuObject) {
|
|
mMenuObject->IconUpdated();
|
|
}
|
|
|
|
return NS_OK;
|
|
|
|
NS_OBJC_END_TRY_ABORT_BLOCK_NSRESULT;
|
|
}
|