/usr/lib/python2.7/dist-packages/autokey/scripting.py is in autokey-common 0.90.4-1.1.
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 | # -*- coding: utf-8 -*-
# Copyright (C) 2011 Chris Dekter
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import subprocess, threading, time, re
import common, model, iomediator
if common.USING_QT:
from PyQt4.QtGui import QClipboard, QApplication
else:
from gi.repository import Gtk, Gdk
class Keyboard:
"""
Provides access to the keyboard for event generation.
"""
def __init__(self, mediator):
self.mediator = mediator
def send_keys(self, keyString):
"""
Send a sequence of keys via keyboard events
Usage: C{keyboard.send_keys(keyString)}
@param keyString: string of keys (including special keys) to send
"""
self.mediator.interface.begin_send()
self.mediator.send_string(keyString.decode("utf-8"))
self.mediator.interface.finish_send()
def send_key(self, key, repeat=1):
"""
Send a keyboard event
Usage: C{keyboard.send_key(key, repeat=1)}
@param key: they key to be sent (e.g. "s" or "<enter>")
@param repeat: number of times to repeat the key event
"""
for x in xrange(repeat):
self.mediator.send_key(key.decode("utf-8"))
self.mediator.flush()
def press_key(self, key):
"""
Send a key down event
Usage: C{keyboard.press_key(key)}
The key will be treated as down until a matching release_key() is sent.
@param key: they key to be pressed (e.g. "s" or "<enter>")
"""
self.mediator.press_key(key.decode("utf-8"))
def release_key(self, key):
"""
Send a key up event
Usage: C{keyboard.release_key(key)}
If the specified key was not made down using press_key(), the event will be
ignored.
@param key: they key to be released (e.g. "s" or "<enter>")
"""
self.mediator.release_key(key.decode("utf-8"))
def fake_keypress(self, key, repeat=1):
"""
Fake a keypress
Usage: C{keyboard.fake_keypress(key, repeat=1)}
Uses XTest to 'fake' a keypress. This is useful to send keypresses to some
applications which won't respond to keyboard.send_key()
@param key: they key to be sent (e.g. "s" or "<enter>")
@param repeat: number of times to repeat the key event
"""
for x in xrange(repeat):
self.mediator.fake_keypress(key.decode("utf-8"))
def wait_for_keypress(self, key, modifiers=[], timeOut=10.0):
"""
Wait for a keypress or key combination
Usage: C{keyboard.wait_for_keypress(self, key, modifiers=[], timeOut=10.0)}
Note: this function cannot be used to wait for modifier keys on their own
@param key: they key to wait for
@param modifiers: list of modifiers that should be pressed with the key
@param timeOut: maximum time, in seconds, to wait for the keypress to occur
"""
w = iomediator.Waiter(key, modifiers, None, timeOut)
w.wait()
class Mouse:
"""
Provides access to send mouse clicks
"""
def __init__(self, mediator):
self.mediator = mediator
def click_relative(self, x, y, button):
"""
Send a mouse click relative to the active window
Usage: C{mouse.click_relative(x, y, button)}
@param x: x-coordinate in pixels, relative to upper left corner of window
@param y: y-coordinate in pixels, relative to upper left corner of window
@param button: mouse button to simulate (left=1, middle=2, right=3)
"""
self.mediator.send_mouse_click(x, y, button, True)
def click_relative_self(self, x, y, button):
"""
Send a mouse click relative to the current mouse position
Usage: C{mouse.click_relative_self(x, y, button)}
@param x: x-offset in pixels, relative to current mouse position
@param y: y-offset in pixels, relative to current mouse position
@param button: mouse button to simulate (left=1, middle=2, right=3)
"""
self.mediator.send_mouse_click_relative(x, y, button)
def click_absolute(self, x, y, button):
"""
Send a mouse click relative to the screen (absolute)
Usage: C{mouse.click_absolute(x, y, button)}
@param x: x-coordinate in pixels, relative to upper left corner of window
@param y: y-coordinate in pixels, relative to upper left corner of window
@param button: mouse button to simulate (left=1, middle=2, right=3)
"""
self.mediator.send_mouse_click(x, y, button, False)
def wait_for_click(self, button, timeOut=10.0):
"""
Wait for a mouse click
Usage: C{mouse.wait_for_click(self, button, timeOut=10.0)}
@param button: they mouse button click to wait for as a button number, 1-9
@param timeOut: maximum time, in seconds, to wait for the keypress to occur
"""
button = int(button)
w = iomediator.Waiter(None, None, button, timeOut)
w.wait()
class Store(dict):
"""
Allows persistent storage of values between invocations of the script.
"""
def set_value(self, key, value):
"""
Store a value
Usage: C{store.set_value(key, value)}
"""
self[key] = value
def get_value(self, key):
"""
Get a value
Usage: C{store.get_value(key)}
"""
return self[key]
def remove_value(self, key):
"""
Remove a value
Usage: C{store.remove_value(key)}
"""
del self[key]
def set_global_value(self, key, value):
"""
Store a global value
Usage: C{store.set_global_value(key, value)}
The value stored with this method will be available to all scripts.
"""
Store.GLOBALS[key] = value
def get_global_value(self, key):
"""
Get a global value
Usage: C{store.get_global_value(key)}
"""
return self.GLOBALS[key]
def remove_global_value(self, key):
"""
Remove a global value
Usage: C{store.remove_global_value(key)}
"""
del self.GLOBALS[key]
class QtDialog:
"""
Provides a simple interface for the display of some basic dialogs to collect information from the user.
This version uses KDialog to integrate well with KDE. To pass additional arguments to KDialog that are
not specifically handled, use keyword arguments. For example, to pass the --geometry argument to KDialog
to specify the desired size of the dialog, pass C{geometry="700x400"} as one of the parameters. All
keyword arguments must be given as strings.
A note on exit codes: an exit code of 0 indicates that the user clicked OK.
"""
def __runKdialog(self, title, args, kwargs):
for k, v in kwargs.iteritems():
args.append("--" + k)
args.append(v)
p = subprocess.Popen(["kdialog", "--title", title] + args, stdout=subprocess.PIPE)
retCode = p.wait()
output = p.stdout.read()[:-1] # Drop trailing newline
return (retCode, output)
def info_dialog(self, title="Information", message="", **kwargs):
"""
Show an information dialog
Usage: C{dialog.info_dialog(title="Information", message="", **kwargs)}
@param title: window title for the dialog
@param message: message displayed in the dialog
@return: a tuple containing the exit code and user input
@rtype: C{tuple(int, str)}
"""
return self.__runKdialog(title, ["--msgbox", message], kwargs)
def input_dialog(self, title="Enter a value", message="Enter a value", default="", **kwargs):
"""
Show an input dialog
Usage: C{dialog.input_dialog(title="Enter a value", message="Enter a value", default="", **kwargs)}
@param title: window title for the dialog
@param message: message displayed above the input box
@param default: default value for the input box
@return: a tuple containing the exit code and user input
@rtype: C{tuple(int, str)}
"""
return self.__runKdialog(title, ["--inputbox", message, default], kwargs)
def password_dialog(self, title="Enter password", message="Enter password", **kwargs):
"""
Show a password input dialog
Usage: C{dialog.password_dialog(title="Enter password", message="Enter password", **kwargs)}
@param title: window title for the dialog
@param message: message displayed above the password input box
@return: a tuple containing the exit code and user input
@rtype: C{tuple(int, str)}
"""
return self.__runKdialog(title, ["--password", message], kwargs)
def combo_menu(self, options, title="Choose an option", message="Choose an option", **kwargs):
"""
Show a combobox menu
Usage: C{dialog.combo_menu(options, title="Choose an option", message="Choose an option", **kwargs)}
@param options: list of options (strings) for the dialog
@param title: window title for the dialog
@param message: message displayed above the combobox
@return: a tuple containing the exit code and user choice
@rtype: C{tuple(int, str)}
"""
return self.__runKdialog(title, ["--combobox", message] + options, kwargs)
def list_menu(self, options, title="Choose a value", message="Choose a value", default=None, **kwargs):
"""
Show a single-selection list menu
Usage: C{dialog.list_menu(options, title="Choose a value", message="Choose a value", default=None, **kwargs)}
@param options: list of options (strings) for the dialog
@param title: window title for the dialog
@param message: message displayed above the list
@param default: default value to be selected
@return: a tuple containing the exit code and user choice
@rtype: C{tuple(int, str)}
"""
choices = []
optionNum = 0
for option in options:
choices.append(str(optionNum))
choices.append(option)
if option == default:
choices.append("on")
else:
choices.append("off")
optionNum += 1
retCode, result = self.__runKdialog(title, ["--radiolist", message] + choices, kwargs)
choice = options[int(result)]
return retCode, choice
def list_menu_multi(self, options, title="Choose one or more values", message="Choose one or more values", defaults=[], **kwargs):
"""
Show a multiple-selection list menu
Usage: C{dialog.list_menu_multi(options, title="Choose one or more values", message="Choose one or more values", defaults=[], **kwargs)}
@param options: list of options (strings) for the dialog
@param title: window title for the dialog
@param message: message displayed above the list
@param defaults: list of default values to be selected
@return: a tuple containing the exit code and user choice
@rtype: C{tuple(int, str)}
"""
choices = []
optionNum = 0
for option in options:
choices.append(str(optionNum))
choices.append(option)
if option in defaults:
choices.append("on")
else:
choices.append("off")
optionNum += 1
retCode, output = self.__runKdialog(title, ["--separate-output", "--checklist", message] + choices, kwargs)
results = output.split()
choices = []
for index in results:
choices.append(options[int(index)])
return retCode, choices
def open_file(self, title="Open File", initialDir="~", fileTypes="*|All Files", rememberAs=None, **kwargs):
"""
Show an Open File dialog
Usage: C{dialog.open_file(title="Open File", initialDir="~", fileTypes="*|All Files", rememberAs=None, **kwargs)}
@param title: window title for the dialog
@param initialDir: starting directory for the file dialog
@param fileTypes: file type filter expression
@param rememberAs: gives an ID to this file dialog, allowing it to open at the last used path next time
@return: a tuple containing the exit code and file path
@rtype: C{tuple(int, str)}
"""
if rememberAs is not None:
return self.__runKdialog(title, ["--getopenfilename", initialDir, fileTypes, ":" + rememberAs], kwargs)
else:
return self.__runKdialog(title, ["--getopenfilename", initialDir, fileTypes], kwargs)
def save_file(self, title="Save As", initialDir="~", fileTypes="*|All Files", rememberAs=None, **kwargs):
"""
Show a Save As dialog
Usage: C{dialog.save_file(title="Save As", initialDir="~", fileTypes="*|All Files", rememberAs=None, **kwargs)}
@param title: window title for the dialog
@param initialDir: starting directory for the file dialog
@param fileTypes: file type filter expression
@param rememberAs: gives an ID to this file dialog, allowing it to open at the last used path next time
@return: a tuple containing the exit code and file path
@rtype: C{tuple(int, str)}
"""
if rememberAs is not None:
return self.__runKdialog(title, ["--getsavefilename", initialDir, fileTypes, ":" + rememberAs], kwargs)
else:
return self.__runKdialog(title, ["--getsavefilename", initialDir, fileTypes], kwargs)
def choose_directory(self, title="Select Directory", initialDir="~", rememberAs=None, **kwargs):
"""
Show a Directory Chooser dialog
Usage: C{dialog.choose_directory(title="Select Directory", initialDir="~", rememberAs=None, **kwargs)}
@param title: window title for the dialog
@param initialDir: starting directory for the directory chooser dialog
@param rememberAs: gives an ID to this file dialog, allowing it to open at the last used path next time
@return: a tuple containing the exit code and chosen path
@rtype: C{tuple(int, str)}
"""
if rememberAs is not None:
return self.__runKdialog(title, ["--getexistingdirectory", initialDir, ":" + rememberAs], kwargs)
else:
return self.__runKdialog(title, ["--getexistingdirectory", initialDir], kwargs)
def choose_colour(self, title="Select Colour", **kwargs):
"""
Show a Colour Chooser dialog
Usage: C{dialog.choose_colour(title="Select Colour")}
@param title: window title for the dialog
@return: a tuple containing the exit code and colour
@rtype: C{tuple(int, str)}
"""
return self.__runKdialog(title, ["--getcolor"], kwargs)
def calendar(self, title="Choose a date", format="%Y-%m-%d", date="today", **kwargs):
"""
Show a calendar dialog
Usage: C{dialog.calendar_dialog(title="Choose a date", format="%Y-%m-%d", date="YYYY-MM-DD", **kwargs)}
Note: the format and date parameters are not currently used
@param title: window title for the dialog
@param format: format of date to be returned
@param date: initial date as YYYY-MM-DD, otherwise today
@return: a tuple containing the exit code and date
@rtype: C{tuple(int, str)}
"""
return self.__runKdialog(title, ["--calendar"], kwargs)
class System:
"""
Simplified access to some system commands.
"""
def exec_command(self, command, getOutput=True):
"""
Execute a shell command
Usage: C{system.exec_command(command, getOutput=True)}
Set getOutput to False if the command does not exit and return immediately. Otherwise
AutoKey will not respond to any hotkeys/abbreviations etc until the process started
by the command exits.
@param command: command to be executed (including any arguments) - e.g. "ls -l"
@param getOutput: whether to capture the (stdout) output of the command
@raise subprocess.CalledProcessError: if the command returns a non-zero exit code
"""
if getOutput:
p = subprocess.Popen(command, shell=True, bufsize=-1, stdout=subprocess.PIPE)
retCode = p.wait()
output = p.stdout.read()[:-1]
if retCode != 0:
raise subprocess.CalledProcessError(retCode, output)
else:
return output
else:
subprocess.Popen(command, shell=True, bufsize=-1)
def create_file(self, fileName, contents=""):
"""
Create a file with contents
Usage: C{system.create_file(fileName, contents="")}
@param fileName: full path to the file to be created
@param contents: contents to insert into the file
"""
f = open(fileName, "w")
f.write(contents)
f.close()
class GtkDialog:
"""
Provides a simple interface for the display of some basic dialogs to collect information from the user.
This version uses Zenity to integrate well with GNOME. To pass additional arguments to Zenity that are
not specifically handled, use keyword arguments. For example, to pass the --timeout argument to Zenity
pass C{timeout="15"} as one of the parameters. All keyword arguments must be given as strings.
A note on exit codes: an exit code of 0 indicates that the user clicked OK.
"""
def __runZenity(self, title, args, kwargs):
for k, v in kwargs.iteritems():
args.append("--" + k)
args.append(v)
p = subprocess.Popen(["zenity", "--title", title] + args, stdout=subprocess.PIPE)
retCode = p.wait()
output = p.stdout.read()[:-1] # Drop trailing newline
return (retCode, output)
def info_dialog(self, title="Information", message="", **kwargs):
"""
Show an information dialog
Usage: C{dialog.info_dialog(title="Information", message="", **kwargs)}
@param title: window title for the dialog
@param message: message displayed in the dialog
@return: a tuple containing the exit code and user input
@rtype: C{tuple(int, str)}
"""
return self.__runZenity(title, ["--info", "--text", message], kwargs)
def input_dialog(self, title="Enter a value", message="Enter a value", default="", **kwargs):
"""
Show an input dialog
Usage: C{dialog.input_dialog(title="Enter a value", message="Enter a value", default="", **kwargs)}
@param title: window title for the dialog
@param message: message displayed above the input box
@param default: default value for the input box
@return: a tuple containing the exit code and user input
@rtype: C{tuple(int, str)}
"""
return self.__runZenity(title, ["--entry", "--text", message, "--entry-text", default], kwargs)
def password_dialog(self, title="Enter password", message="Enter password", **kwargs):
"""
Show a password input dialog
Usage: C{dialog.password_dialog(title="Enter password", message="Enter password")}
@param title: window title for the dialog
@param message: message displayed above the password input box
@return: a tuple containing the exit code and user input
@rtype: C{tuple(int, str)}
"""
return self.__runZenity(title, ["--entry", "--text", message, "--hide-text"], kwargs)
#def combo_menu(self, options, title="Choose an option", message="Choose an option"):
"""
Show a combobox menu - not supported by zenity
Usage: C{dialog.combo_menu(options, title="Choose an option", message="Choose an option")}
@param options: list of options (strings) for the dialog
@param title: window title for the dialog
@param message: message displayed above the combobox
"""
#return self.__runZenity(title, ["--combobox", message] + options)
def list_menu(self, options, title="Choose a value", message="Choose a value", default=None, **kwargs):
"""
Show a single-selection list menu
Usage: C{dialog.list_menu(options, title="Choose a value", message="Choose a value", default=None, **kwargs)}
@param options: list of options (strings) for the dialog
@param title: window title for the dialog
@param message: message displayed above the list
@param default: default value to be selected
@return: a tuple containing the exit code and user choice
@rtype: C{tuple(int, str)}
"""
choices = []
#optionNum = 0
for option in options:
if option == default:
choices.append("TRUE")
else:
choices.append("FALSE")
#choices.append(str(optionNum))
choices.append(option)
#optionNum += 1
return self.__runZenity(title, ["--list", "--radiolist", "--text", message, "--column", " ", "--column", "Options"] + choices, kwargs)
#return retCode, choice
def list_menu_multi(self, options, title="Choose one or more values", message="Choose one or more values", defaults=[], **kwargs):
"""
Show a multiple-selection list menu
Usage: C{dialog.list_menu_multi(options, title="Choose one or more values", message="Choose one or more values", defaults=[], **kwargs)}
@param options: list of options (strings) for the dialog
@param title: window title for the dialog
@param message: message displayed above the list
@param defaults: list of default values to be selected
@return: a tuple containing the exit code and user choice
@rtype: C{tuple(int, str)}
"""
choices = []
#optionNum = 0
for option in options:
if option in defaults:
choices.append("TRUE")
else:
choices.append("FALSE")
#choices.append(str(optionNum))
choices.append(option)
#optionNum += 1
retCode, output = self.__runZenity(title, ["--list", "--checklist", "--text", message, "--column", " ", "--column", "Options"] + choices, kwargs)
results = output.split('|')
#choices = []
#for choice in results:
# choices.append(choice)
return retCode, results
def open_file(self, title="Open File", **kwargs):
"""
Show an Open File dialog
Usage: C{dialog.open_file(title="Open File", **kwargs)}
@param title: window title for the dialog
@return: a tuple containing the exit code and file path
@rtype: C{tuple(int, str)}
"""
#if rememberAs is not None:
# return self.__runZenity(title, ["--getopenfilename", initialDir, fileTypes, ":" + rememberAs])
#else:
return self.__runZenity(title, ["--file-selection"], kwargs)
def save_file(self, title="Save As", **kwargs):
"""
Show a Save As dialog
Usage: C{dialog.save_file(title="Save As", **kwargs)}
@param title: window title for the dialog
@return: a tuple containing the exit code and file path
@rtype: C{tuple(int, str)}
"""
#if rememberAs is not None:
# return self.__runZenity(title, ["--getsavefilename", initialDir, fileTypes, ":" + rememberAs])
#else:
return self.__runZenity(title, ["--file-selection", "--save"], kwargs)
def choose_directory(self, title="Select Directory", initialDir="~", **kwargs):
"""
Show a Directory Chooser dialog
Usage: C{dialog.choose_directory(title="Select Directory", **kwargs)}
@param title: window title for the dialog
@return: a tuple containing the exit code and path
@rtype: C{tuple(int, str)}
"""
#if rememberAs is not None:
# return self.__runZenity(title, ["--getexistingdirectory", initialDir, ":" + rememberAs])
#else:
return self.__runZenity(title, ["--file-selection", "--directory"], kwargs)
#def choose_colour(self, title="Select Colour"):
"""
Show a Colour Chooser dialog - not supported by zenity
Usage: C{dialog.choose_colour(title="Select Colour")}
@param title: window title for the dialog
"""
#return self.__runZenity(title, ["--getcolor"])
def calendar(self, title="Choose a date", format="%Y-%m-%d", date="today", **kwargs):
"""
Show a calendar dialog
Usage: C{dialog.calendar_dialog(title="Choose a date", format="%Y-%m-%d", date="YYYY-MM-DD", **kwargs)}
@param title: window title for the dialog
@param format: format of date to be returned
@param date: initial date as YYYY-MM-DD, otherwise today
@return: a tuple containing the exit code and date
@rtype: C{tuple(int, str)}
"""
if re.match(r"[0-9]{4}-[0-9]{2}-[0-9]{2}", date):
year = date[0:4]
month = date[5:7]
day = date[8:10]
date_args = ["--year=" + year, "--month=" + month, "--day=" + day]
else:
date_args = []
return self.__runZenity(title, ["--calendar", "--date-format=" + format] + date_args, kwargs)
class QtClipboard:
"""
Read/write access to the X selection and clipboard - QT version
"""
def __init__(self, app):
self.clipBoard = QApplication.clipboard()
self.app = app
def fill_selection(self, contents):
"""
Copy text into the X selection
Usage: C{clipboard.fill_selection(contents)}
@param contents: string to be placed in the selection
"""
self.__execAsync(self.__fillSelection, contents)
def __fillSelection(self, string):
self.clipBoard.setText(string, QClipboard.Selection)
self.sem.release()
def get_selection(self):
"""
Read text from the X selection
Usage: C{clipboard.get_selection()}
@return: text contents of the mouse selection
@rtype: C{str}
"""
self.__execAsync(self.__getSelection)
return unicode(self.text)
def __getSelection(self):
self.text = self.clipBoard.text(QClipboard.Selection)
self.sem.release()
def fill_clipboard(self, contents):
"""
Copy text into the clipboard
Usage: C{clipboard.fill_clipboard(contents)}
@param contents: string to be placed in the selection
"""
self.__execAsync(self.__fillClipboard, contents)
def __fillClipboard(self, string):
self.clipBoard.setText(string, QClipboard.Clipboard)
self.sem.release()
def get_clipboard(self):
"""
Read text from the clipboard
Usage: C{clipboard.get_clipboard()}
@return: text contents of the clipboard
@rtype: C{str}
"""
self.__execAsync(self.__getClipboard)
return unicode(self.text)
def __getClipboard(self):
self.text = self.clipBoard.text(QClipboard.Clipboard)
self.sem.release()
def __execAsync(self, callback, *args):
self.sem = threading.Semaphore(0)
self.app.exec_in_main(callback, *args)
self.sem.acquire()
class GtkClipboard:
"""
Read/write access to the X selection and clipboard - GTK version
"""
def __init__(self, app):
self.clipBoard = Gtk.Clipboard.get(Gdk.SELECTION_CLIPBOARD)
self.selection = Gtk.Clipboard.get(Gdk.SELECTION_PRIMARY)
self.app = app
def fill_selection(self, contents):
"""
Copy text into the X selection
Usage: C{clipboard.fill_selection(contents)}
@param contents: string to be placed in the selection
"""
#self.__execAsync(self.__fillSelection, contents)
self.__fillSelection(contents)
def __fillSelection(self, string):
Gdk.threads_enter()
self.selection.set_text(string.encode("utf-8"))
Gdk.threads_leave()
#self.sem.release()
def get_selection(self):
"""
Read text from the X selection
Usage: C{clipboard.get_selection()}
@return: text contents of the mouse selection
@rtype: C{str}
@raise Exception: if no text was found in the selection
"""
Gdk.threads_enter()
text = self.selection.wait_for_text()
Gdk.threads_leave()
if text is not None:
return text.decode("utf-8")
else:
raise Exception("No text found in X selection")
def fill_clipboard(self, contents):
"""
Copy text into the clipboard
Usage: C{clipboard.fill_clipboard(contents)}
@param contents: string to be placed in the selection
"""
Gdk.threads_enter()
self.clipBoard.set_text(contents.encode("utf-8"))
Gdk.threads_leave()
def get_clipboard(self):
"""
Read text from the clipboard
Usage: C{clipboard.get_clipboard()}
@return: text contents of the clipboard
@rtype: C{str}
@raise Exception: if no text was found on the clipboard
"""
Gdk.threads_enter()
text = self.clipBoard.wait_for_text()
Gdk.threads_leave()
if text is not None:
return text.decode("utf-8")
else:
raise Exception("No text found on clipboard")
class Window:
"""
Basic window management using wmctrl
Note: in all cases where a window title is required (with the exception of wait_for_focus()),
two special values of window title are permitted:
:ACTIVE: - select the currently active window
:SELECT: - select the desired window by clicking on it
"""
def __init__(self, mediator):
self.mediator = mediator
def wait_for_focus(self, title, timeOut=5):
"""
Wait for window with the given title to have focus
Usage: C{window.wait_for_focus(title, timeOut=5)}
If the window becomes active, returns True. Otherwise, returns False if
the window has not become active by the time the timeout has elapsed.
@param title: title to match against (as a regular expression)
@param timeOut: period (seconds) to wait before giving up
@rtype: boolean
"""
regex = re.compile(title)
waited = 0
while waited <= timeOut:
if regex.match(self.mediator.interface.get_window_title()):
return True
if timeOut == 0:
break # zero length timeout, if not matched go straight to end
time.sleep(0.3)
waited += 0.3
return False
def wait_for_exist(self, title, timeOut=5):
"""
Wait for window with the given title to be created
Usage: C{window.wait_for_exist(title, timeOut=5)}
If the window is in existence, returns True. Otherwise, returns False if
the window has not been created by the time the timeout has elapsed.
@param title: title to match against (as a regular expression)
@param timeOut: period (seconds) to wait before giving up
@rtype: boolean
"""
regex = re.compile(title)
waited = 0
while waited <= timeOut:
retCode, output = self.__runWmctrl(["-l"])
for line in output.split('\n'):
if regex.match(line[14:].split(' ', 1)[-1]):
return True
if timeOut == 0:
break # zero length timeout, if not matched go straight to end
time.sleep(0.3)
waited += 0.3
return False
def activate(self, title, switchDesktop=False, matchClass=False):
"""
Activate the specified window, giving it input focus
Usage: C{window.activate(title, switchDesktop=False, matchClass=False)}
If switchDesktop is False (default), the window will be moved to the current desktop
and activated. Otherwise, switch to the window's current desktop and activate it there.
@param title: window title to match against (as case-insensitive substring match)
@param switchDesktop: whether or not to switch to the window's current desktop
@param matchClass: if True, match on the window class instead of the title
"""
if switchDesktop:
args = ["-a", title]
else:
args = ["-R", title]
if matchClass:
args += ["-x"]
self.__runWmctrl(args)
def close(self, title, matchClass=False):
"""
Close the specified window gracefully
Usage: C{window.close(title, matchClass=False)}
@param title: window title to match against (as case-insensitive substring match)
@param matchClass: if True, match on the window class instead of the title
"""
if matchClass:
self.__runWmctrl(["-c", title, "-x"])
else:
self.__runWmctrl(["-c", title])
def resize_move(self, title, xOrigin=-1, yOrigin=-1, width=-1, height=-1, matchClass=False):
"""
Resize and/or move the specified window
Usage: C{window.close(title, xOrigin=-1, yOrigin=-1, width=-1, height=-1, matchClass=False)}
Leaving and of the position/dimension values as the default (-1) will cause that
value to be left unmodified.
@param title: window title to match against (as case-insensitive substring match)
@param xOrigin: new x origin of the window (upper left corner)
@param yOrigin: new y origin of the window (upper left corner)
@param width: new width of the window
@param height: new height of the window
@param matchClass: if True, match on the window class instead of the title
"""
mvArgs = ["0", str(xOrigin), str(yOrigin), str(width), str(height)]
if matchClass:
xArgs = ["-x"]
else:
xArgs = []
self.__runWmctrl(["-r", title, "-e", ','.join(mvArgs)] + xArgs)
def move_to_desktop(self, title, deskNum, matchClass=False):
"""
Move the specified window to the given desktop
Usage: C{window.move_to_desktop(title, deskNum, matchClass=False)}
@param title: window title to match against (as case-insensitive substring match)
@param deskNum: desktop to move the window to (note: zero based)
@param matchClass: if True, match on the window class instead of the title
"""
if matchClass:
xArgs = ["-x"]
else:
xArgs = []
self.__runWmctrl(["-r", title, "-t", str(deskNum)] + xArgs)
def switch_desktop(self, deskNum):
"""
Switch to the specified desktop
Usage: C{window.switch_desktop(deskNum)}
@param deskNum: desktop to switch to (note: zero based)
"""
self.__runWmctrl(["-s", str(deskNum)])
def set_property(self, title, action, prop, matchClass=False):
"""
Set a property on the given window using the specified action
Usage: C{window.set_property(title, action, prop, matchClass=False)}
Allowable actions: C{add, remove, toggle}
Allowable properties: C{modal, sticky, maximized_vert, maximized_horz, shaded, skip_taskbar,
skip_pager, hidden, fullscreen, above}
@param title: window title to match against (as case-insensitive substring match)
@param action: one of the actions listed above
@param prop: one of the properties listed above
@param matchClass: if True, match on the window class instead of the title
"""
if matchClass:
xArgs = ["-x"]
else:
xArgs = []
self.__runWmctrl(["-r", title, "-b" + action + ',' + prop] + xArgs)
def get_active_geometry(self):
"""
Get the geometry of the currently active window
Usage: C{window.get_active_geometry()}
@return: a 4-tuple containing the x-origin, y-origin, width and height of the window (in pixels)
@rtype: C{tuple(int, int, int, int)}
"""
active = self.mediator.interface.get_window_title()
result, output = self.__runWmctrl(["-l", "-G"])
matchingLine = None
for line in output.split('\n'):
if active in line[34:].split(' ', 1)[-1]:
matchingLine = line
if matchingLine is not None:
output = matchingLine.split()[2:6]
return map(int, output)
else:
return None
def get_active_title(self):
"""
Get the visible title of the currently active window
Usage: C{window.get_active_title()}
@return: the visible title of the currentle active window
@rtype: C{str}
"""
return self.mediator.interface.get_window_title()
def get_active_class(self):
"""
Get the class of the currently active window
Usage: C{window.get_active_class()}
@return: the class of the currentle active window
@rtype: C{str}
"""
return self.mediator.interface.get_window_class()
def __runWmctrl(self, args):
p = subprocess.Popen(["wmctrl"] + args, stdout=subprocess.PIPE)
retCode = p.wait()
output = p.stdout.read()[:-1] # Drop trailing newline
return (retCode, output)
class Engine:
"""
Provides access to the internals of AutoKey.
Note that any configuration changes made using this API while the configuration window
is open will not appear until it is closed and re-opened.
"""
def __init__(self, configManager, runner):
self.configManager = configManager
self.runner = runner
self.monitor = configManager.app.monitor
self.__returnValue = ''
def get_folder(self, title):
"""
Retrieve a folder by its title
Usage: C{engine.get_folder(title)}
Note that if more than one folder has the same title, only the first match will be
returned.
"""
for folder in self.configManager.allFolders:
if folder.title == title:
return folder
return None
def create_phrase(self, folder, description, contents):
"""
Create a text phrase
Usage: C{engine.create_phrase(folder, description, contents)}
A new phrase with no abbreviation or hotkey is created in the specified folder
@param folder: folder to place the abbreviation in, retrieved using C{engine.get_folder()}
@param description: description for the phrase
@param contents: the expansion text
"""
self.monitor.suspend()
p = model.Phrase(description, contents)
folder.add_item(p)
p.persist()
self.monitor.unsuspend()
self.configManager.config_altered(False)
def create_abbreviation(self, folder, description, abbr, contents):
"""
Create a text abbreviation
Usage: C{engine.create_abbreviation(folder, description, abbr, contents)}
When the given abbreviation is typed, it will be replaced with the given
text.
@param folder: folder to place the abbreviation in, retrieved using C{engine.get_folder()}
@param description: description for the phrase
@param abbr: the abbreviation that will trigger the expansion
@param contents: the expansion text
@raise Exception: if the specified abbreviation is not unique
"""
if not self.configManager.check_abbreviation_unique(abbr, None, None):
raise Exception("The specified abbreviation is already in use")
self.monitor.suspend()
p = model.Phrase(description, contents)
p.modes.append(model.TriggerMode.ABBREVIATION)
p.abbreviations = [abbr]
folder.add_item(p)
p.persist()
self.monitor.unsuspend()
self.configManager.config_altered(False)
def create_hotkey(self, folder, description, modifiers, key, contents):
"""
Create a text hotkey
Usage: C{engine.create_hotkey(folder, description, modifiers, key, contents)}
When the given hotkey is pressed, it will be replaced with the given
text. Modifiers must be given as a list of strings, with the following
values permitted:
<ctrl>
<alt>
<super>
<hyper>
<meta>
<shift>
The key must be an unshifted character (i.e. lowercase)
@param folder: folder to place the abbreviation in, retrieved using C{engine.get_folder()}
@param description: description for the phrase
@param modifiers: modifiers to use with the hotkey (as a list)
@param key: the hotkey
@param contents: the expansion text
@raise Exception: if the specified hotkey is not unique
"""
modifiers.sort()
if not self.configManager.check_hotkey_unique(modifiers, key, None, None):
raise Exception("The specified hotkey and modifier combination is already in use")
self.monitor.suspend()
p = model.Phrase(description, contents)
p.modes.append(model.TriggerMode.HOTKEY)
p.set_hotkey(modifiers, key)
folder.add_item(p)
p.persist()
self.monitor.unsuspend()
self.configManager.config_altered(False)
def run_script(self, description):
"""
Run an existing script using its description to look it up
Usage: C{engine.run_script(description)}
@param description: description of the script to run
@raise Exception: if the specified script does not exist
"""
targetScript = None
for item in self.configManager.allItems:
if item.description == description and isinstance(item, model.Script):
targetScript = item
if targetScript is not None:
self.runner.run_subscript(targetScript)
else:
raise Exception("No script with description '%s' found" % description)
def run_script_from_macro(self, args):
"""
Used internally by AutoKey for phrase macros
"""
self.__macroArgs = args["args"].split(',')
try:
self.run_script(args["name"])
except Exception, e:
self.set_return_value("{ERROR: %s}" % str(e))
def get_macro_arguments(self):
"""
Get the arguments supplied to the current script via its macro
Usage: C{engine.get_macro_arguments()}
@return: the arguments
@rtype: C{list(str())}
"""
return self.__macroArgs
def set_return_value(self, val):
"""
Store a return value to be used by a phrase macro
Usage: C{engine.set_return_value(val)}
@param val: value to be stored
"""
self.__returnValue = val
def get_return_value(self):
"""
Used internally by AutoKey for phrase macros
"""
ret = self.__returnValue
self.__returnValue = ''
return ret
|