scummvm/backends/taskbar/macosx/macosx-taskbar.mm
Donovan Watteau 4f5ccdbe75 MACOSX: Update some comments about macOS 10.4/10.5 behavior
Found while doing a review of our existing workarounds for those
versions, and the system features which can be used there.

Also fix indentation and some typos while there.
2022-11-05 10:09:58 +01:00

278 lines
8.7 KiB
Plaintext

/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
// Disable symbol overrides so that we can use system headers
#define FORBIDDEN_SYMBOL_ALLOW_ALL
#include "common/scummsys.h"
#if defined(MACOSX) && defined(USE_TASKBAR)
#include "backends/taskbar/macosx/macosx-taskbar.h"
#include "backends/platform/sdl/macosx/macosx-compat.h"
#include <AppKit/NSApplication.h>
#include <AppKit/NSImage.h>
#include <Foundation/NSString.h>
#include <Foundation/NSDictionary.h>
#include <Foundation/NSArray.h>
#include <Foundation/NSUserDefaults.h>
#include <AppKit/NSImageView.h>
#include <AppKit/NSColor.h>
#include <AppKit/NSBezierPath.h>
#include <CoreFoundation/CFString.h>
// NSDockTile was introduced with Mac OS X 10.5.
// The following makes it possible to compile this feature with the 10.4
// SDK (by avoiding any NSDockTile symbol), while letting the same build
// use this feature at run-time on 10.5+.
#if MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_5
typedef id NSDockTilePtr;
#else
#include <AppKit/NSDockTile.h>
typedef NSDockTile * NSDockTilePtr;
#endif
NSDockTilePtr _dockTile;
NSImageView *_applicationIconView;
NSImageView *_overlayIconView;
BOOL hasDockTile() {
if (_dockTile != nil)
return YES;
if ([NSApp respondsToSelector:@selector(dockTile)])
_dockTile = [NSApp dockTile];
return _dockTile != nil;
}
// Using a NSProgressIndicator as a sub-view of the NSDockTile view does not work properly.
// The progress indicator is grayed out and display no progress. So instead the bar is drawn
// manually, which is a bit more work :(
MacOSXTaskbarManager::MacOSXTaskbarManager() : _progress(-1.0) {
_dockTile = nil;
_applicationIconView = nil;
_overlayIconView = nil;
}
MacOSXTaskbarManager::~MacOSXTaskbarManager() {
clearApplicationIconView();
}
void MacOSXTaskbarManager::initApplicationIconView() {
if (!hasDockTile())
return;
if (_applicationIconView == nil) {
_applicationIconView = [[NSImageView alloc] init];
[_applicationIconView setImage:[NSApp applicationIconImage]];
[_dockTile performSelector:@selector(setContentView:) withObject:_applicationIconView];
}
}
void MacOSXTaskbarManager::clearApplicationIconView() {
if (!hasDockTile())
return;
[_dockTile performSelector:@selector(setContentView:) withObject:nil];
[_applicationIconView release];
_applicationIconView = nil;
}
void MacOSXTaskbarManager::initOverlayIconView() {
if (!hasDockTile())
return;
if (_overlayIconView == nil) {
const double overlaySize = 0.75;
initApplicationIconView();
NSSize size = [_applicationIconView frame].size;
_overlayIconView = [[NSImageView alloc] initWithFrame:NSMakeRect(size.width * (1.0-overlaySize), 0.0f, size.width * overlaySize, size.height * overlaySize)];
[_overlayIconView setImageAlignment:NSImageAlignBottomRight];
[_applicationIconView addSubview:_overlayIconView];
[_overlayIconView release];
}
}
void MacOSXTaskbarManager::clearOverlayIconView() {
if (_progress < 0.0)
clearApplicationIconView();
else
[_overlayIconView removeFromSuperview];
_overlayIconView = nil;
}
void MacOSXTaskbarManager::setOverlayIcon(const Common::String &name, const Common::String &description) {
if (!hasDockTile())
return;
if (name.empty()) {
clearOverlayIconView();
[_dockTile performSelector:@selector(display)];
return;
}
Common::String path = getIconPath(name, ".png");
if (path.empty())
return;
initOverlayIconView();
CFStringRef imageFile = CFStringCreateWithCString(0, path.c_str(), kCFStringEncodingASCII);
NSImage *image = [[NSImage alloc] initWithContentsOfFile:(NSString *)imageFile];
[_overlayIconView setImage:image];
[image release];
CFRelease(imageFile);
[_dockTile performSelector:@selector(display)];
}
void MacOSXTaskbarManager::setProgressValue(int completed, int total) {
if (!hasDockTile())
return;
if (total > 0)
_progress = (double)completed / (double)total;
else if (_progress < 0)
_progress = 0.0;
NSImage *mainIcon = [[NSApp applicationIconImage] copy];
double barSize = [mainIcon size].width;
double progressSize = barSize * _progress;
[mainIcon lockFocus];
[[NSColor colorWithDeviceRed:(40.0/255.0) green:(120.0/255.0) blue:(255.0/255.0) alpha:0.78] set];
[NSBezierPath fillRect:NSMakeRect(0, 0, progressSize, 11)];
[[NSColor colorWithDeviceRed:(241.0/255.0) green:(241.0/255.0) blue:(241.0/255.0) alpha:0.78] set];
[NSBezierPath fillRect:NSMakeRect(progressSize, 0, barSize-progressSize, 11)];
[mainIcon unlockFocus];
initApplicationIconView();
[_applicationIconView setImage:mainIcon];
[mainIcon release];
[_dockTile performSelector:@selector(display)];
}
void MacOSXTaskbarManager::setProgressState(TaskbarProgressState state) {
if (!hasDockTile())
return;
// Only support two states: visible and not visible.
if (state == kTaskbarNoProgress) {
_progress = -1.0;
if (_overlayIconView == nil)
clearApplicationIconView();
else if (_applicationIconView != nil)
[_applicationIconView setImage:[NSApp applicationIconImage]];
return;
}
setProgressValue(-1, -1);
}
void MacOSXTaskbarManager::setCount(int count) {
if (!hasDockTile())
return;
if (count > 0)
[_dockTile performSelector:@selector(setBadgeLabel:) withObject:[NSString stringWithFormat:@"%d", count]];
else
[_dockTile performSelector:@selector(setBadgeLabel:) withObject:nil];
}
void MacOSXTaskbarManager::notifyError() {
if (!hasDockTile())
return;
// NSImageNameCaution was introduced in 10.6.
// For compatibility with older systems we should use something else (e.g. overlay label
// or our own icon).
//initOverlayIconView();
//[_overlayIconView setImage:[NSImage imageNamed:NSImageNameCaution]];
//[_dockTile performSelector:@selector(display)];
}
void MacOSXTaskbarManager::clearError() {
if (!hasDockTile())
return;
clearOverlayIconView();
[_dockTile performSelector:@selector(display)];
return;
}
void MacOSXTaskbarManager::addRecent(const Common::String &name, const Common::String &description) {
//warning("[MacOSXTaskbarManager::addRecent] Adding recent list entry: %s (%s)", name.c_str(), description.c_str());
if (!hasDockTile())
return;
// Store the game, description and icon in user preferences.
// The NSDockTilePlugin will retrieve them there to list them in the dock tile menu.
CFStringRef gameName = CFStringCreateWithCString(0, name.c_str(), kCFStringEncodingASCII);
CFStringRef desc = CFStringCreateWithCString(0, description.c_str(), kCFStringEncodingASCII);
// First build the dictionary for this game.
NSMutableDictionary *dict = [[NSMutableDictionary alloc] init];
[dict setObject:(NSString *)gameName forKey:@"game"];
[dict setObject:(NSString *)desc forKey:@"description"];
// Icon
Common::String iconPath = getIconPath(name, ".png");
if (!iconPath.empty()) {
CFStringRef icon = CFStringCreateWithCString(0, iconPath.c_str(), kCFStringEncodingASCII);
[dict setObject:(NSString *)icon forKey:@"icon"];
CFRelease(icon);
}
// Retrieve the current list of recent items and update it.
NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
NSArray *oldArray = [defaults arrayForKey:@"recentGames"];
if (oldArray == nil) {
[defaults setObject:[NSArray arrayWithObject:dict] forKey:@"recentGames"];
} else {
NSMutableArray *newArray = [[NSMutableArray alloc] initWithArray:oldArray];
// Insert the new game at the start
[newArray insertObject:dict atIndex:0];
// If the game was already present in the array, remove it
for (unsigned int i = 1 ; i < [newArray count] ; ++i) {
NSDictionary *oldDict = [newArray objectAtIndex:i];
if (oldDict == nil)
continue;
NSString *oldGame = [oldDict valueForKey:@"game"];
if (oldGame != nil && [oldGame isEqualToString:(NSString*)gameName]) {
[newArray removeObjectAtIndex:i];
break;
}
}
// And make sure we limit the size of the array to 5 games
if ([newArray count] > 5)
[newArray removeLastObject];
[defaults setObject:newArray forKey:@"recentGames"];
[newArray release];
}
// Finally release the dictionary
[dict release];
CFRelease(gameName);
CFRelease(desc);
}
#endif