apple_remote/source/RemoteControl.m

   1 /* -*- Mode: ObjC; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*****************************************************************************
   3  * RemoteControl.m
   4  * RemoteControlWrapper
   5  *
   6  * Created by Martin Kahr on 11.03.06 under a MIT-style license.
   7  * Copyright (c) 2006 martinkahr.com. All rights reserved.
   8  *
   9  * Code modified and adapted to OpenOffice.org
  10  * by Eric Bachard on 11.08.2008 under the same License
  11  *
  12  * Permission is hereby granted, free of charge, to any person obtaining a
  13  * copy of this software and associated documentation files (the "Software"),
  14  * to deal in the Software without restriction, including without limitation
  15  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  16  * and/or sell copies of the Software, and to permit persons to whom the
  17  * Software is furnished to do so, subject to the following conditions:
  18  *
  19  * The above copyright notice and this permission notice shall be included
  20  * in all copies or substantial portions of the Software.
  21  *
  22  * THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  23  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  25  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  26  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  27  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  28  * THE SOFTWARE.
  29  *
  30  *****************************************************************************/
  31
  32 #import <apple_remote/RemoteControl.h>
  33
  34 // notification names that are being used to signal that an application wants to
  35 // have access to the remote control device or if the application has finished
  36 // using the remote control device
  37 NSString* REQUEST_FOR_REMOTE_CONTROL_NOTIFICATION     = @"mac.remotecontrols.RequestForRemoteControl";
  38 NSString* FINISHED_USING_REMOTE_CONTROL_NOTIFICATION = @"mac.remotecontrols.FinishedUsingRemoteControl";
  39
  40 // keys used in user objects for distributed notifications
  41 NSString* kRemoteControlDeviceName = @"RemoteControlDeviceName";
  42 NSString* kApplicationIdentifier   = @"CFBundleIdentifier";
  43 // bundle identifier of the application that should get access to the remote control
  44 // this key is being used in the FINISHED notification only
  45 NSString* kTargetApplicationIdentifier = @"TargetBundleIdentifier";
  46
  47
  48 @implementation RemoteControl
  49
  50 // returns nil if the remote control device is not available
  51 - (id) initWithDelegate: (id) _remoteControlDelegate {
  52     if ( (self = [super init]) ) {
  53         delegate = [_remoteControlDelegate retain];
  54 #ifdef DEBUG
  55         NSLog( @"Apple RemoteControl initWithDelegate ok");
  56 #endif
  57     }
  58     return self;
  59 }
  60
  61 - (void) dealloc {
  62     [delegate release];
  63     [super dealloc];
  64 }
  65
  66 - (void) setListeningToRemote: (BOOL) value {
  67 #ifdef DEBUG
  68         NSLog( @"Apple RemoteControl setListeningToRemote ok");
  69 #endif
  70     (void)value;
  71 }
  72 - (BOOL) isListeningToRemote {
  73     return NO;
  74 }
  75
  76 - (void) startListening: (id) sender {
  77 #ifdef DEBUG
  78             NSLog( @"Apple RemoteControl startListening ok");
  79 #endif
  80     (void)sender;
  81 }
  82 - (void) stopListening: (id) sender {
  83 #ifdef DEBUG
  84             NSLog( @"Apple RemoteControl stopListening ok");
  85 #endif
  86     (void)sender;
  87 }
  88
  89 - (BOOL) isOpenInExclusiveMode {
  90     return YES;
  91 }
  92 - (void) setOpenInExclusiveMode: (BOOL) value {
  93     (void)value;
  94 }
  95
  96 - (BOOL) sendsEventForButtonIdentifier: (RemoteControlEventIdentifier) identifier {
  97 #ifdef DEBUG
  98     NSLog( @"Apple RemoteControl: sending event for button identifier\n");
  99 #endif
 100     (void)identifier;
 101     return YES;
 102 }
 103
 104 + (void) sendDistributedNotification: (NSString*) notificationName targetBundleIdentifier: (NSString*) targetIdentifier
 105 {
 106     NSDictionary* userInfo = [NSDictionary dictionaryWithObjectsAndKeys: [NSString stringWithCString:[self remoteControlDeviceName] encoding:NSASCIIStringEncoding],
 107                             kRemoteControlDeviceName /* key = RemoteControlDeviceName  -> OK */,
 108                             [[NSBundle mainBundle] bundleIdentifier] /* value = org.openoffice.script -> OK */,
 109                             kApplicationIdentifier/* key = CFBundleIdentifier -> OK */,
 110                             targetIdentifier /*value = AppleIRController -> OK */,
 111                             kTargetApplicationIdentifier /*targetBundleIdentifier -> does not appear, since the peer is nil*/,
 112                             nil];
 113 #ifdef DEBUG
 114     NSLog( @"Apple Remote: sendDistributedNotification ...");
 115     // Debug purpose: returns all the existing dictionary keys.
 116     NSEnumerator* itKey = [userInfo keyEnumerator];
 117     NSEnumerator* itVal = [userInfo objectEnumerator];
 118     for(;;) {
 119         NSString* sKey = [itKey nextObject];
 120         NSString* sVal = [itVal nextObject];
 121         if( !sKey && !sVal)
 122             break;
 123         if( !sKey) sKey = @"nil";
 124         if( !sVal) sVal = @"nil";
 125         NSLog( @"\tARdict[\"%@\"] = \"%@\"",sKey,sVal);
 126     }
 127 #endif
 128
 129     [[NSDistributedNotificationCenter defaultCenter] postNotificationName:notificationName
 130                                                      object:nil
 131                                                      userInfo:userInfo
 132                                                      deliverImmediately:YES];
 133 }
 134
 135 + (void) sendFinishedNotificationForAppIdentifier: (NSString*) identifier {
 136     [self sendDistributedNotification:FINISHED_USING_REMOTE_CONTROL_NOTIFICATION targetBundleIdentifier:identifier];
 137 #ifdef DEBUG
 138     NSLog( @"Apple RemoteControl: sendFinishedNotificationForAppIdentifier ...");
 139 #endif
 140 }
 141 + (void) sendRequestForRemoteControlNotification {
 142     [self sendDistributedNotification:REQUEST_FOR_REMOTE_CONTROL_NOTIFICATION targetBundleIdentifier:nil];
 143 #ifdef DEBUG
 144     NSLog( @"Apple RemoteControl: sendRequestForRemoteControlNotification ...");
 145 #endif
 146 }
 147
 148 + (const char*) remoteControlDeviceName {
 149     return NULL;
 150 }
 151
 152 @end
 153
 154 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */