added detecting use of touch device for user input on current platform
[rocksndiamonds.git] / src / events.c
index 5a3d0ca8c3bf75653ddfb5bdbc0877cda6d586a4..b94e57c5cbfbce47c600abc665a2ac96c09f3439 100644 (file)
@@ -39,6 +39,8 @@ static int cursor_mode_last = CURSOR_DEFAULT;
 static unsigned int special_cursor_delay = 0;
 static unsigned int special_cursor_delay_value = 1000;
 
+static boolean virtual_button_pressed = FALSE;
+
 
 // forward declarations for internal use
 static void HandleNoEvent(void);
@@ -56,13 +58,11 @@ static int FilterEvents(const Event *event)
 {
   MotionEvent *motion;
 
-#if defined(TARGET_SDL2)
   // skip repeated key press events if keyboard auto-repeat is disabled
   if (event->type == EVENT_KEYPRESS &&
       event->key.repeat &&
       !keyrepeat_status)
     return 0;
-#endif
 
   if (event->type == EVENT_BUTTONPRESS ||
       event->type == EVENT_BUTTONRELEASE)
@@ -185,7 +185,6 @@ static void HandleEvents(void)
        HandleMotionEvent((MotionEvent *) &event);
        break;
 
-#if defined(TARGET_SDL2)
       case EVENT_WHEELMOTION:
        HandleWheelEvent((WheelEvent *) &event);
        break;
@@ -210,7 +209,6 @@ static void HandleEvents(void)
       case SDL_APP_DIDENTERFOREGROUND:
        HandlePauseResumeEvent((PauseResumeEvent *) &event);
        break;
-#endif
 
       case EVENT_KEYPRESS:
       case EVENT_KEYRELEASE:
@@ -253,8 +251,6 @@ void HandleOtherEvents(Event *event)
       HandleClientMessageEvent((ClientMessageEvent *) event);
       break;
 
-#if defined(TARGET_SDL)
-#if defined(TARGET_SDL2)
     case SDL_CONTROLLERBUTTONDOWN:
     case SDL_CONTROLLERBUTTONUP:
       // for any game controller button event, disable overlay buttons
@@ -266,17 +262,18 @@ void HandleOtherEvents(Event *event)
     case SDL_CONTROLLERDEVICEADDED:
     case SDL_CONTROLLERDEVICEREMOVED:
     case SDL_CONTROLLERAXISMOTION:
-#endif
     case SDL_JOYAXISMOTION:
     case SDL_JOYBUTTONDOWN:
     case SDL_JOYBUTTONUP:
       HandleJoystickEvent(event);
       break;
 
-    case SDL_SYSWMEVENT:
-      HandleWindowManagerEvent(event);
+    case SDL_DROPBEGIN:
+    case SDL_DROPCOMPLETE:
+    case SDL_DROPFILE:
+    case SDL_DROPTEXT:
+      HandleDropEvent(event);
       break;
-#endif
 
     default:
       break;
@@ -349,7 +346,6 @@ void EventLoop(void)
 
 void ClearAutoRepeatKeyEvents(void)
 {
-#if defined(TARGET_SDL2)
   while (PendingEvent())
   {
     Event next_event;
@@ -363,7 +359,6 @@ void ClearAutoRepeatKeyEvents(void)
     else
       break;
   }
-#endif
 }
 
 void ClearEventQueue(void)
@@ -382,12 +377,10 @@ void ClearEventQueue(void)
        ClearPlayerAction();
        break;
 
-#if defined(TARGET_SDL2)
       case SDL_CONTROLLERBUTTONUP:
        HandleJoystickEvent(&event);
        ClearPlayerAction();
        break;
-#endif
 
       default:
        HandleOtherEvents(&event);
@@ -410,7 +403,10 @@ void ClearPlayerAction(void)
   // simulate key release events for still pressed keys
   key_joystick_mapping = 0;
   for (i = 0; i < MAX_PLAYERS; i++)
+  {
     stored_player[i].action = 0;
+    stored_player[i].snap_action = 0;
+  }
 
   ClearJoystickState();
   ClearPlayerMouseAction();
@@ -467,12 +463,10 @@ void SleepWhileUnmapped(void)
        key_joystick_mapping = 0;
        break;
 
-#if defined(TARGET_SDL2)
       case SDL_CONTROLLERBUTTONUP:
        HandleJoystickEvent(&event);
        key_joystick_mapping = 0;
        break;
-#endif
 
       case EVENT_MAPNOTIFY:
        window_unmapped = FALSE;
@@ -540,8 +534,6 @@ void HandleMotionEvent(MotionEvent *event)
   HandleButton(event->x, event->y, button_status, button_status);
 }
 
-#if defined(TARGET_SDL2)
-
 void HandleWheelEvent(WheelEvent *event)
 {
   int button_nr;
@@ -692,6 +684,7 @@ static struct
   SDL_FingerID finger_id;
   int counter;
   Key key;
+  byte action;
 } touch_info[NUM_TOUCH_FINGERS];
 
 static void HandleFingerEvent_VirtualButtons(FingerEvent *event)
@@ -738,6 +731,8 @@ static void HandleFingerEvent_VirtualButtons(FingerEvent *event)
                           "KEY_PRESSED");
   int i;
 
+  virtual_button_pressed = (key_status == KEY_PRESSED && key != KSYM_UNDEFINED);
+
   // for any touch input event, enable overlay buttons (if activated)
   SetOverlayEnabled(TRUE);
 
@@ -818,6 +813,9 @@ static void HandleFingerEvent_VirtualButtons(FingerEvent *event)
        {
          HandleKey(touch_info[i].key, KEY_RELEASED);
 
+         // undraw previous grid button when moving finger away
+         overlay.grid_button_action &= ~touch_info[i].action;
+
          Error(ERR_DEBUG, "=> key == '%s', key_status == '%s' [slot %d] [2]",
                getKeyNameFromKey(touch_info[i].key), "KEY_RELEASED", i);
        }
@@ -835,6 +833,7 @@ static void HandleFingerEvent_VirtualButtons(FingerEvent *event)
       touch_info[i].finger_id = event->fingerId;
       touch_info[i].counter = Counter();
       touch_info[i].key = key;
+      touch_info[i].action = grid_button_action;
     }
     else
     {
@@ -850,6 +849,7 @@ static void HandleFingerEvent_VirtualButtons(FingerEvent *event)
       touch_info[i].finger_id = 0;
       touch_info[i].counter = 0;
       touch_info[i].key = 0;
+      touch_info[i].action = JOY_NO_ACTION;
     }
   }
 }
@@ -1016,6 +1016,8 @@ void HandleFingerEvent(FingerEvent *event)
        event->pressure);
 #endif
 
+  runtime.uses_touch_device = TRUE;
+
   if (game_status != GAME_MODE_PLAYING)
     return;
 
@@ -1037,8 +1039,6 @@ void HandleFingerEvent(FingerEvent *event)
     HandleFingerEvent_WipeGestures(event);
 }
 
-#endif
-
 static void HandleButtonOrFinger_WipeGestures_MM(int mx, int my, int button)
 {
   static int old_mx = 0, old_my = 0;
@@ -1398,8 +1398,6 @@ static void HandleButtonOrFinger(int mx, int my, int button)
   }
 }
 
-#if defined(TARGET_SDL2)
-
 static boolean checkTextInputKeyModState(void)
 {
   // when playing, only handle raw key events and ignore text input
@@ -1448,8 +1446,6 @@ void HandlePauseResumeEvent(PauseResumeEvent *event)
   }
 }
 
-#endif
-
 void HandleKeyEvent(KeyEvent *event)
 {
   int key_status = (event->type == EVENT_KEYPRESS ? KEY_PRESSED : KEY_RELEASED);
@@ -1474,22 +1470,24 @@ void HandleKeyEvent(KeyEvent *event)
     // always map the "back" button to the "escape" key on Android devices
     key = KSYM_Escape;
   }
+  else if (key == KSYM_Menu)
+  {
+    // the "menu" button can be used to toggle displaying virtual buttons
+    if (key_status == KEY_PRESSED)
+      SetOverlayEnabled(!GetOverlayEnabled());
+  }
   else
   {
-    // for any key event other than "back" button, disable overlay buttons
+    // for any other "real" key event, disable virtual buttons
     SetOverlayEnabled(FALSE);
   }
 #endif
 
   HandleKeyModState(keymod, key_status);
 
-#if defined(TARGET_SDL2)
   // only handle raw key input without text modifier keys pressed
   if (!checkTextInputKeyModState())
     HandleKey(key, key_status);
-#else
-  HandleKey(key, key_status);
-#endif
 }
 
 void HandleFocusEvent(FocusChangeEvent *event)
@@ -1538,11 +1536,179 @@ void HandleClientMessageEvent(ClientMessageEvent *event)
     CloseAllAndExit(0);
 }
 
-void HandleWindowManagerEvent(Event *event)
+static int HandleDropFileEvent(char *filename)
 {
-#if defined(TARGET_SDL)
-  SDLHandleWindowManagerEvent(event);
-#endif
+  Error(ERR_DEBUG, "DROP FILE EVENT: '%s'", filename);
+
+  // check and extract dropped zip files into correct user data directory
+  if (!strSuffixLower(filename, ".zip"))
+  {
+    Error(ERR_WARN, "file '%s' not supported", filename);
+
+    return TREE_TYPE_UNDEFINED;
+  }
+
+  TreeInfo *tree_node = NULL;
+  int tree_type = GetZipFileTreeType(filename);
+  char *directory = TREE_USERDIR(tree_type);
+
+  if (directory == NULL)
+  {
+    Error(ERR_WARN, "zip file '%s' has invalid content!", filename);
+
+    return TREE_TYPE_UNDEFINED;
+  }
+
+  if (tree_type == TREE_TYPE_LEVEL_DIR &&
+      game_status == GAME_MODE_LEVELS &&
+      leveldir_current->node_parent != NULL)
+  {
+    // extract new level set next to currently selected level set
+    tree_node = leveldir_current;
+
+    // get parent directory of currently selected level set directory
+    directory = getLevelDirFromTreeInfo(leveldir_current->node_parent);
+
+    // use private level directory instead of top-level package level directory
+    if (strPrefix(directory, options.level_directory) &&
+       strEqual(leveldir_current->node_parent->fullpath, "."))
+      directory = getUserLevelDir(NULL);
+  }
+
+  // extract level or artwork set from zip file to target directory
+  char *top_dir = ExtractZipFileIntoDirectory(filename, directory, tree_type);
+
+  if (top_dir == NULL)
+  {
+    // error message already issued by "ExtractZipFileIntoDirectory()"
+
+    return TREE_TYPE_UNDEFINED;
+  }
+
+  // add extracted level or artwork set to tree info structure
+  AddTreeSetToTreeInfo(tree_node, directory, top_dir, tree_type);
+
+  // update menu screen (and possibly change current level set)
+  DrawScreenAfterAddingSet(top_dir, tree_type);
+
+  return tree_type;
+}
+
+static void HandleDropTextEvent(char *text)
+{
+  Error(ERR_DEBUG, "DROP TEXT EVENT: '%s'", text);
+}
+
+static void HandleDropCompleteEvent(int num_level_sets_succeeded,
+                                   int num_artwork_sets_succeeded,
+                                   int num_files_failed)
+{
+  // only show request dialog if no other request dialog already active
+  if (game.request_active)
+    return;
+
+  // this case can happen with drag-and-drop with older SDL versions
+  if (num_level_sets_succeeded == 0 &&
+      num_artwork_sets_succeeded == 0 &&
+      num_files_failed == 0)
+    return;
+
+  char message[100];
+
+  if (num_level_sets_succeeded > 0 || num_artwork_sets_succeeded > 0)
+  {
+    char message_part1[50];
+
+    sprintf(message_part1, "New %s set%s added",
+           (num_artwork_sets_succeeded == 0 ? "level" :
+            num_level_sets_succeeded == 0 ? "artwork" : "level and artwork"),
+           (num_level_sets_succeeded +
+            num_artwork_sets_succeeded > 1 ? "s" : ""));
+
+    if (num_files_failed > 0)
+      sprintf(message, "%s, but %d dropped file%s failed!",
+             message_part1, num_files_failed, num_files_failed > 1 ? "s" : "");
+    else
+      sprintf(message, "%s!", message_part1);
+  }
+  else if (num_files_failed > 0)
+  {
+    sprintf(message, "Failed to process dropped file%s!",
+           num_files_failed > 1 ? "s" : "");
+  }
+
+  Request(message, REQ_CONFIRM);
+}
+
+void HandleDropEvent(Event *event)
+{
+  static boolean confirm_on_drop_complete = FALSE;
+  static int num_level_sets_succeeded = 0;
+  static int num_artwork_sets_succeeded = 0;
+  static int num_files_failed = 0;
+
+  switch (event->type)
+  {
+    case SDL_DROPBEGIN:
+    {
+      confirm_on_drop_complete = TRUE;
+      num_level_sets_succeeded = 0;
+      num_artwork_sets_succeeded = 0;
+      num_files_failed = 0;
+
+      break;
+    }
+
+    case SDL_DROPFILE:
+    {
+      int tree_type = HandleDropFileEvent(event->drop.file);
+
+      if (tree_type == TREE_TYPE_LEVEL_DIR)
+       num_level_sets_succeeded++;
+      else if (tree_type == TREE_TYPE_GRAPHICS_DIR ||
+              tree_type == TREE_TYPE_SOUNDS_DIR ||
+              tree_type == TREE_TYPE_MUSIC_DIR)
+       num_artwork_sets_succeeded++;
+      else
+       num_files_failed++;
+
+      // SDL_DROPBEGIN / SDL_DROPCOMPLETE did not exist in older SDL versions
+      if (!confirm_on_drop_complete)
+      {
+       // process all remaining events, including further SDL_DROPFILE events
+       ClearEventQueue();
+
+       HandleDropCompleteEvent(num_level_sets_succeeded,
+                               num_artwork_sets_succeeded,
+                               num_files_failed);
+
+       num_level_sets_succeeded = 0;
+       num_artwork_sets_succeeded = 0;
+       num_files_failed = 0;
+      }
+
+      break;
+    }
+
+    case SDL_DROPTEXT:
+    {
+      HandleDropTextEvent(event->drop.file);
+
+      break;
+    }
+
+    case SDL_DROPCOMPLETE:
+    {
+      HandleDropCompleteEvent(num_level_sets_succeeded,
+                             num_artwork_sets_succeeded,
+                             num_files_failed);
+
+      break;
+    }
+  }
+
+  if (event->drop.file != NULL)
+    SDL_free(event->drop.file);
 }
 
 void HandleButton(int mx, int my, int button, int button_nr)
@@ -1567,10 +1733,13 @@ void HandleButton(int mx, int my, int button, int button_nr)
 #if defined(PLATFORM_ANDROID)
   // when playing, only handle gadgets when using "follow finger" controls
   // or when using touch controls in combination with the MM game engine
+  // or when using gadgets that do not overlap with virtual buttons
   handle_gadgets =
     (game_status != GAME_MODE_PLAYING ||
      level.game_engine_type == GAME_ENGINE_TYPE_MM ||
-     strEqual(setup.touch.control_type, TOUCH_CONTROL_FOLLOW_FINGER));
+     strEqual(setup.touch.control_type, TOUCH_CONTROL_FOLLOW_FINGER) ||
+     (strEqual(setup.touch.control_type, TOUCH_CONTROL_VIRTUAL_BUTTONS) &&
+      !virtual_button_pressed));
 #endif
 
   if (HandleGlobalAnimClicks(mx, my, button))
@@ -1806,11 +1975,14 @@ static void HandleKeysSpecial(Key key)
   }
 }
 
-void HandleKeysDebug(Key key)
+boolean HandleKeysDebug(Key key, int key_status)
 {
 #ifdef DEBUG
   int i;
 
+  if (key_status != KEY_PRESSED)
+    return FALSE;
+
   if (game_status == GAME_MODE_PLAYING || !setup.debug.frame_delay_game_only)
   {
     boolean mod_key_pressed = ((GetKeyModState() & KMOD_Valid) != KMOD_None);
@@ -1829,15 +2001,15 @@ void HandleKeysDebug(Key key)
        SetVideoFrameDelay(GameFrameDelay);
 
        if (GameFrameDelay > ONE_SECOND_DELAY)
-         Error(ERR_DEBUG, "frame delay == %d ms", GameFrameDelay);
+         Error(ERR_INFO, "frame delay == %d ms", GameFrameDelay);
        else if (GameFrameDelay != 0)
-         Error(ERR_DEBUG, "frame delay == %d ms (max. %d fps / %d %%)",
+         Error(ERR_INFO, "frame delay == %d ms (max. %d fps / %d %%)",
                GameFrameDelay, ONE_SECOND_DELAY / GameFrameDelay,
                GAME_FRAME_DELAY * 100 / GameFrameDelay);
        else
-         Error(ERR_DEBUG, "frame delay == 0 ms (maximum speed)");
+         Error(ERR_INFO, "frame delay == 0 ms (maximum speed)");
 
-       break;
+       return TRUE;
       }
     }
   }
@@ -1848,16 +2020,22 @@ void HandleKeysDebug(Key key)
     {
       options.debug = !options.debug;
 
-      Error(ERR_DEBUG, "debug mode %s",
+      Error(ERR_INFO, "debug mode %s",
            (options.debug ? "enabled" : "disabled"));
+
+      return TRUE;
     }
     else if (key == KSYM_v)
     {
-      Error(ERR_DEBUG, "currently using game engine version %d",
+      Error(ERR_INFO, "currently using game engine version %d",
            game.engine_version);
+
+      return TRUE;
     }
   }
 #endif
+
+  return FALSE;
 }
 
 void HandleKey(Key key, int key_status)
@@ -1884,13 +2062,14 @@ void HandleKey(Key key, int key_status)
   int joy = 0;
   int i;
 
-#if defined(TARGET_SDL2)
+  if (HandleKeysDebug(key, key_status))
+    return;            // do not handle already processed keys again
+
   // map special keys (media keys / remote control buttons) to default keys
   if (key == KSYM_PlayPause)
     key = KSYM_space;
   else if (key == KSYM_Select)
     key = KSYM_Return;
-#endif
 
   HandleSpecialGameControllerKeys(key, key_status);
 
@@ -1903,6 +2082,7 @@ void HandleKey(Key key, int key_status)
     for (pnr = 0; pnr < MAX_PLAYERS; pnr++)
     {
       byte key_action = 0;
+      byte key_snap_action = 0;
 
       if (setup.input[pnr].use_joystick)
        continue;
@@ -1918,15 +2098,33 @@ void HandleKey(Key key, int key_status)
       {
        ssi = setup.shortcut;
 
+       // also remember normal snap key when handling snap+direction keys
+       key_snap_action |= key_action & JOY_BUTTON_SNAP;
+
        for (i = 0; i < NUM_DIRECTIONS; i++)
+       {
          if (key == *key_info[i].key_snap)
-           key_action |= key_info[i].action | JOY_BUTTON_SNAP;
+         {
+           key_action      |= key_info[i].action | JOY_BUTTON_SNAP;
+           key_snap_action |= key_info[i].action;
+         }
+       }
       }
 
       if (key_status == KEY_PRESSED)
-       stored_player[pnr].action |= key_action;
+      {
+       stored_player[pnr].action      |= key_action;
+       stored_player[pnr].snap_action |= key_snap_action;
+      }
       else
-       stored_player[pnr].action &= ~key_action;
+      {
+       stored_player[pnr].action      &= ~key_action;
+       stored_player[pnr].snap_action &= ~key_snap_action;
+      }
+
+      // restore snap action if one of several pressed snap keys was released
+      if (stored_player[pnr].snap_action)
+       stored_player[pnr].action |= JOY_BUTTON_SNAP;
 
       if (tape.single_step && tape.recording && tape.pausing && !tape.use_mouse)
       {
@@ -2111,10 +2309,7 @@ void HandleKey(Key key, int key_status)
   HandleKeysSpecial(key);
 
   if (HandleGadgetsKeyInput(key))
-  {
-    if (key != KSYM_Escape)    // always allow ESC key to be handled
-      key = KSYM_UNDEFINED;
-  }
+    return;            // do not handle already processed keys again
 
   switch (game_status)
   {
@@ -2231,8 +2426,6 @@ void HandleKey(Key key, int key_status)
        return;
       }
   }
-
-  HandleKeysDebug(key);
 }
 
 void HandleNoEvent(void)
@@ -2370,6 +2563,16 @@ void HandleJoystick(void)
     return;
   }
 
+  if (newbutton && (game_status == GAME_MODE_PSEUDO_TYPENAME ||
+                   anyTextGadgetActive()))
+  {
+    // leave name input in main menu or text input gadget
+    HandleKey(KSYM_Escape, KEY_PRESSED);
+    HandleKey(KSYM_Escape, KEY_RELEASED);
+
+    return;
+  }
+
   if (level.game_engine_type == GAME_ENGINE_TYPE_MM)
   {
     if (game_status == GAME_MODE_PLAYING)
@@ -2471,7 +2674,6 @@ void HandleJoystick(void)
 
 void HandleSpecialGameControllerButtons(Event *event)
 {
-#if defined(TARGET_SDL2)
   int key_status;
   Key key;
 
@@ -2504,12 +2706,10 @@ void HandleSpecialGameControllerButtons(Event *event)
   }
 
   HandleKey(key, key_status);
-#endif
 }
 
 void HandleSpecialGameControllerKeys(Key key, int key_status)
 {
-#if defined(TARGET_SDL2)
 #if defined(KSYM_Rewind) && defined(KSYM_FastForward)
   int button = SDL_CONTROLLER_BUTTON_INVALID;
 
@@ -2534,7 +2734,6 @@ void HandleSpecialGameControllerKeys(Key key, int key_status)
     HandleJoystickEvent(&event);
   }
 #endif
-#endif
 }
 
 boolean DoKeysymAction(int keysym)