Merge remote-tracking branch 'upstream/master' into appear-disabled-while-paused

Author: ErezVolk

.gitmodules

@@ -1,3 +1,3 @@
 [submodule "ShortcutRecorder"]
 	path = ShortcutRecorder
-	url = git://github.com/joaomoreno/ShortcutRecorder.git
+	url = git@github.com:plopp/ShortcutRecorder.git

DDHotKeyCenter.h

@@ -1,7 +1,7 @@
 /*
  DDHotKey -- DDHotKeyCenter.h
  
- Copyright (c) 2010, Dave DeLong <http://www.davedelong.com>
+ Copyright (c) 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.
  
@@ -10,52 +10,87 @@
 
 #import <Cocoa/Cocoa.h>
 
-#define BUILD_FOR_SNOWLEOPARD (MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6)
+NS_ASSUME_NONNULL_BEGIN
 
-#if BUILD_FOR_SNOWLEOPARD
 //a convenient typedef for the required signature of a hotkey block callback
 typedef void (^DDHotKeyTask)(NSEvent*);
-#endif
 
-@interface DDHotKeyCenter : NSObject {
+@interface DDHotKey : NSObject
 
-}
+// creates a new hotkey but does not register it
++ (instancetype)hotKeyWithKeyCode:(unsigned short)keyCode modifierFlags:(NSUInteger)flags task:(DDHotKeyTask _Nullable)task;
+
+@property (nonatomic, assign, readonly, nullable) id target;
+@property (nonatomic, readonly, nullable) SEL action;
+@property (nonatomic, strong, readonly, nullable) id object;
+@property (nonatomic, copy, readonly, nullable) DDHotKeyTask task;
+
+@property (nonatomic, readonly) unsigned short keyCode;
+@property (nonatomic, readonly) NSUInteger modifierFlags;
+
+@end
+
+#pragma mark -
+
+@interface DDHotKeyCenter : NSObject
+
+@property (class, readonly, nonnull) DDHotKeyCenter *sharedHotKeyCenter;
+
+/**
+ Register a hotkey.
+ */
+- (DDHotKey * _Nullable)registerHotKey:(DDHotKey *)hotKey withError:(NSError **)error;
 
 /**
  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.
+ The modifierFlags must be a bitwise OR of NSEventModifierFlagCommand, NSEventModifierFlagOption, NSEventModifierFlagControl, or NSEventModifierFlagShift;
+ Returns the hotkey registered.  If registration failed, returns nil.
  */
-- (BOOL) registerHotKeyWithKeyCode:(unsigned short)keyCode modifierFlags:(NSUInteger)flags target:(id)target action:(SEL)action object:(id)object;
+- (DDHotKey * _Nullable)registerHotKeyWithKeyCode:(unsigned short)keyCode modifierFlags:(NSUInteger)flags target:(id)target action:(SEL)action object:(id)object error:(NSError **)error;
 
-#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.
+ The modifierFlags must be a bitwise OR of NSEventModifierFlagCommand, NSEventModifierFlagOption, NSEventModifierFlagControl, or NSEventModifierFlagShift;
+ Returns the hotkey registered.  If registration failed, returns nil.
  */
-- (BOOL) registerHotKeyWithKeyCode:(unsigned short)keyCode modifierFlags:(NSUInteger)flags task:(DDHotKeyTask)task;
-#endif
+- (DDHotKey * _Nullable)registerHotKeyWithKeyCode:(unsigned short)keyCode modifierFlags:(NSUInteger)flags task:(DDHotKeyTask)task error:(NSError **)error;
 
 /**
  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.
+ NOTE: this will only check among hotkeys you have explicitly registered with DDHotKeyCenter. This does not check all globally registered hotkeys.
  */
-- (BOOL) hasRegisteredHotKeyWithKeyCode:(unsigned short)keyCode modifierFlags:(NSUInteger)flags;
+- (BOOL)hasRegisteredHotKeyWithKeyCode:(unsigned short)keyCode modifierFlags:(NSUInteger)flags;
+
+/**
+ Unregister a specific hotkey
+ */
+- (void)unregisterHotKey:(DDHotKey *)hotKey;
+
+/**
+ Unregister all hotkeys
+ */
+- (void)unregisterAllHotKeys;
 
 /**
  Unregister all hotkeys with a specific target
  */
-- (void) unregisterHotKeysWithTarget:(id)target;
+- (void)unregisterHotKeysWithTarget:(id)target;
 
 /**
  Unregister all hotkeys with a specific target and action
  */
-- (void) unregisterHotKeysWithTarget:(id)target action:(SEL)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;
+- (void)unregisterHotKeyWithKeyCode:(unsigned short)keyCode modifierFlags:(NSUInteger)flags;
+
+/**
+ Returns a set of currently registered hotkeys
+ **/
+- (NSSet<DDHotKey *> *)registeredHotKeys;
 
 @end
+
+NS_ASSUME_NONNULL_END