FFKeyboard.m

//
//  FFKeyboard.m
//  FunctionFlip
//
//  Created by Kevin Gessner on 10/25/08.
//  Copyright (c) 2008-2010, Kevin Gessner, http://kevingessner.com
//  
//  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 "FFKeyboard.h"
#import "FFPreferenceManager.h"
#import "FFKey.h"
#import "FFKeyLibrary.h"
#import "DDHidLib.h"

@implementation FFKeyboard

static NSMutableDictionary *keyboards;

// just create one keyboard per device, returning it if it already exists
+ (FFKeyboard *)keyboardWithDevice:(DDHidKeyboard *)aDevice {
	if(!keyboards) keyboards = [[NSMutableDictionary alloc] init];
	if(![keyboards objectForKey:[aDevice productName]]) { // use product name since DDHidKeyboard's aren't copyable
		FFKeyboard *keyboard = [[[FFKeyboard alloc] initWithDevice:aDevice] autorelease];
//		NSLog(@"kbFF: %@", keyboard);
		[keyboards setObject:keyboard forKey:([aDevice productName] ? [aDevice productName] : [NSString stringWithFormat:@"%x-%x", [aDevice vendorId], [aDevice productId]])];
	}
	return [keyboards objectForKey:([aDevice productName] ? [aDevice productName] : [NSString stringWithFormat:@"%x-%x", [aDevice vendorId], [aDevice productId]])];
}

- (id)initWithDevice:(DDHidKeyboard *)aDevice {
	if(self = [super init]) {
		self.device = aDevice;
		
		// extract the FN key map
		// it's a comma-separated string of hex values: <first fkey code>,<first special code>,<second fkey code>,etc...
		CFStringRef fnusagemap = IORegistryEntrySearchCFProperty([device ioDevice], kIOServicePlane, (CFStringRef)@"FnFunctionUsageMap", kCFAllocatorDefault, kIORegistryIterateRecursively);
		if(fnusagemap) { // if we've got a non-special keyboard, this won't be set
			NSArray *codes = [(NSString *)fnusagemap componentsSeparatedByString:@","];
			NSMutableArray *fkeyCodes = [NSMutableArray array];
			NSMutableArray *specialCodes = [NSMutableArray array];
			NSInteger index = 0;
			// even indices (0,2,...) go in fkeyCodes, odd indices in specialCodes
			for(NSString *code in codes) {
				if(index % 2 == 0)
					[fkeyCodes addObject:code];
				else
					[specialCodes addObject:code];
				index++;
			}
			fkeyMap = [[NSDictionary dictionaryWithObjects:specialCodes forKeys:fkeyCodes] retain];
		}
	}
	return self;
}

- (BOOL)hasSpecialFkeys {
	return ([fkeyMap count] > 0);
}

- (NSDictionary *)fkeyMap {
	return fkeyMap;
}

- (NSString *)specialIdForKeyId:(NSString *)keyId {
	return [fkeyMap objectForKey:keyId];
}

- (NSArray *)fkeys {
	if(![self hasSpecialFkeys]) return NSNotApplicableMarker;
	NSMutableArray *keys = [NSMutableArray array];
	for(NSString *keyId in [[fkeyMap allKeys] sortedArrayUsingSelector:@selector(compare:)]) {
		if (![FFKeyLibrary descriptionForSpecialId:[self specialIdForKeyId:keyId]]) continue;
		[keys addObject:[FFKey keyWithKeyId:keyId ofKeyboard:self]];
	}
	return keys;
}
						 
- (BOOL)isKeyFlipped:(FFKey *)key {
//	NSLog(@"isflipped %@", key);
	return [[[FFPreferenceManager sharedInstance] valueForKey:[NSString stringWithFormat:@"flipped.%@.%@", [device productName], [key keyId]]] boolValue];
}
- (void)setKey:(FFKey *)key isFlipped:(BOOL)flag {
//	NSLog(@"sets flipped %@", key);
	[[FFPreferenceManager sharedInstance] setValue:[NSNumber numberWithBool:flag] forKey:[NSString stringWithFormat:@"flipped.%@.%@", [device productName], [key keyId]]];
}

- (NSString *)description {
	return [[self device] productName] ? [[self device] productName] : @"Unidentified keyboard";
}

@synthesize device;

@end