RemoteControl.m

/*****************************************************************************
 * RemoteControl.m
 * RemoteControlWrapper
 *
 * Created by Martin Kahr on 11.03.06 under a MIT-style license.
 * Copyright (c) 2006-2014 martinkahr.com. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS 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 "RemoteControl.h"

// notification names that are being used to signal that an application wants to
// have access to the remote control device or if the application has finished
// using the remote control device
NSString* const REQUEST_FOR_REMOTE_CONTROL_NOTIFCATION     = @"mac.remotecontrols.RequestForRemoteControl";
NSString* const FINISHED_USING_REMOTE_CONTROL_NOTIFICATION = @"mac.remotecontrols.FinishedUsingRemoteControl";

// keys used in user objects for distributed notifications
NSString* const kRemoteControlDeviceName = @"RemoteControlDeviceName";
// bundle identifier of the application that should get access to the remote control
// this key is being used in the FINISHED notification only
NSString* const kTargetApplicationIdentifier = @"TargetBundleIdentifier";


@implementation RemoteControl

// Designated initializer
// returns nil if the remote control device is not available
- (nullable instancetype) initWithDelegate: (nullable id<RemoteControlDelegate>) inRemoteControlDelegate {
	if ( (self = [super init]) ) {
		_delegate = inRemoteControlDelegate;
	}
	return self;
}

// Cover the superclass' designated initialiser
- (instancetype)init NS_UNAVAILABLE
{
	assert(0);
	return nil;
}

- (void) setDelegate:(nullable id<RemoteControlDelegate>)inDelegate {
	_delegate = inDelegate;
}
- (nullable id<RemoteControlDelegate>) delegate {
	return _delegate;
}

- (void) setListeningToRemote: (BOOL) value {
	(void)value;
}
- (BOOL) isListeningToRemote {
	return NO;
}

- (IBAction) startListening: (id) sender {
	(void)sender;
}
- (IBAction) stopListening: (id) sender {
	(void)sender;
}

- (BOOL) isOpenInExclusiveMode {
	return YES;
}
- (void) setOpenInExclusiveMode: (BOOL) value {
	(void)value;
}

- (BOOL) sendsEventForButtonIdentifier: (RemoteControlEventIdentifier) identifier {
	(void)identifier;
	return YES;
}

+ (void) sendDistributedNotification: (NSString*) notificationName targetBundleIdentifier: (nullable NSString*) targetIdentifier {
	assert(notificationName);
	const char* deviceName = [self remoteControlDeviceName];
	NSString* bundleIdentifier = [[NSBundle mainBundle] bundleIdentifier];
	if (deviceName && bundleIdentifier) {
		NSDictionary* userInfo = [NSDictionary dictionaryWithObjectsAndKeys:
								  @(deviceName), kRemoteControlDeviceName,
								  bundleIdentifier, kCFBundleIdentifierKey,
								  targetIdentifier, kTargetApplicationIdentifier, // can be nil
								  nil];
		
		[[NSDistributedNotificationCenter defaultCenter] postNotificationName:notificationName
																	   object:nil
																	 userInfo:userInfo
														   deliverImmediately:YES];
	}
}

+ (void) sendFinishedNotifcationForAppIdentifier: (nullable NSString*) identifier {
	[self sendDistributedNotification:FINISHED_USING_REMOTE_CONTROL_NOTIFICATION targetBundleIdentifier:identifier];
}
+ (void) sendRequestForRemoteControlNotification {
	[self sendDistributedNotification:REQUEST_FOR_REMOTE_CONTROL_NOTIFCATION targetBundleIdentifier:nil];
}

+ (const char*) remoteControlDeviceName {
	return "";
}

@end