From 6ecab805e00e99c37bd23c425835ca35507cb593 Mon Sep 17 00:00:00 2001
From: Rafael Kitover <rkitover@gmail.com>
Date: Thu, 2 Feb 2017 07:13:39 -0800
Subject: [PATCH] fix game freezing on kbd input #54

Apparently in some configurations, holding a key on the keyboard makes
Wx stop processing Idle events, so the emulator does not run until the
key is released, freezing the game and ignoring the key.

Hopefully fix this by calling wxWakeUpIdle() from OnKeyDown() and
OnKeyUp().

Other Misc. Improvements:

- refactor process_key_press() to only return true if the system is in a
  pressed key state on key presses or a game key was released on
  releases and always true on double releases.

- call ev.StopPropagation() from OnKey* events for game keys, this may
  not actually do anything, but just in case.

- remove static OnKeyUp and OnKeyDown events from GameArea, these are
  connected to the DrawingPanel dynamically now.

- remove the dynamic_cast<>s from PaintEv/EraseBackground/OnSize event
  forwarders, since there is already a panel member to use.

TODO:

The state returned by process_key_press() is still not entirely correct,
if a joystick button is pressed, it will return true for a non-game
keyboard press, and it needs to return the correct state for double
releases.
---
 src/wx/panel.cpp | 61 ++++++++++++++++++++++++++++++++----------------
 1 file changed, 41 insertions(+), 20 deletions(-)

diff --git a/src/wx/panel.cpp b/src/wx/panel.cpp
index e1ecdae6..8b3da44d 100644
--- a/src/wx/panel.cpp
+++ b/src/wx/panel.cpp
@@ -1123,10 +1123,22 @@ static uint32_t bmask[NUM_KEYS] = {
 
 static wxJoyKeyBinding_v keys_pressed;
 
+static bool game_key_pressed()
+{
+    bool game_key_pressed = false;
+
+    for (int i = 0; i < 4; i++) {
+        if (joypress[i] != 0) {
+            game_key_pressed = true;
+            break;
+        }
+    }
+
+    return game_key_pressed;
+}
+
 static bool process_key_press(bool down, int key, int mod, int joy = 0)
 {
-    static bool in_game_key = false;
-
     // modifier-only key releases do not set the modifier flag
     // so we set it here to match key release events to key press events
     switch (key) {
@@ -1156,14 +1168,15 @@ static bool process_key_press(bool down, int key, int mod, int joy = 0)
     if (kpno < keys_pressed.size()) {
         // double press is noop
         if (down)
-            return in_game_key;
+            return game_key_pressed();
 
         // otherwise forget it
         keys_pressed.erase(keys_pressed.begin() + kpno);
     } else {
         // double release is noop
         if (!down)
-            return in_game_key;
+            // we will just mark it processed so it is ignored, this is not entirely correct
+            return true;
 
         // otherwise remember it
         // c++0x
@@ -1172,7 +1185,7 @@ static bool process_key_press(bool down, int key, int mod, int joy = 0)
         keys_pressed.push_back(jb);
     }
 
-    bool matched_game_key = false;
+    bool game_key_released = false;
 
     // find all game keys this is bound to
     for (int i = 0; i < 4; i++)
@@ -1184,7 +1197,6 @@ static bool process_key_press(bool down, int key, int mod, int joy = 0)
                     if (down) {
                         // press button
                         joypress[i] |= bmask[j];
-                        matched_game_key = true;
                     }
                     else {
                         // only release if no others pressed
@@ -1205,7 +1217,7 @@ static bool process_key_press(bool down, int key, int mod, int joy = 0)
                         if (k2 == b.size()) {
                             // release button
                             joypress[i] &= ~bmask[j];
-                            matched_game_key = true;
+                            game_key_released = true;
                         }
                     }
 
@@ -1213,40 +1225,51 @@ static bool process_key_press(bool down, int key, int mod, int joy = 0)
                 }
         }
 
-    in_game_key = matched_game_key;
-    
-    return in_game_key;
+    if (down) {
+        return game_key_pressed();
+    }
+    else {
+        return game_key_released;
+    }
 }
 
 void GameArea::OnKeyDown(wxKeyEvent& ev)
 {
-    ev.Skip(!process_key_press(true, ev.GetKeyCode(), ev.GetModifiers()));
+    if (process_key_press(true, ev.GetKeyCode(), ev.GetModifiers())) {
+        ev.Skip(false);
+        ev.StopPropagation();
+        wxWakeUpIdle();
+    }
+    else {
+        ev.Skip(true);
+    }
 }
 
 void GameArea::OnKeyUp(wxKeyEvent& ev)
 {
-    ev.Skip(!process_key_press(false, ev.GetKeyCode(), ev.GetModifiers()));
+    if (process_key_press(false, ev.GetKeyCode(), ev.GetModifiers())) {
+        ev.Skip(false);
+        ev.StopPropagation();
+        wxWakeUpIdle();
+    }
+    else {
+        ev.Skip(true);
+    }
 }
 
 // these three are forwarded to the DrawingPanel instance
 void GameArea::PaintEv(wxPaintEvent& ev)
 {
-    DrawingPanelBase* panel = dynamic_cast<DrawingPanelBase*>(ev.GetEventObject());
-
     panel->PaintEv(ev);
 }
 
 void GameArea::EraseBackground(wxEraseEvent& ev)
 {
-    DrawingPanelBase* panel = dynamic_cast<DrawingPanelBase*>(ev.GetEventObject());
-
     panel->EraseBackground(ev);
 }
 
 void GameArea::OnSize(wxSizeEvent& ev)
 {
-    DrawingPanelBase* panel = dynamic_cast<DrawingPanelBase*>(ev.GetEventObject());
-
     panel->OnSize(ev);
 }
 
@@ -1276,8 +1299,6 @@ void GameArea::OnSDLJoy(wxSDLJoyEvent& ev)
 BEGIN_EVENT_TABLE(GameArea, wxPanel)
 EVT_IDLE(GameArea::OnIdle)
 EVT_SDLJOY(GameArea::OnSDLJoy)
-EVT_KEY_DOWN(GameArea::OnKeyDown)
-EVT_KEY_UP(GameArea::OnKeyUp)
 // FIXME: wxGTK does not generate motion events in MainFrame (not sure
 // what to do about it)
 EVT_MOUSE_EVENTS(GameArea::MouseEvent)