/usr/lib/perl5/X11/GUITest.pm is in libx11-guitest-perl 0.25-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | # X11::GUITest ($Id: GUITest.pm 211 2011-05-21 14:06:02Z ctrondlp $)
#
# Copyright (c) 2003-2011 Dennis K. Paulsen, All Rights Reserved.
# Email: ctrondlp@cpan.org
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation; either version 2 of
# the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, see <http://www.gnu.org/licenses>.
#
#
=head1 NAME
B<X11::GUITest> - Provides GUI testing/interaction routines.
Developed by Dennis K. Paulsen
=head1 VERSION
0.25
Updates are made available at the following sites:
ttp://sourceforge.net/projects/x11guitest
http://www.cpan.org
Please consult 'docs/Changes' for the list of changes between
module revisions.
=head1 DESCRIPTION
This Perl package is intended to facilitate the testing of GUI applications
by means of user emulation. It can be used to test/interact with GUI
applications; which have been built upon the X library or toolkits
(i.e., GTK+, Xt, Qt, Motif, etc.) that "wrap" the X library's functionality.
A basic recorder (x11guirecord) is also available, and can be found in
the source code respository.
=head1 DEPENDENCIES
An X server with the XTest extensions enabled. This seems to be the
norm. If it is not enabled, it usually can be by modifying the X
server configuration (i.e., XF86Config).
The standard DISPLAY environment variable is utilized to determine
the host, display, and screen to work with. By default it is usually set
to ":0.0" for the localhost. However, by altering this variable one can
interact with applications under a remote host's X server. To change this
from a terminal window, one can utilize the following basic syntax:
export DISPLAY=<hostname-or-ipaddress>:<display>.<screen> Please note that
under most circumstances, xhost will need to be executed properly on the remote
host as well.
There is a known incompatibility between the XTest and Xinerama extensions,
which causes the XTestFakeMotionEvent() function to misbehave. When the
Xinerama (X server) extension is turned on, this (Perl) extension has been
modified to allow one to invoke an alternative function. See Makefile.PL for
details.
=head1 INSTALLATION
perl Makefile.PL
make
make test
make install
# If you'd like to install the recorder, use these steps:
cd recorder
./autogen.sh
./configure
make
make install
x11guirecord --help
=head1 SYNOPSIS
For additional examples, please look under the 'eg/'
sub-directory from the installation folder.
use X11::GUITest qw/
StartApp
WaitWindowViewable
SendKeys
/;
# Start gedit application
StartApp('gedit');
# Wait for application window to come up and become viewable.
my ($GEditWinId) = WaitWindowViewable('gedit');
if (!$GEditWinId) {
die("Couldn't find gedit window in time!");
}
# Send text to it
SendKeys("Hello, how are you?\n");
# Close Application (Alt-f, q).
SendKeys('%(f)q');
# Handle gedit's Question window if it comes up when closing. Wait
# at most 5 seconds for it.
if (WaitWindowViewable('Question', undef, 5)) {
# DoN't Save (Alt-n)
SendKeys('%(n)');
}
=cut
package X11::GUITest;
use strict;
use warnings;
use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
require Exporter;
require DynaLoader;
#require AutoLoader;
@ISA = qw(Exporter DynaLoader);
# Items to export into callers namespace by default. Note: do not export
# names by default without a very good reason. Use EXPORT_OK instead.
# Do not simply export all your public functions/methods/constants.
@EXPORT = qw(
);
@EXPORT_OK = qw(
ClickMouseButton
ClickWindow
DefaultScreen
FindWindowLike
GetChildWindows
GetEventSendDelay
GetInputFocus
GetKeySendDelay
GetMousePos
GetParentWindow
GetRootWindow
GetScreenDepth
GetScreenRes
GetWindowFromPoint
GetWindowName
GetWindowPos
IconifyWindow
IsChild
IsKeyPressed
IsMouseButtonPressed
IsWindow
IsWindowCursor
IsWindowViewable
LowerWindow
MoveMouseAbs
MoveWindow
PressKey
PressMouseButton
PressReleaseKey
QSfSK
QuoteStringForSendKeys
RaiseWindow
ReleaseKey
ReleaseMouseButton
ResizeWindow
RunApp
ScreenCount
SendKeys
SetEventSendDelay
SetInputFocus
SetKeySendDelay
SetWindowName
StartApp
UnIconifyWindow
WaitSeconds
WaitWindowClose
WaitWindowLike
WaitWindowViewable
);
# Tags (:ALL, etc.)
%EXPORT_TAGS = (
'ALL' => \@EXPORT_OK,
'CONST' => [qw(DEF_WAIT M_LEFT M_MIDDLE M_RIGHT M_UP M_DOWN M_BTN1 M_BTN2 M_BTN3 M_BTN4 M_BTN5 XC_X_CURSOR XC_ARROW XC_BASED_ARROW_DOWN XC_BASED_ARROW_UP XC_BOAT XC_BOGOSITY XC_BOTTOM_LEFT_CORNER XC_BOTTOM_RIGHT_CORNER XC_BOTTOM_SIDE XC_BOTTOM_TEE XC_BOX_SPIRAL XC_CENTER_PTR XC_CIRCLE XC_CLOCK XC_COFFEE_MUG XC_CROSS XC_CROSS_REVERSE XC_CROSSHAIR XC_DIAMOND_CROSS XC_DOT XC_DOTBOX XC_DOUBLE_ARROW XC_DRAFT_LARGE XC_DRAFT_SMALL XC_DRAPED_BOX XC_EXCHANGE XC_FLEUR XC_GOBBLER XC_GUMBY XC_HAND1 XC_HAND2 XC_HEART XC_ICON XC_IRON_CROSS XC_LEFT_PTR XC_LEFT_SIDE XC_LEFT_TEE XC_LEFTBUTTON XC_LL_ANGLE XC_LR_ANGLE XC_MAN XC_MIDDLEBUTTON XC_MOUSE XC_PENCIL XC_PIRATE XC_PLUS XC_QUESTION_ARROW XC_RIGHT_PTR XC_RIGHT_SIDE XC_RIGHT_TEE XC_RIGHTBUTTON XC_RTL_LOGO XC_SAILBOAT XC_SB_DOWN_ARROW XC_SB_H_DOUBLE_ARROW XC_SB_LEFT_ARROW XC_SB_RIGHT_ARROW XC_SB_UP_ARROW XC_SB_V_DOUBLE_ARROW XC_SHUTTLE XC_SIZING XC_SPIDER XC_SPRAYCAN XC_STAR XC_TARGET XC_TCROSS XC_TOP_LEFT_ARROW XC_TOP_LEFT_CORNER XC_TOP_RIGHT_CORNER XC_TOP_SIDE XC_TOP_TEE XC_TREK XC_UL_ANGLE XC_UMBRELLA XC_UR_ANGLE XC_WATCH XC_XTERM)],
);
Exporter::export_ok_tags(keys %EXPORT_TAGS);
$VERSION = '0.25';
# Module Constants
sub DEF_WAIT() { 10; }
# Mouse Buttons
sub M_BTN1() { 1; }
sub M_BTN2() { 2; }
sub M_BTN3() { 3; }
sub M_BTN4() { 4; }
sub M_BTN5() { 5; }
sub M_LEFT() { M_BTN1; }
sub M_MIDDLE() { M_BTN2; }
sub M_RIGHT() { M_BTN3; }
sub M_UP() { M_BTN4; }
sub M_DOWN() { M_BTN5; }
# Cursors
sub XC_X_CURSOR() { 0 };
sub XC_ARROW() { 2 };
sub XC_BASED_ARROW_DOWN() { 4 };
sub XC_BASED_ARROW_UP() { 6 };
sub XC_BOAT() { 8 };
sub XC_BOGOSITY() { 10 };
sub XC_BOTTOM_LEFT_CORNER() { 12 };
sub XC_BOTTOM_RIGHT_CORNER() { 14 };
sub XC_BOTTOM_SIDE() { 16 };
sub XC_BOTTOM_TEE() { 18 };
sub XC_BOX_SPIRAL() { 20 };
sub XC_CENTER_PTR() { 22 };
sub XC_CIRCLE() { 24 };
sub XC_CLOCK() { 26 };
sub XC_COFFEE_MUG() { 28 };
sub XC_CROSS() { 30 };
sub XC_CROSS_REVERSE() { 32 };
sub XC_CROSSHAIR() { 34 };
sub XC_DIAMOND_CROSS() { 36 };
sub XC_DOT() { 38 };
sub XC_DOTBOX() { 40 };
sub XC_DOUBLE_ARROW() { 42 };
sub XC_DRAFT_LARGE() { 44 };
sub XC_DRAFT_SMALL() { 46 };
sub XC_DRAPED_BOX() { 48 };
sub XC_EXCHANGE() { 50 };
sub XC_FLEUR() { 52 };
sub XC_GOBBLER() { 54 };
sub XC_GUMBY() { 56 };
sub XC_HAND1() { 58 };
sub XC_HAND2() { 60 };
sub XC_HEART() { 62 };
sub XC_ICON() { 64 };
sub XC_IRON_CROSS() { 66 };
sub XC_LEFT_PTR() { 68 };
sub XC_LEFT_SIDE() { 70 };
sub XC_LEFT_TEE() { 72 };
sub XC_LEFTBUTTON() { 74 };
sub XC_LL_ANGLE() { 76 };
sub XC_LR_ANGLE() { 78 };
sub XC_MAN() { 80 };
sub XC_MIDDLEBUTTON() { 82 };
sub XC_MOUSE() { 84 };
sub XC_PENCIL() { 86 };
sub XC_PIRATE() { 88 };
sub XC_PLUS() { 90 };
sub XC_QUESTION_ARROW() { 92 };
sub XC_RIGHT_PTR() { 94 };
sub XC_RIGHT_SIDE() { 96 };
sub XC_RIGHT_TEE() { 98 };
sub XC_RIGHTBUTTON() { 100 };
sub XC_RTL_LOGO() { 102 };
sub XC_SAILBOAT() { 104 };
sub XC_SB_DOWN_ARROW() { 106 };
sub XC_SB_H_DOUBLE_ARROW() { 108 };
sub XC_SB_LEFT_ARROW() { 110 };
sub XC_SB_RIGHT_ARROW() { 112 };
sub XC_SB_UP_ARROW() { 114 };
sub XC_SB_V_DOUBLE_ARROW() { 116 };
sub XC_SHUTTLE() { 118 };
sub XC_SIZING() { 120 };
sub XC_SPIDER() { 122 };
sub XC_SPRAYCAN() { 124 };
sub XC_STAR() { 126 };
sub XC_TARGET() { 128 };
sub XC_TCROSS() { 130 };
sub XC_TOP_LEFT_ARROW() { 132 };
sub XC_TOP_LEFT_CORNER() { 134 };
sub XC_TOP_RIGHT_CORNER() { 136 };
sub XC_TOP_SIDE() { 138 };
sub XC_TOP_TEE() { 140 };
sub XC_TREK() { 142 };
sub XC_UL_ANGLE() { 144 };
sub XC_UMBRELLA() { 146 };
sub XC_UR_ANGLE() { 148 };
sub XC_WATCH() { 150 };
sub XC_XTERM() { 152 };
# Module Variables
bootstrap X11::GUITest $VERSION;
=head1 FUNCTIONS
Parameters enclosed within [] are optional.
If there are multiple optional parameters available for a function
and you would like to specify the last one, for example, you can
utilize undef for those parameters you don't specify.
REGEX in the documentation below denotes an item that is treated as
a regular expression. For example, the regex "^OK$" would look for
an exact match for the word OK.
=over 8
=item FindWindowLike TITLEREGEX [, WINDOWIDSTARTUNDER]
Finds the window Ids of the windows matching the specified title regex.
Optionally one can specify the window to start under; which would allow
one to constrain the search to child windows of that window.
An array of window Ids is returned for the matches found. An empty
array is returned if no matches were found.
my @WindowIds = FindWindowLike('gedit');
# Only worry about first window found
my ($WindowId) = FindWindowLike('gedit');
=back
=cut
my $FindWindowLikeAux =
sub {
my $titlerx = shift;
my $start = shift;
my $winname = '';
my @wins = ();
# Match the starting window???
$winname = GetWindowName($start);
if (defined $winname && $winname =~ /$titlerx/i) {
push @wins, $start;
}
# Match a child window?
foreach my $child (GetChildWindows($start)) {
$winname = GetWindowName($child);
if (defined $winname && $winname =~ /$titlerx/i) {
push @wins, $child;
}
}
return(@wins);
};
sub FindWindowLike {
my $titlerx = shift;
my $start = shift;
if (defined $start) {
return &$FindWindowLikeAux($titlerx, $start);
}
else {
my @wins = ();
for (my $i = ScreenCount() - 1; $i >= 0 ; --$i) {
push @wins, &$FindWindowLikeAux($titlerx,
GetRootWindow($i));
}
return(@wins);
}
}
=over 8
=item WaitWindowLike TITLEREGEX [, WINDOWIDSTARTUNDER] [, MAXWAITINSECONDS]
Waits for a window to come up that matches the specified title regex.
Optionally one can specify the window to start under; which would allow
one to constrain the search to child windows of that window.
One can optionally specify an alternative wait amount in seconds. A
window will keep being looked for that matches the specified title regex
until this amount of time has been reached. The default amount is defined
in the DEF_WAIT constant available through the :CONST export tag.
If a window is going to be manipulated by input, WaitWindowViewable is the
more robust solution to utilize.
An array of window Ids is returned for the matches found. An empty
array is returned if no matches were found.
my @WindowIds = WaitWindowLike('gedit');
# Only worry about first window found
my ($WindowId) = WaitWindowLike('gedit');
WaitWindowLike('gedit') or die("gedit window not found!");
=back
=cut
sub WaitWindowLike {
my $titlerx = shift;
my $start = shift;
my $wait = shift || DEF_WAIT;
my @wins = ();
# For each second we $wait, look for window title once.
for (my $i = 0; $i < $wait; $i++) {
my @wins = FindWindowLike($titlerx, $start);
if (@wins) {
return(@wins);
}
# Wait 1 sec in order not to bog down the system
select(undef, undef, undef, 1);
}
# Nothing
return(@wins);
}
=over 8
=item WaitWindowViewable TITLEREGEX [, WINDOWIDSTARTUNDER] [, MAXWAITINSECONDS]
Similar to WaitWindow, but only recognizes windows that are viewable. When GUI
applications are started, their window isn't necessarily viewable yet, let alone
available for input, so this function is very useful.
Likewise, this function will only return an array of the matching window Ids for
those windows that are viewable. An empty array is returned if no matches were
found.
=back
=cut
sub WaitWindowViewable {
my $titlerx = shift;
my $start = shift;
my $wait = shift || DEF_WAIT;
my @wins = ();
# For each second we $wait, look for window title once.
for (my $i = 0; $i < $wait; $i++) {
# Find windows, but recognize only those that are viewable
foreach my $win (FindWindowLike($titlerx, $start)) {
if (IsWindowViewable($win)) {
push @wins, $win;
}
}
if (@wins) {
return(@wins);
}
# Wait 1 sec in order not to bog down the system.
select(undef, undef, undef, 1);
}
# Nothing
return(@wins);
}
=over 8
=item WaitWindowClose WINDOWID [, MAXWAITINSECONDS]
Waits for the specified window to close.
One can optionally specify an alternative wait amount in seconds. The
window will keep being checked to see if it has closed until this amount
of time has been reached. The default amount is defined in the DEF_WAIT
constant available through the :CONST export tag.
zero is returned if window is not gone, non-zero if it is gone.
=back
=cut
sub WaitWindowClose {
my $win = shift;
my $wait = shift || DEF_WAIT;
# For each second we $wait, check window Id
# twice (2 lookups * 500ms = ~1 second).
for (my $i = 0; $i < ($wait * 2); $i++) {
if (not IsWindow($win)) {
# Success, window isn't recognized
return(1);
}
# Wait 500 ms in order not to bog down the system. If one
# changes this, the ($wait * 2) above will want to be changed
# in order to represent seconds correctly.
select(undef, undef, undef, 0.50);
}
# Failure
return(0);
}
=over 8
=item WaitSeconds SECONDS
Pauses execution for the specified amount of seconds.
WaitSeconds(0.5); # Wait 1/2 second
WaitSeconds(3); # Wait 3 seconds
=back
=cut
sub WaitSeconds {
select(undef, undef, undef, shift);
}
=over 8
=item ClickWindow WINDOWID [, X Offset] [, Y Offset] [, Button]
Clicks on the specified window with the mouse.
Optionally one can specify the X offset and Y offset. By default,
the top left corner of the window is clicked on, with these two
parameters one can specify a different position to be clicked on.
One can also specify an alternative button. The default button is
M_LEFT, but M_MIDDLE and M_RIGHT may be specified too. Also,
you could use the logical Id for the button: M_BTN1, M_BTN2, M_BTN3,
M_BTN4, M_BTN5. These are all available through the :CONST export
tag.
zero is returned on failure, non-zero for success
=back
=cut
sub ClickWindow {
my $win = shift;
my $x_offset = shift || 0;
my $y_offset = shift || 0;
my $button = shift || M_LEFT;
my ($x, $y, $scr);
($x, $y, undef, undef, undef, $scr) = GetWindowPos($win);
if (!defined($x) or !defined($y)) {
return(0);
}
if (!MoveMouseAbs($x + $x_offset, $y + $y_offset, $scr)) {
return(0);
}
if (!ClickMouseButton($button)) {
return(0);
}
return(1);
}
=over 8
=item GetWindowFromPoint X, Y [, SCREEN]
Returns the window that is at the specified point. If no screen is given, it
is taken from the value given when opening the X display.
zero is returned if there are no matches (i.e., off screen).
=back
=cut
sub GetWindowFromPoint {
my $x = shift;
my $y = shift;
my $scr = shift;
my $lastmatch = 0;
if ( ! defined $scr) {
$scr = DefaultScreen();
}
# Note: Windows are returned in current stacking order, therefore
# the last match should be the top-most window.
foreach my $win ( GetChildWindows(GetRootWindow($scr)) ) {
my ($w_x1, $w_y1, $w_w, $w_h, $w_b) = GetWindowPos($win);
# Is window position invalid?
if (!defined $w_x1) {
next;
}
my $w_x2 = ($w_x1 + $w_w + ($w_b << 1));
my $w_y2 = ($w_y1 + $w_h + ($w_b << 1));
# Does window match our point?
if ($x >= $w_x1 && $x < $w_x2 && $y >= $w_y1 && $y < $w_y2) {
$lastmatch = $win;
}
}
return($lastmatch);
}
=over 8
=item IsChild PARENTWINDOWID, WINDOWID
Determines if the specified window is a child of the
specified parent.
zero is returned for false, non-zero for true.
=back
=cut
sub IsChild {
my $parent = shift;
my $win = shift;
foreach my $child ( GetChildWindows($parent) ) {
if ($child == $win && $child != $parent) {
return(1);
}
}
return(0);
}
=over 8
=item QuoteStringForSendKeys STRING
Quotes {} characters in the specified string that would be interpreted
as having special meaning if sent to SendKeys directly. This function
would be useful if you had a text file in which you wanted to use each
line of the file as input to the SendKeys function, but didn't want
any special interpretation of the characters in the file.
Returns the quoted string, undef is returned on error.
# Quote ~, %, etc. as {~}, {%}, etc for literal use in SendKeys.
SendKeys( QuoteStringForSendKeys('Hello: ~%^(){}+#') );
SendKeys( QSfSK('#+#') );
=back
=cut
sub QuoteStringForSendKeys {
my $str = shift;
if (!defined($str)) {
return(undef);
}
# Quote {} special characters (^, %, (, {, etc.)
$str =~ s/(\^|\%|\+|\~|\(|\)|\{|\})/\{$1\}/gm;
return($str);
}
sub QSfSK {
return QuoteStringForSendKeys(shift);
}
=over 8
=item StartApp COMMANDLINE
Uses the shell to execute a program. This function returns as
soon as the program is called. Useful for starting GUI
applications and then going on to work with them.
zero is returned on failure, non-zero for success
StartApp('gedit');
=back
=cut
sub StartApp {
my @cmd = @_;
my $pid = fork;
if ($pid) {
use POSIX qw(WNOHANG);
sleep 1;
waitpid($pid, WNOHANG) != $pid
and kill(0, $pid) == 1
and return $pid;
} elsif (defined $pid) {
use POSIX qw(_exit);
exec @cmd or _exit(1);
}
return;
}
=over 8
=item RunApp COMMANDLINE
Uses the shell to execute a program until its completion.
Return value will be application specific, however -1 is returned
to indicate a failure in starting the program.
RunApp('/work/myapp');
=back
=cut
sub RunApp {
my $cmdline = shift;
return( system($cmdline) );
}
=over 8
=item ClickMouseButton BUTTON
Clicks the specified mouse button. Available mouse buttons
are: M_LEFT, M_MIDDLE, M_RIGHT, M_DOWN, M_UP. Also, you could
use the logical Id for the button: M_BTN1, M_BTN2, M_BTN3,
M_BTN4, M_BTN5. These are all available through the :CONST
export tag.
zero is returned on failure, non-zero for success.
=back
=cut
sub ClickMouseButton {
my $button = shift;
if (!PressMouseButton($button) ||
!ReleaseMouseButton($button)) {
return(0);
}
return(1);
}
# Subroutine: INIT
# Description: Used to initialize the underlying mechanisms
# that this package utilizes.
# Note: Perl idiom not to return values for this subroutine.
sub INIT {
if (!defined($ENV{'AUTOMATED_TESTING'}) || $ENV{'AUTOMATED_TESTING'} ne 1) {
InitGUITest();
}
}
# Subroutine: END
# Description: Used to deinitialize the underlying mechanisms
# that this package utilizes.
# Note: Perl idiom not to return values for this subroutine.
sub END {
DeInitGUITest();
}
=over 8
=item DefaultScreen
Returns the screen number specified in the X display value used to open the
display.
Leverages the Xlib macro of the same name.
=back
=cut
=over 8
=item ScreenCount
Returns the number of screens in the X display specified when opening it.
Leverages the Xlib macro of the same name.
=back
=cut
=over 8
=item SetEventSendDelay DELAYINMILLISECONDS
Sets the milliseconds of delay between events being sent to the
X display. It is usually not a good idea to set this to 0.
Please note that this delay will also affect SendKeys.
Returns the old delay amount in milliseconds.
=back
=cut
=over 8
=item GetEventSendDelay
Returns the current event sending delay amount in milliseconds.
=back
=cut
=over 8
=item SetKeySendDelay DELAYINMILLISECONDS
Sets the milliseconds of delay between keystrokes.
Returns the old delay amount in milliseconds.
=back
=cut
=over 8
=item GetKeySendDelay
Returns the current keystroke sending delay amount in milliseconds.
=back
=cut
=over 8
=item GetWindowName WINDOWID
Returns the window name for the specified window Id. undef
is returned if name could not be obtained.
# Return the name of the window that has the input focus.
my $WinName = GetWindowName(GetInputFocus());
=back
=cut
=over 8
=item SetWindowName WINDOWID, NAME
Sets the window name for the specified window Id.
zero is returned on failure, non-zero for success.
=back
=cut
=over 8
=item GetRootWindow [SCREEN]
Returns the Id of the root window of the screen. This is the top/root level
window that all other windows are under. If no screen is given, it is taken
from the value given when opening the X display.
=back
=cut
=over 8
=item GetChildWindows WINDOWID
Returns an array of the child windows for the specified
window Id. If it detects that the window hierarchy
is in transition, it will wait half a second and try
again.
=back
=cut
=over 8
=item MoveMouseAbs X, Y [, SCREEN]
Moves the mouse cursor to the specified absolute position in the optionally
given screen. If no screen is given, it is taken from the value given when
opening the X display.
Zero is returned on failure, non-zero for success.
=back
=cut
=over 8
=item GetMousePos
Returns an array containing the position and the screen (number) of the mouse
cursor.
my ($x, $y, $scr_num) = GetMousePos();
=back
=cut
=over 8
=item PressMouseButton BUTTON
Presses the specified mouse button. Available mouse buttons
are: M_LEFT, M_MIDDLE, M_RIGHT, M_DOWN, M_UP. Also, you could
use the logical Id for the button: M_BTN1, M_BTN2, M_BTN3, M_BTN4,
M_BTN5. These are all available through the :CONST export tag.
zero is returned on failure, non-zero for success.
=back
=cut
=over 8
=item ReleaseMouseButton BUTTON
Releases the specified mouse button. Available mouse buttons
are: M_LEFT, M_MIDDLE, M_RIGHT, M_DOWN, M_UP. Also, you could
use the logical Id for the button: M_BTN1, M_BTN2, M_BTN3, M_BTN4,
M_BTN5. These are all available through the :CONST export tag.
zero is returned on failure, non-zero for success.
=back
=cut
=over 8
=item SendKeys KEYS
Sends keystrokes to the window that has the input focus.
The keystrokes to send are those specified in KEYS parameter. Some characters
have special meaning, they are:
Modifier Keys:
^ CTRL
% ALT
+ SHIFT
# META
ALTGR
Other Keys:
~ ENTER
\n ENTER
\t TAB
( and ) MODIFIER GROUPING
{ and } QUOTE / ESCAPE CHARACTERS
Simply, one can send a text string like so:
SendKeys('Hello, how are you today?');
Parenthesis allow a modifier to work on one or more characters. For example:
SendKeys('%(f)q'); # Alt-f, then press q
SendKeys('%(fa)^(m)'); # Alt-f, Alt-a, Ctrl-m
SendKeys('+(abc)'); # Uppercase ABC using shift modifier
SendKeys('^(+(l))'); # Ctrl-Shift-l
SendKeys('+'); # Press shift
Braces are used to quote special characters, for utilizing aliased key
names, or for special functionality. Multiple characters can be specified
in a brace by space delimiting the entries. Characters can be repeated using
a number that is space delimited after the preceding key.
Quote Special Characters
SendKeys('{{}'); # {
SendKeys('{+}'); # +
SendKeys('{#}'); # #
You can also use QuoteStringForSendKeys (QSfSK) to perform quoting.
Aliased Key Names
SendKeys('{BAC}'); # Backspace
SendKeys('{F1 F2 F3}'); # F1, F2, F3
SendKeys('{TAB 3}'); # Press TAB 3 times
SendKeys('{SPC 3 a b c}'); # Space 3 times, a, b, c
Special Functionality
# Pause execution for 500 milliseconds
SendKeys('{PAUSE 500}');
Combinations
SendKeys('abc+(abc){TAB PAUSE 500}'); # a, b, c, A, B, C, Tab, Pause 500
SendKeys('+({a b c})'); # A, B, C
The following abbreviated key names are currently recognized within a brace set. If you
don't see the desired key, you can still use the unabbreviated name for the key. If you
are unsure of this name, utilize the xev (X event view) tool, press the key you
want and look at the tools output for the name of that key. Names that are in the list
below can be utilized regardless of case. Ones that aren't in this list are going to be
case sensitive and also not abbreviated. For example, using 'xev' you will find that the
name of the backspace key is BackSpace, so you could use {BackSpace} in place of {bac}
if you really wanted to.
Name Action
-------------------
BAC BackSpace
BS BackSpace
BKS BackSpace
BRE Break
CAN Cancel
CAP Caps_Lock
DEL Delete
DOW Down
END End
ENT Return
ESC Escape
F1 F1
... ...
F12 F12
HEL Help
HOM Home
INS Insert
LAL Alt_L
LMA Meta_L
LCT Control_L
LEF Left
LSH Shift_L
LSK Super_L
MNU Menu
NUM Num_Lock
PGD Page_Down
PGU Page_Up
PRT Print
RAL Alt_R
RMA Meta_R
RCT Control_R
RIG Right
RSH Shift_R
RSK Super_R
SCR Scroll_Lock
SPA Space
SPC Space
TAB Tab
UP Up
zero is returned on failure, non-zero for success. For configurations (Xvfb)
that don't support Alt_Left, Meta_Left is automatically used in its place.
=back
=cut
=over 8
=item PressKey KEY
Presses the specified key.
One can utilize the abbreviated key names from the table
listed above as outlined in the following example:
# Alt-n
PressKey('LAL'); # Left Alt
PressKey('n');
ReleaseKey('n');
ReleaseKey('LAL');
# Uppercase a
PressKey('LSH'); # Left Shift
PressKey('a');
ReleaseKey('a');
ReleaseKey('LSH');
The ReleaseKey calls in the above example are there to set
both key states back.
zero is returned on failure, non-zero for success.
=back
=cut
=over 8
=item ReleaseKey KEY
Releases the specified key. Normally follows a PressKey call.
One can utilize the abbreviated key names from the table
listed above.
ReleaseKey('n');
zero is returned on failure, non-zero for success.
=back
=cut
=over 8
=item PressReleaseKey KEY
Presses and releases the specified key.
One can utilize the abbreviated key names from the table
listed above.
PressReleaseKey('n');
This function is affected by the key send delay.
zero is returned on failure, non-zero for success.
=back
=cut
=over 8
=item IsKeyPressed KEY
Determines if the specified key is currently being pressed.
You can specify such things as 'bac' or the unabbreviated form 'BackSpace' as
covered in the SendKeys information. Brace forms such as '{bac}' are
unsupported. A '{' is taken literally and letters are case sensitive.
if (IsKeyPressed('esc')) { # Is Escape pressed?
if (IsKeyPressed('a')) { # Is a pressed?
if (IsKeyPressed('A')) { # Is A pressed?
Returns non-zero for true, zero for false.
=back
=cut
=over 8
=item IsMouseButtonPressed BUTTON
Determines if the specified mouse button is currently being pressed.
Available mouse buttons are: M_LEFT, M_MIDDLE, M_RIGHT. Also, you
could use the logical Id for the button: M_BTN1, M_BTN2, M_BTN3,
M_BTN4, M_BTN5. These are all available through the :CONST export
tag.
if (IsMouseButtonPressed(M_LEFT)) { # Is left button pressed?
Returns non-zero for true, zero for false.
=back
=cut
=over 8
=item IsWindow WINDOWID
zero is returned if the specified window Id is not for something
that can be recognized as a window. non-zero is returned if it
looks like a window.
=back
=cut
=over 8
=item IsWindowViewable WINDOWID
zero is returned if the specified window Id is for a window that
isn't viewable. non-zero is returned if the window is viewable.
=back
=cut
=over 8
=item IsWindowCursor WINDOWID CURSOR
Determines if the specified window has the specified cursor.
zero is returned for false, non-zero for true.
The following cursors are available through the :CONST export tag.
Name
-------------------
XC_NUM_GLYPHS
XC_X_CURSOR
XC_ARROW
XC_BASED_ARROW_DOWN
XC_BASED_ARROW_UP
XC_BOAT
XC_BOGOSITY
XC_BOTTOM_LEFT_CORNER
XC_BOTTOM_RIGHT_CORNER
XC_BOTTOM_SIDE
XC_BOTTOM_TEE
XC_BOX_SPIRAL
XC_CENTER_PTR
XC_CIRCLE
XC_CLOCK
XC_COFFEE_MUG
XC_CROSS
XC_CROSS_REVERSE
XC_CROSSHAIR
XC_DIAMOND_CROSS
XC_DOT
XC_DOTBOX
XC_DOUBLE_ARROW
XC_DRAFT_LARGE
XC_DRAFT_SMALL
XC_DRAPED_BOX
XC_EXCHANGE
XC_FLEUR
XC_GOBBLER
XC_GUMBY
XC_HAND1
XC_HAND2
XC_HEART
XC_ICON
XC_IRON_CROSS
XC_LEFT_PTR
XC_LEFT_SIDE
XC_LEFT_TEE
XC_LEFTBUTTON
XC_LL_ANGLE
XC_LR_ANGLE
XC_MAN
XC_MIDDLEBUTTON
XC_MOUSE
XC_PENCIL
XC_PIRATE
XC_PLUS
XC_QUESTION_ARROW
XC_RIGHT_PTR
XC_RIGHT_SIDE
XC_RIGHT_TEE
XC_RIGHTBUTTON
XC_RTL_LOGO
XC_SAILBOAT
XC_SB_DOWN_ARROW
XC_SB_H_DOUBLE_ARROW
XC_SB_LEFT_ARROW
XC_SB_RIGHT_ARROW
XC_SB_UP_ARROW
XC_SB_V_DOUBLE_ARROW
XC_SHUTTLE
XC_SIZING
XC_SPIDER
XC_SPRAYCAN
XC_STAR
XC_TARGET
XC_TCROSS
XC_TOP_LEFT_ARROW
XC_TOP_LEFT_CORNER
XC_TOP_RIGHT_CORNER
XC_TOP_SIDE
XC_TOP_TEE
XC_TREK
XC_UL_ANGLE
XC_UMBRELLA
XC_UR_ANGLE
XC_WATCH
XC_XTERM
=back
=cut
=over 8
=item MoveWindow WINDOWID, X, Y
Moves the window to the specified location.
zero is returned on failure, non-zero for success.
=back
=cut
=over 8
=item ResizeWindow WINDOWID, WIDTH, HEIGHT
Resizes the window to the specified size.
zero is returned on failure, non-zero for success.
=back
=cut
=over 8
=item IconifyWindow WINDOWID
Minimizes (Iconifies) the specified window.
zero is returned on failure, non-zero for success.
=back
=cut
=over 8
=item UnIconifyWindow WINDOWID
Unminimizes (UnIconifies) the specified window.
zero is returned on failure, non-zero for success.
=back
=cut
=over 8
=item RaiseWindow WINDOWID
Raises the specified window to the top of the stack, so
that no other windows cover it.
zero is returned on failure, non-zero for success.
=back
=cut
=over 8
=item LowerWindow WINDOWID
Lowers the specified window to the bottom of the stack, so
other existing windows will cover it.
zero is returned on failure, non-zero for success.
=back
=cut
=over 8
=item GetInputFocus
Returns the window that currently has the input focus.
=back
=cut
=over 8
=item SetInputFocus WINDOWID
Sets the specified window to be the one that has the input focus.
zero is returned on failure, non-zero for success.
=back
=cut
=over 8
=item GetWindowPos WINDOWID
Returns an array containing the position information for the specified
window. It also returns size information (including border width) and the
number of the screen where the window resides.
my ($x, $y, $width, $height, $borderWidth, $screen) =
GetWindowPos(GetRootWindow());
=back
=cut
=over 8
=item GetParentWindow WINDOWID
Returns the parent of the specified window.
zero is returned if parent couldn't be determined (i.e., root window).
=back
=cut
=over 8
=item GetScreenDepth [SCREEN]
Returns the color depth for the screen. If no screen is specified, it is taken
from the value given when opening the X display. If the screen (number) is
invalid, -1 will be returned.
Value is represented as bits, i.e. 16.
my $depth = GetScreenDepth();
=back
=cut
=over 8
=item GetScreenRes [SCREEN]
Returns the screen resolution. If no screen is specified, it is taken from the
value given when opening the X display. If the screen (number) is invalid, the
returned list will be empty.
my ($x, $y) = GetScreenRes();
=back
=cut
=head1 OTHER DOCUMENTATION
=begin html
<a href='Changes'>Module Changes</a><br>
<a href='CodingStyle'>Coding-Style Guidelines</a><br>
<a href='ToDo'>ToDo List</a><br>
<a href='Copying'>Copy of the GPL License</a><br>
=end html
=begin text
Available under the docs sub-directory.
Changes (Module Changes)
CodingStyle (Coding-Style Guidelines)
ToDo (ToDo List)
Copying (Copy of the GPL License)
=end text
=begin man
Not installed.
=end man
=head1 COPYRIGHT
Copyright(c) 2003-2011 Dennis K. Paulsen, All Rights Reserved. This
program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License.
=head1 AUTHOR
Dennis K. Paulsen <ctrondlp@cpan.org> (Des Moines, Iowa USA)
=head1 CREDITS
Thanks to everyone; including those specifically mentioned below for patches,
suggestions, etc.:
Alexey Tourbin
Richard Clamp
Gustav Larsson
Nelson D. Caro
=cut
# Autoload methods go after __END__, and are processed by the autosplit program.
# Return success
1;
__END__
|