Index: src/Makefile ================================================================== --- src/Makefile +++ src/Makefile @@ -23,10 +23,11 @@ OFData+MessagePackParsing.m \ OFDate.m \ OFDictionary.m \ OFEnumerator.m \ OFFileManager.m \ + OFGameController.m \ OFGZIPStream.m \ OFHMAC.m \ OFINICategory.m \ OFINIFile.m \ OFIRI.m \ ADDED src/OFGameController.h Index: src/OFGameController.h ================================================================== --- /dev/null +++ src/OFGameController.h @@ -0,0 +1,93 @@ +/* + * Copyright (c) 2008-2024 Jonathan Schleifer + * + * All rights reserved. + * + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License version 3.0 only, + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License + * version 3.0 for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * version 3.0 along with this program. If not, see + * . + */ + +#import "OFObject.h" +#import "OFString.h" + +OF_ASSUME_NONNULL_BEGIN + +/** @file */ + +@class OFArray OF_GENERIC(ObjectType); +@class OFMutableSet OF_GENERIC(ObjectType); +@class OFSet OF_GENERIC(ObjectType); + +/** + * @brief A class for reading state from a game controller. + */ +OF_SUBCLASSING_RESTRICTED +@interface OFGameController: OFObject +{ +#ifdef OF_LINUX + OFString *_path; + int _fd; + OFString *_name; + OFMutableSet *_buttons, *_pressedButtons; + size_t _numAnalogSticks; + OFPoint _analogStickPositions[2]; +#endif +} + +#ifdef OF_HAVE_CLASS_PROPERTIES +@property (class, readonly, nonatomic) + OFArray *controllers; +#endif + +/** + * @brief The name of the controller. + */ +@property (readonly, nonatomic, copy) OFString *name; + +/** + * @brief The buttons the controller has. + */ +@property (readonly, nonatomic, copy) OFSet OF_GENERIC(OFString *) *buttons; + +/** + * @brief The currently pressed buttons on the controller. + */ +@property (readonly, nonatomic, copy) + OFSet OF_GENERIC(OFString *) *pressedButtons; + +/** + * @brief The number of analog sticks the controller has. + */ +@property (readonly, nonatomic) size_t numAnalogSticks; + +/** + * @brief Returns the available controllers. + * + * @return The available controllers + */ ++ (OFArray OF_GENERIC(OFGameController *) *)controllers; + +- (instancetype)init OF_UNAVAILABLE; + +/** + * @brief Returns the current position of the specified analog stick. + * + * The range is from (-1, -1) to (1, 1). + * + * @param index The index of the analog stick whose position to return + * @return The current position of the specified analog stick + */ +- (OFPoint)positionOfAnalogStickWithIndex: (size_t)index; +@end + +OF_ASSUME_NONNULL_END ADDED src/OFGameController.m Index: src/OFGameController.m ================================================================== --- /dev/null +++ src/OFGameController.m @@ -0,0 +1,51 @@ +/* + * Copyright (c) 2008-2024 Jonathan Schleifer + * + * All rights reserved. + * + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License version 3.0 only, + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License + * version 3.0 for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * version 3.0 along with this program. If not, see + * . + */ + +#include "config.h" + +#import "OFGameController.h" + +#import "OFOutOfRangeException.h" + +#if defined(OF_LINUX) && defined(OF_HAVE_FILES) +# include "platform/Linux/OFGameController.m" +#elif defined(OF_NINTENDO_DS) +# include "platform/NintendoDS/OFGameController.m" +#elif defined(OF_NINTENDO_3DS) +# include "platform/Nintendo3DS/OFGameController.m" +#else +@implementation OFGameController +@dynamic name, buttons, pressedButtons, numAnalogSticks; + ++ (OFArray OF_GENERIC(OFGameController *) *)controllers +{ + return [OFArray array]; +} + +- (instancetype)init +{ + OF_INVALID_INIT_METHOD +} + +- (OFPoint)positionOfAnalogStickWithIndex: (size_t)index +{ + OF_UNRECOGNIZED_SELECTOR +} +@end +#endif Index: src/ObjFW.h ================================================================== --- src/ObjFW.h +++ src/ObjFW.h @@ -146,10 +146,11 @@ #import "OFOptionsParser.h" #import "OFTimer.h" #import "OFRunLoop.h" #import "OFMatrix4x4.h" +#import "OFGameController.h" #ifdef OF_WINDOWS # import "OFWindowsRegistryKey.h" #endif ADDED src/platform/Linux/OFGameController.m Index: src/platform/Linux/OFGameController.m ================================================================== --- /dev/null +++ src/platform/Linux/OFGameController.m @@ -0,0 +1,337 @@ +/* + * Copyright (c) 2008-2024 Jonathan Schleifer + * + * All rights reserved. + * + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License version 3.0 only, + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License + * version 3.0 for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * version 3.0 along with this program. If not, see + * . + */ + +#include "config.h" + +#include +#include +#include + +#import "OFGameController.h" +#import "OFArray.h" +#import "OFFileManager.h" +#import "OFLocale.h" +#import "OFSet.h" + +#include +#include + +#import "OFInitializationFailedException.h" +#import "OFInvalidArgumentException.h" +#import "OFOpenItemFailedException.h" +#import "OFOutOfRangeException.h" +#import "OFReadFailedException.h" + +@interface OFGameController () +- (instancetype)of_initWithPath: (OFString *)path OF_METHOD_FAMILY(init); +- (void)of_processEvents; +@end + +static const uint16_t buttons[] = { + BTN_A, BTN_B, BTN_C, BTN_X, BTN_Y, BTN_Z, BTN_TL, BTN_TR, BTN_TL2, + BTN_TR2, BTN_SELECT, BTN_START, BTN_MODE, BTN_THUMBL, BTN_THUMBR, + BTN_DPAD_UP, BTN_DPAD_DOWN, BTN_DPAD_LEFT, BTN_DPAD_RIGHT +}; + +static OFString * +buttonToName(uint16_t button) +{ + switch (button) { + case BTN_A: + return @"A"; + case BTN_B: + return @"B"; + case BTN_C: + return @"C"; + case BTN_X: + return @"X"; + case BTN_Y: + return @"Y"; + case BTN_Z: + return @"Z"; + case BTN_TL: + return @"TL"; + case BTN_TR: + return @"TR"; + case BTN_TL2: + return @"TL2"; + case BTN_TR2: + return @"TR2"; + case BTN_SELECT: + return @"Select"; + case BTN_START: + return @"Start"; + case BTN_MODE: + return @"Mode"; + case BTN_THUMBL: + return @"Thumb L"; + case BTN_THUMBR: + return @"Thumb R"; + case BTN_DPAD_UP: + return @"D-Pad Up"; + case BTN_DPAD_DOWN: + return @"D-Pad Down"; + case BTN_DPAD_LEFT: + return @"D-Pad Left"; + case BTN_DPAD_RIGHT: + return @"D-Pad Right"; + } + + return nil; +} + +@implementation OFGameController +@synthesize name = _name, buttons = _buttons; +@synthesize numAnalogSticks = _numAnalogSticks; + ++ (OFArray OF_GENERIC(OFGameController *) *)controllers +{ + OFMutableArray *controllers = [OFMutableArray array]; + void *pool = objc_autoreleasePoolPush(); + + for (OFString *device in [[OFFileManager defaultManager] + contentsOfDirectoryAtPath: @"/dev/input"]) { + OFString *path; + OFGameController *controller; + + if (![device hasPrefix: @"event"]) + continue; + + path = [@"/dev/input" stringByAppendingPathComponent: device]; + + @try { + controller = [[[OFGameController alloc] + of_initWithPath: path] autorelease]; + } @catch (OFOpenItemFailedException *e) { + if (e.errNo == EACCES) + continue; + + @throw e; + } @catch (OFInvalidArgumentException *e) { + /* Not a game controller. */ + continue; + } + + [controllers addObject: controller]; + } + + [controllers sort]; + [controllers makeImmutable]; + + objc_autoreleasePoolPop(pool); + + return controllers; +} + +- (instancetype)init +{ + OF_INVALID_INIT_METHOD +} + +- (instancetype)of_initWithPath: (OFString *)path +{ + self = [super init]; + + @try { + OFStringEncoding encoding = [OFLocale encoding]; + unsigned long evBits[OFRoundUpToPowerOf2(OF_ULONG_BIT, + EV_MAX) / OF_ULONG_BIT] = { 0 }; + unsigned long keyBits[OFRoundUpToPowerOf2(OF_ULONG_BIT, + KEY_MAX) / OF_ULONG_BIT] = { 0 }; + unsigned long absBits[OFRoundUpToPowerOf2(OF_ULONG_BIT, + ABS_MAX) / OF_ULONG_BIT] = { 0 }; + char name[128]; + + _path = [path copy]; + + if ((_fd = open([_path cStringWithEncoding: encoding], + O_RDONLY | O_NONBLOCK)) == -1) + @throw [OFOpenItemFailedException + exceptionWithPath: _path + mode: @"r" + errNo: errno]; + + if (ioctl(_fd, EVIOCGBIT(0, sizeof(evBits)), evBits) == -1) + @throw [OFInitializationFailedException exception]; + + if (!OFBitSetIsSet(evBits, EV_KEY)) + @throw [OFInvalidArgumentException exception]; + + if (ioctl(_fd, EVIOCGBIT(EV_KEY, sizeof(keyBits)), keyBits) == + -1) + @throw [OFInitializationFailedException exception]; + + if (!OFBitSetIsSet(keyBits, BTN_GAMEPAD)) + @throw [OFInvalidArgumentException exception]; + + if (ioctl(_fd, EVIOCGNAME(sizeof(name)), name) == -1) + @throw [OFInitializationFailedException exception]; + + _name = [[OFString alloc] initWithCString: name + encoding: encoding]; + + _buttons = [[OFMutableSet alloc] init]; + for (size_t i = 0; i < sizeof(buttons) / sizeof(*buttons); i++) + [_buttons addObject: buttonToName(buttons[i])]; + + _pressedButtons = [[OFMutableSet alloc] init]; + + if (OFBitSetIsSet(evBits, EV_ABS)) { + if (ioctl(_fd, EVIOCGBIT(EV_ABS, sizeof(absBits)), + absBits) == -1) + @throw [OFInitializationFailedException + exception]; + + if (OFBitSetIsSet(absBits, ABS_X) && + OFBitSetIsSet(absBits, ABS_Y)) { + _numAnalogSticks++; + + if (OFBitSetIsSet(absBits, ABS_RX) && + OFBitSetIsSet(absBits, ABS_RY)) + _numAnalogSticks++; + } + + if (OFBitSetIsSet(absBits, ABS_HAT0X) && + OFBitSetIsSet(absBits, ABS_HAT0Y)) { + [_buttons addObject: @"D-Pad Left"]; + [_buttons addObject: @"D-Pad Right"]; + [_buttons addObject: @"D-Pad Up"]; + [_buttons addObject: @"D-Pad Down"]; + } + } + + [_buttons makeImmutable]; + } @catch (id e) { + [self release]; + @throw e; + } + + return self; +} + +- (void)dealloc +{ + [_path release]; + + if (_fd != -1) + close(_fd); + + [_name release]; + [_buttons release]; + [_pressedButtons release]; + + [super dealloc]; +} + +- (void)of_processEvents +{ + struct input_event event; + + for (;;) { + errno = 0; + + if (read(_fd, &event, sizeof(event)) < (int)sizeof(event)) { + if (errno == EWOULDBLOCK) + return; + + @throw [OFReadFailedException + exceptionWithObject: self + requestedLength: sizeof(event) + errNo: errno]; + } + + switch (event.type) { + case EV_KEY: + if (event.value) + [_pressedButtons addObject: + buttonToName(event.code)]; + else + [_pressedButtons removeObject: + buttonToName(event.code)]; + break; + case EV_ABS: + switch (event.code) { + case ABS_X: + _analogStickPositions[0].x = + (float)event.value / + (event.value < 0 ? -INT16_MIN : INT16_MAX); + break; + case ABS_Y: + _analogStickPositions[0].y = + (float)event.value / + (event.value < 0 ? -INT16_MIN : INT16_MAX); + break; + case ABS_RX: + _analogStickPositions[1].x = + (float)event.value / + (event.value < 0 ? -INT16_MIN : INT16_MAX); + break; + case ABS_RY: + _analogStickPositions[1].y = + (float)event.value / + (event.value < 0 ? -INT16_MIN : INT16_MAX); + break; + } + + break; + } + } +} + +- (OFComparisonResult)compare: (OFGameController *)otherController +{ + unsigned long long selfIndex, otherIndex; + + if (![otherController isKindOfClass: [OFGameController class]]) + @throw [OFInvalidArgumentException exception]; + + selfIndex = [_path substringFromIndex: 16].unsignedLongLongValue; + otherIndex = [otherController->_path substringFromIndex: 16] + .unsignedLongLongValue; + + if (selfIndex > otherIndex) + return OFOrderedDescending; + if (selfIndex < otherIndex) + return OFOrderedAscending; + + return OFOrderedSame; +} + +- (OFSet *)pressedButtons +{ + [self of_processEvents]; + + return [[_pressedButtons copy] autorelease]; +} + +- (OFPoint)positionOfAnalogStickWithIndex: (size_t)index +{ + if (index + 1 > _numAnalogSticks) + @throw [OFOutOfRangeException exception]; + + [self of_processEvents]; + + return _analogStickPositions[index]; +} + +- (OFString *)description +{ + return [OFString stringWithFormat: @"<%@: %@>", self.class, self.name]; +} +@end ADDED src/platform/Nintendo3DS/OFGameController.m Index: src/platform/Nintendo3DS/OFGameController.m ================================================================== --- /dev/null +++ src/platform/Nintendo3DS/OFGameController.m @@ -0,0 +1,154 @@ +/* + * Copyright (c) 2008-2024 Jonathan Schleifer + * + * All rights reserved. + * + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License version 3.0 only, + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License + * version 3.0 for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * version 3.0 along with this program. If not, see + * . + */ + +#include "config.h" + +#import "OFGameController.h" +#import "OFSet.h" + +#import "OFOutOfRangeException.h" + +#define id id_3ds +#include <3ds.h> +#undef id + +@interface OFGameController () +- (instancetype)of_init OF_METHOD_FAMILY(init); +@end + +static OFArray OF_GENERIC(OFGameController *) *controllers; + +static void +initControllers(void) +{ + void *pool = objc_autoreleasePoolPush(); + + controllers = [[OFArray alloc] initWithObject: + [[[OFGameController alloc] of_init] autorelease]]; + + objc_autoreleasePoolPop(); +} + +@implementation OFGameController ++ (OFArray OF_GENERIC(OFGameController *) *)controllers +{ + static OFOnceControl onceControl = OFOnceControlInitValue; + + OFOnce(&onceControl, initControllers); + + return [[controllers retain] autorelease]; +} + +- (instancetype)init +{ + OF_INVALID_INIT_METHOD +} + +- (instancetype)of_init +{ + return [super init]; +} + +- (OFString *)name +{ + return @"Nintendo 3DS"; +} + +- (OFSet *)buttons +{ + return [OFSet setWithObjects: @"A", @"B", @"Select", @"Start", + @"D-Pad Right", @"D-Pad Left", @"D-Pad Up", @"D-Pad Down", @"R", + @"L", @"X", @"Y", @"ZL", @"ZR", @"C-Stick Right", @"C-Stick Left", + @"C-Stick Up", @"C-Stick Down", nil]; +} + +- (OFSet *)pressedButtons +{ + OFMutableSet *pressedButtons = [OFMutableSet setWithCapacity: 18]; + u32 keys; + + hidScanInput(); + keys = hidKeysHeld(); + + if (keys & KEY_A) + [pressedButtons addObject: @"A"]; + if (keys & KEY_B) + [pressedButtons addObject: @"A"]; + if (keys & KEY_SELECT) + [pressedButtons addObject: @"Select"]; + if (keys & KEY_START) + [pressedButtons addObject: @"Start"]; + if (keys & KEY_DRIGHT) + [pressedButtons addObject: @"D-Pad Right"]; + if (keys & KEY_DLEFT) + [pressedButtons addObject: @"D-Pad Left"]; + if (keys & KEY_DUP) + [pressedButtons addObject: @"D-Pad Up"]; + if (keys & KEY_DDOWN) + [pressedButtons addObject: @"D-Pad Down"]; + if (keys & KEY_R) + [pressedButtons addObject: @"R"]; + if (keys & KEY_L) + [pressedButtons addObject: @"L"]; + if (keys & KEY_X) + [pressedButtons addObject: @"X"]; + if (keys & KEY_Y) + [pressedButtons addObject: @"Y"]; + if (keys & KEY_ZL) + [pressedButtons addObject: @"ZL"]; + if (keys & KEY_ZR) + [pressedButtons addObject: @"ZR"]; + if (keys & KEY_CSTICK_RIGHT) + [pressedButtons addObject: @"C-Stick Right"]; + if (keys & KEY_CSTICK_LEFT) + [pressedButtons addObject: @"C-Stick Left"]; + if (keys & KEY_CSTICK_UP) + [pressedButtons addObject: @"C-Stick Up"]; + if (keys & KEY_CSTICK_DOWN) + [pressedButtons addObject: @"C-Stick Down"]; + + [pressedButtons makeImmutable]; + + return pressedButtons; +} + +- (size_t)numAnalogSticks +{ + return 1; +} + +- (OFPoint)positionOfAnalogStickWithIndex: (size_t)index +{ + circlePosition pos; + + if (index > 0) + @throw [OFOutOfRangeException exception]; + + hidCircleRead(&pos); + + return OFMakePoint( + (float)pos.dx / (pos.dx < 0 ? -INT16_MIN : INT16_MAX), + (float)pos.dy / (pos.dy < 0 ? -INT16_MIN : INT16_MAX)); +} + +- (OFString *)description +{ + return [OFString stringWithFormat: @"<%@: %@>", self.class, self.name]; +} +@end ADDED src/platform/NintendoDS/OFGameController.m Index: src/platform/NintendoDS/OFGameController.m ================================================================== --- /dev/null +++ src/platform/NintendoDS/OFGameController.m @@ -0,0 +1,132 @@ +/* + * Copyright (c) 2008-2024 Jonathan Schleifer + * + * All rights reserved. + * + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License version 3.0 only, + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License + * version 3.0 for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * version 3.0 along with this program. If not, see + * . + */ + +#include "config.h" + +#import "OFGameController.h" +#import "OFSet.h" + +#import "OFOutOfRangeException.h" + +#define asm __asm__ +#include +#undef asm + +@interface OFGameController () +- (instancetype)of_init OF_METHOD_FAMILY(init); +@end + +static OFArray OF_GENERIC(OFGameController *) *controllers; + +static void +initControllers(void) +{ + void *pool = objc_autoreleasePoolPush(); + + controllers = [[OFArray alloc] initWithObject: + [[[OFGameController alloc] of_init] autorelease]]; + + objc_autoreleasePoolPop(); +} + +@implementation OFGameController ++ (OFArray OF_GENERIC(OFGameController *) *)controllers +{ + static OFOnceControl onceControl = OFOnceControlInitValue; + + OFOnce(&onceControl, initControllers); + + return [[controllers retain] autorelease]; +} + +- (instancetype)init +{ + OF_INVALID_INIT_METHOD +} + +- (instancetype)of_init +{ + return [super init]; +} + +- (OFString *)name +{ + return @"Nintendo DS"; +} + +- (OFSet *)buttons +{ + return [OFSet setWithObjects: @"A", @"B", @"Select", @"Start", + @"D-Pad Right", @"D-Pad Left", @"D-Pad Up", @"D-Pad Down", @"R", + @"L", @"X", @"Y", nil]; +} + +- (OFSet *)pressedButtons +{ + OFMutableSet *pressedButtons = [OFMutableSet setWithCapacity: 12]; + uint32 keys; + + scanKeys(); + keys = keysCurrent(); + + if (keys & KEY_A) + [pressedButtons addObject: @"A"]; + if (keys & KEY_B) + [pressedButtons addObject: @"A"]; + if (keys & KEY_SELECT) + [pressedButtons addObject: @"Select"]; + if (keys & KEY_START) + [pressedButtons addObject: @"Start"]; + if (keys & KEY_RIGHT) + [pressedButtons addObject: @"D-Pad Right"]; + if (keys & KEY_LEFT) + [pressedButtons addObject: @"D-Pad Left"]; + if (keys & KEY_UP) + [pressedButtons addObject: @"D-Pad Up"]; + if (keys & KEY_DOWN) + [pressedButtons addObject: @"D-Pad Down"]; + if (keys & KEY_R) + [pressedButtons addObject: @"R"]; + if (keys & KEY_L) + [pressedButtons addObject: @"L"]; + if (keys & KEY_X) + [pressedButtons addObject: @"X"]; + if (keys & KEY_Y) + [pressedButtons addObject: @"Y"]; + + [pressedButtons makeImmutable]; + + return pressedButtons; +} + +- (size_t)numAnalogSticks +{ + return 0; +} + +- (OFPoint)positionOfAnalogStickWithIndex: (size_t)index +{ + @throw [OFOutOfRangeException exception]; +} + +- (OFString *)description +{ + return [OFString stringWithFormat: @"<%@: %@>", self.class, self.name]; +} +@end Index: src/test/OTAppDelegate.m ================================================================== --- src/test/OTAppDelegate.m +++ src/test/OTAppDelegate.m @@ -321,32 +321,28 @@ if (WPAD_ButtonsDown(0) & WPAD_BUTTON_A) break; VIDEO_WaitVSync(); } -#elif defined(OF_NINTENDO_DS) +#elif defined(OF_NINTENDO_DS) || defined(OF_NINTENDO_3DS) [OFStdOut setForegroundColor: [OFColor silver]]; [OFStdOut writeLine: @"Press A to continue"]; for (;;) { - swiWaitForVBlank(); - scanKeys(); - - if (keysDown() & KEY_A) - break; - } -#elif defined(OF_NINTENDO_3DS) - [OFStdOut setForegroundColor: [OFColor silver]]; - [OFStdOut writeLine: @"Press A to continue"]; - - for (;;) { - hidScanInput(); - - if (hidKeysDown() & KEY_A) - break; - - gspWaitForVBlank(); + void *pool = objc_autoreleasePoolPush(); + OFGameController *controller = + [[OFGameController controllers] objectAtIndex: 0]; + + if ([controller.pressedButtons containsObject: @"A"]) + break; + +# if defined(OF_NINTENDO_DS) + swiWaitForVBlank(); +# elif defined(OF_NINTENDO_3DS) + gspWaitForVBlank(); +# endif + objc_autoreleasePoolPop(pool); } #elif defined(OF_NINTENDO_SWITCH) [OFStdOut setForegroundColor: [OFColor silver]]; [OFStdOut writeLine: @"Press A to continue"];