Skip to content

Commit

Permalink
Added Growl notifications, hotkey.
Browse files Browse the repository at this point in the history
  • Loading branch information
João Moreno authored and João Moreno committed Apr 8, 2010
1 parent 12f7524 commit 73652fe
Show file tree
Hide file tree
Showing 13 changed files with 2,060 additions and 0 deletions.
61 changes: 61 additions & 0 deletions DDHotKeyCenter.h
@@ -0,0 +1,61 @@
/*
DDHotKey -- DDHotKeyCenter.h
Copyright (c) 2010, Dave DeLong <http://www.davedelong.com>
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
The software is provided "as is", without warranty of any kind, including all implied warranties of merchantability and fitness. In no event shall the author(s) or copyright holder(s) be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the software or the use or other dealings in the software.
*/

#import <Cocoa/Cocoa.h>

#define BUILD_FOR_SNOWLEOPARD (MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6)

#if BUILD_FOR_SNOWLEOPARD
//a convenient typedef for the required signature of a hotkey block callback
typedef void (^DDHotKeyTask)(NSEvent*);
#endif

@interface DDHotKeyCenter : NSObject {

}

/**
Register a target/action hotkey.
The modifierFlags must be a bitwise OR of NSCommandKeyMask, NSAlternateKeyMask, NSControlKeyMask, or NSShiftKeyMask;
Returns YES if the hotkey was registered; NO otherwise.
*/
- (BOOL) registerHotKeyWithKeyCode:(unsigned short)keyCode modifierFlags:(NSUInteger)flags target:(id)target action:(SEL)action object:(id)object;

#if BUILD_FOR_SNOWLEOPARD
/**
Register a block callback hotkey.
The modifierFlags must be a bitwise OR of NSCommandKeyMask, NSAlternateKeyMask, NSControlKeyMask, or NSShiftKeyMask;
Returns YES if the hotkey was registered; NO otherwise.
*/
- (BOOL) registerHotKeyWithKeyCode:(unsigned short)keyCode modifierFlags:(NSUInteger)flags task:(DDHotKeyTask)task;
#endif

/**
See if a hotkey exists with the specified keycode and modifier flags.
NOTE: this will only check among hotkeys you have explicitly registered. This does not check all globally registered hotkeys.
*/
- (BOOL) hasRegisteredHotKeyWithKeyCode:(unsigned short)keyCode modifierFlags:(NSUInteger)flags;

/**
Unregister all hotkeys with a specific target
*/
- (void) unregisterHotKeysWithTarget:(id)target;

/**
Unregister all hotkeys with a specific target and action
*/
- (void) unregisterHotKeysWithTarget:(id)target action:(SEL)action;

/**
Unregister a hotkey with a specific keycode and modifier flags
*/
- (void) unregisterHotKeyWithKeyCode:(unsigned short)keyCode modifierFlags:(NSUInteger)flags;

@end
249 changes: 249 additions & 0 deletions DDHotKeyCenter.m
@@ -0,0 +1,249 @@
/*
DDHotKey -- DDHotKeyCenter.m
Copyright (c) 2010, Dave DeLong <http://www.davedelong.com>
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
The software is provided "as is", without warranty of any kind, including all implied warranties of merchantability and fitness. In no event shall the author(s) or copyright holder(s) be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the software or the use or other dealings in the software.
*/

#import "DDHotKeyCenter.h"
#import <Carbon/Carbon.h>

#pragma mark Private Global Declarations

static NSMutableSet * _registeredHotKeys = nil;
static UInt32 _nextHotKeyID = 1;
OSStatus dd_hotKeyHandler(EventHandlerCallRef nextHandler, EventRef theEvent, void * userData);
NSUInteger dd_translateModifierFlags(NSUInteger flags);

#pragma mark DDHotKey

@interface DDHotKey : NSObject {
id target;
SEL action;
id object;

#if BUILD_FOR_SNOWLEOPARD
DDHotKeyTask task;
#endif

unsigned short keyCode;
NSUInteger modifierFlags;
UInt32 hotKeyID;
NSValue * hotKeyRef;
}

@property (retain) id target;
@property SEL action;
@property (retain) id object;
#if BUILD_FOR_SNOWLEOPARD
@property (copy) DDHotKeyTask task;
#endif
@property unsigned short keyCode;
@property NSUInteger modifierFlags;
@property UInt32 hotKeyID;
@property (retain) NSValue * hotKeyRef;

- (void) invokeWithEvent:(NSEvent *)event;
- (BOOL) registerHotKey;
- (void) unregisterHotKey;

@end

@implementation DDHotKey

@synthesize target, action, object, task, keyCode, modifierFlags, hotKeyID, hotKeyRef;

- (void) invokeWithEvent:(NSEvent *)event {
if (target != nil && action != nil && [target respondsToSelector:action]) {
[target performSelector:action withObject:event withObject:object];
}
#if BUILD_FOR_SNOWLEOPARD
else if (task != nil) {
task(event);
}
#endif
}

- (NSString *) actionString {
return NSStringFromSelector(action);
}

- (BOOL) registerHotKey {
EventHotKeyID keyID;
keyID.signature = 'htk1';
keyID.id = _nextHotKeyID;

EventHotKeyRef carbonHotKey;
OSStatus err = RegisterEventHotKey(keyCode, modifierFlags, keyID, GetEventDispatcherTarget(), 0, &carbonHotKey);

//error registering hot key
if (err != 0) { return NO; }

NSValue * refValue = [NSValue valueWithPointer:carbonHotKey];
[self setHotKeyRef:refValue];
[self setHotKeyID:_nextHotKeyID];

_nextHotKeyID++;

return YES;
}

- (void) unregisterHotKey {
EventHotKeyRef carbonHotKey = (EventHotKeyRef)[hotKeyRef pointerValue];
UnregisterEventHotKey(carbonHotKey);
[self setHotKeyRef:nil];
}

- (void) dealloc {
[target release], target = nil;
[object release], object = nil;
if (hotKeyRef != nil) {
[self unregisterHotKey];
[hotKeyRef release], hotKeyRef = nil;
}
[super dealloc];
}

@end

#pragma mark DDHotKeyCenter

@implementation DDHotKeyCenter

+ (void) initialize {
if (_registeredHotKeys == nil) {
_registeredHotKeys = [[NSMutableSet alloc] init];
_nextHotKeyID = 1;
EventTypeSpec eventSpec;
eventSpec.eventClass = kEventClassKeyboard;
eventSpec.eventKind = kEventHotKeyReleased;
InstallApplicationEventHandler(&dd_hotKeyHandler, 1, &eventSpec, NULL, NULL);
}
}

- (NSSet *) hotKeysMatchingPredicate:(NSPredicate *)predicate {
return [_registeredHotKeys filteredSetUsingPredicate:predicate];
}

- (BOOL) hasRegisteredHotKeyWithKeyCode:(unsigned short)keyCode modifierFlags:(NSUInteger)flags {
NSPredicate * predicate = [NSPredicate predicateWithFormat:@"keyCode = %hu AND modifierFlags = %lu", keyCode, dd_translateModifierFlags(flags)];
return ([[self hotKeysMatchingPredicate:predicate] count] > 0);
}

#if BUILD_FOR_SNOWLEOPARD
- (BOOL) registerHotKeyWithKeyCode:(unsigned short)keyCode modifierFlags:(NSUInteger)flags task:(DDHotKeyTask)task {
//we can't add a new hotkey if something already has this combo
if ([self hasRegisteredHotKeyWithKeyCode:keyCode modifierFlags:flags]) { return NO; }

//translate the flags
NSUInteger modifierFlags = dd_translateModifierFlags(flags);

DDHotKey * newHotKey = [[DDHotKey alloc] init];
[newHotKey setTask:task];
[newHotKey setKeyCode:keyCode];
[newHotKey setModifierFlags:modifierFlags];

BOOL success = [newHotKey registerHotKey];
if (success) {
[_registeredHotKeys addObject:newHotKey];
}

[newHotKey release];
return success;
}
#endif

- (BOOL) registerHotKeyWithKeyCode:(unsigned short)keyCode modifierFlags:(NSUInteger)flags target:(id)target action:(SEL)action object:(id)object {
//we can't add a new hotkey if something already has this combo
if ([self hasRegisteredHotKeyWithKeyCode:keyCode modifierFlags:flags]) { return NO; }

//translate the flags
NSUInteger modifierFlags = dd_translateModifierFlags(flags);

//build the hotkey object:
DDHotKey * newHotKey = [[DDHotKey alloc] init];
[newHotKey setTarget:target];
[newHotKey setAction:action];
[newHotKey setObject:object];
[newHotKey setKeyCode:keyCode];
[newHotKey setModifierFlags:modifierFlags];

BOOL success = [newHotKey registerHotKey];
if (success) {
[_registeredHotKeys addObject:newHotKey];
}

[newHotKey release];
return success;
}

- (void) unregisterHotKeysMatchingPredicate:(NSPredicate *)predicate {
//explicitly unregister the hotkey, since relying on the unregistration in -dealloc can be problematic
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSSet * matches = [self hotKeysMatchingPredicate:predicate];
[_registeredHotKeys minusSet:matches];
for (DDHotKey * key in matches) {
[key unregisterHotKey];
}
[pool release];
}

- (void) unregisterHotKeysWithTarget:(id)target {
NSPredicate * predicate = [NSPredicate predicateWithFormat:@"target = %@", target];
[self unregisterHotKeysMatchingPredicate:predicate];
}

- (void) unregisterHotKeysWithTarget:(id)target action:(SEL)action {
NSPredicate * predicate = [NSPredicate predicateWithFormat:@"target = %@ AND actionString = %@", target, NSStringFromSelector(action)];
[self unregisterHotKeysMatchingPredicate:predicate];
}

- (void) unregisterHotKeyWithKeyCode:(unsigned short)keyCode modifierFlags:(NSUInteger)flags {
NSPredicate * predicate = [NSPredicate predicateWithFormat:@"keyCode = %hu AND modifierFlags = %lu", keyCode, dd_translateModifierFlags(flags)];
[self unregisterHotKeysMatchingPredicate:predicate];
}

@end

OSStatus dd_hotKeyHandler(EventHandlerCallRef nextHandler, EventRef theEvent, void * userData) {
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];

EventHotKeyID hotKeyID;
GetEventParameter(theEvent, kEventParamDirectObject, typeEventHotKeyID, NULL, sizeof(hotKeyID),NULL,&hotKeyID);

UInt32 keyID = hotKeyID.id;

NSSet * matchingHotKeys = [_registeredHotKeys filteredSetUsingPredicate:[NSPredicate predicateWithFormat:@"hotKeyID = %u", keyID]];
if ([matchingHotKeys count] > 1) { NSLog(@"ERROR!"); }
DDHotKey * matchingHotKey = [matchingHotKeys anyObject];

NSEvent * event = [NSEvent eventWithEventRef:theEvent];
NSEvent * keyEvent = [NSEvent keyEventWithType:NSKeyUp
location:[event locationInWindow]
modifierFlags:[event modifierFlags]
timestamp:[event timestamp]
windowNumber:-1
context:nil
characters:@""
charactersIgnoringModifiers:@""
isARepeat:NO
keyCode:[matchingHotKey keyCode]];

[matchingHotKey invokeWithEvent:keyEvent];

[pool release];

return noErr;
}

NSUInteger dd_translateModifierFlags(NSUInteger flags) {
NSUInteger newFlags = 0;
if ((flags & NSControlKeyMask) > 0) { newFlags |= controlKey; }
if ((flags & NSCommandKeyMask) > 0) { newFlags |= cmdKey; }
if ((flags & NSShiftKeyMask) > 0) { newFlags |= shiftKey; }
if ((flags & NSAlternateKeyMask) > 0) { newFlags |= optionKey; }
return newFlags;
}
13 changes: 13 additions & 0 deletions Growl Registration Ticket.growlRegDict
@@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>AllNotifications</key>
<array>
<string>start</string>
<string>stop</string>
</array>
<key>TicketVersion</key>
<integer>1</integer>
</dict>
</plist>
1 change: 1 addition & 0 deletions Growl.framework/Growl
1 change: 1 addition & 0 deletions Growl.framework/Headers
1 change: 1 addition & 0 deletions Growl.framework/Resources
Binary file added Growl.framework/Versions/A/Growl
Binary file not shown.
6 changes: 6 additions & 0 deletions Growl.framework/Versions/A/Headers/Growl.h
@@ -0,0 +1,6 @@
#include "GrowlDefines.h"

#ifdef __OBJC__
# include "GrowlApplicationBridge.h"
#endif
#include "GrowlApplicationBridge-Carbon.h"

0 comments on commit 73652fe

Please sign in to comment.