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 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <linux/input.h>
#include <algorithm>
#include <iterator>
#include <memory>
#include <optional>
#include "ash/accelerators/accelerator_controller_impl.h"
#include "ash/constants/ash_features.h"
#include "ash/events/event_rewriter_controller_impl.h"
#include "ash/public/cpp/accelerators_util.h"
#include "ash/public/cpp/input_device_settings_controller.h"
#include "ash/public/mojom/input_device_settings.mojom-forward.h"
#include "ash/public/mojom/input_device_settings.mojom-shared.h"
#include "ash/public/mojom/input_device_settings.mojom.h"
#include "ash/shell.h"
#include "ash/system/input_device_settings/input_device_settings_controller_impl.h"
#include "ash/system/input_device_settings/input_device_settings_logging.h"
#include "base/check.h"
#include "base/check_op.h"
#include "base/containers/fixed_flat_map.h"
#include "base/containers/span.h"
#include "base/metrics/histogram_functions.h"
#include "base/notreached.h"
#include "base/strings/string_util.h"
#include "base/strings/stringprintf.h"
#include "ui/aura/env.h"
#include "ui/base/accelerators/ash/quick_insert_event_property.h"
#include "ui/base/ui_base_features.h"
#include "ui/display/manager/display_manager.h"
#include "ui/display/screen.h"
#include "ui/events/ash/mojom/modifier_key.mojom-shared.h"
#include "ui/events/event.h"
#include "ui/events/event_constants.h"
#include "ui/events/event_dispatcher.h"
#include "ui/events/event_utils.h"
#include "ui/events/keycodes/dom/dom_code.h"
#include "ui/events/keycodes/dom/dom_key.h"
#include "ui/events/keycodes/keyboard_codes_posix.h"
#include "ui/events/ozone/evdev/mouse_button_property.h"
#include "ui/events/ozone/layout/keyboard_layout_engine.h"
#include "ui/events/ozone/layout/keyboard_layout_engine_manager.h"
#include "ui/events/types/event_type.h"
#include "ui/gfx/geometry/point_f.h"
namespace ash {
namespace {
using RemappingActionResult =
PeripheralCustomizationEventRewriter::RemappingActionResult;
constexpr int kMouseRemappableFlags = ui::EF_BACK_MOUSE_BUTTON |
ui::EF_FORWARD_MOUSE_BUTTON |
ui::EF_MIDDLE_MOUSE_BUTTON;
constexpr int kGraphicsTabletRemappableFlags =
ui::EF_RIGHT_MOUSE_BUTTON | ui::EF_BACK_MOUSE_BUTTON |
ui::EF_FORWARD_MOUSE_BUTTON | ui::EF_MIDDLE_MOUSE_BUTTON;
constexpr auto kStaticActionToMouseButtonFlag =
base::MakeFixedFlatMap<mojom::StaticShortcutAction, ui::EventFlags>({
{mojom::StaticShortcutAction::kLeftClick, ui::EF_LEFT_MOUSE_BUTTON},
{mojom::StaticShortcutAction::kRightClick, ui::EF_RIGHT_MOUSE_BUTTON},
{mojom::StaticShortcutAction::kMiddleClick, ui::EF_MIDDLE_MOUSE_BUTTON},
});
mojom::KeyEvent GetStaticShortcutAction(mojom::StaticShortcutAction action) {
mojom::KeyEvent key_event;
switch (action) {
case mojom::StaticShortcutAction::kDisable:
case mojom::StaticShortcutAction::kLeftClick:
case mojom::StaticShortcutAction::kRightClick:
case mojom::StaticShortcutAction::kMiddleClick:
NOTREACHED();
case mojom::StaticShortcutAction::kCopy:
key_event =
mojom::KeyEvent(ui::VKEY_C, static_cast<int>(ui::DomCode::US_C),
static_cast<int>(ui::DomKey::FromCharacter('c')),
ui::EF_CONTROL_DOWN, /*key_display=*/"");
break;
case mojom::StaticShortcutAction::kPaste:
key_event =
mojom::KeyEvent(ui::VKEY_V, static_cast<int>(ui::DomCode::US_V),
static_cast<int>(ui::DomKey::FromCharacter('v')),
ui::EF_CONTROL_DOWN, /*key_display=*/"");
break;
case mojom::StaticShortcutAction::kUndo:
key_event =
mojom::KeyEvent(ui::VKEY_Z, static_cast<int>(ui::DomCode::US_Z),
static_cast<int>(ui::DomKey::FromCharacter('z')),
ui::EF_CONTROL_DOWN, /*key_display=*/"");
break;
case mojom::StaticShortcutAction::kRedo:
key_event = mojom::KeyEvent(
ui::VKEY_Z, static_cast<int>(ui::DomCode::US_Z),
static_cast<int>(ui::DomKey::FromCharacter('z')),
ui::EF_CONTROL_DOWN | ui::EF_SHIFT_DOWN, /*key_display=*/"");
break;
case mojom::StaticShortcutAction::kZoomIn:
key_event = mojom::KeyEvent(
ui::VKEY_OEM_PLUS, static_cast<int>(ui::DomCode::EQUAL),
static_cast<int>(ui::DomKey::FromCharacter('=')), ui::EF_CONTROL_DOWN,
/*key_display=*/"");
break;
case mojom::StaticShortcutAction::kZoomOut:
key_event = mojom::KeyEvent(
ui::VKEY_OEM_MINUS, static_cast<int>(ui::DomCode::MINUS),
static_cast<int>(ui::DomKey::FromCharacter('-')), ui::EF_CONTROL_DOWN,
/*key_display=*/"");
break;
case mojom::StaticShortcutAction::kPreviousPage:
key_event = mojom::KeyEvent(ui::VKEY_BROWSER_BACK,
static_cast<int>(ui::DomCode::BROWSER_BACK),
static_cast<int>(ui::DomKey::BROWSER_BACK),
ui::EF_NONE, /*key_display=*/"");
break;
case mojom::StaticShortcutAction::kNextPage:
key_event =
mojom::KeyEvent(ui::VKEY_BROWSER_FORWARD,
static_cast<int>(ui::DomCode::BROWSER_FORWARD),
static_cast<int>(ui::DomKey::BROWSER_FORWARD),
ui::EF_NONE, /*key_display=*/"");
break;
}
return key_event;
}
int ConvertKeyCodeToFlags(ui::KeyboardCode key_code) {
switch (key_code) {
case ui::VKEY_LWIN:
case ui::VKEY_RWIN:
return ui::EF_COMMAND_DOWN;
case ui::VKEY_CONTROL:
case ui::VKEY_RCONTROL:
return ui::EF_CONTROL_DOWN;
case ui::VKEY_SHIFT:
case ui::VKEY_LSHIFT:
case ui::VKEY_RSHIFT:
return ui::EF_SHIFT_DOWN;
case ui::VKEY_MENU:
case ui::VKEY_RMENU:
return ui::EF_ALT_DOWN;
default:
return ui::EF_NONE;
}
}
int ConvertModifierKeyToFlags(ui::mojom::ModifierKey modifier_key) {
switch (modifier_key) {
case ui::mojom::ModifierKey::kMeta:
return ui::EF_COMMAND_DOWN;
case ui::mojom::ModifierKey::kControl:
return ui::EF_CONTROL_DOWN;
case ui::mojom::ModifierKey::kAlt:
return ui::EF_ALT_DOWN;
case ui::mojom::ModifierKey::kFunction:
return ui::EF_FUNCTION_DOWN;
case ui::mojom::ModifierKey::kEscape:
case ui::mojom::ModifierKey::kBackspace:
case ui::mojom::ModifierKey::kAssistant:
case ui::mojom::ModifierKey::kCapsLock:
case ui::mojom::ModifierKey::kVoid:
case ui::mojom::ModifierKey::kIsoLevel5ShiftMod3:
case ui::mojom::ModifierKey::kQuickInsert:
return ui::EF_NONE;
}
}
bool AreScrollWheelEventRewritesAllowed(
mojom::CustomizationRestriction customization_restriction) {
switch (customization_restriction) {
case mojom::CustomizationRestriction::kDisallowCustomizations:
case mojom::CustomizationRestriction::kDisableKeyEventRewrites:
case mojom::CustomizationRestriction::kAllowAlphabetKeyEventRewrites:
case mojom::CustomizationRestriction::
kAllowAlphabetOrNumberKeyEventRewrites:
case mojom::CustomizationRestriction::kAllowTabEventRewrites:
case mojom::CustomizationRestriction::kAllowFKeyRewrites:
return false;
case mojom::CustomizationRestriction::kAllowHorizontalScrollWheelRewrites:
case mojom::CustomizationRestriction::kAllowCustomizations:
return true;
}
}
template <typename Iterator>
std::vector<std::unique_ptr<ui::Event>> RewriteModifiers(
const ui::Event& event,
uint32_t modifiers_to_press,
uint32_t modifiers_already_pressed,
bool pressed,
Iterator begin,
Iterator end) {
std::vector<std::unique_ptr<ui::Event>> rewritten_events;
// Keeps track of the modifier flags that must be applied to the next
// rewritten event. For key presses, this should start at
// `0` and go to `modifiers_to_press`. For releases, it should do the opposite
// as we start will all modifiers down.
uint32_t modifiers_pressed = pressed ? 0u : modifiers_to_press;
for (auto iter = begin; iter != end; iter++) {
if (!(iter->flag & modifiers_to_press)) {
continue;
}
if (pressed) {
modifiers_pressed += iter->flag;
} else {
modifiers_pressed -= iter->flag;
}
const ui::EventType pressed_or_released_type =
pressed ? ui::EventType::kKeyPressed : ui::EventType::kKeyReleased;
auto rewritten_modifier_event = std::make_unique<ui::KeyEvent>(
pressed_or_released_type, iter->key_code, iter->dom_code,
modifiers_pressed | modifiers_already_pressed |
ui::EF_IS_CUSTOMIZED_FROM_BUTTON,
event.time_stamp());
rewritten_modifier_event->set_source_device_id(event.source_device_id());
rewritten_events.push_back(std::move(rewritten_modifier_event));
}
// Verify our modifier rewriting worked as expected.
if (pressed) {
CHECK_EQ(modifiers_to_press, modifiers_pressed);
} else {
CHECK_EQ(0u, modifiers_pressed);
}
return rewritten_events;
}
std::vector<std::unique_ptr<ui::Event>> GenerateFullKeyEventSequence(
const ui::Event& event,
uint32_t modifiers_to_press,
uint32_t modifiers_already_pressed,
bool pressed,
std::unique_ptr<ui::Event> rewritten_event) {
static constexpr struct {
ui::KeyboardCode key_code;
ui::DomCode dom_code;
ui::EventFlags flag;
} kModifiers[] = {
{ui::VKEY_LWIN, ui::DomCode::META_LEFT, ui::EF_COMMAND_DOWN},
{ui::VKEY_CONTROL, ui::DomCode::CONTROL_LEFT, ui::EF_CONTROL_DOWN},
{ui::VKEY_MENU, ui::DomCode::ALT_LEFT, ui::EF_ALT_DOWN},
{ui::VKEY_SHIFT, ui::DomCode::SHIFT_LEFT, ui::EF_SHIFT_DOWN},
};
static constexpr auto kModifierSpan = base::span(kModifiers);
CHECK(rewritten_event);
std::vector<std::unique_ptr<ui::Event>> rewritten_events;
if (pressed) {
// If it is a key press, we rewrite the modifiers in forward order and then
// add the main rewritten event after the press events.
rewritten_events =
RewriteModifiers(event, modifiers_to_press, modifiers_already_pressed,
pressed, kModifierSpan.begin(), kModifierSpan.end());
rewritten_events.push_back(std::move(rewritten_event));
} else {
// For key releases, we add the main rewritten event first and then append
// the rewritten modifiers after. The modifiers must be rewritten in reverse
// order from the `kModifiers` array.
rewritten_events.push_back(std::move(rewritten_event));
auto modifier_events =
RewriteModifiers(event, modifiers_to_press, modifiers_already_pressed,
pressed, kModifierSpan.rbegin(), kModifierSpan.rend());
rewritten_events.insert(rewritten_events.end(),
std::make_move_iterator(modifier_events.begin()),
std::make_move_iterator(modifier_events.end()));
}
return rewritten_events;
}
std::vector<std::unique_ptr<ui::Event>> RewriteEventToKeyEvents(
const ui::Event& event,
const mojom::KeyEvent& key_event,
int flags_to_release,
bool key_press) {
const ui::EventType event_type =
key_press ? ui::EventType::kKeyPressed : ui::EventType::kKeyReleased;
const uint32_t modifier_key_flag = ConvertKeyCodeToFlags(key_event.vkey);
// `other_modifiers_to_apply` symbolizes the flags that are not handled by
// `modifier_key_flag` or flags that are already included in the event. The
// flags remaining in `other_modifiers_to_apply` are the modifiers we must
// write events for in addition to the main key event.
// On release events, we should release the flags passed in instead of our
// computed set of flags in case some modifiers were released since we
// originally pressed them down.
// Mouse wheel is an exception here since presses and releases happen
// atomically. Therefore always release every key you originally pressed.
const uint32_t other_modifiers_to_apply =
(key_press || event.type() == ui::EventType::kMousewheel)
? (key_event.modifiers & ~event.flags() & ~modifier_key_flag)
: (flags_to_release & ~event.flags() & ~modifier_key_flag);
uint32_t applied_modifier_key_flag = modifier_key_flag;
// Do not apply modifier flags when the key is a modifier and it is a release
// event. Modifier keys do not apply their flag on release.
if (event_type == ui::EventType::kKeyReleased &&
key_event.modifiers == modifier_key_flag) {
applied_modifier_key_flag = ui::EF_NONE;
}
const bool is_rewrite_to_quick_insert =
key_event.vkey == ui::VKEY_QUICK_INSERT;
ui::KeyboardCode key_code = key_event.vkey;
if (is_rewrite_to_quick_insert) {
key_code = ui::VKEY_ASSISTANT;
}
// Use ui::DomKey::NONE so the DomKey is recomputed with applicable flags.
auto rewritten_event = std::make_unique<ui::KeyEvent>(
event_type, key_code, static_cast<ui::DomCode>(key_event.dom_code),
applied_modifier_key_flag | other_modifiers_to_apply | event.flags() |
ui::EF_IS_CUSTOMIZED_FROM_BUTTON,
ui::DomKey::NONE, event.time_stamp());
rewritten_event->set_source_device_id(event.source_device_id());
if (is_rewrite_to_quick_insert) {
ui::SetQuickInsertProperty(rewritten_event.get());
}
return GenerateFullKeyEventSequence(
event, other_modifiers_to_apply, event.flags(),
/*pressed=*/event_type == ui::EventType::kKeyPressed,
std::move(rewritten_event));
}
std::vector<std::unique_ptr<ui::Event>> RewriteEventToKeyEvents(
const ui::Event& event,
const mojom::KeyEvent& key_event,
int flags_to_release) {
// If the original event is a mouse scroll event, we must generate both a
// press and release from the single event.
const bool should_press_and_release =
event.type() == ui::EventType::kMousewheel;
const bool key_press = should_press_and_release ||
event.type() == ui::EventType::kMousePressed ||
event.type() == ui::EventType::kKeyPressed;
std::vector<std::unique_ptr<ui::Event>> rewritten_events =
RewriteEventToKeyEvents(event, key_event, flags_to_release, key_press);
if (should_press_and_release) {
std::vector<std::unique_ptr<ui::Event>> release_rewritten_events =
RewriteEventToKeyEvents(event, key_event, flags_to_release, false);
rewritten_events.reserve(rewritten_events.size() +
release_rewritten_events.size());
rewritten_events.insert(
rewritten_events.end(),
std::make_move_iterator(release_rewritten_events.begin()),
std::make_move_iterator(release_rewritten_events.end()));
}
return rewritten_events;
}
// TODO(b/339754921): Add integration test for when the display is rotated and
// adjusted via overscan boundaries.
gfx::PointF GetCurrentCursorLocation() {
auto* screen = display::Screen::GetScreen();
CHECK(screen);
const display::Display display =
screen->GetDisplayNearestPoint(screen->GetCursorScreenPoint());
// Returns the physical point on the display not considering display
// orientation.
gfx::PointF physical_screen_location =
gfx::PointF(screen->GetCursorScreenPoint() -
display.bounds().origin().OffsetFromOrigin());
// Transpose/flip the point based on the orientation of device.
auto& display_size = display.size();
switch (display.rotation()) {
case display::Display::ROTATE_0:
break;
case display::Display::ROTATE_90:
physical_screen_location.Transpose();
physical_screen_location.set_x(display_size.height() -
physical_screen_location.x());
break;
case display::Display::ROTATE_180: {
physical_screen_location.set_x(display_size.width() -
physical_screen_location.x());
physical_screen_location.set_y(display_size.height() -
physical_screen_location.y());
break;
}
case display::Display::ROTATE_270:
physical_screen_location.Transpose();
physical_screen_location.set_y(display_size.width() -
physical_screen_location.y());
break;
}
// Scale the location to match the users chosen scaling factor then apply
// overscan insets. Overscan insets are stored as post-scaled values so they
// must be applied after scaling the original location.
auto scaled_location =
gfx::ScalePoint(physical_screen_location, display.device_scale_factor());
auto overscan_insets =
Shell::Get()->display_manager()->GetOverscanInsets(display.id());
scaled_location.set_x(scaled_location.x() + overscan_insets.left());
scaled_location.set_y(scaled_location.y() + overscan_insets.top());
return scaled_location;
}
std::vector<std::unique_ptr<ui::Event>> RewriteEventToMouseButtonEvents(
const ui::Event& event,
mojom::StaticShortcutAction action) {
// If the original event is a mouse scroll event, we must generate both a
// press and release from the single event.
const bool should_press_and_release =
event.type() == ui::EventType::kMousewheel;
std::vector<std::unique_ptr<ui::Event>> rewritten_events;
auto flag_iter = kStaticActionToMouseButtonFlag.find(action);
CHECK(flag_iter != kStaticActionToMouseButtonFlag.end());
const int characteristic_flag = flag_iter->second;
const gfx::PointF location = GetCurrentCursorLocation();
const ui::EventType type = (should_press_and_release ||
event.type() == ui::EventType::kMousePressed ||
event.type() == ui::EventType::kKeyPressed)
? ui::EventType::kMousePressed
: ui::EventType::kMouseReleased;
rewritten_events.push_back(std::make_unique<ui::MouseEvent>(
type, location, location, event.time_stamp(),
event.flags() | characteristic_flag, characteristic_flag));
rewritten_events.back()->set_source_device_id(event.source_device_id());
if (should_press_and_release) {
rewritten_events.push_back(std::make_unique<ui::MouseEvent>(
ui::EventType::kMouseReleased, location, location, event.time_stamp(),
event.flags() | characteristic_flag, characteristic_flag));
rewritten_events.back()->set_source_device_id(event.source_device_id());
}
return rewritten_events;
}
bool IsMouseButtonEvent(const ui::MouseEvent& mouse_event) {
return mouse_event.type() == ui::EventType::kMousePressed ||
mouse_event.type() == ui::EventType::kMouseReleased;
}
bool IsMouseRemappableButton(int flags) {
return (flags & kMouseRemappableFlags) != 0;
}
bool IsGraphicsTabletRemappableButton(int flags) {
return (flags & kGraphicsTabletRemappableFlags) != 0;
}
int GetRemappableMouseEventFlags(
PeripheralCustomizationEventRewriter::DeviceType device_type) {
switch (device_type) {
case PeripheralCustomizationEventRewriter::DeviceType::kMouse:
return kMouseRemappableFlags;
case PeripheralCustomizationEventRewriter::DeviceType::kGraphicsTablet:
return kGraphicsTabletRemappableFlags;
}
}
mojom::ButtonPtr GetButtonFromMouseEvent(const ui::MouseEvent& mouse_event) {
switch (mouse_event.changed_button_flags()) {
case ui::EF_LEFT_MOUSE_BUTTON:
return mojom::Button::NewCustomizableButton(
mojom::CustomizableButton::kLeft);
case ui::EF_RIGHT_MOUSE_BUTTON:
return mojom::Button::NewCustomizableButton(
mojom::CustomizableButton::kRight);
case ui::EF_MIDDLE_MOUSE_BUTTON:
return mojom::Button::NewCustomizableButton(
mojom::CustomizableButton::kMiddle);
case ui::EF_FORWARD_MOUSE_BUTTON:
case ui::EF_BACK_MOUSE_BUTTON:
break;
}
CHECK(mouse_event.changed_button_flags() == ui::EF_FORWARD_MOUSE_BUTTON ||
mouse_event.changed_button_flags() == ui::EF_BACK_MOUSE_BUTTON);
auto linux_key_code = ui::GetForwardBackMouseButtonProperty(mouse_event);
if (!linux_key_code) {
return (mouse_event.changed_button_flags() == ui::EF_FORWARD_MOUSE_BUTTON)
? mojom::Button::NewCustomizableButton(
mojom::CustomizableButton::kForward)
: mojom::Button::NewCustomizableButton(
mojom::CustomizableButton::kBack);
}
switch (*linux_key_code) {
case BTN_FORWARD:
return mojom::Button::NewCustomizableButton(
mojom::CustomizableButton::kForward);
case BTN_BACK:
return mojom::Button::NewCustomizableButton(
mojom::CustomizableButton::kBack);
case BTN_SIDE:
return mojom::Button::NewCustomizableButton(
mojom::CustomizableButton::kSide);
case BTN_EXTRA:
return mojom::Button::NewCustomizableButton(
mojom::CustomizableButton::kExtra);
}
NOTREACHED();
}
// Returns the customizable button for the scroll wheel event. Will return null
// if the scroll event is not a horizontal scroll event.
mojom::ButtonPtr GetButtonFromMouseWheelEvent(
const ui::MouseWheelEvent& mouse_wheel_event) {
if (mouse_wheel_event.x_offset() == 0) {
return nullptr;
}
if (mouse_wheel_event.x_offset() > 0) {
return mojom::Button::NewCustomizableButton(
mojom::CustomizableButton::kScrollRight);
}
return mojom::Button::NewCustomizableButton(
mojom::CustomizableButton::kScrollLeft);
}
int ConvertButtonToFlags(const mojom::Button& button) {
if (button.is_customizable_button()) {
switch (button.get_customizable_button()) {
case mojom::CustomizableButton::kLeft:
return ui::EF_LEFT_MOUSE_BUTTON;
case mojom::CustomizableButton::kRight:
return ui::EF_RIGHT_MOUSE_BUTTON;
case mojom::CustomizableButton::kMiddle:
return ui::EF_MIDDLE_MOUSE_BUTTON;
case mojom::CustomizableButton::kForward:
case mojom::CustomizableButton::kExtra:
return ui::EF_FORWARD_MOUSE_BUTTON;
case mojom::CustomizableButton::kBack:
case mojom::CustomizableButton::kSide:
return ui::EF_BACK_MOUSE_BUTTON;
case mojom::CustomizableButton::kScrollLeft:
case mojom::CustomizableButton::kScrollRight:
return ui::EF_NONE;
}
}
if (button.is_vkey()) {
return ConvertKeyCodeToFlags(button.get_vkey());
}
return ui::EF_NONE;
}
std::optional<ui::mojom::ModifierKey> ConvertDomCodeToModifierKey(
ui::DomCode code) {
switch (code) {
case ui::DomCode::META_LEFT:
case ui::DomCode::META_RIGHT:
return ui::mojom::ModifierKey::kMeta;
case ui::DomCode::CONTROL_LEFT:
case ui::DomCode::CONTROL_RIGHT:
return ui::mojom::ModifierKey::kControl;
case ui::DomCode::ALT_LEFT:
case ui::DomCode::ALT_RIGHT:
return ui::mojom::ModifierKey::kAlt;
case ui::DomCode::CAPS_LOCK:
return ui::mojom::ModifierKey::kCapsLock;
case ui::DomCode::BACKSPACE:
return ui::mojom::ModifierKey::kBackspace;
case ui::DomCode::LAUNCH_ASSISTANT:
return ui::mojom::ModifierKey::kAssistant;
case ui::DomCode::ESCAPE:
return ui::mojom::ModifierKey::kEscape;
default:
return std::nullopt;
}
}
std::optional<PeripheralCustomizationEventRewriter::RemappingActionResult>
GetRemappingActionFromMouseSettings(const mojom::Button& button,
const mojom::MouseSettings& settings) {
const auto button_remapping_iter = std::ranges::find(
settings.button_remappings, button,
[](const mojom::ButtonRemappingPtr& entry) { return *entry->button; });
if (button_remapping_iter != settings.button_remappings.end()) {
const mojom::ButtonRemapping& button_remapping = *(*button_remapping_iter);
if (!button_remapping.remapping_action) {
return std::nullopt;
}
auto result = PeripheralCustomizationEventRewriter::RemappingActionResult(
*button_remapping.remapping_action,
InputDeviceSettingsMetricsManager::PeripheralCustomizationMetricsType::
kMouse);
return result;
}
return std::nullopt;
}
std::optional<PeripheralCustomizationEventRewriter::RemappingActionResult>
GetRemappingActionFromGraphicsTabletSettings(
const mojom::Button& button,
const mojom::GraphicsTabletSettings& settings) {
const auto pen_button_remapping_iter = std::ranges::find(
settings.pen_button_remappings, button,
[](const mojom::ButtonRemappingPtr& entry) { return *entry->button; });
if (pen_button_remapping_iter != settings.pen_button_remappings.end()) {
const mojom::ButtonRemapping& button_remapping =
*(*pen_button_remapping_iter);
if (!button_remapping.remapping_action) {
return std::nullopt;
}
auto pen_action =
PeripheralCustomizationEventRewriter::RemappingActionResult(
*button_remapping.remapping_action,
InputDeviceSettingsMetricsManager::
PeripheralCustomizationMetricsType::kGraphicsTabletPen);
return std::move(pen_action);
}
const auto tablet_button_remapping_iter = std::ranges::find(
settings.tablet_button_remappings, button,
[](const mojom::ButtonRemappingPtr& entry) { return *entry->button; });
if (tablet_button_remapping_iter != settings.tablet_button_remappings.end()) {
const mojom::ButtonRemapping& button_remapping =
*(*tablet_button_remapping_iter);
if (!button_remapping.remapping_action) {
return std::nullopt;
}
auto tablet_action =
PeripheralCustomizationEventRewriter::RemappingActionResult(
*button_remapping.remapping_action,
InputDeviceSettingsMetricsManager::
PeripheralCustomizationMetricsType::kGraphicsTablet);
return std::move(tablet_action);
}
return std::nullopt;
}
int GetRemappedModifiersFromMouseSettings(
const mojom::MouseSettings& settings) {
int modifiers = 0;
for (const auto& button_remapping : settings.button_remappings) {
if (button_remapping->remapping_action) {
modifiers |= ConvertButtonToFlags(*button_remapping->button);
}
}
return modifiers;
}
int GetRemappedModifiersFromGraphicsTabletSettings(
const mojom::GraphicsTabletSettings& settings) {
int modifiers = 0;
for (const auto& button_remapping : settings.pen_button_remappings) {
modifiers |= ConvertButtonToFlags(*button_remapping->button);
}
for (const auto& button_remapping : settings.tablet_button_remappings) {
modifiers |= ConvertButtonToFlags(*button_remapping->button);
}
return modifiers;
}
// Verify if the keyboard code is an alpha key or punctuation.
bool IsAlphaKeyEvent(const ui::KeyEvent& key_event) {
return GetKeyInputTypeFromKeyEvent(key_event) ==
AcceleratorKeyInputType::kAlpha;
}
// Verify if the keyboard code is a number.
bool IsNumberKeyEvent(const ui::KeyEvent& key_event) {
return GetKeyInputTypeFromKeyEvent(key_event) ==
AcceleratorKeyInputType::kDigit;
}
void RecordMouseInvalidKeyPressed(InputDeviceSettingsController* controller,
const ui::KeyEvent& key_event) {
if (key_event.type() == ui::EventType::kKeyReleased ||
key_event.is_repeat()) {
return;
}
auto* mouse = controller->GetMouse(key_event.source_device_id());
auto* keyboard = controller->GetKeyboard(key_event.source_device_id());
if (!mouse) {
return;
}
if (mouse && keyboard) {
base::UmaHistogramSparse("ChromeOS.Inputs.Mouse.InvalidRegistration.Combo",
key_event.key_code());
return;
}
if (mouse) {
base::UmaHistogramSparse(
"ChromeOS.Inputs.Mouse.InvalidRegistration.NonCombo",
key_event.key_code());
}
LOG(WARNING) << base::StringPrintf(
"Mouse '%s' with identifier '%s' attempted to register keyboard code "
"'%04x'.",
mouse->name.c_str(), mouse->device_key.c_str(), key_event.key_code());
base::UmaHistogramSparse("ChromeOS.Inputs.Mouse.InvalidRegistration",
key_event.key_code());
}
} // namespace
// Compares the `DeviceIdButton` struct based on first the device id, and then
// the button stored within the `DeviceIdButton` struct.
bool operator<(
const PeripheralCustomizationEventRewriter::DeviceIdButton& left,
const PeripheralCustomizationEventRewriter::DeviceIdButton& right) {
if (right.device_id != left.device_id) {
return left.device_id < right.device_id;
}
// If both are VKeys, compare them.
if (left.button->is_vkey() && right.button->is_vkey()) {
return left.button->get_vkey() < right.button->get_vkey();
}
// If both are customizable buttons, compare them.
if (left.button->is_customizable_button() &&
right.button->is_customizable_button()) {
return left.button->get_customizable_button() <
right.button->get_customizable_button();
}
// Otherwise, return true if the lhs is a VKey as they mismatch and VKeys
// should be considered less than customizable buttons.
return left.button->is_vkey();
}
PeripheralCustomizationEventRewriter::DeviceIdButton::DeviceIdButton(
int device_id,
mojom::ButtonPtr button)
: device_id(device_id), button(std::move(button)) {}
PeripheralCustomizationEventRewriter::DeviceIdButton::DeviceIdButton(
DeviceIdButton&& device_id_button)
: device_id(device_id_button.device_id),
button(std::move(device_id_button.button)) {}
PeripheralCustomizationEventRewriter::DeviceIdButton::~DeviceIdButton() =
default;
PeripheralCustomizationEventRewriter::DeviceIdButton&
PeripheralCustomizationEventRewriter::DeviceIdButton::operator=(
PeripheralCustomizationEventRewriter::DeviceIdButton&& device_id_button) =
default;
PeripheralCustomizationEventRewriter::RemappingActionResult::
RemappingActionResult(
mojom::RemappingAction& remapping_action,
InputDeviceSettingsMetricsManager::PeripheralCustomizationMetricsType
peripheral_kind)
: remapping_action(remapping_action), peripheral_kind(peripheral_kind) {}
PeripheralCustomizationEventRewriter::RemappingActionResult::
RemappingActionResult(RemappingActionResult&& result)
: remapping_action(std::move(result.remapping_action)),
peripheral_kind(result.peripheral_kind) {}
PeripheralCustomizationEventRewriter::RemappingActionResult::
~RemappingActionResult() = default;
PeripheralCustomizationEventRewriter::PeripheralCustomizationEventRewriter(
InputDeviceSettingsController* input_device_settings_controller)
: input_device_settings_controller_(input_device_settings_controller) {
metrics_manager_ = std::make_unique<InputDeviceSettingsMetricsManager>();
}
PeripheralCustomizationEventRewriter::~PeripheralCustomizationEventRewriter() =
default;
std::optional<PeripheralCustomizationEventRewriter::DeviceType>
PeripheralCustomizationEventRewriter::GetDeviceTypeToObserve(int device_id) {
if (mice_to_observe_.contains(device_id)) {
return DeviceType::kMouse;
}
if (graphics_tablets_to_observe_.contains(device_id)) {
return DeviceType::kGraphicsTablet;
}
return std::nullopt;
}
void PeripheralCustomizationEventRewriter::StartObservingMouse(
int device_id,
mojom::CustomizationRestriction customization_restriction) {
mice_to_observe_.insert_or_assign(device_id, customization_restriction);
}
void PeripheralCustomizationEventRewriter::StartObservingGraphicsTablet(
int device_id,
mojom::CustomizationRestriction customization_restriction) {
graphics_tablets_to_observe_.insert_or_assign(device_id,
customization_restriction);
}
void PeripheralCustomizationEventRewriter::StopObserving() {
graphics_tablets_to_observe_.clear();
mice_to_observe_.clear();
}
bool PeripheralCustomizationEventRewriter::NotifyMouseWheelEventObserving(
const ui::MouseWheelEvent& mouse_wheel_event,
DeviceType device_type) {
const auto customization_restriction_iter =
mice_to_observe_.find(mouse_wheel_event.source_device_id());
if (customization_restriction_iter == mice_to_observe_.end()) {
return false;
}
auto customization_restriction = customization_restriction_iter->second;
if (!AreScrollWheelEventRewritesAllowed(customization_restriction)) {
return false;
}
const mojom::ButtonPtr button =
GetButtonFromMouseWheelEvent(mouse_wheel_event);
if (!button) {
return false;
}
switch (device_type) {
case DeviceType::kMouse:
input_device_settings_controller_->OnMouseButtonPressed(
mouse_wheel_event.source_device_id(), *button);
break;
case DeviceType::kGraphicsTablet:
input_device_settings_controller_->OnGraphicsTabletButtonPressed(
mouse_wheel_event.source_device_id(), *button);
break;
}
return true;
}
bool PeripheralCustomizationEventRewriter::NotifyMouseEventObserving(
const ui::MouseEvent& mouse_event,
DeviceType device_type) {
if (!IsMouseButtonEvent(mouse_event)) {
return false;
}
// Make sure the button is remappable for the current `device_type`.
switch (device_type) {
case DeviceType::kMouse:
if (!IsMouseRemappableButton(mouse_event.changed_button_flags())) {
return false;
}
break;
case DeviceType::kGraphicsTablet:
if (!IsGraphicsTabletRemappableButton(
mouse_event.changed_button_flags())) {
return false;
}
break;
}
if (mouse_event.type() != ui::EventType::kMousePressed) {
return true;
}
const auto button = GetButtonFromMouseEvent(mouse_event);
switch (device_type) {
case DeviceType::kMouse:
input_device_settings_controller_->OnMouseButtonPressed(
mouse_event.source_device_id(), *button);
break;
case DeviceType::kGraphicsTablet:
input_device_settings_controller_->OnGraphicsTabletButtonPressed(
mouse_event.source_device_id(), *button);
break;
}
return true;
}
bool PeripheralCustomizationEventRewriter::IsButtonCustomizable(
const ui::KeyEvent& key_event) {
const auto iter = mice_to_observe_.find(key_event.source_device_id());
if (iter == mice_to_observe().end()) {
return false;
}
const auto customization_restriction = iter->second;
// There are several cases for the customization restriction:
// 1. If restriction is kAllowCustomizations, mice are allowed to observe
// key events.
// 2. If restriction is kAllowAlphabetKeyEventRewrites, mice are allowed to
// observe only alphabet or punctuation events.
// 3. If restriction is kAllowAlphabetOrNumberKeyEventRewrites, mice are
// allowed to observe alphabet, punctuation, or number key event.
// 4. Mice are not allowed to observe key event in other cases.
switch (customization_restriction) {
case mojom::CustomizationRestriction::kAllowCustomizations:
return true;
case mojom::CustomizationRestriction::kAllowAlphabetKeyEventRewrites:
return IsAlphaKeyEvent(key_event);
case mojom::CustomizationRestriction::
kAllowAlphabetOrNumberKeyEventRewrites:
return IsAlphaKeyEvent(key_event) || IsNumberKeyEvent(key_event);
case mojom::CustomizationRestriction::kAllowTabEventRewrites:
return key_event.key_code() == ui::VKEY_TAB;
case mojom::CustomizationRestriction::kAllowFKeyRewrites:
return key_event.key_code() >= ui::VKEY_F1 &&
key_event.key_code() <= ui::VKEY_F15;
case mojom::CustomizationRestriction::kDisallowCustomizations:
case mojom::CustomizationRestriction::kDisableKeyEventRewrites:
case mojom::CustomizationRestriction::kAllowHorizontalScrollWheelRewrites:
return false;
}
}
bool PeripheralCustomizationEventRewriter::NotifyKeyEventObserving(
const ui::KeyEvent& key_event,
DeviceType device_type) {
if (device_type == DeviceType::kMouse && !IsButtonCustomizable(key_event)) {
RecordMouseInvalidKeyPressed(input_device_settings_controller_, key_event);
return false;
}
// Observers should only be notified on key presses.
if (key_event.type() != ui::EventType::kKeyPressed) {
return true;
}
const auto button = mojom::Button::NewVkey(key_event.key_code());
switch (device_type) {
case DeviceType::kMouse:
input_device_settings_controller_->OnMouseButtonPressed(
key_event.source_device_id(), *button);
break;
case DeviceType::kGraphicsTablet:
input_device_settings_controller_->OnGraphicsTabletButtonPressed(
key_event.source_device_id(), *button);
break;
}
return true;
}
bool PeripheralCustomizationEventRewriter::RewriteEventFromButton(
const ui::Event& event,
const mojom::Button& button,
std::vector<std::unique_ptr<ui::Event>>& rewritten_events) {
std::optional<RemappingActionResult> remapping_action_result =
GetRemappingAction(event.source_device_id(), button);
if (!remapping_action_result) {
return false;
}
auto remapping_action = remapping_action_result->remapping_action;
if (event.type() == ui::EventType::kKeyPressed ||
event.type() == ui::EventType::kMousePressed) {
metrics_manager_->RecordRemappingActionWhenButtonPressed(
*remapping_action, remapping_action_result->peripheral_kind);
}
auto id = event.source_device_id();
switch (remapping_action_result->peripheral_kind) {
case InputDeviceSettingsMetricsManager::PeripheralCustomizationMetricsType::
kMouse:
PR_LOG(INFO, Feature::IDS) << GetMouseSettingsLog(
"Mouse button is pressed",
*(input_device_settings_controller_->GetMouse(id)));
break;
case InputDeviceSettingsMetricsManager::PeripheralCustomizationMetricsType::
kGraphicsTablet:
PR_LOG(INFO, Feature::IDS) << GetGraphicsTabletSettingsLog(
"Graphics tablet button is pressed",
*(input_device_settings_controller_->GetGraphicsTablet(id)));
break;
case InputDeviceSettingsMetricsManager::PeripheralCustomizationMetricsType::
kGraphicsTabletPen:
PR_LOG(INFO, Feature::IDS) << GetGraphicsTabletSettingsLog(
"Graphics tablet pen button is pressed",
*(input_device_settings_controller_->GetGraphicsTablet(id)));
break;
}
if (remapping_action->is_accelerator_action()) {
if (event.type() == ui::EventType::kKeyPressed ||
event.type() == ui::EventType::kMousePressed ||
event.type() == ui::EventType::kMousewheel) {
// Every accelerator supported by peripheral customization is not impacted
// by the accelerator passed. Therefore, passing an empty accelerator will
// cause no issues.
Shell::Get()->accelerator_controller()->PerformActionIfEnabled(
remapping_action->get_accelerator_action(), /*accelerator=*/{});
}
return true;
}
// Get flags to release in rewriting key events.
int flags_to_release = 0;
auto iter =
device_button_to_flags_.find({event.source_device_id(), button.Clone()});
if (iter != device_button_to_flags_.end()) {
flags_to_release = iter->second;
}
if (remapping_action->is_key_event()) {
const auto& key_event = remapping_action->get_key_event();
auto entry = FindKeyCodeEntry(key_event->vkey);
// If no entry can be found, use the stored key_event struct.
if (!entry) {
rewritten_events =
RewriteEventToKeyEvents(event, *key_event, flags_to_release);
} else {
rewritten_events = RewriteEventToKeyEvents(
event,
mojom::KeyEvent(
entry->resulting_key_code, static_cast<int>(entry->dom_code),
static_cast<int>(entry->dom_key), key_event->modifiers, ""),
flags_to_release);
}
}
if (remapping_action->is_static_shortcut_action()) {
const auto static_action = remapping_action->get_static_shortcut_action();
if (static_action == mojom::StaticShortcutAction::kDisable) {
// Return true to discard the event.
return true;
}
if (kStaticActionToMouseButtonFlag.contains(static_action)) {
rewritten_events = RewriteEventToMouseButtonEvents(event, static_action);
} else {
rewritten_events = RewriteEventToKeyEvents(
event,
GetStaticShortcutAction(
remapping_action->get_static_shortcut_action()),
flags_to_release);
}
}
return false;
}
ui::EventDispatchDetails PeripheralCustomizationEventRewriter::RewriteKeyEvent(
const ui::KeyEvent& key_event,
const Continuation continuation) {
auto device_type_to_observe =
GetDeviceTypeToObserve(key_event.source_device_id());
if (device_type_to_observe) {
if (NotifyKeyEventObserving(key_event, *device_type_to_observe)) {
return DiscardEvent(continuation);
}
}
// Clone event and remove the already remapped modifiers and use this as the
// "source" key event for the rest of the rewriting.
std::unique_ptr<ui::Event> original_event_with_modifiers_removed =
CloneEvent(key_event);
RemoveRemappedModifiers(*original_event_with_modifiers_removed);
std::vector<std::unique_ptr<ui::Event>> rewritten_events;
mojom::ButtonPtr button = mojom::Button::NewVkey(key_event.key_code());
bool updated_button_map = false;
if (RewriteEventFromButton(*original_event_with_modifiers_removed, *button,
rewritten_events)) {
return DiscardEvent(continuation);
}
const bool event_rewritten = !rewritten_events.empty();
// Discard all "button" type events usually from graphics tablets.
if (!event_rewritten && key_event.key_code() >= ui::VKEY_BUTTON_0 &&
key_event.key_code() <= ui::VKEY_BUTTON_Z) {
return DiscardEvent(continuation);
}
// Add an event to our list to rewrite based on other pressed buttons.
if (rewritten_events.empty()) {
rewritten_events.push_back(
std::move(original_event_with_modifiers_removed));
}
// If the button was released, the pressed button map must be updated before
// applying remapped modifiers.
const ui::Event& last_rewritten_event = *rewritten_events.back();
if (event_rewritten &&
(last_rewritten_event.type() == ui::EventType::kMouseReleased ||
last_rewritten_event.type() == ui::EventType::kKeyReleased)) {
updated_button_map = true;
UpdatePressedButtonMap(std::move(button), key_event, rewritten_events);
}
// Remove flags from modifiers that are released on other devices.
if (!event_rewritten) {
UpdatePressedButtonMapFlags(key_event);
}
for (const auto& rewritten_event : rewritten_events) {
ApplyRemappedModifiers(*rewritten_event);
}
if (event_rewritten && !updated_button_map) {
UpdatePressedButtonMap(std::move(button), key_event, rewritten_events);
}
ui::EventDispatchDetails details;
for (const auto& rewritten_event : rewritten_events) {
details = SendEvent(continuation, rewritten_event.get());
}
return details;
}
void PeripheralCustomizationEventRewriter::UpdatePressedButtonMap(
mojom::ButtonPtr button,
const ui::Event& original_event,
const std::vector<std::unique_ptr<ui::Event>>& rewritten_events) {
// Scroll wheel events cannot affect other events modifiers since they do a
// full press/release sequence with the one event.
if (original_event.type() == ui::EventType::kMousewheel) {
return;
}
DeviceIdButton device_id_button_key =
DeviceIdButton{original_event.source_device_id(), std::move(button)};
// If the button is released, the entry must be removed from the map.
if (original_event.type() == ui::EventType::kMouseReleased ||
original_event.type() == ui::EventType::kKeyReleased) {
device_button_to_flags_.erase(std::move(device_id_button_key));
// Release all modifier flags on other currently pressed buttons.
for (const auto& rewritten_event : rewritten_events) {
if (rewritten_event->IsKeyEvent()) {
UpdatePressedButtonMapFlags(*rewritten_event->AsKeyEvent());
}
}
return;
}
// For each rewritten event, combine the flags that need to be applied to
// correctly handle the newly pressed event. This matters when pressing a
// modifier or a key with a combo of modifiers or when holding a rewritten
// mouse button.
ui::EventFlags event_flags = 0;
for (const auto& rewritten_event : rewritten_events) {
if (!rewritten_event) {
continue;
}
if (rewritten_event->IsKeyEvent()) {
const auto& key_event = *rewritten_event->AsKeyEvent();
event_flags |= ConvertKeyCodeToFlags(key_event.key_code());
continue;
}
if (rewritten_event->IsMouseEvent()) {
const auto& mouse_event = *rewritten_event->AsMouseEvent();
event_flags |= mouse_event.changed_button_flags();
continue;
}
}
if (!event_flags) {
return;
}
// Add the entry to the map with the flags that must be applied to other
// events.
device_button_to_flags_.insert_or_assign(std::move(device_id_button_key),
event_flags);
}
void PeripheralCustomizationEventRewriter::UpdatePressedButtonMapFlags(
const ui::KeyEvent& key_event) {
if (key_event.type() == ui::EventType::kKeyPressed) {
return;
}
// Remap the released key based on modifier remappings.
auto* settings = input_device_settings_controller_->GetKeyboardSettings(
key_event.source_device_id());
auto modifier_key = ConvertDomCodeToModifierKey(key_event.code());
int key_event_characteristic_flag =
ConvertKeyCodeToFlags(key_event.key_code());
// Modifiers only need to be remapped now if the rewriter fix is disabled.
if (!features::IsKeyboardRewriterFixEnabled() && settings && modifier_key) {
auto iter = settings->modifier_remappings.find(*modifier_key);
if (iter != settings->modifier_remappings.end()) {
key_event_characteristic_flag = ConvertModifierKeyToFlags(iter->second);
}
}
// Remove the key event characteristic flag as the key has already been
// released and should no longer apply the flag to other pressed events.
for (auto& [_, flag] : device_button_to_flags_) {
flag &= ~key_event_characteristic_flag;
}
}
ui::EventDispatchDetails
PeripheralCustomizationEventRewriter::RewriteMouseWheelEvent(
const ui::MouseWheelEvent& mouse_wheel_event,
const Continuation continuation) {
auto device_type_to_observe =
GetDeviceTypeToObserve(mouse_wheel_event.source_device_id());
if (device_type_to_observe) {
if (NotifyMouseWheelEventObserving(mouse_wheel_event,
*device_type_to_observe)) {
return DiscardEvent(continuation);
}
// Otherwise, the flags must be cleared for the remappable buttons so they
// do not affect the application while the mouse is meant to be observed.
std::unique_ptr<ui::Event> rewritten_event = CloneEvent(mouse_wheel_event);
const int remappable_flags =
GetRemappableMouseEventFlags(*device_type_to_observe);
rewritten_event->SetFlags(rewritten_event->flags() & ~remappable_flags);
if (rewritten_event->IsMouseEvent()) {
auto& rewritten_mouse_event = *rewritten_event->AsMouseEvent();
rewritten_mouse_event.set_changed_button_flags(
rewritten_mouse_event.changed_button_flags() & ~remappable_flags);
}
return SendEvent(continuation, rewritten_event.get());
}
// Clone event and remove the already remapped modifiers and use this as the
// "source" key event for the rest of the rewriting.
std::unique_ptr<ui::Event> original_event_with_modifiers_removed =
CloneEvent(mouse_wheel_event);
RemoveRemappedModifiers(*original_event_with_modifiers_removed);
std::vector<std::unique_ptr<ui::Event>> rewritten_events;
mojom::ButtonPtr button = GetButtonFromMouseWheelEvent(mouse_wheel_event);
bool updated_button_map = false;
if (!button.is_null()) {
if (RewriteEventFromButton(*original_event_with_modifiers_removed, *button,
rewritten_events)) {
return DiscardEvent(continuation);
}
}
const bool event_rewritten = !rewritten_events.empty();
// Add an event to our list to rewrite based on other pressed buttons.
if (!event_rewritten) {
rewritten_events.push_back(
std::move(original_event_with_modifiers_removed));
}
// If the button was released, the pressed button map must be updated before
// applying remapped modifiers.
const ui::Event& last_rewritten_event = *rewritten_events.back();
if (event_rewritten &&
(last_rewritten_event.type() == ui::EventType::kMouseReleased ||
last_rewritten_event.type() == ui::EventType::kKeyReleased)) {
updated_button_map = true;
UpdatePressedButtonMap(std::move(button), mouse_wheel_event,
rewritten_events);
}
for (const auto& rewritten_event : rewritten_events) {
ApplyRemappedModifiers(*rewritten_event);
}
if (event_rewritten && !updated_button_map) {
UpdatePressedButtonMap(std::move(button), mouse_wheel_event,
rewritten_events);
}
ui::EventDispatchDetails details;
for (const auto& rewritten_event : rewritten_events) {
details = SendEvent(continuation, rewritten_event.get());
}
return details;
}
ui::EventDispatchDetails
PeripheralCustomizationEventRewriter::RewriteMouseEvent(
const ui::MouseEvent& mouse_event,
const Continuation continuation) {
auto device_type_to_observe =
GetDeviceTypeToObserve(mouse_event.source_device_id());
if (device_type_to_observe) {
if (NotifyMouseEventObserving(mouse_event, *device_type_to_observe)) {
return DiscardEvent(continuation);
}
// Otherwise, the flags must be cleared for the remappable buttons so they
// do not affect the application while the mouse is meant to be observed.
std::unique_ptr<ui::Event> rewritten_event = CloneEvent(mouse_event);
const int remappable_flags =
GetRemappableMouseEventFlags(*device_type_to_observe);
rewritten_event->SetFlags(rewritten_event->flags() & ~remappable_flags);
if (rewritten_event->IsMouseEvent()) {
auto& rewritten_mouse_event = *rewritten_event->AsMouseEvent();
rewritten_mouse_event.set_changed_button_flags(
rewritten_mouse_event.changed_button_flags() & ~remappable_flags);
}
return SendEvent(continuation, rewritten_event.get());
}
// Clone event and remove the already remapped modifiers and use this as the
// "source" key event for the rest of the rewriting.
std::unique_ptr<ui::Event> original_event_with_modifiers_removed =
CloneEvent(mouse_event);
RemoveRemappedModifiers(*original_event_with_modifiers_removed);
std::vector<std::unique_ptr<ui::Event>> rewritten_events;
mojom::ButtonPtr button;
bool updated_button_map = false;
if (IsMouseButtonEvent(mouse_event) && mouse_event.changed_button_flags()) {
button = GetButtonFromMouseEvent(mouse_event);
if (RewriteEventFromButton(*original_event_with_modifiers_removed, *button,
rewritten_events)) {
return DiscardEvent(continuation);
}
}
const bool event_rewritten = !rewritten_events.empty();
// Add an event to our list to rewrite based on other pressed buttons.
if (!event_rewritten) {
rewritten_events.push_back(
std::move(original_event_with_modifiers_removed));
}
// If the button was released, the pressed button map must be updated before
// applying remapped modifiers.
const ui::Event& last_rewritten_event = *rewritten_events.back();
if (event_rewritten &&
(last_rewritten_event.type() == ui::EventType::kMouseReleased ||
last_rewritten_event.type() == ui::EventType::kKeyReleased)) {
updated_button_map = true;
UpdatePressedButtonMap(std::move(button), mouse_event, rewritten_events);
}
for (const auto& rewritten_event : rewritten_events) {
ApplyRemappedModifiers(*rewritten_event);
}
if (event_rewritten && !updated_button_map) {
UpdatePressedButtonMap(std::move(button), mouse_event, rewritten_events);
}
ui::EventDispatchDetails details;
for (const auto& rewritten_event : rewritten_events) {
details = SendEvent(continuation, rewritten_event.get());
}
return details;
}
ui::EventDispatchDetails PeripheralCustomizationEventRewriter::RewriteEvent(
const ui::Event& event,
const Continuation continuation) {
if (event.IsMouseWheelEvent()) {
return RewriteMouseWheelEvent(*event.AsMouseWheelEvent(), continuation);
}
if (event.IsMouseEvent()) {
return RewriteMouseEvent(*event.AsMouseEvent(), continuation);
}
if (event.IsKeyEvent()) {
return RewriteKeyEvent(*event.AsKeyEvent(), continuation);
}
return SendEvent(continuation, &event);
}
std::optional<PeripheralCustomizationEventRewriter::RemappingActionResult>
PeripheralCustomizationEventRewriter::GetRemappingAction(
int device_id,
const mojom::Button& button) {
const auto* mouse_settings =
input_device_settings_controller_->GetMouseSettings(device_id);
if (mouse_settings) {
return GetRemappingActionFromMouseSettings(button, *mouse_settings);
}
const auto* graphics_tablet_settings =
input_device_settings_controller_->GetGraphicsTabletSettings(device_id);
if (graphics_tablet_settings) {
return GetRemappingActionFromGraphicsTabletSettings(
button, *graphics_tablet_settings);
}
return std::nullopt;
}
void PeripheralCustomizationEventRewriter::RemoveRemappedModifiers(
ui::Event& event) {
int modifier_flags = 0;
if (const auto* mouse_settings =
input_device_settings_controller_->GetMouseSettings(
event.source_device_id());
mouse_settings) {
modifier_flags = GetRemappedModifiersFromMouseSettings(*mouse_settings);
} else if (const auto* graphics_tablet_settings =
input_device_settings_controller_->GetGraphicsTabletSettings(
event.source_device_id());
graphics_tablet_settings) {
modifier_flags = GetRemappedModifiersFromGraphicsTabletSettings(
*graphics_tablet_settings);
}
// TODO(dpad): This logic isn't quite correct. If a second devices is holding
// "Ctrl" and the original device has a button that is "Ctrl" that is
// remapped, this will behave incorrectly as it will remove "Ctrl". Instead,
// this needs to track what keys are being pressed by the device that have
// modifiers attached to them. For now, this is close enough to being correct.
if (modifier_flags) {
event.SetFlags(event.flags() & ~modifier_flags);
}
}
void PeripheralCustomizationEventRewriter::ApplyRemappedModifiers(
ui::Event& event) {
int flags = 0;
for (const auto& [_, flag] : device_button_to_flags_) {
flags |= flag;
}
if (flags) {
event.SetFlags(event.flags() | flags);
}
}
std::unique_ptr<ui::Event> PeripheralCustomizationEventRewriter::CloneEvent(
const ui::Event& event) {
std::unique_ptr<ui::Event> cloned_event = event.Clone();
// SetNativeEvent must be called explicitly as native events are not copied
// on ChromeOS by default. This is because `PlatformEvent` is a pointer by
// default, so its lifetime can not be guaranteed in general. In this case,
// the lifetime of `rewritten_event` is guaranteed to be less than the
// original `mouse_event`.
SetNativeEvent(*cloned_event, event.native_event());
return cloned_event;
}
} // namespace ash
|