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 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631
|
// Copyright 2015 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/exo/keyboard.h"
#include "ash/accelerators/accelerator_controller_impl.h"
#include "ash/accessibility/accessibility_controller_impl.h"
#include "ash/constants/app_types.h"
#include "ash/constants/ash_features.h"
#include "ash/constants/ash_pref_names.h"
#include "ash/keyboard/keyboard_controller_impl.h"
#include "ash/public/cpp/external_arc/overlay/arc_overlay_manager.h"
#include "ash/shell.h"
#include "ash/test/ash_test_helper.h"
#include "ash/test/test_widget_builder.h"
#include "ash/test/test_window_builder.h"
#include "ash/wm/desks/desks_controller.h"
#include "ash/wm/desks/desks_test_util.h"
#include "ash/wm/tablet_mode/tablet_mode_controller.h"
#include "base/memory/raw_ptr.h"
#include "base/run_loop.h"
#include "base/test/scoped_feature_list.h"
#include "components/exo/buffer.h"
#include "components/exo/keyboard_delegate.h"
#include "components/exo/keyboard_device_configuration_delegate.h"
#include "components/exo/keyboard_modifiers.h"
#include "components/exo/keyboard_observer.h"
#include "components/exo/seat.h"
#include "components/exo/shell_surface.h"
#include "components/exo/surface.h"
#include "components/exo/test/exo_test_base.h"
#include "components/exo/test/exo_test_helper.h"
#include "components/exo/test/shell_surface_builder.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "ui/aura/client/aura_constants.h"
#include "ui/aura/client/focus_client.h"
#include "ui/base/accelerators/test_accelerator_target.h"
#include "ui/base/ime/constants.h"
#include "ui/base/ime/dummy_text_input_client.h"
#include "ui/base/ime/events.h"
#include "ui/events/devices/device_data_manager.h"
#include "ui/events/event_constants.h"
#include "ui/events/keycodes/dom/dom_code.h"
#include "ui/events/ozone/events_ozone.h"
#include "ui/events/test/event_generator.h"
#include "ui/events/types/event_type.h"
#include "ui/views/controls/textfield/textfield.h"
namespace exo {
namespace {
// XKB mod masks for the default keymap.
constexpr uint32_t kShiftMask = 1 << 0;
constexpr uint32_t kControlMask = 1 << 2;
constexpr uint32_t kAltMask = 1 << 3;
constexpr uint32_t kNumLockMask = 1 << 4;
constexpr uint32_t kCommandMask = 1 << 6;
class KeyboardTest : public test::ExoTestBase {
public:
KeyboardTest()
: test::ExoTestBase(base::test::TaskEnvironment::TimeSource::MOCK_TIME) {}
~KeyboardTest() override = default;
};
class KeyboardKeyTest : public KeyboardTest,
public testing::WithParamInterface<bool> {
public:
void SetUp() override {
if (GetParam()) {
feature_list_.InitAndEnableFeature(
ash::features::kExoConsumedByImeByFlag);
} else {
feature_list_.InitAndDisableFeature(
ash::features::kExoConsumedByImeByFlag);
}
KeyboardTest::SetUp();
}
private:
base::test::ScopedFeatureList feature_list_;
};
INSTANTIATE_TEST_SUITE_P(, KeyboardKeyTest, ::testing::Bool());
class MockKeyboardDelegate : public KeyboardDelegate {
public:
MockKeyboardDelegate() = default;
// Overridden from KeyboardDelegate:
MOCK_METHOD(bool, CanAcceptKeyboardEventsForSurface, (Surface*), (const));
MOCK_METHOD(void,
OnKeyboardEnter,
(Surface*, (const base::flat_map<ui::DomCode, KeyState>&)));
MOCK_METHOD(void, OnKeyboardLeave, (Surface*));
MOCK_METHOD(uint32_t, OnKeyboardKey, (base::TimeTicks, ui::DomCode, bool));
MOCK_METHOD(void, OnKeyboardModifiers, (const KeyboardModifiers&));
MOCK_METHOD(void,
OnKeyRepeatSettingsChanged,
(bool, base::TimeDelta, base::TimeDelta));
MOCK_METHOD(void, OnKeyboardLayoutUpdated, (base::StringPiece));
};
using NiceMockKeyboardDelegate = ::testing::NiceMock<MockKeyboardDelegate>;
class MockKeyboardDeviceConfigurationDelegate
: public KeyboardDeviceConfigurationDelegate {
public:
MockKeyboardDeviceConfigurationDelegate() = default;
// Overridden from KeyboardDeviceConfigurationDelegate:
MOCK_METHOD(void, OnKeyboardTypeChanged, (bool));
};
class MockKeyboardObserver : public KeyboardObserver {
public:
MockKeyboardObserver() = default;
// Overridden from KeyboardObserver:
MOCK_METHOD(void, OnKeyboardDestroying, (Keyboard*));
MOCK_METHOD(void, OnKeyboardKey, (base::TimeTicks, ui::DomCode, bool));
};
using NiceMockKeyboardObserver = ::testing::NiceMock<MockKeyboardObserver>;
class TestShellSurface : public ShellSurface {
public:
explicit TestShellSurface(Surface* surface) : ShellSurface(surface) {}
MOCK_METHOD(bool, AcceleratorPressed, (const ui::Accelerator& accelerator));
};
// This event handler moves the focus to the given window when receiving a key
// event.
class TestEventHandler : public ui::EventHandler {
public:
explicit TestEventHandler(aura::Window* focus_window)
: focus_window_(focus_window) {}
TestEventHandler(const TestEventHandler&) = delete;
TestEventHandler& operator=(const TestEventHandler&) = delete;
void OnKeyEvent(ui::KeyEvent* event) override {
aura::client::GetFocusClient(ash::Shell::GetPrimaryRootWindow())
->FocusWindow(focus_window_);
}
raw_ptr<aura::Window, ExperimentalAsh> focus_window_;
};
// Verifies that switching desks via alt-tab doesn't prevent Seat from receiving
// key events. https://crbug.com/1008574.
TEST_F(KeyboardTest, CorrectSeatPressedKeysOnSwitchingDesks) {
Seat seat;
Keyboard keyboard(std::make_unique<NiceMockKeyboardDelegate>(), &seat);
// Create 2 desks.
auto* desks_controller = ash::DesksController::Get();
desks_controller->NewDesk(ash::DesksCreationRemovalSource::kButton);
ASSERT_EQ(2u, desks_controller->desks().size());
ash::Desk* desk_1 = desks_controller->desks()[0].get();
const ash::Desk* desk_2 = desks_controller->desks()[1].get();
// Desk 1 has a normal window.
auto win0 = CreateAppWindow(gfx::Rect(0, 0, 250, 100));
// Desk 2 has an exo surface window.
ash::ActivateDesk(desk_2);
auto shell_surface = test::ShellSurfaceBuilder({10, 10}).BuildShellSurface();
// Go back to desk 1, and trigger an alt-tab (releasing alt first). This would
// trigger activating the exo surface window on desk 2, which would lead to a
// desk switch animation. During the animation, expect that Seat gets all the
// keys in `OnKeyEvent()`, and the |pressed_keys_| map is correctly updated.
ash::ActivateDesk(desk_1);
auto displatch_key_event = [&](ui::EventType type, ui::KeyboardCode key_code,
ui::DomCode code, int flags) {
ui::KeyEvent key_event{type, key_code, code, flags};
seat.WillProcessEvent(&key_event);
GetEventGenerator()->Dispatch(&key_event);
EXPECT_EQ(type != ui::ET_KEY_RELEASED, seat.pressed_keys().count(code));
seat.DidProcessEvent(&key_event);
};
ash::DeskSwitchAnimationWaiter waiter;
displatch_key_event(ui::ET_KEY_PRESSED, ui::VKEY_MENU, ui::DomCode::ALT_LEFT,
/*flags=*/0);
displatch_key_event(ui::ET_KEY_PRESSED, ui::VKEY_TAB, ui::DomCode::TAB,
/*flags=*/ui::EF_ALT_DOWN);
displatch_key_event(ui::ET_KEY_RELEASED, ui::VKEY_MENU, ui::DomCode::ALT_LEFT,
/*flags=*/0);
displatch_key_event(ui::ET_KEY_RELEASED, ui::VKEY_TAB, ui::DomCode::TAB,
/*flags=*/0);
EXPECT_TRUE(seat.pressed_keys().empty());
EXPECT_EQ(desk_2, desks_controller->GetTargetActiveDesk());
waiter.Wait();
}
TEST_F(KeyboardTest, OnKeyboardEnter) {
auto shell_surface = test::ShellSurfaceBuilder({10, 10}).BuildShellSurface();
auto* surface = shell_surface->surface_for_testing();
Seat seat;
// Pressing key before Keyboard instance is created and surface has
// received focus.
ui::test::EventGenerator generator(ash::Shell::GetPrimaryRootWindow());
seat.set_physical_code_for_currently_processing_event_for_testing(
ui::DomCode::US_A);
generator.PressKey(ui::VKEY_A, ui::EF_SHIFT_DOWN);
aura::client::FocusClient* focus_client =
aura::client::GetFocusClient(ash::Shell::GetPrimaryRootWindow());
focus_client->FocusWindow(surface->window());
// Keyboard should try to set initial focus to surface.
auto delegate = std::make_unique<NiceMockKeyboardDelegate>();
auto* delegate_ptr = delegate.get();
EXPECT_CALL(*delegate_ptr, CanAcceptKeyboardEventsForSurface(surface))
.WillOnce(testing::Return(false));
Keyboard keyboard(std::move(delegate), &seat);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// Set up expectation for the key release.
EXPECT_CALL(*delegate_ptr, CanAcceptKeyboardEventsForSurface(surface))
.WillOnce(testing::Return(true));
EXPECT_CALL(
*delegate_ptr,
OnKeyboardEnter(surface, base::flat_map<ui::DomCode, KeyState>(
{{ui::DomCode::US_A,
KeyState{ui::DomCode::US_A, false}}})));
focus_client->FocusWindow(nullptr);
focus_client->FocusWindow(surface->window());
// Surface should maintain keyboard focus when moved to top-level window.
focus_client->FocusWindow(surface->window()->GetToplevelWindow());
// Release key after surface lost focus.
focus_client->FocusWindow(nullptr);
generator.ReleaseKey(ui::VKEY_A, ui::EF_SHIFT_DOWN);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// Key should no longer be pressed when focus returns.
EXPECT_CALL(*delegate_ptr, CanAcceptKeyboardEventsForSurface(surface))
.WillOnce(testing::Return(true));
EXPECT_CALL(*delegate_ptr, OnKeyboardModifiers(KeyboardModifiers{
kShiftMask | kNumLockMask, 0, 0, 0}));
EXPECT_CALL(
*delegate_ptr,
OnKeyboardEnter(surface, base::flat_map<ui::DomCode, KeyState>()));
focus_client->FocusWindow(surface->window()->GetToplevelWindow());
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
}
TEST_F(KeyboardTest, OnKeyboardLeave) {
auto shell_surface = test::ShellSurfaceBuilder({10, 10}).BuildShellSurface();
auto* surface = shell_surface->surface_for_testing();
aura::client::FocusClient* focus_client =
aura::client::GetFocusClient(ash::Shell::GetPrimaryRootWindow());
focus_client->FocusWindow(nullptr);
auto delegate = std::make_unique<NiceMockKeyboardDelegate>();
auto* delegate_ptr = delegate.get();
Seat seat;
auto keyboard = std::make_unique<Keyboard>(std::move(delegate), &seat);
ON_CALL(*delegate_ptr, CanAcceptKeyboardEventsForSurface(surface))
.WillByDefault(testing::Return(true));
EXPECT_CALL(*delegate_ptr,
OnKeyboardModifiers(KeyboardModifiers{kNumLockMask, 0, 0, 0}));
EXPECT_CALL(
*delegate_ptr,
OnKeyboardEnter(surface, base::flat_map<ui::DomCode, KeyState>()));
focus_client->FocusWindow(surface->window());
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
EXPECT_CALL(*delegate_ptr, OnKeyboardLeave(surface));
focus_client->FocusWindow(nullptr);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
EXPECT_CALL(*delegate_ptr,
OnKeyboardModifiers(KeyboardModifiers{kNumLockMask, 0, 0, 0}));
EXPECT_CALL(
*delegate_ptr,
OnKeyboardEnter(surface, base::flat_map<ui::DomCode, KeyState>()));
focus_client->FocusWindow(surface->window());
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
EXPECT_CALL(*delegate_ptr, OnKeyboardLeave(surface));
shell_surface.reset();
// Verify before destroying keyboard to make sure the expected call
// is made on the methods above, rather than in the destructor.
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
}
TEST_P(KeyboardKeyTest, OnKeyboardKey) {
auto shell_surface = test::ShellSurfaceBuilder({10, 10}).BuildShellSurface();
auto* surface = shell_surface->surface_for_testing();
aura::client::FocusClient* focus_client =
aura::client::GetFocusClient(ash::Shell::GetPrimaryRootWindow());
focus_client->FocusWindow(nullptr);
auto delegate = std::make_unique<NiceMockKeyboardDelegate>();
auto* delegate_ptr = delegate.get();
NiceMockKeyboardObserver observer;
Seat seat;
Keyboard keyboard(std::move(delegate), &seat);
keyboard.AddObserver(&observer);
EXPECT_CALL(*delegate_ptr, CanAcceptKeyboardEventsForSurface(surface))
.WillOnce(testing::Return(true));
EXPECT_CALL(*delegate_ptr,
OnKeyboardModifiers(KeyboardModifiers{kNumLockMask, 0, 0, 0}));
EXPECT_CALL(
*delegate_ptr,
OnKeyboardEnter(surface, base::flat_map<ui::DomCode, KeyState>()));
focus_client->FocusWindow(surface->window());
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
ui::test::EventGenerator generator(ash::Shell::GetPrimaryRootWindow());
// This should only generate a press event for KEY_A.
{
testing::InSequence s;
EXPECT_CALL(observer, OnKeyboardKey(testing::_, ui::DomCode::US_A, true));
EXPECT_CALL(*delegate_ptr,
OnKeyboardKey(testing::_, ui::DomCode::US_A, true));
}
seat.set_physical_code_for_currently_processing_event_for_testing(
ui::DomCode::US_A);
generator.PressKey(ui::VKEY_A, 0);
testing::Mock::VerifyAndClearExpectations(&observer);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// This should not generate another press event for KEY_A.
generator.PressKey(ui::VKEY_A, 0);
testing::Mock::VerifyAndClearExpectations(&observer);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// This should only generate a single release event for KEY_A.
{
testing::InSequence s;
EXPECT_CALL(observer, OnKeyboardKey(testing::_, ui::DomCode::US_A, false));
EXPECT_CALL(*delegate_ptr,
OnKeyboardKey(testing::_, ui::DomCode::US_A, false));
}
generator.ReleaseKey(ui::VKEY_A, 0);
testing::Mock::VerifyAndClearExpectations(&observer);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// Test key event rewriting. In this case, ARROW_DOWN is rewritten to KEY_END
// as a result of ALT being pressed.
{
testing::InSequence s;
EXPECT_CALL(observer, OnKeyboardKey(testing::_, ui::DomCode::END, true));
EXPECT_CALL(*delegate_ptr,
OnKeyboardKey(testing::_, ui::DomCode::END, true));
}
EXPECT_CALL(*delegate_ptr, OnKeyboardModifiers(KeyboardModifiers{
kAltMask | kNumLockMask, 0, 0, 0}));
seat.set_physical_code_for_currently_processing_event_for_testing(
ui::DomCode::ARROW_DOWN);
generator.PressKey(ui::VKEY_END, ui::EF_ALT_DOWN);
testing::Mock::VerifyAndClearExpectations(&observer);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// This should generate a release event for KEY_END as that is the key
// associated with the key press.
{
testing::InSequence s;
EXPECT_CALL(observer, OnKeyboardKey(testing::_, ui::DomCode::END, false));
EXPECT_CALL(*delegate_ptr,
OnKeyboardKey(testing::_, ui::DomCode::END, false));
}
EXPECT_CALL(*delegate_ptr,
OnKeyboardModifiers(KeyboardModifiers{kNumLockMask, 0, 0, 0}));
generator.ReleaseKey(ui::VKEY_DOWN, 0);
testing::Mock::VerifyAndClearExpectations(&observer);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// Press accelerator after surface lost focus.
EXPECT_CALL(*delegate_ptr, OnKeyboardLeave(surface));
focus_client->FocusWindow(nullptr);
seat.set_physical_code_for_currently_processing_event_for_testing(
ui::DomCode::US_W);
generator.PressKey(ui::VKEY_W, ui::EF_CONTROL_DOWN);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// Key should be pressed when focus returns.
EXPECT_CALL(*delegate_ptr, CanAcceptKeyboardEventsForSurface(surface))
.WillOnce(testing::Return(true));
EXPECT_CALL(*delegate_ptr, OnKeyboardModifiers(KeyboardModifiers{
kControlMask | kNumLockMask, 0, 0, 0}));
EXPECT_CALL(
*delegate_ptr,
OnKeyboardEnter(surface, base::flat_map<ui::DomCode, KeyState>(
{{ui::DomCode::US_W,
KeyState{ui::DomCode::US_W, false}}})));
focus_client->FocusWindow(surface->window());
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// Releasing accelerator when surface has focus should generate event.
{
testing::InSequence s;
EXPECT_CALL(observer, OnKeyboardKey(testing::_, ui::DomCode::US_W, false));
EXPECT_CALL(*delegate_ptr,
OnKeyboardKey(testing::_, ui::DomCode::US_W, false));
}
generator.ReleaseKey(ui::VKEY_W, ui::EF_CONTROL_DOWN);
testing::Mock::VerifyAndClearExpectations(&observer);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// Key events should be ignored when the focused window is not an
// exo::Surface.
std::unique_ptr<aura::Window> window =
ash::ChildTestWindowBuilder(shell_surface->GetWidget()->GetNativeWindow(),
surface->window()->bounds())
.Build();
// Moving the focus away will reset the focused surface.
EXPECT_CALL(*delegate_ptr, CanAcceptKeyboardEventsForSurface(surface))
.Times(0);
focus_client->FocusWindow(window.get());
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
EXPECT_FALSE(seat.GetFocusedSurface());
EXPECT_FALSE(keyboard.focused_surface_for_testing());
EXPECT_CALL(observer,
OnKeyboardKey(testing::_, ui::DomCode::ARROW_LEFT, true))
.Times(0);
EXPECT_CALL(*delegate_ptr,
OnKeyboardKey(testing::_, ui::DomCode::ARROW_LEFT, true))
.Times(0);
seat.set_physical_code_for_currently_processing_event_for_testing(
ui::DomCode::ARROW_LEFT);
generator.PressKey(ui::VKEY_LEFT, 0);
testing::Mock::VerifyAndClearExpectations(&observer);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
EXPECT_CALL(observer,
OnKeyboardKey(testing::_, ui::DomCode::ARROW_LEFT, false))
.Times(0);
EXPECT_CALL(*delegate_ptr,
OnKeyboardKey(testing::_, ui::DomCode::ARROW_LEFT, false))
.Times(0);
generator.ReleaseKey(ui::VKEY_LEFT, 0);
// Verify before destroying keyboard to make sure the expected call
// is made on the methods above, rather than in the destructor.
testing::Mock::VerifyAndClearExpectations(&observer);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
}
TEST_P(KeyboardKeyTest, OnKeyboardKey_NotSendKeyIfConsumedByIme) {
auto shell_surface = test::ShellSurfaceBuilder({10, 10}).BuildShellSurface();
auto* surface = shell_surface->surface_for_testing();
aura::client::FocusClient* focus_client =
aura::client::GetFocusClient(ash::Shell::GetPrimaryRootWindow());
focus_client->FocusWindow(nullptr);
auto delegate = std::make_unique<NiceMockKeyboardDelegate>();
auto* delegate_ptr = delegate.get();
NiceMockKeyboardObserver observer;
Seat seat;
Keyboard keyboard(std::move(delegate), &seat);
keyboard.AddObserver(&observer);
EXPECT_CALL(*delegate_ptr, CanAcceptKeyboardEventsForSurface(surface))
.WillOnce(testing::Return(true));
EXPECT_CALL(*delegate_ptr,
OnKeyboardModifiers(KeyboardModifiers{kNumLockMask, 0, 0, 0}));
EXPECT_CALL(
*delegate_ptr,
OnKeyboardEnter(surface, base::flat_map<ui::DomCode, KeyState>()));
focus_client->FocusWindow(surface->window());
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
ui::test::EventGenerator generator(ash::Shell::GetPrimaryRootWindow());
views::Widget* widget =
views::Widget::GetTopLevelWidgetForNativeView(surface->window());
ui::InputMethod* input_method = widget->GetInputMethod();
ui::DummyTextInputClient client{ui::TEXT_INPUT_TYPE_TEXT};
input_method->SetFocusedTextInputClient(&client);
// If a text field is focused, a pressed key event is not sent to a client
// because a key event should be consumed by the IME.
// However, the observer should receive OnKeyboardKey, always.
EXPECT_CALL(observer, OnKeyboardKey(testing::_, ui::DomCode::US_A, true));
EXPECT_CALL(*delegate_ptr, OnKeyboardKey(testing::_, ui::DomCode::US_A, true))
.Times(0);
seat.set_physical_code_for_currently_processing_event_for_testing(
ui::DomCode::US_A);
{
ui::KeyEvent event(ui::ET_KEY_PRESSED, ui::VKEY_A, 0);
ui::SetKeyboardImeFlags(&event, ui::kPropertyKeyboardImeHandledFlag);
event.set_source_device_id(0);
generator.Dispatch(&event);
}
testing::Mock::VerifyAndClearExpectations(&observer);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// TODO(yhanada): The below EXPECT_CALL fails because exo::Keyboard currently
// sends a key release event for the keys which exo::Keyboard sent a pressed
// event for. It might causes a never-ending key repeat in the client.
// EXPECT_CALL(delegate, OnKeyboardKey(testing::_, ui::DomCode::US_A, false));
EXPECT_CALL(observer, OnKeyboardKey(testing::_, ui::DomCode::US_A, false));
generator.ReleaseKey(ui::VKEY_A, 0);
testing::Mock::VerifyAndClearExpectations(&observer);
// Any key event should be sent to a client if a key event skips IME.
surface->window()->SetProperty(aura::client::kSkipImeProcessing, true);
{
testing::InSequence s;
EXPECT_CALL(observer, OnKeyboardKey(testing::_, ui::DomCode::US_C, true));
EXPECT_CALL(*delegate_ptr,
OnKeyboardKey(testing::_, ui::DomCode::US_C, true));
}
seat.set_physical_code_for_currently_processing_event_for_testing(
ui::DomCode::US_C);
generator.PressKey(ui::VKEY_C, 0);
testing::Mock::VerifyAndClearExpectations(&observer);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
{
testing::InSequence s;
EXPECT_CALL(observer, OnKeyboardKey(testing::_, ui::DomCode::US_C, false));
EXPECT_CALL(*delegate_ptr,
OnKeyboardKey(testing::_, ui::DomCode::US_C, false));
}
generator.ReleaseKey(ui::VKEY_C, 0);
testing::Mock::VerifyAndClearExpectations(&observer);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
input_method->SetFocusedTextInputClient(nullptr);
}
TEST_P(KeyboardKeyTest, OnKeyboardKey_KeyboardInhibit) {
auto shell_surface = test::ShellSurfaceBuilder({10, 10}).BuildShellSurface();
auto* surface = shell_surface->surface_for_testing();
// Set lacros attribute now for testing. This can be removed, when
// all clients are migrated into this model.
surface->window()->SetProperty(aura::client::kAppType,
static_cast<int>(ash::AppType::LACROS));
aura::client::FocusClient* focus_client =
aura::client::GetFocusClient(ash::Shell::GetPrimaryRootWindow());
focus_client->FocusWindow(nullptr);
// Register accelerator to be triggered.
ui::TestAcceleratorTarget accelerator_target;
{
ui::Accelerator accelerator(ui::VKEY_P,
ui::EF_ALT_DOWN | ui::EF_SHIFT_DOWN);
ash::AcceleratorControllerImpl* controller =
ash::Shell::Get()->accelerator_controller();
controller->Register({accelerator}, &accelerator_target);
}
auto delegate = std::make_unique<NiceMockKeyboardDelegate>();
auto* delegate_ptr = delegate.get();
NiceMockKeyboardObserver observer;
Seat seat;
Keyboard keyboard(std::move(delegate), &seat);
keyboard.AddObserver(&observer);
keyboard.SetNeedKeyboardKeyAcks(true);
EXPECT_CALL(*delegate_ptr, CanAcceptKeyboardEventsForSurface(surface))
.WillOnce(testing::Return(true));
EXPECT_CALL(*delegate_ptr,
OnKeyboardModifiers(KeyboardModifiers{kNumLockMask, 0, 0, 0}));
EXPECT_CALL(
*delegate_ptr,
OnKeyboardEnter(surface, base::flat_map<ui::DomCode, KeyState>()));
focus_client->FocusWindow(surface->window());
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
ui::test::EventGenerator generator(ash::Shell::GetPrimaryRootWindow());
// This should only generate a press event for KEY_P.
accelerator_target.ResetCounts();
EXPECT_CALL(observer,
OnKeyboardKey(testing::_, ui::DomCode::US_P, testing::_))
.Times(0);
EXPECT_CALL(*delegate_ptr,
OnKeyboardKey(testing::_, ui::DomCode::US_P, testing::_))
.Times(0);
seat.set_physical_code_for_currently_processing_event_for_testing(
ui::DomCode::US_P);
generator.PressKey(ui::VKEY_P, ui::EF_ALT_DOWN | ui::EF_SHIFT_DOWN);
EXPECT_EQ(1, accelerator_target.accelerator_count());
testing::Mock::VerifyAndClearExpectations(&observer);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// Set keyboard-shortcut-inhibited, so the key event should be sent to app.
surface->SetKeyboardShortcutsInhibited(true);
accelerator_target.ResetCounts();
{
testing::InSequence s;
EXPECT_CALL(observer, OnKeyboardKey(testing::_, ui::DomCode::US_P, true));
EXPECT_CALL(*delegate_ptr,
OnKeyboardKey(testing::_, ui::DomCode::US_P, true));
}
seat.set_physical_code_for_currently_processing_event_for_testing(
ui::DomCode::US_P);
generator.PressKey(ui::VKEY_P, ui::EF_ALT_DOWN | ui::EF_SHIFT_DOWN);
EXPECT_EQ(0, accelerator_target.accelerator_count());
testing::Mock::VerifyAndClearExpectations(&observer);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
}
TEST_F(KeyboardTest, KeyboardKey_SuppressAutoRepeat) {
auto shell_surface = test::ShellSurfaceBuilder({10, 10}).BuildShellSurface();
auto* surface = shell_surface->surface_for_testing();
// Set lacros attribute now for testing. This can be removed, when
// all clients are migrated into this model.
surface->window()->SetProperty(aura::client::kAppType,
static_cast<int>(ash::AppType::LACROS));
aura::client::FocusClient* focus_client =
aura::client::GetFocusClient(ash::Shell::GetPrimaryRootWindow());
focus_client->FocusWindow(nullptr);
auto delegate = std::make_unique<NiceMockKeyboardDelegate>();
auto* delegate_ptr = delegate.get();
NiceMockKeyboardObserver observer;
Seat seat;
Keyboard keyboard(std::move(delegate), &seat);
keyboard.AddObserver(&observer);
keyboard.SetNeedKeyboardKeyAcks(true);
EXPECT_CALL(*delegate_ptr, CanAcceptKeyboardEventsForSurface(surface))
.WillOnce(testing::Return(true));
focus_client->FocusWindow(surface->window());
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
ui::test::EventGenerator generator(ash::Shell::GetPrimaryRootWindow());
// Send KeyEvent annotated the auto repeat suppression.
{
testing::InSequence s;
EXPECT_CALL(*delegate_ptr,
OnKeyRepeatSettingsChanged(false, testing::_, testing::_))
.Times(1);
EXPECT_CALL(observer,
OnKeyboardKey(testing::_, ui::DomCode::US_X, testing::_))
.Times(1);
EXPECT_CALL(*delegate_ptr,
OnKeyboardKey(testing::_, ui::DomCode::US_X, testing::_))
.Times(1);
}
seat.set_physical_code_for_currently_processing_event_for_testing(
ui::DomCode::US_X);
{
ui::KeyEvent event(ui::ET_KEY_PRESSED, ui::VKEY_X, 0);
event.set_source_device_id(ui::ED_UNKNOWN_DEVICE);
{
ui::Event::Properties properties;
ui::SetKeyboardImeFlagProperty(&properties,
ui::kPropertyKeyboardImeIgnoredFlag);
ui::SetKeyEventSuppressAutoRepeat(properties);
event.SetProperties(properties);
}
generator.Dispatch(&event);
}
testing::Mock::VerifyAndClearExpectations(&observer);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// Following KeyEvent without the annotation will re-enable
// auto-repeat.
{
testing::InSequence s;
EXPECT_CALL(*delegate_ptr,
OnKeyRepeatSettingsChanged(true, testing::_, testing::_))
.Times(1);
EXPECT_CALL(observer,
OnKeyboardKey(testing::_, ui::DomCode::US_Y, testing::_))
.Times(1);
EXPECT_CALL(*delegate_ptr,
OnKeyboardKey(testing::_, ui::DomCode::US_Y, testing::_))
.Times(1);
}
seat.set_physical_code_for_currently_processing_event_for_testing(
ui::DomCode::US_Y);
{
ui::KeyEvent event(ui::ET_KEY_PRESSED, ui::VKEY_Y, 0);
event.set_source_device_id(ui::ED_UNKNOWN_DEVICE);
{
ui::Event::Properties properties;
ui::SetKeyboardImeFlagProperty(&properties,
ui::kPropertyKeyboardImeIgnoredFlag);
event.SetProperties(properties);
}
generator.Dispatch(&event);
}
testing::Mock::VerifyAndClearExpectations(&observer);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
}
TEST_F(KeyboardTest, FocusWithArcOverlay) {
auto delegate = std::make_unique<NiceMockKeyboardDelegate>();
// Just allow any surface to receive focus.
EXPECT_CALL(*delegate, CanAcceptKeyboardEventsForSurface(::testing::_))
.WillRepeatedly(testing::Return(true));
Seat seat;
Keyboard keyboard(std::move(delegate), &seat);
// TODO(oshima): Create a TestExoWindowBuilder.
class TestPropertyResolver : public exo::WMHelper::AppPropertyResolver {
public:
TestPropertyResolver() = default;
~TestPropertyResolver() override = default;
void PopulateProperties(
const Params& params,
ui::PropertyHandler& out_properties_container) override {
out_properties_container.SetProperty(
aura::client::kAppType, static_cast<int>(ash::AppType::ARC_APP));
}
};
WMHelper::GetInstance()->RegisterAppPropertyResolver(
std::make_unique<TestPropertyResolver>());
ash::ArcOverlayManager arc_overlay_manager_;
auto* widget1 = ash::TestWidgetBuilder()
.SetBounds(gfx::Rect(200, 200))
.BuildOwnedByNativeWidget();
views::Textfield* textfield1 = new views::Textfield();
widget1->GetContentsView()->AddChildView(textfield1);
textfield1->SetBounds(0, 0, 100, 100);
auto* widget2 = ash::TestWidgetBuilder()
.SetBounds(gfx::Rect(200, 200))
.BuildOwnedByNativeWidget();
auto hold = arc_overlay_manager_.RegisterHostWindow(
"test", widget1->GetNativeWindow());
auto surface = std::make_unique<Surface>();
auto shell_surface = std::make_unique<ShellSurface>(surface.get());
gfx::Size buffer_size(10, 10);
std::unique_ptr<Buffer> buffer(
new Buffer(exo_test_helper()->CreateGpuMemoryBuffer(buffer_size)));
surface->SetClientSurfaceId("billing_id:test");
surface->Attach(buffer.get());
surface->Commit();
EXPECT_TRUE(shell_surface->GetWidget());
// The overlay should have the focus when created.
EXPECT_EQ(keyboard.focused_surface_for_testing(), surface.get());
widget2->Activate();
EXPECT_FALSE(keyboard.focused_surface_for_testing());
// Activating the host widget should set the focus back to the overlay.
widget1->Activate();
EXPECT_EQ(keyboard.focused_surface_for_testing(), surface.get());
constexpr char kFocusedViewClassName[] = "OverlayNativeViewHost";
EXPECT_STREQ(kFocusedViewClassName,
widget1->GetFocusManager()->GetFocusedView()->GetClassName());
// Tabbing should not move the focus away from the overlay.
ui::test::EventGenerator generator(ash::Shell::GetPrimaryRootWindow());
generator.PressKey(ui::VKEY_TAB, 0);
EXPECT_STREQ(kFocusedViewClassName,
widget1->GetFocusManager()->GetFocusedView()->GetClassName());
EXPECT_EQ(keyboard.focused_surface_for_testing(), surface.get());
hold.RunAndReset();
widget1->CloseNow();
}
TEST_F(KeyboardTest, OnKeyboardModifiers) {
auto shell_surface = test::ShellSurfaceBuilder({10, 10}).BuildShellSurface();
auto* surface = shell_surface->surface_for_testing();
aura::client::FocusClient* focus_client =
aura::client::GetFocusClient(ash::Shell::GetPrimaryRootWindow());
focus_client->FocusWindow(nullptr);
auto delegate = std::make_unique<NiceMockKeyboardDelegate>();
auto* delegate_ptr = delegate.get();
Seat seat;
Keyboard keyboard(std::move(delegate), &seat);
EXPECT_CALL(*delegate_ptr, CanAcceptKeyboardEventsForSurface(surface))
.WillOnce(testing::Return(true));
EXPECT_CALL(*delegate_ptr,
OnKeyboardModifiers(KeyboardModifiers{kNumLockMask, 0, 0, 0}));
EXPECT_CALL(
*delegate_ptr,
OnKeyboardEnter(surface, base::flat_map<ui::DomCode, KeyState>()));
focus_client->FocusWindow(surface->window());
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
ui::test::EventGenerator generator(ash::Shell::GetPrimaryRootWindow());
// This should generate a modifier event.
EXPECT_CALL(*delegate_ptr,
OnKeyboardKey(testing::_, ui::DomCode::US_A, true));
EXPECT_CALL(*delegate_ptr, OnKeyboardModifiers(KeyboardModifiers{
kShiftMask | kNumLockMask, 0, 0, 0}));
seat.set_physical_code_for_currently_processing_event_for_testing(
ui::DomCode::US_A);
generator.PressKey(ui::VKEY_A, ui::EF_SHIFT_DOWN);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// This should generate another modifier event.
EXPECT_CALL(*delegate_ptr,
OnKeyboardKey(testing::_, ui::DomCode::US_B, true));
EXPECT_CALL(*delegate_ptr,
OnKeyboardModifiers(KeyboardModifiers{
kShiftMask | kAltMask | kNumLockMask, 0, 0, 0}));
seat.set_physical_code_for_currently_processing_event_for_testing(
ui::DomCode::US_B);
generator.PressKey(ui::VKEY_B, ui::EF_SHIFT_DOWN | ui::EF_ALT_DOWN);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// This should generate a third modifier event.
EXPECT_CALL(*delegate_ptr,
OnKeyboardKey(testing::_, ui::DomCode::US_B, false));
EXPECT_CALL(*delegate_ptr,
OnKeyboardModifiers(KeyboardModifiers{kNumLockMask, 0, 0, 0}));
generator.ReleaseKey(ui::VKEY_B, 0);
// Verify before destroying keyboard to make sure the expected call
// is made on the methods above, rather than in the destructor.
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
}
TEST_F(KeyboardTest, OnKeyboardTypeChanged) {
auto shell_surface = test::ShellSurfaceBuilder({10, 10}).BuildShellSurface();
aura::client::FocusClient* focus_client =
aura::client::GetFocusClient(ash::Shell::GetPrimaryRootWindow());
focus_client->FocusWindow(nullptr);
ui::DeviceHotplugEventObserver* device_data_manager =
ui::DeviceDataManager::GetInstance();
ASSERT_TRUE(device_data_manager != nullptr);
// Make sure that DeviceDataManager has one external keyboard...
const std::vector<ui::KeyboardDevice> keyboards{
ui::KeyboardDevice(2, ui::InputDeviceType::INPUT_DEVICE_USB, "keyboard")};
device_data_manager->OnKeyboardDevicesUpdated(keyboards);
// and a touch screen.
const std::vector<ui::TouchscreenDevice> touch_screen{
ui::TouchscreenDevice(3, ui::InputDeviceType::INPUT_DEVICE_INTERNAL,
"touch", gfx::Size(600, 400), 1)};
device_data_manager->OnTouchscreenDevicesUpdated(touch_screen);
ash::TabletModeController* tablet_mode_controller =
ash::Shell::Get()->tablet_mode_controller();
tablet_mode_controller->SetEnabledForTest(true);
Seat seat;
auto keyboard = std::make_unique<Keyboard>(
std::make_unique<NiceMockKeyboardDelegate>(), &seat);
MockKeyboardDeviceConfigurationDelegate configuration_delegate;
EXPECT_CALL(configuration_delegate, OnKeyboardTypeChanged(true));
keyboard->SetDeviceConfigurationDelegate(&configuration_delegate);
EXPECT_TRUE(keyboard->HasDeviceConfigurationDelegate());
testing::Mock::VerifyAndClearExpectations(&configuration_delegate);
// Removing all keyboard devices in tablet mode calls
// OnKeyboardTypeChanged() with false.
EXPECT_CALL(configuration_delegate, OnKeyboardTypeChanged(false));
device_data_manager->OnKeyboardDevicesUpdated(
std::vector<ui::KeyboardDevice>({}));
testing::Mock::VerifyAndClearExpectations(&configuration_delegate);
// Re-adding keyboards calls OnKeyboardTypeChanged() with true.
EXPECT_CALL(configuration_delegate, OnKeyboardTypeChanged(true));
device_data_manager->OnKeyboardDevicesUpdated(keyboards);
testing::Mock::VerifyAndClearExpectations(&configuration_delegate);
keyboard.reset();
tablet_mode_controller->SetEnabledForTest(false);
}
TEST_F(KeyboardTest, OnKeyboardTypeChanged_AccessibilityKeyboard) {
auto shell_surface = test::ShellSurfaceBuilder({10, 10}).BuildShellSurface();
aura::client::FocusClient* focus_client =
aura::client::GetFocusClient(ash::Shell::GetPrimaryRootWindow());
focus_client->FocusWindow(nullptr);
ui::DeviceHotplugEventObserver* device_data_manager =
ui::DeviceDataManager::GetInstance();
ASSERT_TRUE(device_data_manager != nullptr);
// Make sure that DeviceDataManager has one external keyboard.
const std::vector<ui::KeyboardDevice> keyboards{
ui::KeyboardDevice(2, ui::InputDeviceType::INPUT_DEVICE_USB, "keyboard")};
device_data_manager->OnKeyboardDevicesUpdated(keyboards);
Seat seat;
Keyboard keyboard(std::make_unique<NiceMockKeyboardDelegate>(), &seat);
MockKeyboardDeviceConfigurationDelegate configuration_delegate;
EXPECT_CALL(configuration_delegate, OnKeyboardTypeChanged(true));
keyboard.SetDeviceConfigurationDelegate(&configuration_delegate);
EXPECT_TRUE(keyboard.HasDeviceConfigurationDelegate());
testing::Mock::VerifyAndClearExpectations(&configuration_delegate);
ash::AccessibilityControllerImpl* accessibility_controller =
ash::Shell::Get()->accessibility_controller();
// Enable a11y keyboard calls OnKeyboardTypeChanged() with false.
EXPECT_CALL(configuration_delegate, OnKeyboardTypeChanged(false));
accessibility_controller->virtual_keyboard().SetEnabled(true);
testing::Mock::VerifyAndClearExpectations(&configuration_delegate);
// Disable a11y keyboard calls OnKeyboardTypeChanged() with true.
EXPECT_CALL(configuration_delegate, OnKeyboardTypeChanged(true));
accessibility_controller->virtual_keyboard().SetEnabled(false);
// Verify before destroying keyboard to make sure the expected call
// is made on the methods above, rather than in the destructor.
testing::Mock::VerifyAndClearExpectations(&configuration_delegate);
}
constexpr base::TimeDelta kDelta50Ms = base::Milliseconds(50);
constexpr base::TimeDelta kDelta500Ms = base::Milliseconds(500);
constexpr base::TimeDelta kDelta1000Ms = base::Milliseconds(1000);
TEST_F(KeyboardTest, KeyRepeatSettingsUninitialized) {
Seat seat;
// Simulate unsigned login state.
auto* keyboard_controller = ash::Shell::Get()->keyboard_controller();
keyboard_controller->OnSigninScreenPrefServiceInitialized(nullptr);
// If KeyboardController is not initialized with prefs,
// no key-repeat setting event should be triggered.
auto delegate = std::make_unique<NiceMockKeyboardDelegate>();
auto* delegate_ptr = delegate.get();
EXPECT_CALL(*delegate_ptr,
OnKeyRepeatSettingsChanged(testing::_, testing::_, testing::_))
.Times(0);
Keyboard keyboard(std::move(delegate), &seat);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// Then, when the pref is initialized, key repeat setting event should be
// triggered.
TestingPrefServiceSimple pref_service;
ash::KeyboardControllerImpl::RegisterProfilePrefs(pref_service.registry(),
/*country=*/"");
EXPECT_CALL(*delegate_ptr,
OnKeyRepeatSettingsChanged(testing::_, testing::_, testing::_));
keyboard_controller->OnSigninScreenPrefServiceInitialized(&pref_service);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// Unset the pref_service before its destruction just for tearing down.
keyboard_controller->OnSigninScreenPrefServiceInitialized(nullptr);
}
TEST_F(KeyboardTest, KeyRepeatSettingsLoadDefaults) {
auto delegate = std::make_unique<NiceMockKeyboardDelegate>();
EXPECT_CALL(*delegate,
OnKeyRepeatSettingsChanged(true, kDelta500Ms, kDelta50Ms));
Seat seat;
Keyboard keyboard(std::move(delegate), &seat);
}
TEST_F(KeyboardTest, KeyRepeatSettingsLoadInitially) {
std::string email = "user0@tray";
SetUserPref(email, ash::prefs::kXkbAutoRepeatEnabled, base::Value(true));
SetUserPref(email, ash::prefs::kXkbAutoRepeatDelay, base::Value(1000));
SetUserPref(email, ash::prefs::kXkbAutoRepeatInterval, base::Value(1000));
auto delegate = std::make_unique<NiceMockKeyboardDelegate>();
auto* delegate_ptr = delegate.get();
EXPECT_CALL(*delegate_ptr,
OnKeyRepeatSettingsChanged(true, kDelta1000Ms, kDelta1000Ms));
Seat seat;
Keyboard keyboard(std::move(delegate), &seat);
// Verify before destroying keyboard to make sure the expected call
// is made on the methods above, rather than in the destructor.
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
}
TEST_F(KeyboardTest, KeyRepeatSettingsUpdateAtRuntime) {
auto delegate = std::make_unique<NiceMockKeyboardDelegate>();
auto* delegate_ptr = delegate.get();
// Initially load defaults.
EXPECT_CALL(*delegate_ptr,
OnKeyRepeatSettingsChanged(testing::_, testing::_, testing::_));
Seat seat;
Keyboard keyboard(std::move(delegate), &seat);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// Make sure that setting prefs triggers the corresponding delegate calls.
const std::string email = "user0@tray";
EXPECT_CALL(*delegate_ptr,
OnKeyRepeatSettingsChanged(false, testing::_, testing::_));
SetUserPref(email, ash::prefs::kXkbAutoRepeatEnabled, base::Value(false));
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
EXPECT_CALL(*delegate_ptr,
OnKeyRepeatSettingsChanged(false, kDelta1000Ms, testing::_));
SetUserPref(email, ash::prefs::kXkbAutoRepeatDelay, base::Value(1000));
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
EXPECT_CALL(*delegate_ptr,
OnKeyRepeatSettingsChanged(false, kDelta1000Ms, kDelta1000Ms));
SetUserPref(email, ash::prefs::kXkbAutoRepeatInterval, base::Value(1000));
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
}
TEST_F(KeyboardTest, KeyRepeatSettingsIgnoredForNonActiveUser) {
// Simulate two users, with the first user as active.
CreateUserSessions(2);
// Key repeat settings should be sent exactly once, for the default values.
auto delegate = std::make_unique<NiceMockKeyboardDelegate>();
auto* delegate_ptr = delegate.get();
EXPECT_CALL(*delegate_ptr,
OnKeyRepeatSettingsChanged(true, kDelta500Ms, kDelta50Ms));
Seat seat;
Keyboard keyboard(std::move(delegate), &seat);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// Set prefs for non-active user; no calls should result.
EXPECT_CALL(*delegate_ptr,
OnKeyRepeatSettingsChanged(testing::_, testing::_, testing::_))
.Times(0);
const std::string email = "user1@tray";
SetUserPref(email, ash::prefs::kXkbAutoRepeatEnabled, base::Value(true));
SetUserPref(email, ash::prefs::kXkbAutoRepeatDelay, base::Value(1000));
SetUserPref(email, ash::prefs::kXkbAutoRepeatInterval, base::Value(1000));
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
}
TEST_F(KeyboardTest, KeyRepeatSettingsUpdateOnProfileChange) {
// Simulate two users, with the first user as active.
CreateUserSessions(2);
// Second user has different preferences.
std::string email = "user1@tray";
SetUserPref(email, ash::prefs::kXkbAutoRepeatEnabled, base::Value(true));
SetUserPref(email, ash::prefs::kXkbAutoRepeatDelay, base::Value(1000));
SetUserPref(email, ash::prefs::kXkbAutoRepeatInterval, base::Value(1000));
auto delegate = std::make_unique<NiceMockKeyboardDelegate>();
auto* delegate_ptr = delegate.get();
// Initially, load default prefs for first user.
EXPECT_CALL(*delegate_ptr,
OnKeyRepeatSettingsChanged(true, kDelta500Ms, kDelta50Ms));
Seat seat;
Keyboard keyboard(std::move(delegate), &seat);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// Switching user should load new prefs.
EXPECT_CALL(*delegate_ptr,
OnKeyRepeatSettingsChanged(true, kDelta1000Ms, kDelta1000Ms));
SimulateUserLogin(email, user_manager::UserType::USER_TYPE_REGULAR);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
}
TEST_F(KeyboardTest, KeyboardLayout) {
auto delegate = std::make_unique<NiceMockKeyboardDelegate>();
auto* delegate_ptr = delegate.get();
// Initially, update to the current keyboard layout.
EXPECT_CALL(*delegate_ptr, OnKeyboardLayoutUpdated(testing::_));
Seat seat;
Keyboard keyboard(std::move(delegate), &seat);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// Updating the keyboard layout should trigger the delegate call.
EXPECT_CALL(*delegate_ptr, OnKeyboardLayoutUpdated(testing::_));
keyboard.OnKeyboardLayoutNameChanged("ja-jp");
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
}
TEST_F(KeyboardTest, KeyboardObserver) {
// Declare before the keyboard so the mock verification happens
// after the keyboard destruction.
MockKeyboardObserver observer1;
MockKeyboardObserver observer2;
Seat seat;
Keyboard keyboard(std::make_unique<NiceMockKeyboardDelegate>(), &seat);
keyboard.AddObserver(&observer1);
keyboard.AddObserver(&observer2);
EXPECT_TRUE(keyboard.HasObserver(&observer1));
EXPECT_TRUE(keyboard.HasObserver(&observer2));
testing::Mock::VerifyAndClearExpectations(&observer1);
testing::Mock::VerifyAndClearExpectations(&observer2);
keyboard.RemoveObserver(&observer1);
EXPECT_FALSE(keyboard.HasObserver(&observer1));
EXPECT_TRUE(keyboard.HasObserver(&observer2));
testing::Mock::VerifyAndClearExpectations(&observer1);
testing::Mock::VerifyAndClearExpectations(&observer2);
// Called from the destructor of Keyboard.
EXPECT_CALL(observer1, OnKeyboardDestroying(&keyboard)).Times(0);
EXPECT_CALL(observer2, OnKeyboardDestroying(&keyboard));
}
TEST_F(KeyboardTest, NeedKeyboardKeyAcks) {
auto shell_surface = test::ShellSurfaceBuilder({10, 10}).BuildShellSurface();
aura::client::FocusClient* focus_client =
aura::client::GetFocusClient(ash::Shell::GetPrimaryRootWindow());
focus_client->FocusWindow(nullptr);
Seat seat;
Keyboard keyboard(std::make_unique<NiceMockKeyboardDelegate>(), &seat);
EXPECT_FALSE(keyboard.AreKeyboardKeyAcksNeeded());
keyboard.SetNeedKeyboardKeyAcks(true);
EXPECT_TRUE(keyboard.AreKeyboardKeyAcksNeeded());
keyboard.SetNeedKeyboardKeyAcks(false);
EXPECT_FALSE(keyboard.AreKeyboardKeyAcksNeeded());
}
TEST_F(KeyboardTest, AckKeyboardKey) {
auto surface = std::make_unique<Surface>();
auto shell_surface = std::make_unique<TestShellSurface>(surface.get());
gfx::Size buffer_size(10, 10);
std::unique_ptr<Buffer> buffer(
new Buffer(exo_test_helper()->CreateGpuMemoryBuffer(buffer_size)));
surface->Attach(buffer.get());
surface->Commit();
aura::client::FocusClient* focus_client =
aura::client::GetFocusClient(ash::Shell::GetPrimaryRootWindow());
focus_client->FocusWindow(nullptr);
auto delegate = std::make_unique<NiceMockKeyboardDelegate>();
auto* delegate_ptr = delegate.get();
Seat seat;
Keyboard keyboard(std::move(delegate), &seat);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
EXPECT_CALL(*delegate_ptr, CanAcceptKeyboardEventsForSurface(surface.get()))
.WillOnce(testing::Return(true));
EXPECT_CALL(*delegate_ptr,
OnKeyboardModifiers(KeyboardModifiers{kNumLockMask, 0, 0, 0}));
EXPECT_CALL(
*delegate_ptr,
OnKeyboardEnter(surface.get(), base::flat_map<ui::DomCode, KeyState>()));
focus_client->FocusWindow(surface->window());
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// If we don't set NeedKeyboardAckKeys to true, accelerators are always passed
// to ShellSurface.
ui::test::EventGenerator generator(ash::Shell::GetPrimaryRootWindow());
// Press KEY_W with Ctrl.
EXPECT_CALL(*shell_surface.get(), AcceleratorPressed(ui::Accelerator(
ui::VKEY_W, ui::EF_CONTROL_DOWN,
ui::Accelerator::KeyState::PRESSED)))
.WillOnce(testing::Return(true));
seat.set_physical_code_for_currently_processing_event_for_testing(
ui::DomCode::US_W);
generator.PressKey(ui::VKEY_W, ui::EF_CONTROL_DOWN);
// Release KEY_W.
generator.ReleaseKey(ui::VKEY_W, ui::EF_CONTROL_DOWN);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
testing::Mock::VerifyAndClearExpectations(shell_surface.get());
// If we set NeedKeyboardAckKeys to true, only unhandled accelerators are
// passed to ShellSurface.
keyboard.SetNeedKeyboardKeyAcks(true);
// Press KEY_W with Ctrl.
EXPECT_CALL(*delegate_ptr, OnKeyboardKey(testing::_, ui::DomCode::US_W, true))
.WillOnce(testing::Return(1));
generator.PressKey(ui::VKEY_W, ui::EF_CONTROL_DOWN);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// Send ack for the key press.
EXPECT_CALL(*shell_surface.get(), AcceleratorPressed(ui::Accelerator(
ui::VKEY_W, ui::EF_CONTROL_DOWN,
ui::Accelerator::KeyState::PRESSED)))
.WillOnce(testing::Return(true));
keyboard.AckKeyboardKey(1, false /* handled */);
testing::Mock::VerifyAndClearExpectations(shell_surface.get());
// Release KEY_W.
EXPECT_CALL(*delegate_ptr,
OnKeyboardKey(testing::_, ui::DomCode::US_W, false))
.WillOnce(testing::Return(2));
generator.ReleaseKey(ui::VKEY_W, ui::EF_CONTROL_DOWN);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// Send ack for the key release.
keyboard.AckKeyboardKey(2, false /* handled */);
// Press KEY_W with Ctrl again.
EXPECT_CALL(*delegate_ptr, OnKeyboardKey(testing::_, ui::DomCode::US_W, true))
.WillOnce(testing::Return(3));
generator.PressKey(ui::VKEY_W, ui::EF_CONTROL_DOWN);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// Send ack for the key press.
// AcceleratorPressed is not called when the accelerator is already handled.
keyboard.AckKeyboardKey(3, true /* handled */);
// A repeat key event should not be sent to the client and also should not
// invoke the accelerator.
EXPECT_CALL(*shell_surface.get(), AcceleratorPressed(ui::Accelerator(
ui::VKEY_W, ui::EF_CONTROL_DOWN,
ui::Accelerator::KeyState::PRESSED)))
.Times(0);
generator.PressKey(ui::VKEY_W, ui::EF_CONTROL_DOWN | ui::EF_IS_REPEAT);
testing::Mock::VerifyAndClearExpectations(shell_surface.get());
// Another key press event while holding the key is also ignored and should
// not invoke the accelerator.
EXPECT_CALL(*shell_surface.get(), AcceleratorPressed(ui::Accelerator(
ui::VKEY_W, ui::EF_CONTROL_DOWN,
ui::Accelerator::KeyState::PRESSED)))
.Times(0);
generator.PressKey(ui::VKEY_W, ui::EF_CONTROL_DOWN);
testing::Mock::VerifyAndClearExpectations(shell_surface.get());
// Release the key and reset modifier_flags.
EXPECT_CALL(*delegate_ptr,
OnKeyboardModifiers(KeyboardModifiers{kNumLockMask, 0, 0, 0}));
EXPECT_CALL(*delegate_ptr,
OnKeyboardKey(testing::_, ui::DomCode::US_W, false));
generator.ReleaseKey(ui::VKEY_W, 0);
// Verify before destroying keyboard to make sure the expected call
// is made on the methods above, rather than in the destructor.
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
}
TEST_F(KeyboardTest, AckKeyboardKeyMoveFocus) {
auto shell_surface = test::ShellSurfaceBuilder({10, 10}).BuildShellSurface();
auto* surface = shell_surface->surface_for_testing();
aura::client::FocusClient* focus_client =
aura::client::GetFocusClient(ash::Shell::GetPrimaryRootWindow());
focus_client->FocusWindow(nullptr);
auto delegate = std::make_unique<NiceMockKeyboardDelegate>();
auto* delegate_ptr = delegate.get();
Seat seat;
Keyboard keyboard(std::move(delegate), &seat);
EXPECT_CALL(*delegate_ptr, CanAcceptKeyboardEventsForSurface(surface))
.WillOnce(testing::Return(true));
EXPECT_CALL(*delegate_ptr,
OnKeyboardModifiers(KeyboardModifiers{kNumLockMask, 0, 0, 0}));
EXPECT_CALL(
*delegate_ptr,
OnKeyboardEnter(surface, base::flat_map<ui::DomCode, KeyState>()));
focus_client->FocusWindow(surface->window());
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
ui::test::EventGenerator generator(ash::Shell::GetPrimaryRootWindow());
keyboard.SetNeedKeyboardKeyAcks(true);
// Press KEY_W with Ctrl.
EXPECT_CALL(*delegate_ptr, OnKeyboardModifiers(KeyboardModifiers{
kControlMask | kNumLockMask, 0, 0, 0}))
.Times(1);
EXPECT_CALL(*delegate_ptr, OnKeyboardKey(testing::_, ui::DomCode::US_W, true))
.WillOnce(testing::Return(1));
seat.set_physical_code_for_currently_processing_event_for_testing(
ui::DomCode::US_W);
generator.PressKey(ui::VKEY_W, ui::EF_CONTROL_DOWN);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// Move focus from the window
EXPECT_CALL(*delegate_ptr, OnKeyboardLeave(surface));
focus_client->FocusWindow(nullptr);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// Send ack for the key press. |AcceleratorPressed()| should not be called.
keyboard.AckKeyboardKey(1, false /* handled */);
}
TEST_F(KeyboardTest, AckKeyboardKeyExpired) {
std::unique_ptr<Surface> surface(new Surface);
auto shell_surface = std::make_unique<TestShellSurface>(surface.get());
gfx::Size buffer_size(10, 10);
std::unique_ptr<Buffer> buffer(
new Buffer(exo_test_helper()->CreateGpuMemoryBuffer(buffer_size)));
surface->Attach(buffer.get());
surface->Commit();
aura::client::FocusClient* focus_client =
aura::client::GetFocusClient(ash::Shell::GetPrimaryRootWindow());
focus_client->FocusWindow(nullptr);
auto delegate = std::make_unique<NiceMockKeyboardDelegate>();
auto* delegate_ptr = delegate.get();
Seat seat;
Keyboard keyboard(std::move(delegate), &seat);
EXPECT_CALL(*delegate_ptr, CanAcceptKeyboardEventsForSurface(surface.get()))
.WillOnce(testing::Return(true));
EXPECT_CALL(*delegate_ptr,
OnKeyboardModifiers(KeyboardModifiers{kNumLockMask, 0, 0, 0}));
EXPECT_CALL(
*delegate_ptr,
OnKeyboardEnter(surface.get(), base::flat_map<ui::DomCode, KeyState>()));
focus_client->FocusWindow(surface->window());
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
ui::test::EventGenerator generator(ash::Shell::GetPrimaryRootWindow());
keyboard.SetNeedKeyboardKeyAcks(true);
// Press KEY_W with Ctrl.
EXPECT_CALL(*delegate_ptr, OnKeyboardModifiers(KeyboardModifiers{
kControlMask | kNumLockMask, 0, 0, 0}));
EXPECT_CALL(*delegate_ptr, OnKeyboardKey(testing::_, ui::DomCode::US_W, true))
.WillOnce(testing::Return(1));
seat.set_physical_code_for_currently_processing_event_for_testing(
ui::DomCode::US_W);
generator.PressKey(ui::VKEY_W, ui::EF_CONTROL_DOWN);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// Keyboard processes pending events as if it is handled when it expires,
// so |AcceleratorPressed()| should not be called.
EXPECT_CALL(*shell_surface.get(), AcceleratorPressed(ui::Accelerator(
ui::VKEY_W, ui::EF_CONTROL_DOWN,
ui::Accelerator::KeyState::PRESSED)))
.Times(0);
// Wait until |ProcessExpiredPendingKeyAcks| is fired.
task_environment()->FastForwardBy(base::Milliseconds(1000));
// Send ack for the key press as if it was not handled. In the normal case,
// |AcceleratorPressed()| should be called, but since the timeout passed, the
// key should have been treated as handled already and removed from the
// pending_key_acks_ map. Since the event is no longer in the map,
// |AcceleratorPressed()| should not be called.
keyboard.AckKeyboardKey(1, false /* handled */);
// Release the key and reset modifier_flags.
EXPECT_CALL(*delegate_ptr,
OnKeyboardModifiers(KeyboardModifiers{kNumLockMask, 0, 0, 0}));
EXPECT_CALL(*delegate_ptr,
OnKeyboardKey(testing::_, ui::DomCode::US_W, false));
generator.ReleaseKey(ui::VKEY_W, 0);
// Verify before destroying keyboard to make sure the expected call
// is made on the methods above, rather than in the destructor.
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
}
TEST_F(KeyboardTest, AckKeyboardKeyAcceleratorOnRelease) {
auto shell_surface = test::ShellSurfaceBuilder({10, 10}).BuildShellSurface();
auto* surface = shell_surface->surface_for_testing();
// Set lacros attribute now for testing. This can be removed, when
// all clients are migrated into this model.
surface->window()->SetProperty(aura::client::kAppType,
static_cast<int>(ash::AppType::LACROS));
// Register accelerator to be triggered.
ui::TestAcceleratorTarget accelerator_target;
{
ui::Accelerator accelerator(ui::VKEY_LWIN, 0,
ui::Accelerator::KeyState::RELEASED);
ash::AcceleratorControllerImpl* controller =
ash::Shell::Get()->accelerator_controller();
controller->Register({accelerator}, &accelerator_target);
}
aura::client::FocusClient* focus_client =
aura::client::GetFocusClient(ash::Shell::GetPrimaryRootWindow());
focus_client->FocusWindow(nullptr);
auto delegate = std::make_unique<NiceMockKeyboardDelegate>();
auto* delegate_ptr = delegate.get();
Seat seat;
Keyboard keyboard(std::move(delegate), &seat);
EXPECT_CALL(*delegate_ptr, CanAcceptKeyboardEventsForSurface(surface))
.WillOnce(testing::Return(true));
EXPECT_CALL(*delegate_ptr,
OnKeyboardModifiers(KeyboardModifiers{kNumLockMask, 0, 0, 0}));
EXPECT_CALL(
*delegate_ptr,
OnKeyboardEnter(surface, base::flat_map<ui::DomCode, KeyState>()));
focus_client->FocusWindow(surface->window());
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
ui::test::EventGenerator generator(ash::Shell::GetPrimaryRootWindow());
keyboard.SetNeedKeyboardKeyAcks(true);
// Press SEARCH key.
EXPECT_CALL(*delegate_ptr, OnKeyboardModifiers(KeyboardModifiers{
kCommandMask | kNumLockMask, 0, 0, 0}));
EXPECT_CALL(*delegate_ptr,
OnKeyboardKey(testing::_, ui::DomCode::META_LEFT, true))
.WillOnce(testing::Return(1));
seat.set_physical_code_for_currently_processing_event_for_testing(
ui::DomCode::META_LEFT);
generator.PressKey(ui::VKEY_LWIN, ui::EF_COMMAND_DOWN);
// SEARCH key can be used as a modifier, so it is handled in release event.
// Thus accelerator handler should not be triggered.
EXPECT_EQ(0, accelerator_target.accelerator_count());
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// Send ack for the key press as if it was not handled.
keyboard.AckKeyboardKey(1, false /* handled */);
// Wait until |ProcessExpiredPendingKeyAcks| is fired.
task_environment()->FastForwardBy(base::Milliseconds(1000));
// Release the key and reset modifier_flags.
EXPECT_CALL(*delegate_ptr,
OnKeyboardModifiers(KeyboardModifiers{kNumLockMask, 0, 0, 0}));
EXPECT_CALL(*delegate_ptr,
OnKeyboardKey(testing::_, ui::DomCode::META_LEFT, false))
.WillOnce(testing::Return(2));
generator.ReleaseKey(ui::VKEY_LWIN, 0);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// Now the accelerator should be handled.
EXPECT_EQ(1, accelerator_target.accelerator_count());
// Then, on ack key, even if application does not process the key event,
// accelerator key should not be handled (because it is already done).
keyboard.AckKeyboardKey(2, false /* handled */);
EXPECT_EQ(1, accelerator_target.accelerator_count());
// Verify before destroying keyboard to make sure the expected call
// is made on the methods above, rather than in the destructor.
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
}
// Test for crbug.com/753539. If action for an accelerator moves the focus to
// another window, it causes clearing the map of pending key acks in Keyboard.
// We can't assume that an iterator of the map is valid after processing an
// accelerator.
class TestShellSurfaceWithMovingFocusAccelerator : public ShellSurface {
public:
explicit TestShellSurfaceWithMovingFocusAccelerator(Surface* surface)
: ShellSurface(surface) {}
bool AcceleratorPressed(const ui::Accelerator& accelerator) override {
aura::client::FocusClient* focus_client =
aura::client::GetFocusClient(ash::Shell::GetPrimaryRootWindow());
focus_client->FocusWindow(nullptr);
return true;
}
};
TEST_F(KeyboardTest, AckKeyboardKeyExpiredWithMovingFocusAccelerator) {
std::unique_ptr<Surface> surface(new Surface);
auto shell_surface =
std::make_unique<TestShellSurfaceWithMovingFocusAccelerator>(
surface.get());
gfx::Size buffer_size(10, 10);
std::unique_ptr<Buffer> buffer(
new Buffer(exo_test_helper()->CreateGpuMemoryBuffer(buffer_size)));
surface->Attach(buffer.get());
surface->Commit();
aura::client::FocusClient* focus_client =
aura::client::GetFocusClient(ash::Shell::GetPrimaryRootWindow());
focus_client->FocusWindow(nullptr);
auto delegate = std::make_unique<NiceMockKeyboardDelegate>();
auto* delegate_ptr = delegate.get();
Seat seat;
Keyboard keyboard(std::move(delegate), &seat);
EXPECT_CALL(*delegate_ptr, CanAcceptKeyboardEventsForSurface(surface.get()))
.WillOnce(testing::Return(true));
EXPECT_CALL(*delegate_ptr,
OnKeyboardModifiers(KeyboardModifiers{kNumLockMask, 0, 0, 0}));
EXPECT_CALL(
*delegate_ptr,
OnKeyboardEnter(surface.get(), base::flat_map<ui::DomCode, KeyState>()));
focus_client->FocusWindow(surface->window());
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
ui::test::EventGenerator generator(ash::Shell::GetPrimaryRootWindow());
keyboard.SetNeedKeyboardKeyAcks(true);
// Press KEY_W with Ctrl.
EXPECT_CALL(*delegate_ptr, OnKeyboardModifiers(KeyboardModifiers{
kControlMask | kNumLockMask, 0, 0, 0}));
EXPECT_CALL(*delegate_ptr, OnKeyboardKey(testing::_, ui::DomCode::US_W, true))
.WillOnce(testing::Return(1));
seat.set_physical_code_for_currently_processing_event_for_testing(
ui::DomCode::US_W);
generator.PressKey(ui::VKEY_W, ui::EF_CONTROL_DOWN);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
EXPECT_CALL(*delegate_ptr, OnKeyboardLeave(surface.get()));
// Send ack as unhandled. This will call |AcceleratorPressed| and move the
// focus.
keyboard.AckKeyboardKey(1, false /* handled */);
// Wait until |ProcessExpiredPendingKeyAcks| is fired.
task_environment()->FastForwardBy(base::Milliseconds(1000));
// Verify before destroying keyboard to make sure the expected call
// is made on the methods above, rather than in the destructor.
testing::Mock::VerifyAndClearExpectations(&delegate);
}
TEST_F(KeyboardTest, OnKeyboardKey_ChangeFocusInPreTargetHandler) {
auto shell_surface = test::ShellSurfaceBuilder({10, 10}).BuildShellSurface();
auto* surface = shell_surface->surface_for_testing();
auto normal_window = CreateAppWindow(gfx::Rect(0, 0, 100, 100));
TestEventHandler handler{shell_surface->GetWidget()->GetNativeView()};
aura::client::FocusClient* focus_client =
aura::client::GetFocusClient(ash::Shell::GetPrimaryRootWindow());
focus_client->FocusWindow(nullptr);
auto delegate = std::make_unique<NiceMockKeyboardDelegate>();
auto* delegate_ptr = delegate.get();
NiceMockKeyboardObserver observer;
Seat seat;
Keyboard keyboard(std::move(delegate), &seat);
keyboard.AddObserver(&observer);
// Focus the non-exo window.
focus_client->FocusWindow(normal_window.get());
ui::test::EventGenerator generator(ash::Shell::GetPrimaryRootWindow());
// Keyboard should not get a key event sent to the non-exo window.
generator.PressKey(ui::VKEY_A, 0);
generator.ReleaseKey(ui::VKEY_A, 0);
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
// Sending a key event causes a focus change.
// It calls OnKeyboardEnter, but OnKeyboardKey should not be called because
// the event's target is |normal_window|.
wm_helper()->AddPreTargetHandler(&handler);
EXPECT_CALL(*delegate_ptr, CanAcceptKeyboardEventsForSurface(surface))
.WillOnce(testing::Return(true));
EXPECT_CALL(*delegate_ptr,
OnKeyboardModifiers(KeyboardModifiers{kNumLockMask, 0, 0, 0}));
EXPECT_CALL(
*delegate_ptr,
OnKeyboardEnter(surface, base::flat_map<ui::DomCode, KeyState>()));
generator.PressKey(ui::VKEY_A, 0);
EXPECT_EQ(shell_surface->GetWidget()->GetNativeView(),
focus_client->GetFocusedWindow());
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
wm_helper()->RemovePreTargetHandler(&handler);
}
TEST_F(KeyboardTest, SystemKeysNotSentAsPressedKeys) {
auto shell_surface = test::ShellSurfaceBuilder({10, 10}).BuildShellSurface();
auto* surface = shell_surface->root_surface();
aura::client::FocusClient* focus_client =
aura::client::GetFocusClient(ash::Shell::GetPrimaryRootWindow());
focus_client->FocusWindow(nullptr);
Seat seat;
// Pressing keys before Keyboard instance is created and surface has
// received focus.
ui::test::EventGenerator* generator = GetEventGenerator();
seat.set_physical_code_for_currently_processing_event_for_testing(
ui::DomCode::US_A);
generator->PressKey(ui::VKEY_A, ui::EF_SHIFT_DOWN);
seat.set_physical_code_for_currently_processing_event_for_testing(
ui::DomCode::LAUNCH_APP1);
generator->PressKey(ui::VKEY_MEDIA_LAUNCH_APP1, 0);
auto delegate = std::make_unique<NiceMockKeyboardDelegate>();
auto* delegate_ptr = delegate.get();
auto keyboard = std::make_unique<Keyboard>(std::move(delegate), &seat);
ON_CALL(*delegate_ptr, CanAcceptKeyboardEventsForSurface(surface))
.WillByDefault(testing::Return(true));
// LAUNCH_APP1 should be filtered out before sending OnKeyboardEnter.
EXPECT_CALL(
*delegate_ptr,
OnKeyboardEnter(surface, base::flat_map<ui::DomCode, KeyState>(
{{ui::DomCode::US_A,
KeyState{ui::DomCode::US_A, false}}})));
focus_client->FocusWindow(surface->window());
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
}
TEST_F(KeyboardTest, CanConsumeSystemKeysSentAsPressedKeys) {
auto shell_surface = test::ShellSurfaceBuilder({10, 10}).BuildShellSurface();
auto* surface = shell_surface->root_surface();
aura::client::FocusClient* focus_client =
aura::client::GetFocusClient(ash::Shell::GetPrimaryRootWindow());
focus_client->FocusWindow(nullptr);
ash::WindowState::Get(surface->window()->GetToplevelWindow())
->SetCanConsumeSystemKeys(true);
Seat seat;
// Pressing keys before Keyboard instance is created and surface has
// received focus.
ui::test::EventGenerator* generator = GetEventGenerator();
seat.set_physical_code_for_currently_processing_event_for_testing(
ui::DomCode::US_A);
generator->PressKey(ui::VKEY_A, ui::EF_SHIFT_DOWN);
seat.set_physical_code_for_currently_processing_event_for_testing(
ui::DomCode::LAUNCH_APP1);
generator->PressKey(ui::VKEY_MEDIA_LAUNCH_APP1, 0);
auto delegate = std::make_unique<NiceMockKeyboardDelegate>();
auto* delegate_ptr = delegate.get();
auto keyboard = std::make_unique<Keyboard>(std::move(delegate), &seat);
ON_CALL(*delegate_ptr, CanAcceptKeyboardEventsForSurface(surface))
.WillByDefault(testing::Return(true));
// LAUNCH_APP1 should not be filtered out before sending OnKeyboardEnter.
EXPECT_CALL(
*delegate_ptr,
OnKeyboardEnter(
surface, base::flat_map<ui::DomCode, KeyState>({
{ui::DomCode::US_A, KeyState{ui::DomCode::US_A, false}},
{ui::DomCode::LAUNCH_APP1,
KeyState{ui::DomCode::LAUNCH_APP1, false}},
})));
focus_client->FocusWindow(surface->window());
testing::Mock::VerifyAndClearExpectations(delegate_ptr);
}
} // namespace
} // namespace exo
|