Implement special key handling on MacOS

1 files changed, 78 insertions, 17 deletions

diff --git a/pugl/pugl_osx.m b/pugl/pugl_osx.m
index d2681cb..8bcbe42 100644
--- a/pugl/pugl_osx.m
+++ b/pugl/pugl_osx.m
@@ -1,5 +1,6 @@
 /*
-  Copyright 2012-2016 David Robillard <http://drobilla.net>
+  Copyright 2012-2017 David Robillard <http://drobilla.net>
+  Copyright 2017 Hanspeter Portner <dev@open-music-kontrollers.ch>
 
   Permission to use, copy, modify, and/or distribute this software for any
   purpose with or without fee is hereby granted, provided that the above
@@ -33,6 +34,7 @@ struct PuglInternalsImpl {
 	PuglOpenGLView*  glview;
 	id               window;
 	NSEvent*         nextEvent;
+	unsigned         mods;
 #ifdef PUGL_HAVE_CAIRO
 	cairo_surface_t* surface;
 	cairo_t*         cr;
@@ -245,6 +247,39 @@ getModifiers(PuglView* view, NSEvent* ev)
 	return mods;
 }
 
+static PuglKey
+keySymToSpecial(PuglView* view, NSEvent* ev)
+{
+	NSString* chars = [ev charactersIgnoringModifiers];
+	if ([chars length] == 1) {
+		switch ([chars characterAtIndex:0]) {
+		case NSF1FunctionKey:         return PUGL_KEY_F1;
+		case NSF2FunctionKey:         return PUGL_KEY_F2;
+		case NSF3FunctionKey:         return PUGL_KEY_F3;
+		case NSF4FunctionKey:         return PUGL_KEY_F4;
+		case NSF5FunctionKey:         return PUGL_KEY_F5;
+		case NSF6FunctionKey:         return PUGL_KEY_F6;
+		case NSF7FunctionKey:         return PUGL_KEY_F7;
+		case NSF8FunctionKey:         return PUGL_KEY_F8;
+		case NSF9FunctionKey:         return PUGL_KEY_F9;
+		case NSF10FunctionKey:        return PUGL_KEY_F10;
+		case NSF11FunctionKey:        return PUGL_KEY_F11;
+		case NSF12FunctionKey:        return PUGL_KEY_F12;
+		case NSLeftArrowFunctionKey:  return PUGL_KEY_LEFT;
+		case NSUpArrowFunctionKey:    return PUGL_KEY_UP;
+		case NSRightArrowFunctionKey: return PUGL_KEY_RIGHT;
+		case NSDownArrowFunctionKey:  return PUGL_KEY_DOWN;
+		case NSPageUpFunctionKey:     return PUGL_KEY_PAGE_UP;
+		case NSPageDownFunctionKey:   return PUGL_KEY_PAGE_DOWN;
+		case NSHomeFunctionKey:       return PUGL_KEY_HOME;
+		case NSEndFunctionKey:        return PUGL_KEY_END;
+		case NSInsertFunctionKey:     return PUGL_KEY_INSERT;
+		}
+		// SHIFT, CTRL, ALT, and SUPER are handled in [flagsChanged]
+	}
+	return (PuglKey)0;
+}
+
 -(void)updateTrackingAreas
 {
 	if (trackingArea != nil) {
@@ -415,7 +450,7 @@ getModifiers(PuglView* view, NSEvent* ev)
 		getModifiers(puglview, event),
 		[event keyCode],
 		puglDecodeUTF8((const uint8_t*)str),
-		0,  // TODO: Special keys?
+		keySymToSpecial(puglview, event),
 		{ 0, 0, 0, 0, 0, 0, 0, 0 },
 		false
 	};
@@ -441,7 +476,7 @@ getModifiers(PuglView* view, NSEvent* ev)
 		getModifiers(puglview, event),
 		[event keyCode],
 		puglDecodeUTF8((const uint8_t*)str),
-		0,  // TODO: Special keys?
+		keySymToSpecial(puglview, event),
 		{ 0, 0, 0, 0, 0, 0, 0, 0 },
 		false,
 	};
@@ -451,21 +486,47 @@ getModifiers(PuglView* view, NSEvent* ev)
 
 - (void) flagsChanged:(NSEvent*)event
 {
-	// TODO: Is this a sensible way to handle special keys?
-	/*
-		const unsigned mods = getModifiers(puglview, event);
-		if ((mods & PUGL_MOD_SHIFT) != (puglview->mods & PUGL_MOD_SHIFT)) {
-			puglview->specialFunc(puglview, mods & PUGL_MOD_SHIFT, PUGL_KEY_SHIFT);
-		} else if ((mods & PUGL_MOD_CTRL) != (puglview->mods & PUGL_MOD_CTRL)) {
-			puglview->specialFunc(puglview, mods & PUGL_MOD_CTRL, PUGL_KEY_CTRL);
-		} else if ((mods & PUGL_MOD_ALT) != (puglview->mods & PUGL_MOD_ALT)) {
-			puglview->specialFunc(puglview, mods & PUGL_MOD_ALT, PUGL_KEY_ALT);
-		} else if ((mods & PUGL_MOD_SUPER) != (puglview->mods & PUGL_MOD_SUPER)) {
-			puglview->specialFunc(puglview, mods & PUGL_MOD_SUPER, PUGL_KEY_SUPER);
-		}
-		puglview->mods = mods;
+	const unsigned mods    = getModifiers(puglview, event);
+	PuglEventType  type    = PUGL_NOTHING;
+	PuglKey        special = 0;
+
+	if ((mods & PUGL_MOD_SHIFT) != (puglview->impl->mods & PUGL_MOD_SHIFT)) {
+		type = mods & PUGL_MOD_SHIFT ? PUGL_KEY_PRESS : PUGL_KEY_RELEASE;
+		special = PUGL_KEY_SHIFT;
+	} else if ((mods & PUGL_MOD_CTRL) != (puglview->impl->mods & PUGL_MOD_CTRL)) {
+		type = mods & PUGL_MOD_CTRL ? PUGL_KEY_PRESS : PUGL_KEY_RELEASE;
+		special = PUGL_KEY_CTRL;
+	} else if ((mods & PUGL_MOD_ALT) != (puglview->impl->mods & PUGL_MOD_ALT)) {
+		type = mods & PUGL_MOD_ALT ? PUGL_KEY_PRESS : PUGL_KEY_RELEASE;
+		special = PUGL_KEY_ALT;
+	} else if ((mods & PUGL_MOD_SUPER) != (puglview->impl->mods & PUGL_MOD_SUPER)) {
+		type = mods & PUGL_MOD_SUPER ? PUGL_KEY_PRESS : PUGL_KEY_RELEASE;
+		special = PUGL_KEY_SUPER;
+	}
+
+	if (special != 0) {
+		const NSPoint wloc = [self eventLocation:event];
+		const NSPoint rloc = [NSEvent mouseLocation];
+		PuglEventKey  ev   = {
+			type,
+			puglview,
+			0,
+			[event timestamp],
+			wloc.x,
+			puglview->height - wloc.y,
+			rloc.x,
+			[[NSScreen mainScreen] frame].size.height - rloc.y,
+			mods,
+			[event keyCode],
+			0,
+			special,
+			{ 0, 0, 0, 0, 0, 0, 0, 0 },
+			false
+		};
+		puglDispatchEvent(puglview, (PuglEvent*)&ev);
 	}
-	*/
+
+	puglview->impl->mods = mods;
 }
 
 @end