thirdparty/scummvm
2
0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
scummvm/backends/events/sdl/sdl-events.cpp
Vladimir Serbinenko 68a9136e4d
COMMON: Rewrite Encoder and drop dependency on iconv (#2586) 
Different platforms have different levels of support of encodings and
often have slight variations. We already have tables for most encoding
with only CJK missing. Full transcoding inclusion allows us to get reliable
encoding results independently of platform. The biggest con is the need for
external tables encoding.dat.

It removes a duplicate table for korean in graphics/korfont.cpp
2020-11-15 16:20:35 +01:00

1081 lines
37 KiB
C++
Raw Blame History

/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#include "common/scummsys.h"
#if defined(SDL_BACKEND)
#include "backends/events/sdl/sdl-events.h"
#include "backends/platform/sdl/sdl.h"
#include "backends/graphics/graphics.h"
#include "backends/graphics3d/sdl/sdl-graphics3d.h"
#include "common/config-manager.h"
#include "common/textconsole.h"
#include "common/fs.h"
#include "engines/engine.h"
#include "gui/gui-manager.h"
#if SDL_VERSION_ATLEAST(2, 0, 0)
#define GAMECONTROLLERDB_FILE "gamecontrollerdb.txt"
static uint32 convUTF8ToUTF32(const char *src) {
Common::U32String u32(src);
return u32[0];
}
void SdlEventSource::loadGameControllerMappingFile() {
bool loaded = false;
if (ConfMan.hasKey("controller_map_db")) {
Common::FSNode file = Common::FSNode(ConfMan.get("controller_map_db"));
if (file.exists()) {
if (SDL_GameControllerAddMappingsFromFile(file.getPath().c_str()) < 0)
error("File %s not valid: %s", file.getPath().c_str(), SDL_GetError());
else {
loaded = true;
debug("Game controller DB file loaded: %s", file.getPath().c_str());
}
} else
warning("Game controller DB file not found: %s", file.getPath().c_str());
}
if (!loaded && ConfMan.hasKey("extrapath")) {
Common::FSNode dir = Common::FSNode(ConfMan.get("extrapath"));
Common::FSNode file = dir.getChild(GAMECONTROLLERDB_FILE);
if (file.exists()) {
if (SDL_GameControllerAddMappingsFromFile(file.getPath().c_str()) < 0)
error("File %s not valid: %s", file.getPath().c_str(), SDL_GetError());
else
debug("Game controller DB file loaded: %s", file.getPath().c_str());
}
}
}
#endif
SdlEventSource::SdlEventSource()
: EventSource(), _scrollLock(false), _joystick(0), _lastScreenID(0), _graphicsManager(0), _queuedFakeMouseMove(false),
_lastHatPosition(SDL_HAT_CENTERED), _mouseX(0), _mouseY(0), _engineRunning(false)
#if SDL_VERSION_ATLEAST(2, 0, 0)
, _queuedFakeKeyUp(false), _fakeKeyUp(), _controller(nullptr)
#endif
{
int joystick_num = ConfMan.getInt("joystick_num");
if (joystick_num >= 0) {
// Initialize SDL joystick subsystem
if (SDL_InitSubSystem(SDL_INIT_JOYSTICK) == -1) {
error("Could not initialize SDL: %s", SDL_GetError());
}
#if SDL_VERSION_ATLEAST(2, 0, 0)
if (SDL_InitSubSystem(SDL_INIT_GAMECONTROLLER) == -1) {
error("Could not initialize SDL: %s", SDL_GetError());
}
loadGameControllerMappingFile();
#endif
openJoystick(joystick_num);
}
}
SdlEventSource::~SdlEventSource() {
closeJoystick();
}
int SdlEventSource::mapKey(SDL_Keycode sdlKey, SDL_Keymod mod, Uint16 unicode) {
Common::KeyCode key = SDLToOSystemKeycode(sdlKey);
// Keep unicode in case it's regular ASCII text, Hebrew or in case we didn't get a valid keycode
//
// We need to use unicode in those cases, simply because SDL1.x passes us non-layout-adjusted keycodes.
// So unicode is the only way to get layout-adjusted keys.
if (unicode < 0x20) {
// don't use unicode, in case it's control characters
unicode = 0;
} else {
// Use unicode, in case keycode is invalid.
// Umlauts and others will set KEYCODE_INVALID on SDL2, so in such a case always keep unicode.
if (key != Common::KEYCODE_INVALID) {
// keycode is valid, check further also depending on modifiers
if (mod & (KMOD_CTRL | KMOD_ALT)) {
// Ctrl and/or Alt is active
//
// We need to restrict unicode to only up to 0x7E, because on macOS the option/alt key will switch to
// an alternate keyboard, which will cause us to receive Unicode characters for some keys, which are outside
// of the ASCII range (e.g. alt-x will get us U+2248). We need to return 'x' for alt-x, so using unicode
// in that case would break alt-shortcuts.
if (unicode > 0x7E)
unicode = 0; // do not allow any characters above 0x7E
} else {
// We allow Hebrew characters
if (unicode >= 0x05D0 && unicode <= 0x05EA)
return unicode;
// We must not restrict as much as when Ctrl/Alt-modifiers are active, otherwise
// we wouldn't let umlauts through for SDL1. For SDL1 umlauts may set for example KEYCODE_QUOTE, KEYCODE_MINUS, etc.
if (unicode > 0xFF)
unicode = 0; // do not allow any characters above 0xFF
}
}
}
// Attention:
// When using SDL1.x, we will get scancodes via sdlKey, that are raw scancodes, so NOT adjusted to keyboard layout/
// mapping. So for example for certain locales, we will get KEYCODE_y, when 'z' is pressed and so on.
// When using SDL2.x however, we will get scancodes based on the keyboard layout.
if (key >= Common::KEYCODE_F1 && key <= Common::KEYCODE_F9) {
return key - Common::KEYCODE_F1 + Common::ASCII_F1;
} else if (key >= Common::KEYCODE_KP0 && key <= Common::KEYCODE_KP9) {
// WORKAROUND: Disable this change for AmigaOS4 as it is breaking numpad usage ("fighting") on that platform.
// This fixes bug #10558.
// The actual issue here is that the SCUMM engine uses ASCII codes instead of keycodes for input.
// See also the relevant FIXME in SCUMM's input.cpp.
#ifndef __amigaos4__
if ((mod & KMOD_NUM) == 0)
return 0; // In case Num-Lock is NOT enabled, return 0 for ascii, so that directional keys on numpad work
#endif
return key - Common::KEYCODE_KP0 + '0';
} else if (key >= Common::KEYCODE_UP && key <= Common::KEYCODE_PAGEDOWN) {
return key;
} else if (unicode) {
// Return unicode in case it's still set and wasn't filtered.
return unicode;
} else if (key >= 'a' && key <= 'z' && (mod & KMOD_SHIFT)) {
return key & ~0x20;
} else if (key >= Common::KEYCODE_NUMLOCK && key < Common::KEYCODE_LAST) {
return 0;
} else {
return key;
}
}
bool SdlEventSource::processMouseEvent(Common::Event &event, int x, int y, int relx, int rely) {
_mouseX = x;
_mouseY = y;
event.mouse.x = x;
event.mouse.y = y;
event.relMouse.x = relx;
event.relMouse.y = rely;
if (_graphicsManager) {
if (dynamic_cast<SdlGraphics3dManager *>(_graphicsManager)) {
dynamic_cast<SdlGraphics3dManager *>(_graphicsManager)->notifyMousePosition(event.mouse);
} else if (dynamic_cast<SdlGraphicsManager *>(_graphicsManager)) {
dynamic_cast<SdlGraphicsManager *>(_graphicsManager)->notifyMousePosition(event.mouse);
}
}
return true;
}
void SdlEventSource::SDLModToOSystemKeyFlags(SDL_Keymod mod, Common::Event &event) {
event.kbd.flags = 0;
if (mod & KMOD_SHIFT)
event.kbd.flags |= Common::KBD_SHIFT;
if (mod & KMOD_ALT)
event.kbd.flags |= Common::KBD_ALT;
if (mod & KMOD_CTRL)
event.kbd.flags |= Common::KBD_CTRL;
#if SDL_VERSION_ATLEAST(2, 0, 0)
if (mod & KMOD_GUI)
event.kbd.flags |= Common::KBD_META;
#else
if (mod & KMOD_META)
event.kbd.flags |= Common::KBD_META;
#endif
// Sticky flags
if (mod & KMOD_NUM)
event.kbd.flags |= Common::KBD_NUM;
if (mod & KMOD_CAPS)
event.kbd.flags |= Common::KBD_CAPS;
}
Common::KeyCode SdlEventSource::SDLToOSystemKeycode(const SDL_Keycode key) {
switch (key) {
case SDLK_BACKSPACE: return Common::KEYCODE_BACKSPACE;
case SDLK_TAB: return Common::KEYCODE_TAB;
case SDLK_CLEAR: return Common::KEYCODE_CLEAR;
case SDLK_RETURN: return Common::KEYCODE_RETURN;
case SDLK_PAUSE: return Common::KEYCODE_PAUSE;
case SDLK_ESCAPE: return Common::KEYCODE_ESCAPE;
case SDLK_SPACE: return Common::KEYCODE_SPACE;
case SDLK_EXCLAIM: return Common::KEYCODE_EXCLAIM;
case SDLK_QUOTEDBL: return Common::KEYCODE_QUOTEDBL;
case SDLK_HASH: return Common::KEYCODE_HASH;
case SDLK_DOLLAR: return Common::KEYCODE_DOLLAR;
case SDLK_AMPERSAND: return Common::KEYCODE_AMPERSAND;
case SDLK_QUOTE: return Common::KEYCODE_QUOTE;
case SDLK_LEFTPAREN: return Common::KEYCODE_LEFTPAREN;
case SDLK_RIGHTPAREN: return Common::KEYCODE_RIGHTPAREN;
case SDLK_ASTERISK: return Common::KEYCODE_ASTERISK;
case SDLK_PLUS: return Common::KEYCODE_PLUS;
case SDLK_COMMA: return Common::KEYCODE_COMMA;
case SDLK_MINUS: return Common::KEYCODE_MINUS;
case SDLK_PERIOD: return Common::KEYCODE_PERIOD;
case SDLK_SLASH: return Common::KEYCODE_SLASH;
case SDLK_0: return Common::KEYCODE_0;
case SDLK_1: return Common::KEYCODE_1;
case SDLK_2: return Common::KEYCODE_2;
case SDLK_3: return Common::KEYCODE_3;
case SDLK_4: return Common::KEYCODE_4;
case SDLK_5: return Common::KEYCODE_5;
case SDLK_6: return Common::KEYCODE_6;
case SDLK_7: return Common::KEYCODE_7;
case SDLK_8: return Common::KEYCODE_8;
case SDLK_9: return Common::KEYCODE_9;
case SDLK_COLON: return Common::KEYCODE_COLON;
case SDLK_SEMICOLON: return Common::KEYCODE_SEMICOLON;
case SDLK_LESS: return Common::KEYCODE_LESS;
case SDLK_EQUALS: return Common::KEYCODE_EQUALS;
case SDLK_GREATER: return Common::KEYCODE_GREATER;
case SDLK_QUESTION: return Common::KEYCODE_QUESTION;
case SDLK_AT: return Common::KEYCODE_AT;
case SDLK_LEFTBRACKET: return Common::KEYCODE_LEFTBRACKET;
case SDLK_BACKSLASH: return Common::KEYCODE_BACKSLASH;
case SDLK_RIGHTBRACKET: return Common::KEYCODE_RIGHTBRACKET;
case SDLK_CARET: return Common::KEYCODE_CARET;
case SDLK_UNDERSCORE: return Common::KEYCODE_UNDERSCORE;
case SDLK_BACKQUOTE: return Common::KEYCODE_BACKQUOTE;
case SDLK_a: return Common::KEYCODE_a;
case SDLK_b: return Common::KEYCODE_b;
case SDLK_c: return Common::KEYCODE_c;
case SDLK_d: return Common::KEYCODE_d;
case SDLK_e: return Common::KEYCODE_e;
case SDLK_f: return Common::KEYCODE_f;
case SDLK_g: return Common::KEYCODE_g;
case SDLK_h: return Common::KEYCODE_h;
case SDLK_i: return Common::KEYCODE_i;
case SDLK_j: return Common::KEYCODE_j;
case SDLK_k: return Common::KEYCODE_k;
case SDLK_l: return Common::KEYCODE_l;
case SDLK_m: return Common::KEYCODE_m;
case SDLK_n: return Common::KEYCODE_n;
case SDLK_o: return Common::KEYCODE_o;
case SDLK_p: return Common::KEYCODE_p;
case SDLK_q: return Common::KEYCODE_q;
case SDLK_r: return Common::KEYCODE_r;
case SDLK_s: return Common::KEYCODE_s;
case SDLK_t: return Common::KEYCODE_t;
case SDLK_u: return Common::KEYCODE_u;
case SDLK_v: return Common::KEYCODE_v;
case SDLK_w: return Common::KEYCODE_w;
case SDLK_x: return Common::KEYCODE_x;
case SDLK_y: return Common::KEYCODE_y;
case SDLK_z: return Common::KEYCODE_z;
case SDLK_DELETE: return Common::KEYCODE_DELETE;
case SDLK_KP_PERIOD: return Common::KEYCODE_KP_PERIOD;
case SDLK_KP_DIVIDE: return Common::KEYCODE_KP_DIVIDE;
case SDLK_KP_MULTIPLY: return Common::KEYCODE_KP_MULTIPLY;
case SDLK_KP_MINUS: return Common::KEYCODE_KP_MINUS;
case SDLK_KP_PLUS: return Common::KEYCODE_KP_PLUS;
case SDLK_KP_ENTER: return Common::KEYCODE_KP_ENTER;
case SDLK_KP_EQUALS: return Common::KEYCODE_KP_EQUALS;
case SDLK_UP: return Common::KEYCODE_UP;
case SDLK_DOWN: return Common::KEYCODE_DOWN;
case SDLK_RIGHT: return Common::KEYCODE_RIGHT;
case SDLK_LEFT: return Common::KEYCODE_LEFT;
case SDLK_INSERT: return Common::KEYCODE_INSERT;
case SDLK_HOME: return Common::KEYCODE_HOME;
case SDLK_END: return Common::KEYCODE_END;
case SDLK_PAGEUP: return Common::KEYCODE_PAGEUP;
case SDLK_PAGEDOWN: return Common::KEYCODE_PAGEDOWN;
case SDLK_F1: return Common::KEYCODE_F1;
case SDLK_F2: return Common::KEYCODE_F2;
case SDLK_F3: return Common::KEYCODE_F3;
case SDLK_F4: return Common::KEYCODE_F4;
case SDLK_F5: return Common::KEYCODE_F5;
case SDLK_F6: return Common::KEYCODE_F6;
case SDLK_F7: return Common::KEYCODE_F7;
case SDLK_F8: return Common::KEYCODE_F8;
case SDLK_F9: return Common::KEYCODE_F9;
case SDLK_F10: return Common::KEYCODE_F10;
case SDLK_F11: return Common::KEYCODE_F11;
case SDLK_F12: return Common::KEYCODE_F12;
case SDLK_F13: return Common::KEYCODE_F13;
case SDLK_F14: return Common::KEYCODE_F14;
case SDLK_F15: return Common::KEYCODE_F15;
case SDLK_CAPSLOCK: return Common::KEYCODE_CAPSLOCK;
case SDLK_RSHIFT: return Common::KEYCODE_RSHIFT;
case SDLK_LSHIFT: return Common::KEYCODE_LSHIFT;
case SDLK_RCTRL: return Common::KEYCODE_RCTRL;
case SDLK_LCTRL: return Common::KEYCODE_LCTRL;
case SDLK_RALT: return Common::KEYCODE_RALT;
case SDLK_LALT: return Common::KEYCODE_LALT;
case SDLK_MODE: return Common::KEYCODE_MODE;
case SDLK_HELP: return Common::KEYCODE_HELP;
case SDLK_SYSREQ: return Common::KEYCODE_SYSREQ;
case SDLK_MENU: return Common::KEYCODE_MENU;
case SDLK_POWER: return Common::KEYCODE_POWER;
case SDLK_UNDO: return Common::KEYCODE_UNDO;
#if SDL_VERSION_ATLEAST(2, 0, 0)
case SDLK_SCROLLLOCK: return Common::KEYCODE_SCROLLOCK;
case SDLK_NUMLOCKCLEAR: return Common::KEYCODE_NUMLOCK;
case SDLK_LGUI: return Common::KEYCODE_LSUPER;
case SDLK_RGUI: return Common::KEYCODE_RSUPER;
case SDLK_PRINTSCREEN: return Common::KEYCODE_PRINT;
case SDLK_APPLICATION: return Common::KEYCODE_COMPOSE;
case SDLK_KP_0: return Common::KEYCODE_KP0;
case SDLK_KP_1: return Common::KEYCODE_KP1;
case SDLK_KP_2: return Common::KEYCODE_KP2;
case SDLK_KP_3: return Common::KEYCODE_KP3;
case SDLK_KP_4: return Common::KEYCODE_KP4;
case SDLK_KP_5: return Common::KEYCODE_KP5;
case SDLK_KP_6: return Common::KEYCODE_KP6;
case SDLK_KP_7: return Common::KEYCODE_KP7;
case SDLK_KP_8: return Common::KEYCODE_KP8;
case SDLK_KP_9: return Common::KEYCODE_KP9;
case SDLK_PERCENT: return Common::KEYCODE_PERCENT;
case SDL_SCANCODE_TO_KEYCODE(SDL_SCANCODE_GRAVE): return Common::KEYCODE_TILDE;
case SDLK_F16: return Common::KEYCODE_F16;
case SDLK_F17: return Common::KEYCODE_F17;
case SDLK_F18: return Common::KEYCODE_F18;
case SDLK_SLEEP: return Common::KEYCODE_SLEEP;
case SDLK_MUTE: return Common::KEYCODE_MUTE;
case SDLK_VOLUMEUP: return Common::KEYCODE_VOLUMEUP;
case SDLK_VOLUMEDOWN: return Common::KEYCODE_VOLUMEDOWN;
case SDLK_EJECT: return Common::KEYCODE_EJECT;
case SDLK_WWW: return Common::KEYCODE_WWW;
case SDLK_MAIL: return Common::KEYCODE_MAIL;
case SDLK_CALCULATOR: return Common::KEYCODE_CALCULATOR;
case SDLK_CUT: return Common::KEYCODE_CUT;
case SDLK_COPY: return Common::KEYCODE_COPY;
case SDLK_PASTE: return Common::KEYCODE_PASTE;
case SDLK_SELECT: return Common::KEYCODE_SELECT;
case SDLK_CANCEL: return Common::KEYCODE_CANCEL;
case SDLK_AC_SEARCH: return Common::KEYCODE_AC_SEARCH;
case SDLK_AC_HOME: return Common::KEYCODE_AC_HOME;
case SDLK_AC_BACK: return Common::KEYCODE_AC_BACK;
case SDLK_AC_FORWARD: return Common::KEYCODE_AC_FORWARD;
case SDLK_AC_STOP: return Common::KEYCODE_AC_STOP;
case SDLK_AC_REFRESH: return Common::KEYCODE_AC_REFRESH;
case SDLK_AC_BOOKMARKS: return Common::KEYCODE_AC_BOOKMARKS;
case SDLK_AUDIONEXT: return Common::KEYCODE_AUDIONEXT;
case SDLK_AUDIOPREV: return Common::KEYCODE_AUDIOPREV;
case SDLK_AUDIOSTOP: return Common::KEYCODE_AUDIOSTOP;
case SDLK_AUDIOPLAY: return Common::KEYCODE_AUDIOPLAYPAUSE;
case SDLK_AUDIOMUTE: return Common::KEYCODE_AUDIOMUTE;
#if SDL_VERSION_ATLEAST(2, 0, 6)
case SDLK_AUDIOREWIND: return Common::KEYCODE_AUDIOREWIND;
case SDLK_AUDIOFASTFORWARD: return Common::KEYCODE_AUDIOFASTFORWARD;
#endif
#else
case SDLK_SCROLLOCK: return Common::KEYCODE_SCROLLOCK;
case SDLK_NUMLOCK: return Common::KEYCODE_NUMLOCK;
case SDLK_LSUPER: return Common::KEYCODE_LSUPER;
case SDLK_RSUPER: return Common::KEYCODE_RSUPER;
case SDLK_PRINT: return Common::KEYCODE_PRINT;
case SDLK_COMPOSE: return Common::KEYCODE_COMPOSE;
case SDLK_KP0: return Common::KEYCODE_KP0;
case SDLK_KP1: return Common::KEYCODE_KP1;
case SDLK_KP2: return Common::KEYCODE_KP2;
case SDLK_KP3: return Common::KEYCODE_KP3;
case SDLK_KP4: return Common::KEYCODE_KP4;
case SDLK_KP5: return Common::KEYCODE_KP5;
case SDLK_KP6: return Common::KEYCODE_KP6;
case SDLK_KP7: return Common::KEYCODE_KP7;
case SDLK_KP8: return Common::KEYCODE_KP8;
case SDLK_KP9: return Common::KEYCODE_KP9;
case SDLK_WORLD_16: return Common::KEYCODE_TILDE;
case SDLK_BREAK: return Common::KEYCODE_BREAK;
case SDLK_LMETA: return Common::KEYCODE_LMETA;
case SDLK_RMETA: return Common::KEYCODE_RMETA;
case SDLK_EURO: return Common::KEYCODE_EURO;
#endif
default: return Common::KEYCODE_INVALID;
}
}
bool SdlEventSource::pollEvent(Common::Event &event) {
#if SDL_VERSION_ATLEAST(2, 0, 0)
// In case we still need to send a key up event for a key down from a
// TEXTINPUT event we do this immediately.
if (_queuedFakeKeyUp) {
event = _fakeKeyUp;
_queuedFakeKeyUp = false;
return true;
}
#endif
// If the screen changed, send an Common::EVENT_SCREEN_CHANGED
int screenID = g_system->getScreenChangeID();
if (screenID != _lastScreenID) {
_lastScreenID = screenID;
event.type = Common::EVENT_SCREEN_CHANGED;
return true;
}
if (_queuedFakeMouseMove) {
event = _fakeMouseMove;
_queuedFakeMouseMove = false;
return true;
}
SDL_Event ev;
while (SDL_PollEvent(&ev)) {
preprocessEvents(&ev);
if (dispatchSDLEvent(ev, event))
return true;
}
return false;
}
bool SdlEventSource::dispatchSDLEvent(SDL_Event &ev, Common::Event &event) {
switch (ev.type) {
case SDL_KEYDOWN:
return handleKeyDown(ev, event);
case SDL_KEYUP:
return handleKeyUp(ev, event);
case SDL_MOUSEMOTION:
return handleMouseMotion(ev, event);
case SDL_MOUSEBUTTONDOWN:
return handleMouseButtonDown(ev, event);
case SDL_MOUSEBUTTONUP:
return handleMouseButtonUp(ev, event);
case SDL_SYSWMEVENT:
return handleSysWMEvent(ev, event);
#if SDL_VERSION_ATLEAST(2, 0, 0)
case SDL_MOUSEWHEEL: {
Sint32 yDir = ev.wheel.y;
// We want the mouse coordinates supplied with a mouse wheel event.
// However, SDL2 does not supply these, thus we use whatever we got
// last time.
if (!processMouseEvent(event, _mouseX, _mouseY)) {
return false;
}
if (yDir < 0) {
event.type = Common::EVENT_WHEELDOWN;
return true;
} else if (yDir > 0) {
event.type = Common::EVENT_WHEELUP;
return true;
} else {
return false;
}
}
case SDL_TEXTINPUT: {
// When we get a TEXTINPUT event it means we got some user input for
// which no KEYDOWN exists. SDL 1.2 introduces a "fake" key down+up
// in such cases. We will do the same to mimic it's behavior.
event.type = Common::EVENT_KEYDOWN;
event.kbd = Common::KeyState(Common::KEYCODE_INVALID, convUTF8ToUTF32(ev.text.text), 0);
SDLModToOSystemKeyFlags(SDL_GetModState(), event);
// Set the scroll lock sticky flag
if (_scrollLock)
event.kbd.flags |= Common::KBD_SCRL;
// Fake a key up when we have a proper ascii value.
_queuedFakeKeyUp = (event.kbd.ascii != 0);
_fakeKeyUp = event;
_fakeKeyUp.type = Common::EVENT_KEYUP;
return _queuedFakeKeyUp;
}
case SDL_WINDOWEVENT:
// We're only interested in events from the current display window
if (_graphicsManager) {
uint32 windowID = 0;
if (dynamic_cast<SdlGraphics3dManager *>(_graphicsManager)) {
windowID = SDL_GetWindowID(dynamic_cast<SdlGraphics3dManager *>(_graphicsManager)->getWindow()->getSDLWindow());
} else if (dynamic_cast<SdlGraphicsManager *>(_graphicsManager)) {
windowID = SDL_GetWindowID(dynamic_cast<SdlGraphicsManager *>(_graphicsManager)->getWindow()->getSDLWindow());
}
if (windowID != ev.window.windowID) {
return false;
}
}
switch (ev.window.event) {
case SDL_WINDOWEVENT_EXPOSED:
if (_graphicsManager) {
if (dynamic_cast<SdlGraphics3dManager *>(_graphicsManager)) {
dynamic_cast<SdlGraphics3dManager *>(_graphicsManager)->notifyVideoExpose();
} else if (dynamic_cast<SdlGraphicsManager *>(_graphicsManager)) {
dynamic_cast<SdlGraphicsManager *>(_graphicsManager)->notifyVideoExpose();
}
}
return false;
// SDL2 documentation indicate that SDL_WINDOWEVENT_SIZE_CHANGED is sent either as a result
// of the size being changed by an external event (for example the user resizing the window
// or going fullscreen) or a call to the SDL API (for example SDL_SetWindowSize). On the
// other hand SDL_WINDOWEVENT_RESIZED is only sent for resize resulting from an external event,
// and is always preceded by a SDL_WINDOWEVENT_SIZE_CHANGED event.
// We need to handle the programmatic resize as well so that the graphics manager always know
// the current size. See comments in SdlWindow::createOrUpdateWindow for details of one case
// where we need to call SDL_SetWindowSize and we need the resulting event to be processed.
// However if the documentation is correct we can ignore SDL_WINDOWEVENT_RESIZED since when we
// get one we should always get a SDL_WINDOWEVENT_SIZE_CHANGED as well.
case SDL_WINDOWEVENT_SIZE_CHANGED:
//case SDL_WINDOWEVENT_RESIZED:
return handleResizeEvent(event, ev.window.data1, ev.window.data2);
case SDL_WINDOWEVENT_FOCUS_GAINED: {
// When we gain focus, we to update whether the display can turn off
// dependingif a game isn't running or not
event.type = Common::EVENT_FOCUS_GAINED;
if (_engineRunning) {
SDL_DisableScreenSaver();
} else {
SDL_EnableScreenSaver();
}
return true;
}
case SDL_WINDOWEVENT_FOCUS_LOST: {
// Always allow the display to turn off if ScummVM is out of focus
event.type = Common::EVENT_FOCUS_LOST;
SDL_EnableScreenSaver();
return true;
}
default:
return false;
}
case SDL_JOYDEVICEADDED:
return handleJoystickAdded(ev.jdevice, event);
case SDL_JOYDEVICEREMOVED:
return handleJoystickRemoved(ev.jdevice, event);
case SDL_DROPFILE:
event.type = Common::EVENT_DROP_FILE;
event.path = Common::String(ev.drop.file);
SDL_free(ev.drop.file);
return true;
case SDL_CLIPBOARDUPDATE:
event.type = Common::EVENT_CLIPBOARD_UPDATE;
return true;
#else
case SDL_VIDEOEXPOSE:
if (_graphicsManager) {
if (dynamic_cast<SdlGraphics3dManager *>(_graphicsManager)) {
dynamic_cast<SdlGraphics3dManager *>(_graphicsManager)->notifyVideoExpose();
} else if (dynamic_cast<SdlGraphicsManager *>(_graphicsManager)) {
dynamic_cast<SdlGraphicsManager *>(_graphicsManager)->notifyVideoExpose();
}
}
return false;
case SDL_VIDEORESIZE:
return handleResizeEvent(event, ev.resize.w, ev.resize.h);
#endif
case SDL_QUIT:
event.type = Common::EVENT_QUIT;
return true;
default:
break;
}
if (_joystick) {
switch (ev.type) {
case SDL_JOYBUTTONDOWN:
return handleJoyButtonDown(ev, event);
case SDL_JOYBUTTONUP:
return handleJoyButtonUp(ev, event);
case SDL_JOYAXISMOTION:
return handleJoyAxisMotion(ev, event);
case SDL_JOYHATMOTION:
return handleJoyHatMotion(ev, event);
default:
break;
}
}
#if SDL_VERSION_ATLEAST(2, 0, 0)
if (_controller) {
switch (ev.type) {
case SDL_CONTROLLERBUTTONDOWN:
return handleControllerButton(ev, event, false);
case SDL_CONTROLLERBUTTONUP:
return handleControllerButton(ev, event, true);
case SDL_CONTROLLERAXISMOTION:
return handleControllerAxisMotion(ev, event);
default:
break;
}
}
#endif
return false;
}
bool SdlEventSource::handleKeyDown(SDL_Event &ev, Common::Event &event) {
SDLModToOSystemKeyFlags(SDL_GetModState(), event);
SDL_Keycode sdlKeycode = obtainKeycode(ev.key.keysym);
Common::KeyCode key = SDLToOSystemKeycode(sdlKeycode);
// Handle scroll lock as a key modifier
if (key == Common::KEYCODE_SCROLLOCK)
_scrollLock = !_scrollLock;
if (_scrollLock)
event.kbd.flags |= Common::KBD_SCRL;
if (remapKey(ev, event))
return true;
event.type = Common::EVENT_KEYDOWN;
event.kbd.keycode = key;
event.kbd.ascii = mapKey(sdlKeycode, (SDL_Keymod)ev.key.keysym.mod, obtainUnicode(ev.key.keysym));
#if SDL_VERSION_ATLEAST(2, 0, 0)
event.kbdRepeat = ev.key.repeat;
#endif
return true;
}
bool SdlEventSource::handleKeyUp(SDL_Event &ev, Common::Event &event) {
if (remapKey(ev, event))
return true;
SDL_Keycode sdlKeycode = obtainKeycode(ev.key.keysym);
SDL_Keymod mod = SDL_GetModState();
event.type = Common::EVENT_KEYUP;
event.kbd.keycode = SDLToOSystemKeycode(sdlKeycode);
event.kbd.ascii = mapKey(sdlKeycode, (SDL_Keymod)ev.key.keysym.mod, 0);
SDLModToOSystemKeyFlags(mod, event);
// Set the scroll lock sticky flag
if (_scrollLock)
event.kbd.flags |= Common::KBD_SCRL;
return true;
}
bool SdlEventSource::handleMouseMotion(SDL_Event &ev, Common::Event &event) {
event.type = Common::EVENT_MOUSEMOVE;
return processMouseEvent(event, ev.motion.x, ev.motion.y, ev.motion.xrel, ev.motion.yrel);
}
bool SdlEventSource::handleMouseButtonDown(SDL_Event &ev, Common::Event &event) {
if (ev.button.button == SDL_BUTTON_LEFT)
event.type = Common::EVENT_LBUTTONDOWN;
else if (ev.button.button == SDL_BUTTON_RIGHT)
event.type = Common::EVENT_RBUTTONDOWN;
#if defined(SDL_BUTTON_WHEELUP) && defined(SDL_BUTTON_WHEELDOWN)
else if (ev.button.button == SDL_BUTTON_WHEELUP)
event.type = Common::EVENT_WHEELUP;
else if (ev.button.button == SDL_BUTTON_WHEELDOWN)
event.type = Common::EVENT_WHEELDOWN;
#endif
#if defined(SDL_BUTTON_MIDDLE)
else if (ev.button.button == SDL_BUTTON_MIDDLE)
event.type = Common::EVENT_MBUTTONDOWN;
#endif
#if defined(SDL_BUTTON_X1)
else if (ev.button.button == SDL_BUTTON_X1)
event.type = Common::EVENT_X1BUTTONDOWN;
#endif
#if defined(SDL_BUTTON_X2)
else if (ev.button.button == SDL_BUTTON_X2)
event.type = Common::EVENT_X2BUTTONDOWN;
#endif
else
return false;
return processMouseEvent(event, ev.button.x, ev.button.y);
}
bool SdlEventSource::handleMouseButtonUp(SDL_Event &ev, Common::Event &event) {
if (ev.button.button == SDL_BUTTON_LEFT)
event.type = Common::EVENT_LBUTTONUP;
else if (ev.button.button == SDL_BUTTON_RIGHT)
event.type = Common::EVENT_RBUTTONUP;
#if defined(SDL_BUTTON_MIDDLE)
else if (ev.button.button == SDL_BUTTON_MIDDLE)
event.type = Common::EVENT_MBUTTONUP;
#endif
#if defined(SDL_BUTTON_X1)
else if (ev.button.button == SDL_BUTTON_X1)
event.type = Common::EVENT_X1BUTTONUP;
#endif
#if defined(SDL_BUTTON_X2)
else if (ev.button.button == SDL_BUTTON_X2)
event.type = Common::EVENT_X2BUTTONUP;
#endif
else
return false;
return processMouseEvent(event, ev.button.x, ev.button.y);
}
bool SdlEventSource::handleSysWMEvent(SDL_Event &ev, Common::Event &event) {
return false;
}
void SdlEventSource::openJoystick(int joystickIndex) {
if (SDL_NumJoysticks() > joystickIndex) {
#if SDL_VERSION_ATLEAST(2, 0, 0)
if (SDL_IsGameController(joystickIndex)) {
_controller = SDL_GameControllerOpen(joystickIndex);
debug("Using game controller: %s", SDL_GameControllerName(_controller));
} else
#endif
{
_joystick = SDL_JoystickOpen(joystickIndex);
debug("Using joystick: %s",
#if SDL_VERSION_ATLEAST(2, 0, 0)
SDL_JoystickName(_joystick)
#else
SDL_JoystickName(joystickIndex)
#endif
);
}
} else {
debug(5, "Invalid joystick: %d", joystickIndex);
}
}
void SdlEventSource::closeJoystick() {
#if SDL_VERSION_ATLEAST(2, 0, 0)
if (_controller) {
SDL_GameControllerClose(_controller);
_controller = nullptr;
}
#endif
if (_joystick) {
SDL_JoystickClose(_joystick);
_joystick = nullptr;
}
}
int SdlEventSource::mapSDLJoystickButtonToOSystem(Uint8 sdlButton) {
Common::JoystickButton osystemButtons[] = {
Common::JOYSTICK_BUTTON_A,
Common::JOYSTICK_BUTTON_B,
Common::JOYSTICK_BUTTON_X,
Common::JOYSTICK_BUTTON_Y,
Common::JOYSTICK_BUTTON_LEFT_SHOULDER,
Common::JOYSTICK_BUTTON_RIGHT_SHOULDER,
Common::JOYSTICK_BUTTON_BACK,
Common::JOYSTICK_BUTTON_START,
Common::JOYSTICK_BUTTON_LEFT_STICK,
Common::JOYSTICK_BUTTON_RIGHT_STICK
};
if (sdlButton >= ARRAYSIZE(osystemButtons)) {
return -1;
}
return osystemButtons[sdlButton];
}
bool SdlEventSource::handleJoyButtonDown(SDL_Event &ev, Common::Event &event) {
int button = mapSDLJoystickButtonToOSystem(ev.jbutton.button);
if (button < 0) {
return false;
}
event.type = Common::EVENT_JOYBUTTON_DOWN;
event.joystick.button = button;
return true;
}
bool SdlEventSource::handleJoyButtonUp(SDL_Event &ev, Common::Event &event) {
int button = mapSDLJoystickButtonToOSystem(ev.jbutton.button);
if (button < 0) {
return false;
}
event.type = Common::EVENT_JOYBUTTON_UP;
event.joystick.button = button;
return true;
}
bool SdlEventSource::handleJoyAxisMotion(SDL_Event &ev, Common::Event &event) {
event.type = Common::EVENT_JOYAXIS_MOTION;
event.joystick.axis = ev.jaxis.axis;
event.joystick.position = ev.jaxis.value;
return true;
}
#define HANDLE_HAT_UP(new, old, mask, joybutton) \
if ((old & mask) && !(new & mask)) { \
event.joystick.button = joybutton; \
g_system->getEventManager()->pushEvent(event); \
}
#define HANDLE_HAT_DOWN(new, old, mask, joybutton) \
if ((new & mask) && !(old & mask)) { \
event.joystick.button = joybutton; \
g_system->getEventManager()->pushEvent(event); \
}
bool SdlEventSource::handleJoyHatMotion(SDL_Event &ev, Common::Event &event) {
event.type = Common::EVENT_JOYBUTTON_UP;
HANDLE_HAT_UP(ev.jhat.value, _lastHatPosition, SDL_HAT_UP, Common::JOYSTICK_BUTTON_DPAD_UP)
HANDLE_HAT_UP(ev.jhat.value, _lastHatPosition, SDL_HAT_DOWN, Common::JOYSTICK_BUTTON_DPAD_DOWN)
HANDLE_HAT_UP(ev.jhat.value, _lastHatPosition, SDL_HAT_LEFT, Common::JOYSTICK_BUTTON_DPAD_LEFT)
HANDLE_HAT_UP(ev.jhat.value, _lastHatPosition, SDL_HAT_RIGHT, Common::JOYSTICK_BUTTON_DPAD_RIGHT)
event.type = Common::EVENT_JOYBUTTON_DOWN;
HANDLE_HAT_DOWN(ev.jhat.value, _lastHatPosition, SDL_HAT_UP, Common::JOYSTICK_BUTTON_DPAD_UP)
HANDLE_HAT_DOWN(ev.jhat.value, _lastHatPosition, SDL_HAT_DOWN, Common::JOYSTICK_BUTTON_DPAD_DOWN)
HANDLE_HAT_DOWN(ev.jhat.value, _lastHatPosition, SDL_HAT_LEFT, Common::JOYSTICK_BUTTON_DPAD_LEFT)
HANDLE_HAT_DOWN(ev.jhat.value, _lastHatPosition, SDL_HAT_RIGHT, Common::JOYSTICK_BUTTON_DPAD_RIGHT)
_lastHatPosition = ev.jhat.value;
return false;
}
#if SDL_VERSION_ATLEAST(2, 0, 0)
bool SdlEventSource::handleJoystickAdded(const SDL_JoyDeviceEvent &device, Common::Event &event) {
debug(5, "SdlEventSource: Received joystick added event for index '%d'", device.which);
int joystick_num = ConfMan.getInt("joystick_num");
if (joystick_num != device.which) {
return false;
}
debug(5, "SdlEventSource: Newly added joystick with index '%d' matches 'joysticky_num', trying to use it", device.which);
closeJoystick();
openJoystick(joystick_num);
event.type = Common::EVENT_INPUT_CHANGED;
return true;
}
bool SdlEventSource::handleJoystickRemoved(const SDL_JoyDeviceEvent &device, Common::Event &event) {
debug(5, "SdlEventSource: Received joystick removed event for instance id '%d'", device.which);
SDL_Joystick *joystick;
if (_controller) {
joystick = SDL_GameControllerGetJoystick(_controller);
} else {
joystick = _joystick;
}
if (!joystick) {
return false;
}
if (SDL_JoystickInstanceID(joystick) != device.which) {
return false;
}
debug(5, "SdlEventSource: Newly removed joystick with instance id '%d' matches currently used joystick, closing current joystick", device.which);
closeJoystick();
event.type = Common::EVENT_INPUT_CHANGED;
return true;
}
int SdlEventSource::mapSDLControllerButtonToOSystem(Uint8 sdlButton) {
Common::JoystickButton osystemButtons[] = {
Common::JOYSTICK_BUTTON_A,
Common::JOYSTICK_BUTTON_B,
Common::JOYSTICK_BUTTON_X,
Common::JOYSTICK_BUTTON_Y,
Common::JOYSTICK_BUTTON_BACK,
Common::JOYSTICK_BUTTON_GUIDE,
Common::JOYSTICK_BUTTON_START,
Common::JOYSTICK_BUTTON_LEFT_STICK,
Common::JOYSTICK_BUTTON_RIGHT_STICK,
Common::JOYSTICK_BUTTON_LEFT_SHOULDER,
Common::JOYSTICK_BUTTON_RIGHT_SHOULDER,
Common::JOYSTICK_BUTTON_DPAD_UP,
Common::JOYSTICK_BUTTON_DPAD_DOWN,
Common::JOYSTICK_BUTTON_DPAD_LEFT,
Common::JOYSTICK_BUTTON_DPAD_RIGHT
};
if (sdlButton >= ARRAYSIZE(osystemButtons)) {
return -1;
}
return osystemButtons[sdlButton];
}
bool SdlEventSource::handleControllerButton(const SDL_Event &ev, Common::Event &event, bool buttonUp) {
int button = mapSDLControllerButtonToOSystem(ev.cbutton.button);
if (button < 0)
return false;
event.type = buttonUp ? Common::EVENT_JOYBUTTON_UP : Common::EVENT_JOYBUTTON_DOWN;
event.joystick.button = button;
return true;
}
bool SdlEventSource::handleControllerAxisMotion(const SDL_Event &ev, Common::Event &event) {
event.type = Common::EVENT_JOYAXIS_MOTION;
event.joystick.axis = ev.caxis.axis;
event.joystick.position = ev.caxis.value;
return true;
}
#endif
bool SdlEventSource::remapKey(SDL_Event &ev, Common::Event &event) {
return false;
}
void SdlEventSource::fakeWarpMouse(const int x, const int y) {
_queuedFakeMouseMove = true;
_fakeMouseMove.type = Common::EVENT_MOUSEMOVE;
_fakeMouseMove.mouse = Common::Point(x, y);
}
bool SdlEventSource::isJoystickConnected() const {
return _joystick
#if SDL_VERSION_ATLEAST(2, 0, 0)
|| _controller
#endif
;
}
void SdlEventSource::setEngineRunning(const bool value) {
_engineRunning = value;
}
bool SdlEventSource::handleResizeEvent(Common::Event &event, int w, int h) {
if (_graphicsManager) {
if (dynamic_cast<SdlGraphics3dManager *>(_graphicsManager)) {
dynamic_cast<SdlGraphics3dManager *>(_graphicsManager)->notifyResize(w, h);
} else if (dynamic_cast<SdlGraphicsManager *>(_graphicsManager)) {
dynamic_cast<SdlGraphicsManager *>(_graphicsManager)->notifyResize(w, h);
}
// If the screen changed, send an Common::EVENT_SCREEN_CHANGED
int screenID = g_system->getScreenChangeID();
if (screenID != _lastScreenID) {
_lastScreenID = screenID;
event.type = Common::EVENT_SCREEN_CHANGED;
return true;
}
}
return false;
}
SDL_Keycode SdlEventSource::obtainKeycode(const SDL_Keysym keySym) {
#if !SDL_VERSION_ATLEAST(2, 0, 0) && defined(WIN32)
// WORKAROUND: SDL 1.2 on Windows does not use the user configured keyboard layout,
// resulting in "keySym.sym" values to always be those expected for an US keyboard.
// For example, SDL returns SDLK_Q when pressing the 'A' key on an AZERTY keyboard.
// This defeats the purpose of keycodes which is to be able to refer to a key without
// knowing where it is physically located.
// We work around this issue by querying the currently active Windows keyboard layout
// using the scancode provided by SDL.
if (keySym.sym >= SDLK_0 && keySym.sym <= SDLK_9) {
// The keycode returned by SDL is kept for the number keys.
// Querying the keyboard layout for those would return the base key values
// for AZERTY keyboards, which are not numbers. For example, SDLK_1 would
// map to SDLK_AMPERSAND. This is theoretically correct but practically unhelpful,
// because it makes it impossible to handle key combinations such as "ctrl-1".
return keySym.sym;
}
int vk = MapVirtualKey(keySym.scancode, MAPVK_VSC_TO_VK);
if (vk) {
int ch = (MapVirtualKey(vk, MAPVK_VK_TO_CHAR) & 0x7FFF);
// The top bit of the result of MapVirtualKey with MAPVK_VSC_TO_VK signals
// a dead key was pressed. In that case we keep the value of the accent alone.
if (ch) {
if (ch >= 'A' && ch <= 'Z') {
// Windows returns uppercase ASCII whereas SDL expects lowercase
return (SDL_Keycode)(SDLK_a + (ch - 'A'));
} else {
return (SDL_Keycode)ch;
}
}
}
#endif
return keySym.sym;
}
uint32 SdlEventSource::obtainUnicode(const SDL_Keysym keySym) {
#if SDL_VERSION_ATLEAST(2, 0, 0)
SDL_Event events[2];
// Update the event queue here to give SDL a chance to insert TEXTINPUT
// events for KEYDOWN events. Otherwise we have a high chance that on
// Windows the TEXTINPUT event is not in the event queue at this point.
// In this case we will get two events with ascii values due to mapKey
// and dispatchSDLEvent. This results in nasty double input of characters
// in the GUI.
//
// FIXME: This is all a bit fragile because in mapKey we derive the ascii
// value from the key code if no unicode value is given. This is legacy
// behavior and should be removed anyway. If that is removed, we might not
// even need to do this peeking here but instead can rely on the
// SDL_TEXTINPUT case in dispatchSDLEvent to introduce keydown/keyup with
// proper ASCII values (but with KEYCODE_INVALID as keycode).
SDL_PumpEvents();
// In SDL2, the unicode field has been removed from the keysym struct.
// Instead a SDL_TEXTINPUT event is generated on key combinations that
// generates unicode.
// Here we peek into the event queue for the event to see if it exists.
int n = SDL_PeepEvents(events, 2, SDL_PEEKEVENT, SDL_KEYDOWN, SDL_TEXTINPUT);
// Make sure that the TEXTINPUT event belongs to this KEYDOWN
// event and not another pending one.
if ((n > 0 && events[0].type == SDL_TEXTINPUT)
|| (n > 1 && events[0].type != SDL_KEYDOWN && events[1].type == SDL_TEXTINPUT)) {
// Remove the text input event we associate with the key press. This
// makes sure we never get any SDL_TEXTINPUT events which do "belong"
// to SDL_KEYDOWN events.
n = SDL_PeepEvents(events, 1, SDL_GETEVENT, SDL_TEXTINPUT, SDL_TEXTINPUT);
// This is basically a paranoia safety check because we know there
// must be a text input event in the queue.
if (n > 0) {
return convUTF8ToUTF32(events[0].text.text);
} else {
return 0;
}
} else {
return 0;
}
#else
return keySym.unicode;
#endif
}
#endif
Reference in a new issue View git blame Copy permalink