1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425
|
/* 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 3 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, see <http://www.gnu.org/licenses/>.
*
*/
#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 "common/config-manager.h"
#include "common/textconsole.h"
#include "common/fs.h"
#include "engines/engine.h"
#include "gui/gui-manager.h"
#if defined(USE_IMGUI) && SDL_VERSION_ATLEAST(2, 0, 0)
#include "backends/imgui/backends/imgui_impl_sdl2.h"
#endif
#if SDL_VERSION_ATLEAST(2, 0, 0)
#define GAMECONTROLLERDB_FILE "gamecontrollerdb.txt"
static uint32 convUTF8ToUTF32(const char *src) {
if (!src || src[0] == 0)
return 0;
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.getPath("controller_map_db"));
if (file.exists()) {
if (SDL_GameControllerAddMappingsFromFile(file.getPath().toString(Common::Path::kNativeSeparator).c_str()) < 0)
error("File %s not valid: %s", file.getPath().toString(Common::Path::kNativeSeparator).c_str(), SDL_GetError());
else {
loaded = true;
debug("Game controller DB file loaded: %s", file.getPath().toString(Common::Path::kNativeSeparator).c_str());
}
} else
warning("Game controller DB file not found: %s", file.getPath().toString(Common::Path::kNativeSeparator).c_str());
}
if (!loaded && ConfMan.hasKey("extrapath")) {
Common::FSNode dir = Common::FSNode(ConfMan.getPath("extrapath"));
Common::FSNode file = dir.getChild(GAMECONTROLLERDB_FILE);
if (file.exists()) {
if (SDL_GameControllerAddMappingsFromFile(file.getPath().toString(Common::Path::kNativeSeparator).c_str()) < 0)
error("File %s not valid: %s", file.getPath().toString(Common::Path::kNativeSeparator).c_str(), SDL_GetError());
else
debug("Game controller DB file loaded: %s", file.getPath().toString(Common::Path::kNativeSeparator).c_str());
}
}
}
#endif
SdlEventSource::SdlEventSource()
: EventSource(), _scrollLock(false), _joystick(nullptr), _lastScreenID(0), _graphicsManager(nullptr), _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) {
warning("Could not initialize SDL joystick: %s", SDL_GetError());
return;
}
#if SDL_VERSION_ATLEAST(2, 0, 0)
if (SDL_InitSubSystem(SDL_INIT_GAMECONTROLLER) == -1) {
warning("Could not initialize SDL game controller: %s", SDL_GetError());
return;
}
loadGameControllerMappingFile();
#endif
openJoystick(joystick_num);
}
#if SDL_VERSION_ATLEAST(2,0,10)
// ensure that touch doesn't create double-events
SDL_SetHint(SDL_HINT_TOUCH_MOUSE_EVENTS, "0");
#endif
}
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;
// Cyrillic
if (unicode >= 0x0400 && unicode <= 0x045F)
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) {
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
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) {
return _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;
#if SDL_VERSION_ATLEAST(1, 2, 3)
case SDLK_UNDO: return Common::KEYCODE_UNDO;
#endif
#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;
}
}
#if SDL_VERSION_ATLEAST(2, 0, 0)
void SdlEventSource::preprocessFingerDown(SDL_Event *event) {
// front (1) or back (2) panel
SDL_TouchID port = event->tfinger.touchId;
// id (for multitouch)
SDL_FingerID id = event->tfinger.fingerId;
int x = _mouseX;
int y = _mouseY;
if (!isTouchPortTouchpadMode(port)) {
convertTouchXYToGameXY(event->tfinger.x, event->tfinger.y, &x, &y);
}
// make sure each finger is not reported down multiple times
for (int i = 0; i < MAX_NUM_FINGERS; i++) {
if (_touchPanels[port]._finger[i].id == id) {
_touchPanels[port]._finger[i].id = -1;
}
}
// we need the timestamps to decide later if the user performed a short tap (click)
// or a long tap (drag)
// we also need the last coordinates for each finger to keep track of dragging
for (int i = 0; i < MAX_NUM_FINGERS; i++) {
if (_touchPanels[port]._finger[i].id == -1) {
_touchPanels[port]._finger[i].id = id;
_touchPanels[port]._finger[i].timeLastDown = event->tfinger.timestamp;
_touchPanels[port]._finger[i].lastDownX = event->tfinger.x;
_touchPanels[port]._finger[i].lastDownY = event->tfinger.y;
_touchPanels[port]._finger[i].lastX = x;
_touchPanels[port]._finger[i].lastY = y;
break;
}
}
}
Common::Point SdlEventSource::getTouchscreenSize() {
int windowWidth, windowHeight;
SDL_GetWindowSize((dynamic_cast<SdlGraphicsManager*>(_graphicsManager))->getWindow()->getSDLWindow(), &windowWidth, &windowHeight);
return Common::Point(windowWidth, windowHeight);
}
bool SdlEventSource::isTouchPortTouchpadMode(SDL_TouchID port) {
return g_system->getFeatureState(OSystem::kFeatureTouchpadMode);
}
bool SdlEventSource::isTouchPortActive(SDL_TouchID port) {
return true;
}
void SdlEventSource::convertTouchXYToGameXY(float touchX, float touchY, int *gameX, int *gameY) {
int windowWidth, windowHeight;
SDL_GetWindowSize((dynamic_cast<SdlGraphicsManager*>(_graphicsManager))->getWindow()->getSDLWindow(), &windowWidth, &windowHeight);
*gameX = windowWidth * touchX;
*gameY = windowHeight * touchY;
}
void SdlEventSource::finishSimulatedMouseClicks() {
for (auto &panel : _touchPanels) {
for (int i = 0; i < 2; i++) {
if (panel._value._simulatedClickStartTime[i] != 0) {
Uint32 currentTime = SDL_GetTicks();
if (currentTime - panel._value._simulatedClickStartTime[i] >= SIMULATED_CLICK_DURATION) {
int simulatedButton;
if (i == 0) {
simulatedButton = SDL_BUTTON_LEFT;
} else {
simulatedButton = SDL_BUTTON_RIGHT;
}
SDL_Event ev;
ev.type = SDL_MOUSEBUTTONUP;
ev.button.button = simulatedButton;
ev.button.x = _mouseX;
ev.button.y = _mouseY;
SDL_PushEvent(&ev);
panel._value._simulatedClickStartTime[i] = 0;
}
}
}
}
}
bool SdlEventSource::preprocessFingerUp(SDL_Event *event, Common::Event *ev) {
// front (1) or back (2) panel
SDL_TouchID port = event->tfinger.touchId;
// id (for multitouch)
SDL_FingerID id = event->tfinger.fingerId;
// find out how many fingers were down before this event
int numFingersDown = 0;
for (int i = 0; i < MAX_NUM_FINGERS; i++) {
if (_touchPanels[port]._finger[i].id >= 0) {
numFingersDown++;
}
}
int x = _mouseX;
int y = _mouseY;
for (int i = 0; i < MAX_NUM_FINGERS; i++) {
if (_touchPanels[port]._finger[i].id == id) {
_touchPanels[port]._finger[i].id = -1;
if (!_touchPanels[port]._multiFingerDragging) {
if ((event->tfinger.timestamp - _touchPanels[port]._finger[i].timeLastDown) <= MAX_TAP_TIME && !_touchPanels[port]._tapMade) {
// short (<MAX_TAP_TIME ms) tap is interpreted as right/left mouse click depending on # fingers already down
// but only if the finger hasn't moved since it was pressed down by more than MAX_TAP_MOTION_DISTANCE pixels
Common::Point touchscreenSize = getTouchscreenSize();
float xrel = ((event->tfinger.x * (float) touchscreenSize.x) - (_touchPanels[port]._finger[i].lastDownX * (float) touchscreenSize.x));
float yrel = ((event->tfinger.y * (float) touchscreenSize.y) - (_touchPanels[port]._finger[i].lastDownY * (float) touchscreenSize.y));
float maxRSquared = (float) (MAX_TAP_MOTION_DISTANCE * MAX_TAP_MOTION_DISTANCE);
if ((xrel * xrel + yrel * yrel) < maxRSquared) {
if (numFingersDown == 3) {
_touchPanels[port]._tapMade = true;
ev->type = Common::EVENT_VIRTUAL_KEYBOARD;
return true;
} else if (numFingersDown == 2 || numFingersDown == 1) {
Uint8 simulatedButton = 0;
if (numFingersDown == 2) {
simulatedButton = SDL_BUTTON_RIGHT;
// need to raise the button later
_touchPanels[port]._simulatedClickStartTime[1] = event->tfinger.timestamp;
_touchPanels[port]._tapMade = true;
} else if (numFingersDown == 1) {
simulatedButton = SDL_BUTTON_LEFT;
// need to raise the button later
_touchPanels[port]._simulatedClickStartTime[0] = event->tfinger.timestamp;
if (!isTouchPortTouchpadMode(port)) {
convertTouchXYToGameXY(event->tfinger.x, event->tfinger.y, &x, &y);
}
}
event->type = SDL_MOUSEBUTTONDOWN;
event->button.button = simulatedButton;
event->button.x = x;
event->button.y = y;
}
}
}
} else if (numFingersDown == 1) {
// when dragging, and the last finger is lifted, the drag is over
if (!isTouchPortTouchpadMode(port)) {
convertTouchXYToGameXY(event->tfinger.x, event->tfinger.y, &x, &y);
}
Uint8 simulatedButton = 0;
if (_touchPanels[port]._multiFingerDragging == DRAG_THREE_FINGER)
simulatedButton = SDL_BUTTON_RIGHT;
else {
simulatedButton = SDL_BUTTON_LEFT;
}
event->type = SDL_MOUSEBUTTONUP;
event->button.button = simulatedButton;
event->button.x = x;
event->button.y = y;
_touchPanels[port]._multiFingerDragging = DRAG_NONE;
}
}
}
if (numFingersDown == 1) {
_touchPanels[port]._tapMade = false;
}
return false;
}
void SdlEventSource::preprocessFingerMotion(SDL_Event *event) {
// front (1) or back (2) panel
SDL_TouchID port = event->tfinger.touchId;
// id (for multitouch)
SDL_FingerID id = event->tfinger.fingerId;
// find out how many fingers were down before this event
int numFingersDown = 0;
for (int i = 0; i < MAX_NUM_FINGERS; i++) {
if (_touchPanels[port]._finger[i].id >= 0) {
numFingersDown++;
}
}
if (numFingersDown >= 1) {
int x = _mouseX;
int y = _mouseY;
int xMax = _graphicsManager->getWindowWidth() - 1;
int yMax = _graphicsManager->getWindowHeight() - 1;
if (!isTouchPortTouchpadMode(port)) {
convertTouchXYToGameXY(event->tfinger.x, event->tfinger.y, &x, &y);
} else {
// for relative mode, use the pointer speed setting
const int kbdMouseSpeed = CLIP<int>(ConfMan.getInt("kbdmouse_speed"), 0, 7);
float speedFactor = (kbdMouseSpeed + 1) * 0.25;
// convert touch events to relative mouse pointer events
// track sub-pixel relative finger motion using the FINGER_SUBPIXEL_MULTIPLIER
_touchPanels[port]._hiresDX += (event->tfinger.dx * 1.25 * speedFactor * xMax * FINGER_SUBPIXEL_MULTIPLIER);
_touchPanels[port]._hiresDY += (event->tfinger.dy * 1.25 * speedFactor * yMax * FINGER_SUBPIXEL_MULTIPLIER);
int xRel = _touchPanels[port]._hiresDX / FINGER_SUBPIXEL_MULTIPLIER;
int yRel = _touchPanels[port]._hiresDY / FINGER_SUBPIXEL_MULTIPLIER;
x = _mouseX + xRel;
y = _mouseY + yRel;
_touchPanels[port]._hiresDX %= FINGER_SUBPIXEL_MULTIPLIER;
_touchPanels[port]._hiresDY %= FINGER_SUBPIXEL_MULTIPLIER;
}
x = CLIP(x, 0, xMax);
y = CLIP(y, 0, yMax);
// update the current finger's coordinates so we can track it later
for (int i = 0; i < MAX_NUM_FINGERS; i++) {
if (_touchPanels[port]._finger[i].id == id) {
_touchPanels[port]._finger[i].lastX = x;
_touchPanels[port]._finger[i].lastY = y;
}
}
// If we are starting a multi-finger drag, start holding down the mouse button
if (numFingersDown >= 2) {
if (!_touchPanels[port]._multiFingerDragging) {
// only start a multi-finger drag if at least two fingers have been down long enough
int numFingersDownLong = 0;
for (int i = 0; i < MAX_NUM_FINGERS; i++) {
if (_touchPanels[port]._finger[i].id >= 0) {
if (event->tfinger.timestamp - _touchPanels[port]._finger[i].timeLastDown > MAX_TAP_TIME) {
numFingersDownLong++;
}
}
}
if (numFingersDownLong >= 2) {
// starting drag, so push mouse down at current location (back)
// or location of "oldest" finger (front)
int mouseDownX = _mouseX;
int mouseDownY = _mouseY;
if (!isTouchPortTouchpadMode(port)) {
for (int i = 0; i < MAX_NUM_FINGERS; i++) {
if (_touchPanels[port]._finger[i].id == id) {
Uint32 earliestTime = _touchPanels[port]._finger[i].timeLastDown;
for (int j = 0; j < MAX_NUM_FINGERS; j++) {
if (_touchPanels[port]._finger[j].id >= 0 && (i != j) ) {
if (_touchPanels[port]._finger[j].timeLastDown < earliestTime) {
mouseDownX = _touchPanels[port]._finger[j].lastX;
mouseDownY = _touchPanels[port]._finger[j].lastY;
earliestTime = _touchPanels[port]._finger[j].timeLastDown;
}
}
}
break;
}
}
}
Uint8 simulatedButton = 0;
if (numFingersDownLong == 2) {
simulatedButton = SDL_BUTTON_LEFT;
_touchPanels[port]._multiFingerDragging = DRAG_TWO_FINGER;
} else {
simulatedButton = SDL_BUTTON_RIGHT;
_touchPanels[port]._multiFingerDragging = DRAG_THREE_FINGER;
}
SDL_Event ev;
ev.type = SDL_MOUSEBUTTONDOWN;
ev.button.button = simulatedButton;
ev.button.x = mouseDownX;
ev.button.y = mouseDownY;
SDL_PushEvent(&ev);
}
}
}
//check if this is the "oldest" finger down (or the only finger down), otherwise it will not affect mouse motion
bool updatePointer = true;
if (numFingersDown > 1) {
for (int i = 0; i < MAX_NUM_FINGERS; i++) {
if (_touchPanels[port]._finger[i].id == id) {
for (int j = 0; j < MAX_NUM_FINGERS; j++) {
if (_touchPanels[port]._finger[j].id >= 0 && (i != j) ) {
if (_touchPanels[port]._finger[j].timeLastDown < _touchPanels[port]._finger[i].timeLastDown) {
updatePointer = false;
}
}
}
}
}
}
if (updatePointer) {
event->type = SDL_MOUSEMOTION;
event->motion.x = x;
event->motion.y = y;
}
}
}
#endif
bool SdlEventSource::pollEvent(Common::Event &event) {
#if SDL_VERSION_ATLEAST(2, 0, 0)
finishSimulatedMouseClicks();
// 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 SDL_VERSION_ATLEAST(2, 0, 0)
// Supported touch gestures:
// left mouse click: single finger short tap
// right mouse click: second finger short tap while first finger is still down
// pointer motion: single finger drag
if (ev.type == SDL_FINGERDOWN || ev.type == SDL_FINGERUP || ev.type == SDL_FINGERMOTION) {
// front (0) or back (1) panel
SDL_TouchID port = ev.tfinger.touchId;
// touchpad_mouse_mode off: use only front panel for direct touch control of pointer
// touchpad_mouse_mode on: also enable rear touch with indirect touch control
// where the finger can be somewhere else than the pointer and still move it
if (isTouchPortActive(port)) {
switch (ev.type) {
case SDL_FINGERDOWN:
preprocessFingerDown(&ev);
break;
case SDL_FINGERUP:
if (preprocessFingerUp(&ev, &event))
return true;
break;
case SDL_FINGERMOTION:
preprocessFingerMotion(&ev);
break;
}
}
}
#endif
#if defined(USE_IMGUI) && SDL_VERSION_ATLEAST(2, 0, 0)
if (ImGui_ImplSDL2_Ready()) {
ImGui_ImplSDL2_ProcessEvent(&ev);
ImGuiIO &io = ImGui::GetIO();
if (io.WantTextInput || io.WantCaptureMouse)
continue;
}
#endif
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 = SDL_GetWindowID(_graphicsManager->getWindow()->getSDLWindow());
if (windowID != ev.window.windowID) {
return false;
}
}
switch (ev.window.event) {
case SDL_WINDOWEVENT_EXPOSED:
if (_graphicsManager) {
_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::Path(ev.drop.file, Common::Path::kNativeSeparator);
SDL_free(ev.drop.file);
return true;
case SDL_CLIPBOARDUPDATE:
event.type = Common::EVENT_CLIPBOARD_UPDATE;
return true;
#else
case SDL_VIDEOEXPOSE:
if (_graphicsManager) {
_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;
SDL_Keymod mod = (SDL_Keymod)ev.key.keysym.mod;
#if defined(__amigaos4__)
// On AmigaOS, SDL always reports numlock as off. However, we get KEYCODE_KP# only when
// it is on, and get different keycodes (for example KEYCODE_PAGEDOWN) when it is off.
if (event.kbd.keycode >= Common::KEYCODE_KP0 && event.kbd.keycode <= Common::KEYCODE_KP9) {
event.kbd.flags |= Common::KBD_NUM;
mod = SDL_Keymod(mod | KMOD_NUM);
}
#endif
event.kbd.ascii = mapKey(sdlKeycode, 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;
SDLModToOSystemKeyFlags(SDL_GetModState(), event);
SDL_Keycode sdlKeycode = obtainKeycode(ev.key.keysym);
// Set the scroll lock sticky flag
if (_scrollLock)
event.kbd.flags |= Common::KBD_SCRL;
event.type = Common::EVENT_KEYUP;
event.kbd.keycode = SDLToOSystemKeycode(sdlKeycode);
SDL_Keymod mod = (SDL_Keymod)ev.key.keysym.mod;
#if defined(__amigaos4__)
// On AmigaOS, SDL always reports numlock as off. However, we get KEYCODE_KP# only when
// it is on, and get different keycodes (for example KEYCODE_PAGEDOWN) when it is off.
if (event.kbd.keycode >= Common::KEYCODE_KP0 && event.kbd.keycode <= Common::KEYCODE_KP9) {
event.kbd.flags |= Common::KBD_NUM;
mod = SDL_Keymod(mod | KMOD_NUM);
}
#endif
event.kbd.ascii = mapKey(sdlKeycode, mod, 0);
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) {
_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
|