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 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786
|
# Orca
#
# Copyright 2010 Joanmarie Diggs.
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the
# Free Software Foundation, Inc., Franklin Street, Fifth Floor,
# Boston MA 02110-1301 USA.
"""Commonly-required utility methods needed by -- and potentially
customized by -- application and toolkit scripts. They have
been pulled out from the scripts because certain scripts had
gotten way too large as a result of including these methods."""
__id__ = "$Id$"
__version__ = "$Revision$"
__date__ = "$Date$"
__copyright__ = "Copyright (c) 2010 Joanmarie Diggs."
__license__ = "LGPL"
import functools
import math
import pyatspi
import re
from . import chnames
from . import debug
from . import keynames
from . import keybindings
from . import input_event
from . import messages
from . import mouse_review
from . import orca_state
from . import pronunciation_dict
from . import settings
#############################################################################
# #
# Utilities #
# #
#############################################################################
class Utilities:
EMBEDDED_OBJECT_CHARACTER = '\ufffc'
SUPERSCRIPT_DIGITS = \
['\u2070', '\u00b9', '\u00b2', '\u00b3', '\u2074',
'\u2075', '\u2076', '\u2077', '\u2078', '\u2079']
SUBSCRIPT_DIGITS = \
['\u2080', '\u2081', '\u2082', '\u2083', '\u2084',
'\u2085', '\u2086', '\u2087', '\u2088', '\u2089']
flags = re.UNICODE
WORDS_RE = re.compile("(\W+)", flags)
SUPERSCRIPTS_RE = re.compile("[%s]+" % "".join(SUPERSCRIPT_DIGITS), flags)
SUBSCRIPTS_RE = re.compile("[%s]+" % "".join(SUBSCRIPT_DIGITS), flags)
# generatorCache
#
DISPLAYED_LABEL = 'displayedLabel'
DISPLAYED_TEXT = 'displayedText'
KEY_BINDING = 'keyBinding'
NESTING_LEVEL = 'nestingLevel'
NODE_LEVEL = 'nodeLevel'
REAL_ACTIVE_DESCENDANT = 'realActiveDescendant'
def __init__(self, script):
"""Creates an instance of the Utilities class.
Arguments:
- script: the script with which this instance is associated.
"""
self._script = script
#########################################################################
# #
# Utilities for finding, identifying, and comparing accessibles #
# #
#########################################################################
@staticmethod
def __hasLabelForRelation(label):
"""Check if label has a LABEL_FOR relation
Arguments:
- label: the label in question
Returns TRUE if label has a LABEL_FOR relation.
"""
if (not label) or (label.getRole() != pyatspi.ROLE_LABEL):
return False
relations = label.getRelationSet()
for relation in relations:
if relation.getRelationType() == pyatspi.RELATION_LABEL_FOR:
return True
return False
@staticmethod
def __isLabeling(label, obj):
"""Check if label is connected via LABEL_FOR relation with object
Arguments:
- obj: the object in question
- labeled: the label in question
Returns TRUE if label has a relation LABEL_FOR for object.
"""
if not obj or not label or label.getRole() != pyatspi.ROLE_LABEL:
return False
relations = label.getRelationSet()
if not relations:
return False
for relation in relations:
if relation.getRelationType() == pyatspi.RELATION_LABEL_FOR:
for i in range(0, relation.getNTargets()):
target = relation.getTarget(i)
if target == obj:
return True
return False
@staticmethod
def activeWindow():
"""Traverses the list of known apps looking for one who has an
immediate child (i.e., a window) whose state includes the active
state.
Returns the Python Accessible of the window that's active or None if
no windows are active.
"""
apps = Utilities.knownApplications()
for app in apps:
for child in app:
try:
if child.getState().contains(pyatspi.STATE_ACTIVE):
return child
except:
debug.printException(debug.LEVEL_FINEST)
return None
@staticmethod
def allDescendants(root, onlyShowing=True):
"""Returns a list of all objects under the given root. Objects
are returned in no particular order - this function does a simple
tree traversal, ignoring the children of objects which report the
MANAGES_DESCENDANTS state.
Arguments:
- root: the Accessible object to traverse
- onlyShowing: examine only those objects that are SHOWING
Returns: a list of all objects under the specified object
"""
if root and root.childCount <= 0:
return []
objlist = []
for i, child in enumerate(root):
debug.println(debug.LEVEL_FINEST,
"Script.allDescendants looking at child %d" % i)
try:
state = child.getState()
except:
debug.println(debug.LEVEL_FINEST, "Error getting state")
continue
if not onlyShowing \
or (onlyShowing and state.contains(pyatspi.STATE_SHOWING)):
objlist.append(child)
if not state.contains(pyatspi.STATE_MANAGES_DESCENDANTS) \
and child.childCount > 0:
objlist.extend(Utilities.allDescendants(child, onlyShowing))
return objlist
@staticmethod
def ancestorWithRole(obj, ancestorRoles, stopRoles):
"""Returns the object of the specified roles which contains the
given object, or None if the given object is not contained within
an object the specified roles.
Arguments:
- obj: the Accessible object
- ancestorRoles: the list of roles to look for
- stopRoles: the list of roles to stop the search at
"""
if not obj:
return None
if not isinstance(ancestorRoles, [].__class__):
ancestorRoles = [ancestorRoles]
if not isinstance(stopRoles, [].__class__):
stopRoles = [stopRoles]
ancestor = None
obj = obj.parent
while obj and (obj != obj.parent):
try:
role = obj.getRole()
except:
break
if role in ancestorRoles:
ancestor = obj
break
elif role in stopRoles:
break
else:
obj = obj.parent
return ancestor
def cellIndex(self, obj):
"""Returns the index of the cell which should be used with the
table interface. This is necessary because in some apps we
cannot count on getIndexInParent() returning the index we need.
Arguments:
-obj: the table cell whose index we need.
"""
return obj.getIndexInParent()
def childNodes(self, obj):
"""Gets all of the children that have RELATION_NODE_CHILD_OF pointing
to this expanded table cell.
Arguments:
-obj: the Accessible Object
Returns: a list of all the child nodes
"""
try:
table = obj.parent.queryTable()
except:
return []
else:
if not obj.getState().contains(pyatspi.STATE_EXPANDED):
return []
nodes = []
# First see if this accessible implements RELATION_NODE_PARENT_OF.
# If it does, the full target list are the nodes. If it doesn't
# we'll do an old-school, row-by-row search for child nodes.
#
relations = obj.getRelationSet()
try:
for relation in relations:
if relation.getRelationType() == \
pyatspi.RELATION_NODE_PARENT_OF:
for target in range(relation.getNTargets()):
node = relation.getTarget(target)
if node and node.getIndexInParent() != -1:
nodes.append(node)
return nodes
except:
pass
index = self.cellIndex(obj)
row = table.getRowAtIndex(index)
col = table.getColumnAtIndex(index)
nodeLevel = self.nodeLevel(obj)
done = False
# Candidates will be in the rows beneath the current row.
# Only check in the current column and stop checking as
# soon as the node level of a candidate is equal or less
# than our current level.
#
for i in range(row+1, table.nRows):
cell = table.getAccessibleAt(i, col)
relations = cell.getRelationSet()
for relation in relations:
if relation.getRelationType() \
== pyatspi.RELATION_NODE_CHILD_OF:
nodeOf = relation.getTarget(0)
if self.isSameObject(obj, nodeOf):
nodes.append(cell)
else:
currentLevel = self.nodeLevel(nodeOf)
if currentLevel <= nodeLevel:
done = True
break
if done:
break
return nodes
def commonAncestor(self, a, b):
"""Finds the common ancestor between Accessible a and Accessible b.
Arguments:
- a: Accessible
- b: Accessible
"""
debug.println(debug.LEVEL_FINEST,
"script_utilities.commonAncestor...")
if (not a) or (not b):
return None
if a == b:
return a
aParents = [a]
try:
parent = a.parent
while parent and (parent.parent != parent):
aParents.append(parent)
parent = parent.parent
aParents.reverse()
except:
debug.printException(debug.LEVEL_FINEST)
bParents = [b]
try:
parent = b.parent
while parent and (parent.parent != parent):
bParents.append(parent)
parent = parent.parent
bParents.reverse()
except:
debug.printException(debug.LEVEL_FINEST)
commonAncestor = None
maxSearch = min(len(aParents), len(bParents))
i = 0
while i < maxSearch:
if self.isSameObject(aParents[i], bParents[i]):
commonAncestor = aParents[i]
i += 1
else:
break
debug.println(debug.LEVEL_FINEST,
"...script_utilities.commonAncestor")
return commonAncestor
def componentAtDesktopCoords(self, parent, x, y):
"""Get the descendant component at the given desktop coordinates.
Arguments:
- parent: The parent component we are searching below.
- x: X coordinate.
- y: Y coordinate.
Returns end-node that contains the given coordinates, or None.
"""
acc = self.popupItemAtDesktopCoords(x, y)
if acc:
return acc
container = parent
while True:
try:
ci = container.queryComponent()
except:
return None
else:
inner_container = container
container = ci.getAccessibleAtPoint(x, y, pyatspi.DESKTOP_COORDS)
if not container or container.queryComponent() == ci:
break
if inner_container.getRole() == pyatspi.ROLE_PAGE_TAB_LIST:
return container
if inner_container == parent:
return None
else:
return inner_container
def defaultButton(self, obj):
"""Returns the default button in the dialog which contains obj.
Arguments:
- obj: the top-level object (e.g. window, frame, dialog) for
which the status bar is sought.
"""
# There are some objects which are not worth descending.
#
skipRoles = [pyatspi.ROLE_TREE,
pyatspi.ROLE_TREE_TABLE,
pyatspi.ROLE_TABLE]
if obj.getState().contains(pyatspi.STATE_MANAGES_DESCENDANTS) \
or obj.getRole() in skipRoles:
return
defaultButton = None
# The default button is likely near the bottom of the window.
#
for i in range(obj.childCount - 1, -1, -1):
if obj[i].getRole() == pyatspi.ROLE_PUSH_BUTTON \
and obj[i].getState().contains(pyatspi.STATE_IS_DEFAULT):
defaultButton = obj[i]
elif not obj[i].getRole() in skipRoles:
defaultButton = self.defaultButton(obj[i])
if defaultButton:
break
return defaultButton
@staticmethod
def descendantsWithRole(root, role, onlyShowing=True):
"""Returns a list of all objects of a specific role beneath the
given root.
Arguments:
- root: the Accessible object to traverse
- role: the string describing the Accessible role of the object
- onlyShowing: examine only those objects that are SHOWING
Returns a list of descendants of the root that are of the given role.
"""
allObjs = Utilities.allDescendants(root, onlyShowing)
return [o for o in allObjs if o.getRole() == role]
def displayedLabel(self, obj):
"""If there is an object labelling the given object, return the
text being displayed for the object labelling this object.
Otherwise, return None.
Argument:
- obj: the object in question
Returns the string of the object labelling this object, or None
if there is nothing of interest here.
"""
try:
return self._script.generatorCache[self.DISPLAYED_LABEL][obj]
except:
if self.DISPLAYED_LABEL not in self._script.generatorCache:
self._script.generatorCache[self.DISPLAYED_LABEL] = {}
labelString = None
labels = self.labelsForObject(obj)
for label in labels:
labelString = \
self.appendString(labelString, self.displayedText(label))
self._script.generatorCache[self.DISPLAYED_LABEL][obj] = labelString
return self._script.generatorCache[self.DISPLAYED_LABEL][obj]
def _displayedTextInComboBox(self, combo):
"""Returns the text being displayed in a combo box. If nothing is
displayed, then None is returned.
Arguments:
- combo: the combo box
Returns the text in the combo box or an empty string if nothing is
displayed.
"""
displayedText = None
# Find the text displayed in the combo box. This is either:
#
# 1) The last text object that's a child of the combo box
# 2) The selected child of the combo box.
# 3) The contents of the text of the combo box itself when
# treated as a text object.
#
# Preference is given to #1, if it exists.
#
# If the label of the combo box is the same as the utterance for
# the child object, then this utterance is only displayed once.
#
# [[[TODO: WDW - Combo boxes are complex beasts. This algorithm
# needs serious work. Logged as bugzilla bug 319745.]]]
#
textObj = None
for child in combo:
if child and child.getRole() == pyatspi.ROLE_TEXT:
textObj = child
if textObj:
[displayedText, caretOffset, startOffset] = \
self._script.getTextLineAtCaret(textObj)
#print "TEXTOBJ", displayedText
else:
try:
comboSelection = combo.querySelection()
selectedItem = comboSelection.getSelectedChild(0)
except:
selectedItem = None
if selectedItem:
displayedText = self.displayedText(selectedItem)
#print "SELECTEDITEM", displayedText
if displayedText:
return displayedText
if combo.name and len(combo.name):
# We give preference to the name over the text because
# the text for combo boxes seems to never change in
# some cases. The main one where we see this is in
# the gaim "Join Chat" window.
#
displayedText = combo.name
#print "NAME", displayedText
else:
[displayedText, caretOffset, startOffset] = \
self._script.getTextLineAtCaret(combo)
# Set to None instead of empty string.
displayedText = displayedText or None
#print "TEXT", displayedText
return displayedText
def displayedText(self, obj):
"""Returns the text being displayed for an object.
Arguments:
- obj: the object
Returns the text being displayed for an object or None if there isn't
any text being shown.
"""
try:
return self._script.generatorCache[self.DISPLAYED_TEXT][obj]
except:
displayedText = None
try:
role = obj.getRole()
except (LookupError, RuntimeError):
role = None
if role == pyatspi.ROLE_PUSH_BUTTON and obj.name:
return obj.name
if role == pyatspi.ROLE_COMBO_BOX:
displayedText = self._displayedTextInComboBox(obj)
if self.DISPLAYED_TEXT not in self._script.generatorCache:
self._script.generatorCache[self.DISPLAYED_TEXT] = {}
self._script.generatorCache[self.DISPLAYED_TEXT][obj] = \
displayedText
return self._script.generatorCache[self.DISPLAYED_TEXT][obj]
# The accessible text of an object is used to represent what is
# drawn on the screen.
#
try:
text = obj.queryText()
except NotImplementedError:
pass
else:
displayedText = text.getText(0, text.characterCount)
# [[[WDW - HACK to account for things such as Gecko that want
# to use the EMBEDDED_OBJECT_CHARACTER on a label to hold the
# object that has the real accessible text for the label. We
# detect this by the specfic case where the text for the
# current object is a single EMBEDDED_OBJECT_CHARACTER. In
# this case, we look to the child for the real text.]]]
#
if len(displayedText) == 1 \
and displayedText[0] == self.EMBEDDED_OBJECT_CHARACTER \
and obj.childCount > 0:
try:
displayedText = self.displayedText(obj[0])
except:
debug.printException(debug.LEVEL_WARNING)
else:
# [[[TODO: HACK - Welll.....we'll just plain ignore any
# text with EMBEDDED_OBJECT_CHARACTERs here. We still need a
# general case to handle this stuff and expand objects
# with EMBEDDED_OBJECT_CHARACTERs.]]]
#
for i in range(len(displayedText)):
if displayedText[i] == self.EMBEDDED_OBJECT_CHARACTER:
displayedText = None
break
if not displayedText:
# TODO - JD: This should probably get nuked. But all sorts of
# existing code might be relying upon this bogus hack. So it
# will need thorough testing when removed.
try:
displayedText = obj.name
except (LookupError, RuntimeError):
pass
# [[[WDW - HACK because push buttons can have labels as their
# children. An example of this is the Font: button on the General
# tab in the Editing Profile dialog in gnome-terminal.
#
if not displayedText and role == pyatspi.ROLE_PUSH_BUTTON:
for child in obj:
if child.getRole() == pyatspi.ROLE_LABEL:
childText = self.displayedText(child)
if childText and len(childText):
displayedText = \
self.appendString(displayedText, childText)
if self.DISPLAYED_TEXT not in self._script.generatorCache:
self._script.generatorCache[self.DISPLAYED_TEXT] = {}
self._script.generatorCache[self.DISPLAYED_TEXT][obj] = displayedText
return self._script.generatorCache[self.DISPLAYED_TEXT][obj]
def documentFrame(self):
"""Returns the document frame which is displaying the content.
Note that this is intended primarily for web content."""
return None
def documentFrameURI(self):
"""Returns the URI of the document frame that is active."""
return None
@staticmethod
def focusedObject(root):
"""Returns the accessible that has focus under or including the
given root.
TODO: This will currently traverse all children, whether they are
visible or not and/or whether they are children of parents that
manage their descendants. At some point, this method should be
optimized to take such things into account.
Arguments:
- root: the root object where to start searching
Returns the object with the FOCUSED state or None if no object with
the FOCUSED state can be found.
"""
if not root:
return None
if root.getState().contains(pyatspi.STATE_FOCUSED):
return root
for child in root:
try:
candidate = Utilities.focusedObject(child)
if candidate:
return candidate
except:
pass
return None
def frameAndDialog(self, obj):
"""Returns the frame and (possibly) the dialog containing obj."""
results = [None, None]
parent = obj.parent
while parent and (parent.parent != parent):
if parent.getRole() == pyatspi.ROLE_FRAME:
results[0] = parent
if parent.getRole() in [pyatspi.ROLE_DIALOG,
pyatspi.ROLE_FILE_CHOOSER]:
results[1] = parent
parent = parent.parent
return results
def grabFocusBeforeRouting(self, obj, offset):
"""Whether or not we should perform a grabFocus before routing
the cursor via the braille cursor routing keys.
Arguments:
- obj: the accessible object where the cursor should be routed
- offset: the offset to which it should be routed
Returns True if we should do an explicit grabFocus on obj prior
to routing the cursor.
"""
return False
def hasMatchingHierarchy(self, obj, rolesList):
"""Called to determine if the given object and it's hierarchy of
parent objects, each have the desired roles. Please note: You
should strongly consider an alternative means for determining
that a given object is the desired item. Failing that, you should
include only enough of the hierarchy to make the determination.
If the developer of the application you are providing access to
does so much as add an Adjustment to reposition a widget, this
method can fail. You have been warned.
Arguments:
- obj: the accessible object to check.
- rolesList: the list of desired roles for the components and the
hierarchy of its parents.
Returns True if all roles match.
"""
current = obj
for role in rolesList:
if current is None:
return False
if not isinstance(role, list):
role = [role]
try:
if isinstance(role[0], str):
current_role = current.getRoleName()
else:
current_role = current.getRole()
except:
current_role = None
if not current_role in role:
return False
current = self.validParent(current)
return True
def inFindToolbar(self, obj=None):
"""Returns True if the given object is in the Find toolbar.
Arguments:
- obj: an accessible object
"""
if not obj:
obj = orca_state.locusOfFocus
if not (obj and obj.getRole() == pyatspi.ROLE_ENTRY):
return False
isToolbar = lambda x: x and x.getRole() == pyatspi.ROLE_TOOL_BAR
toolbar = pyatspi.findAncestor(obj, isToolbar)
return toolbar != None
def isFunctionalDialog(self, obj):
"""Returns True if the window is a functioning as a dialog.
This method should be subclassed by application scripts as
needed.
"""
return False
def isHidden(self, obj):
return False
def isLayoutOnly(self, obj):
"""Returns True if the given object is a container which has
no presentable information (label, name, displayed text, etc.)."""
if self.isHidden(obj):
return True
layoutOnly = False
try:
attributes = obj.getAttributes()
except:
attributes = {}
try:
role = obj.getRole()
except:
role = None
if role == pyatspi.ROLE_TABLE:
for attribute in attributes:
if attribute == "layout-guess:true":
layoutOnly = True
break
elif role == pyatspi.ROLE_TABLE_CELL and obj.childCount:
if obj[0].getRole() == pyatspi.ROLE_TABLE_CELL:
layoutOnly = True
elif obj.parent.getRole() == pyatspi.ROLE_TABLE:
layoutOnly = self.isLayoutOnly(obj.parent)
elif role == pyatspi.ROLE_SECTION:
layoutOnly = True
elif role == pyatspi.ROLE_FILLER:
layoutOnly = True
elif role == pyatspi.ROLE_SCROLL_PANE:
layoutOnly = True
elif role == pyatspi.ROLE_AUTOCOMPLETE:
layoutOnly = True
elif role in [pyatspi.ROLE_LIST_BOX, pyatspi.ROLE_TREE_TABLE]:
layoutOnly = False
elif role in [pyatspi.ROLE_DIALOG, pyatspi.ROLE_WINDOW]:
layoutOnly = False
elif role == pyatspi.ROLE_LIST or self.isTableRow(obj):
state = obj.getState()
layoutOnly = not (state.contains(pyatspi.STATE_FOCUSABLE) \
or state.contains(pyatspi.STATE_SELECTABLE))
else:
if not (self.displayedText(obj) or self.displayedLabel(obj)):
layoutOnly = True
if layoutOnly:
debug.println(debug.LEVEL_FINEST,
"Object deemed to be for layout purposes only: %s" \
% obj)
return layoutOnly
@staticmethod
def isInActiveApp(obj):
"""Returns True if the given object is from the same application that
currently has keyboard focus.
Arguments:
- obj: an Accessible object
"""
if not obj or not orca_state.locusOfFocus:
return False
return orca_state.locusOfFocus.getApplication() == obj.getApplication()
def isLink(self, obj):
"""Returns True if obj is a link."""
if not obj:
return False
try:
role = obj.getRole()
except (LookupError, RuntimeError):
debug.println(debug.LEVEL_FINE, 'Error - isLink getting role')
return False
return role == pyatspi.ROLE_LINK
def isReadOnlyTextArea(self, obj):
"""Returns True if obj is a text entry area that is read only."""
if not self.isTextArea(obj):
return False
state = obj.getState()
readOnly = state.contains(pyatspi.STATE_FOCUSABLE) \
and not state.contains(pyatspi.STATE_EDITABLE)
details = debug.getAccessibleDetails(debug.LEVEL_ALL, obj)
debug.println(debug.LEVEL_ALL,
"isReadOnlyTextArea=%s for %s" \
% (readOnly, details))
return readOnly
def _hasSamePath(self, obj1, obj2):
path1 = pyatspi.utils.getPath(obj1)
path2 = pyatspi.utils.getPath(obj2)
if len(path1) != len(path2):
return False
# The first item in all paths, even valid ones, is -1.
path1 = path1[1:]
path2 = path2[1:]
# If both have invalid child indices, all bets are off.
if path1.count(-1) and path2.count(-1):
return False
try:
index = path1.index(-1)
except ValueError:
try:
index = path2.index(-1)
except ValueError:
index = len(path2)
return path1[0:index] == path2[0:index]
def isSameObject(self, obj1, obj2, comparePaths=False):
if (obj1 == obj2):
return True
elif (not obj1) or (not obj2):
return False
try:
if (obj1.name != obj2.name) or (obj1.getRole() != obj2.getRole()):
return False
if comparePaths and self._hasSamePath(obj1, obj2):
return True
else:
# Comparing the extents of objects which claim to be different
# addresses both managed descendants and implementations which
# recreate accessibles for the same widget.
extents1 = \
obj1.queryComponent().getExtents(pyatspi.DESKTOP_COORDS)
extents2 = \
obj2.queryComponent().getExtents(pyatspi.DESKTOP_COORDS)
# Objects which claim to be different and which are in different
# locations are almost certainly not recreated objects.
if extents1 != extents2:
return False
# Objects which claim to have the same role, the same name, and
# the same size and position are highly likely to be the same
# functional object -- if they have valid, on-screen extents.
if extents1.x >= 0 and extents1.y >= 0 and extents1.width > 0 \
and extents1.height > 0:
return True
except:
pass
return False
def isTextArea(self, obj):
"""Returns True if obj is a GUI component that is for entering text.
Arguments:
- obj: an accessible
"""
if self.isLink(obj):
return False
return obj and obj.getRole() in (pyatspi.ROLE_TEXT,
pyatspi.ROLE_ENTRY,
pyatspi.ROLE_PARAGRAPH,
pyatspi.ROLE_TERMINAL)
@staticmethod
def knownApplications():
"""Retrieves the list of currently running apps for the desktop
as a list of Accessible objects.
"""
debug.println(debug.LEVEL_FINEST,
"knownApplications...")
apps = [x for x in pyatspi.Registry.getDesktop(0) if x is not None]
debug.println(debug.LEVEL_FINEST,
"...knownApplications")
return apps
def labelsForObject(self, obj):
"""Return a list of the objects that are labelling this object.
Argument:
- obj: the object in question
Returns a list of the objects that are labelling this object.
"""
# For some reason, some objects are labelled by the same thing
# more than once. Go figure, but we need to check for this.
#
label = []
try:
relations = obj.getRelationSet()
except (LookupError, RuntimeError):
debug.println(debug.LEVEL_SEVERE,
"labelsForObject() - Error getting RelationSet")
return label
allTargets = []
for relation in relations:
if relation.getRelationType() \
== pyatspi.RELATION_LABELLED_BY:
# The object can be labelled by more than one thing, so we just
# get all the labels (from unique objects) and append them
# together. An example of such objects live in the "Basic"
# page of the gnome-accessibility-keyboard-properties app.
# The "Delay" and "Speed" objects are labelled both by
# their names and units.
#
for i in range(0, relation.getNTargets()):
target = relation.getTarget(i)
if not target in allTargets:
allTargets.append(target)
label.append(target)
return label
@staticmethod
def linkBasename(obj):
"""Returns the relevant information from the URI. The idea is
to attempt to strip off all prefix and suffix, much like the
basename command in a shell."""
basename = None
try:
hyperlink = obj.queryHyperlink()
except:
pass
else:
uri = hyperlink.getURI(0)
if uri and len(uri):
# Sometimes the URI is an expression that includes a URL.
# Currently that can be found at the bottom of safeway.com.
# It can also be seen in the backwards.html test file.
#
expression = uri.split(',')
if len(expression) > 1:
for item in expression:
if item.find('://') >=0:
if not item[0].isalnum():
item = item[1:-1]
if not item[-1].isalnum():
item = item[0:-2]
uri = item
break
# We're assuming that there IS a base name to be had.
# What if there's not? See backwards.html.
#
uri = uri.split('://')[-1]
if not uri:
return basename
# Get the last thing after all the /'s, unless it ends
# in a /. If it ends in a /, we'll look to the stuff
# before the ending /.
#
if uri[-1] == "/":
basename = uri[0:-1]
basename = basename.split('/')[-1]
elif not uri.count("/"):
basename = uri
else:
basename = uri.split('/')[-1]
if basename.startswith("index"):
basename = uri.split('/')[-2]
# Now, try to strip off the suffixes.
#
basename = basename.split('.')[0]
basename = basename.split('?')[0]
basename = basename.split('#')[0]
return basename
@staticmethod
def linkIndex(obj, characterIndex):
"""A brute force method to see if an offset is a link. This
is provided because not all Accessible Hypertext implementations
properly support the getLinkIndex method. Returns an index of
0 or greater of the characterIndex is on a hyperlink.
Arguments:
-obj: the object with the Accessible Hypertext specialization
-characterIndex: the text position to check
"""
if not obj:
return -1
try:
obj.queryText()
except NotImplementedError:
return -1
try:
hypertext = obj.queryHypertext()
except NotImplementedError:
return -1
for i in range(hypertext.getNLinks()):
link = hypertext.getLink(i)
if (characterIndex >= link.startIndex) \
and (characterIndex <= link.endIndex):
return i
return -1
def nestingLevel(self, obj):
"""Determines the nesting level of this object in a list. If this
object is not in a list relation, then 0 will be returned.
Arguments:
-obj: the Accessible object
"""
if not obj:
return 0
try:
return self._script.generatorCache[self.NESTING_LEVEL][obj]
except:
if self.NESTING_LEVEL not in self._script.generatorCache:
self._script.generatorCache[self.NESTING_LEVEL] = {}
nestingLevel = 0
parent = obj.parent
while parent.parent and parent.parent.getRole() == pyatspi.ROLE_LIST:
nestingLevel += 1
parent = parent.parent
self._script.generatorCache[self.NESTING_LEVEL][obj] = nestingLevel
return self._script.generatorCache[self.NESTING_LEVEL][obj]
def nodeLevel(self, obj):
"""Determines the node level of this object if it is in a tree
relation, with 0 being the top level node. If this object is
not in a tree relation, then -1 will be returned.
Arguments:
-obj: the Accessible object
"""
if not obj:
return -1
try:
return self._script.generatorCache[self.NODE_LEVEL][obj]
except:
if self.NODE_LEVEL not in self._script.generatorCache:
self._script.generatorCache[self.NODE_LEVEL] = {}
nodes = []
node = obj
done = False
while not done:
try:
relations = node.getRelationSet()
except (LookupError, RuntimeError):
debug.println(debug.LEVEL_SEVERE,
"nodeLevel() - Error getting RelationSet")
return -1
node = None
for relation in relations:
if relation.getRelationType() \
== pyatspi.RELATION_NODE_CHILD_OF:
node = relation.getTarget(0)
break
# We want to avoid situations where something gives us an
# infinite cycle of nodes. Bon Echo has been seen to do
# this (see bug 351847).
#
if (len(nodes) > 100) or nodes.count(node):
debug.println(debug.LEVEL_WARNING,
"nodeLevel detected a cycle!!!")
done = True
elif node:
nodes.append(node)
debug.println(debug.LEVEL_FINEST,
"nodeLevel %d" % len(nodes))
else:
done = True
self._script.generatorCache[self.NODE_LEVEL][obj] = len(nodes) - 1
return self._script.generatorCache[self.NODE_LEVEL][obj]
def popupItemAtDesktopCoords(self, x, y):
"""Since pop-up items often don't contain nested components, we need
a way to efficiently determine if the cursor is over a menu item.
Arguments:
- x: X coordinate.
- y: Y coordinate.
Returns a menu item the mouse is over, or None.
"""
suspect_children = []
if self._script.lastSelectedMenu:
try:
si = self._script.lastSelectedMenu.querySelection()
except NotImplementedError:
return None
if si.nSelectedChildren > 0:
suspect_children = [si.getSelectedChild(0)]
else:
suspect_children = self._script.lastSelectedMenu
for child in suspect_children:
try:
ci = child.queryComponent()
except NotImplementedError:
continue
if ci.contains(x, y, pyatspi.DESKTOP_COORDS) \
and ci.getLayer() == pyatspi.LAYER_POPUP:
return child
def pursueForFlatReview(self, obj):
"""Determines if we should look any further at the object
for flat review."""
if self.isHidden(obj):
return False
try:
state = obj.getState()
except:
debug.printException(debug.LEVEL_WARNING)
return False
else:
return state.contains(pyatspi.STATE_SHOWING)
@staticmethod
def isTableRow(obj):
"""Determines if obj is a table row -- real or functionally."""
if not (obj and obj.parent and obj.childCount):
return False
role = obj.getRole()
if role == pyatspi.ROLE_TABLE_ROW:
return True
if role == pyatspi.ROLE_TABLE_CELL:
return False
if not obj.parent.getRole() == pyatspi.ROLE_TABLE:
return False
isCell = lambda x: x and x.getRole() in [pyatspi.ROLE_TABLE_CELL,
pyatspi.ROLE_ROW_HEADER,
pyatspi.ROLE_COLUMN_HEADER]
cellChildren = list(filter(isCell, [x for x in obj]))
if len(cellChildren) == obj.childCount:
return True
return False
def realActiveDescendant(self, obj):
"""Given an object that should be a child of an object that
manages its descendants, return the child that is the real
active descendant carrying useful information.
Arguments:
- obj: an object that should be a child of an object that
manages its descendants.
"""
try:
return self._script.\
generatorCache[self.REAL_ACTIVE_DESCENDANT][obj]
except:
if self.REAL_ACTIVE_DESCENDANT not in self._script.\
generatorCache:
self._script.generatorCache[self.REAL_ACTIVE_DESCENDANT] = {}
activeDescendant = None
# If obj is a table cell and all of it's children are table cells
# (probably cell renderers), then return the first child which has
# a non zero length text string. If no such object is found, just
# fall through and use the default approach below. See bug #376791
# for more details.
#
if obj.getRole() == pyatspi.ROLE_TABLE_CELL and obj.childCount:
nonTableCellFound = False
for child in obj:
if child.getRole() != pyatspi.ROLE_TABLE_CELL:
nonTableCellFound = True
if not nonTableCellFound:
for child in obj:
try:
text = child.queryText()
except NotImplementedError:
continue
else:
if text.getText(0, text.characterCount):
activeDescendant = child
self._script.generatorCache[self.REAL_ACTIVE_DESCENDANT][obj] = \
activeDescendant or obj
return self._script.generatorCache[self.REAL_ACTIVE_DESCENDANT][obj]
def showingDescendants(self, parent):
"""Given a parent that manages its descendants, return a list of
Accessible children that are actually showing. This algorithm
was inspired a little by the srw_elements_from_accessible logic
in Gnopernicus, and makes the assumption that the children of
an object that manages its descendants are arranged in a row
and column format.
Arguments:
- parent: The accessible which manages its descendants
Returns a list of Accessible descendants which are showing.
"""
import sys
if not parent:
return []
if not parent.getState().contains(pyatspi.STATE_MANAGES_DESCENDANTS) \
or parent.childCount <= 50:
return []
try:
icomponent = parent.queryComponent()
except NotImplementedError:
return []
descendants = []
parentExtents = icomponent.getExtents(0)
# [[[TODO: WDW - HACK related to GAIL bug where table column
# headers seem to be ignored:
# http://bugzilla.gnome.org/show_bug.cgi?id=325809. The
# problem is that this causes getAccessibleAtPoint to return
# the cell effectively below the real cell at a given point,
# making a mess of everything. So...we just manually add in
# showing headers for now. The remainder of the logic below
# accidentally accounts for this offset, yet it should also
# work when bug 325809 is fixed.]]]
#
try:
table = parent.queryTable()
except NotImplementedError:
table = None
if table:
for i in range(0, table.nColumns):
header = table.getColumnHeader(i)
if header:
extents = header.queryComponent().getExtents(0)
stateset = header.getState()
if stateset.contains(pyatspi.STATE_SHOWING) \
and (extents.x >= 0) and (extents.y >= 0) \
and (extents.width > 0) and (extents.height > 0) \
and self.containsRegion(
extents.x, extents.y,
extents.width, extents.height,
parentExtents.x, parentExtents.y,
parentExtents.width, parentExtents.height):
descendants.append(header)
# This algorithm goes left to right, top to bottom while attempting
# to do *some* optimization over queries. It could definitely be
# improved. The gridSize is a minimal chunk to jump around in the
# table.
#
gridSize = 7
currentY = parentExtents.y
while currentY < (parentExtents.y + parentExtents.height):
currentX = parentExtents.x
minHeight = sys.maxsize
index = -1
while currentX < (parentExtents.x + parentExtents.width):
child = \
icomponent.getAccessibleAtPoint(currentX, currentY + 1, 0)
if child:
index = child.getIndexInParent()
extents = child.queryComponent().getExtents(0)
if extents.x >= 0 and extents.y >= 0:
newX = extents.x + extents.width
minHeight = min(minHeight, extents.height)
if not descendants.count(child):
descendants.append(child)
else:
newX = currentX + gridSize
else:
debug.println(debug.LEVEL_FINEST,
"script_utilities.showingDescendants failed. " \
"Last valid child at index %d" % index)
break
if newX <= currentX:
currentX += gridSize
else:
currentX = newX
if minHeight == sys.maxsize:
minHeight = gridSize
currentY += minHeight
return descendants
def statusBar(self, obj):
"""Returns the status bar in the window which contains obj.
Arguments:
- obj: the top-level object (e.g. window, frame, dialog) for which
the status bar is sought.
"""
# There are some objects which are not worth descending.
#
skipRoles = [pyatspi.ROLE_TREE,
pyatspi.ROLE_TREE_TABLE,
pyatspi.ROLE_TABLE]
if obj.getState().contains(pyatspi.STATE_MANAGES_DESCENDANTS) \
or obj.getRole() in skipRoles:
return
statusBar = None
# The status bar is likely near the bottom of the window.
#
for i in range(obj.childCount - 1, -1, -1):
if obj[i].getRole() == pyatspi.ROLE_STATUS_BAR:
statusBar = obj[i]
elif not obj[i].getRole() in skipRoles:
statusBar = self.statusBar(obj[i])
if statusBar:
break
return statusBar
@staticmethod
def topLevelObject(obj):
"""Returns the top-level object (frame, dialog ...) containing obj,
or None if obj is not inside a top-level object.
Arguments:
- obj: the Accessible object
"""
if not obj:
return None
stopAtRoles = [pyatspi.ROLE_ALERT,
pyatspi.ROLE_DIALOG,
pyatspi.ROLE_FRAME,
pyatspi.ROLE_WINDOW]
while obj and obj.parent \
and not obj.getRole() in stopAtRoles \
and not obj.parent.getRole() == pyatspi.ROLE_APPLICATION:
obj = obj.parent
return obj
@staticmethod
def onSameLine(obj1, obj2, delta=0):
"""Determines if obj1 and obj2 are on the same line."""
try:
bbox1 = obj1.queryComponent().getExtents(pyatspi.DESKTOP_COORDS)
bbox2 = obj2.queryComponent().getExtents(pyatspi.DESKTOP_COORDS)
except:
return False
center1 = bbox1.y + bbox1.height / 2
center2 = bbox2.y + bbox2.height / 2
return abs(center1 - center2) <= delta
@staticmethod
def spatialComparison(obj1, obj2):
"""Compares the physical locations of obj1 and obj2 and returns -1,
0, or 1 to indicate if obj1 physically is before, is in the same
place as, or is after obj2."""
try:
bbox = obj1.queryComponent().getExtents(pyatspi.DESKTOP_COORDS)
x1, y1 = bbox.x, bbox.y
except:
x1, y1 = 0, 0
try:
bbox = obj2.queryComponent().getExtents(pyatspi.DESKTOP_COORDS)
x2, y2 = bbox.x, bbox.y
except:
x2, y2 = 0, 0
rv = y1 - y2 or x1 - x2
# If the objects claim to have the same coordinates, there is either
# a horrible design crime or we've been given bogus extents. Fall back
# on the index in the parent. This is seen with GtkListBox items which
# had been scrolled off-screen.
if not rv and obj1.parent == obj2.parent:
rv = obj1.getIndexInParent() - obj2.getIndexInParent()
rv = max(rv, -1)
rv = min(rv, 1)
return rv
def unrelatedLabels(self, root, onlyShowing=True):
"""Returns a list containing all the unrelated (i.e., have no
relations to anything and are not a fundamental element of a
more atomic component like a combo box) labels under the given
root. Note that the labels must also be showing on the display.
Arguments:
- root: the Accessible object to traverse
- onlyShowing: if True, only return labels with STATE_SHOWING
Returns a list of unrelated labels under the given root.
"""
allLabels = self.descendantsWithRole(root, pyatspi.ROLE_LABEL, onlyShowing)
try:
labels = [x for x in allLabels if not x.getRelationSet()]
labels = [x for x in labels if x.parent and x.name != x.parent.name]
if onlyShowing:
labels = [x for x in labels if x.getState().contains(pyatspi.STATE_SHOWING)]
except:
return []
# Eliminate duplicates
d = {}
for label in labels:
if label.name == root.name:
continue
d[label.name] = label
labels = list(d.values())
return sorted(labels, key=functools.cmp_to_key(self.spatialComparison))
def unfocusedAlertAndDialogCount(self, obj):
"""If the current application has one or more alert or dialog
windows and the currently focused window is not an alert or a dialog,
return a count of the number of alert and dialog windows, otherwise
return a count of zero.
Arguments:
- obj: the Accessible object
Returns the alert and dialog count.
"""
alertAndDialogCount = 0
app = obj.getApplication()
window = Utilities.topLevelObject(obj)
if window and window.getRole() != pyatspi.ROLE_ALERT and \
window.getRole() != pyatspi.ROLE_DIALOG and \
not self.isFunctionalDialog(window):
for child in app:
if child.getRole() == pyatspi.ROLE_ALERT or \
child.getRole() == pyatspi.ROLE_DIALOG or \
self.isFunctionalDialog(child):
alertAndDialogCount += 1
return alertAndDialogCount
def uri(self, obj):
"""Return the URI for a given link object.
Arguments:
- obj: the Accessible object.
"""
try:
return obj.queryHyperlink().getURI(0)
except:
return None
def validParent(self, obj):
"""Returns the first valid parent/ancestor of obj. We need to do
this in some applications and toolkits due to bogus hierarchies.
Arguments:
- obj: the Accessible object
"""
if not obj:
return None
return obj.parent
#########################################################################
# #
# Utilities for working with the accessible text interface #
# #
#########################################################################
@staticmethod
def adjustTextSelection(obj, offset):
"""Adjusts the end point of a text selection
Arguments:
- obj: the Accessible object.
- offset: the new end point - can be to the left or to the right
depending on the direction of selection
"""
try:
text = obj.queryText()
except:
return
if not text.getNSelections():
caretOffset = text.caretOffset
startOffset = min(offset, caretOffset)
endOffset = max(offset, caretOffset)
text.addSelection(startOffset, endOffset)
else:
startOffset, endOffset = text.getSelection(0)
if offset < startOffset:
startOffset = offset
else:
endOffset = offset
text.setSelection(0, startOffset, endOffset)
def allSelectedText(self, obj):
"""Get all the text applicable text selections for the given object.
including any previous or next text objects that also have
selected text and add in their text contents.
Arguments:
- obj: the text object to start extracting the selected text from.
Returns: all the selected text contents plus the start and end
offsets within the text for the given object.
"""
textContents = ""
startOffset = 0
endOffset = 0
text = obj.queryText()
if text.getNSelections() > 0:
[textContents, startOffset, endOffset] = self.selectedText(obj)
current = obj
morePossibleSelections = True
while morePossibleSelections:
morePossibleSelections = False
for relation in current.getRelationSet():
if relation.getRelationType() == pyatspi.RELATION_FLOWS_FROM:
prevObj = relation.getTarget(0)
prevObjText = prevObj.queryText()
if prevObjText.getNSelections() > 0:
[newTextContents, start, end] = \
self.selectedText(prevObj)
textContents = newTextContents + " " + textContents
current = prevObj
morePossibleSelections = True
else:
displayedText = prevObjText.getText(0,
prevObjText.characterCount)
if len(displayedText) == 0:
current = prevObj
morePossibleSelections = True
break
current = obj
morePossibleSelections = True
while morePossibleSelections:
morePossibleSelections = False
for relation in current.getRelationSet():
if relation.getRelationType() == pyatspi.RELATION_FLOWS_TO:
nextObj = relation.getTarget(0)
nextObjText = nextObj.queryText()
if nextObjText.getNSelections() > 0:
[newTextContents, start, end] = \
self.selectedText(nextObj)
textContents += " " + newTextContents
current = nextObj
morePossibleSelections = True
else:
displayedText = nextObjText.getText(0,
nextObjText.characterCount)
if len(displayedText) == 0:
current = nextObj
morePossibleSelections = True
break
return [textContents, startOffset, endOffset]
@staticmethod
def allTextSelections(obj):
"""Get a list of text selections in the given accessible object,
equivalent to getNSelections()*texti.getSelection()
Arguments:
- obj: An accessible.
Returns list of start and end offsets for multiple selections, or an
empty list if nothing is selected or if the accessible does not support
the text interface.
"""
try:
text = obj.queryText()
except:
return []
rv = []
try:
nSelections = text.getNSelections()
except:
nSelections = 0
for i in range(nSelections):
rv.append(text.getSelection(i))
return rv
@staticmethod
def characterOffsetInParent(obj):
"""Returns the character offset of the embedded object
character for this object in its parent's accessible text.
Arguments:
- obj: an Accessible that should implement the accessible
hyperlink specialization.
Returns an integer representing the character offset of the
embedded object character for this hyperlink in its parent's
accessible text, or -1 something was amuck.
"""
offset = -1
try:
hyperlink = obj.queryHyperlink()
except NotImplementedError:
pass
else:
# We need to make sure that this is an embedded object in
# some accessible text (as opposed to an imagemap link).
#
try:
obj.parent.queryText()
offset = hyperlink.startIndex
except:
pass
return offset
@staticmethod
def clearTextSelection(obj):
"""Clears the text selection if the object supports it.
Arguments:
- obj: the Accessible object.
"""
try:
text = obj.queryText()
except:
return
for i in range(text.getNSelections()):
text.removeSelection(0)
def expandEOCs(self, obj, startOffset=0, endOffset=-1):
"""Expands the current object replacing EMBEDDED_OBJECT_CHARACTERS
with their text.
Arguments
- obj: the object whose text should be expanded
- startOffset: the offset of the first character to be included
- endOffset: the offset of the last character to be included
Returns the fully expanded text for the object.
"""
try:
string = self.substring(obj, startOffset, endOffset)
except:
return ""
if self.EMBEDDED_OBJECT_CHARACTER in string:
# If we're not getting the full text of this object, but
# rather a substring, we need to figure out the offset of
# the first child within this substring.
#
childOffset = 0
for child in obj:
if Utilities.characterOffsetInParent(child) >= startOffset:
break
childOffset += 1
toBuild = list(string)
count = toBuild.count(self.EMBEDDED_OBJECT_CHARACTER)
for i in range(count):
index = toBuild.index(self.EMBEDDED_OBJECT_CHARACTER)
child = obj[i + childOffset]
childText = self.expandEOCs(child)
if not childText:
childText = ""
toBuild[index] = childText
string = "".join(toBuild)
return string
def hasTextSelections(self, obj):
"""Return an indication of whether this object has selected text.
Note that it's possible that this object has no selection, but is part
of a selected text area. Because of this, we need to check the
objects on either side to see if they are none zero length and
have text selections.
Arguments:
- obj: the text object to start checking for selected text.
Returns: an indication of whether this object has selected text,
or adjacent text objects have selected text.
"""
currentSelected = False
otherSelected = False
text = obj.queryText()
nSelections = text.getNSelections()
if nSelections:
currentSelected = True
else:
otherSelected = False
text = obj.queryText()
displayedText = text.getText(0, text.characterCount)
if (text.caretOffset == 0) or len(displayedText) == 0:
current = obj
morePossibleSelections = True
while morePossibleSelections:
morePossibleSelections = False
for relation in current.getRelationSet():
if relation.getRelationType() == \
pyatspi.RELATION_FLOWS_FROM:
prevObj = relation.getTarget(0)
prevObjText = prevObj.queryText()
if prevObjText.getNSelections() > 0:
otherSelected = True
else:
displayedText = prevObjText.getText(0,
prevObjText.characterCount)
if len(displayedText) == 0:
current = prevObj
morePossibleSelections = True
break
current = obj
morePossibleSelections = True
while morePossibleSelections:
morePossibleSelections = False
for relation in current.getRelationSet():
if relation.getRelationType() == \
pyatspi.RELATION_FLOWS_TO:
nextObj = relation.getTarget(0)
nextObjText = nextObj.queryText()
if nextObjText.getNSelections() > 0:
otherSelected = True
else:
displayedText = nextObjText.getText(0,
nextObjText.characterCount)
if len(displayedText) == 0:
current = nextObj
morePossibleSelections = True
break
return [currentSelected, otherSelected]
def isWordMisspelled(self, obj, offset):
"""Identifies if the current word is flagged as misspelled by the
application. Different applications and toolkits flag misspelled
words differently. Thus each script will likely need to implement
its own version of this method.
Arguments:
- obj: An accessible which implements the accessible text interface.
- offset: Offset in the accessible's text for which to retrieve the
attributes.
Returns True if the word is flagged as misspelled.
"""
return False
@staticmethod
def queryNonEmptyText(obj):
"""Get the text interface associated with an object, if it is
non-empty.
Arguments:
- obj: an accessible object
"""
try:
text = obj.queryText()
except:
pass
else:
if text.characterCount:
return text
return None
@staticmethod
def selectedText(obj):
"""Get the text selection for the given object.
Arguments:
- obj: the text object to extract the selected text from.
Returns: the selected text contents plus the start and end
offsets within the text.
"""
textContents = ""
startOffset = endOffset = 0
textObj = obj.queryText()
nSelections = textObj.getNSelections()
for i in range(0, nSelections):
[startOffset, endOffset] = textObj.getSelection(i)
debug.println(debug.LEVEL_FINEST,
"getSelectedText: selection start=%d, end=%d" % \
(startOffset, endOffset))
selectedText = textObj.getText(startOffset, endOffset)
debug.println(debug.LEVEL_FINEST,
"getSelectedText: selected text=<%s>" % selectedText)
if i > 0:
textContents += " "
textContents += selectedText
return [textContents, startOffset, endOffset]
def setCaretOffset(self, obj, offset):
"""Set the caret offset on a given accessible. Similar to
Accessible.setCaretOffset()
Arguments:
- obj: Given accessible object.
- offset: Offset to hich to set the caret.
"""
try:
texti = obj.queryText()
except:
return None
texti.setCaretOffset(offset)
def substring(self, obj, startOffset, endOffset):
"""Returns the substring of the given object's text specialization.
Arguments:
- obj: an accessible supporting the accessible text specialization
- startOffset: the starting character position
- endOffset: the ending character position. Note that an end offset
of -1 means the last character
"""
try:
text = obj.queryText()
except:
return ""
return text.getText(startOffset, endOffset)
def textAttributes(self, acc, offset, get_defaults=False):
"""Get the text attributes run for a given offset in a given accessible
Arguments:
- acc: An accessible.
- offset: Offset in the accessible's text for which to retrieve the
attributes.
- get_defaults: Get the default attributes as well as the unique ones.
Default is True
Returns a dictionary of attributes, a start offset where the attributes
begin, and an end offset. Returns ({}, 0, 0) if the accessible does not
supprt the text attribute.
"""
rv = {}
try:
text = acc.queryText()
except:
return rv, 0, 0
if get_defaults:
stringAndDict = \
self.stringToKeysAndDict(text.getDefaultAttributes())
rv.update(stringAndDict[1])
attrString, start, end = text.getAttributes(offset)
stringAndDict = self.stringToKeysAndDict(attrString)
rv.update(stringAndDict[1])
return rv, start, end
def unicodeText(self, obj):
"""Returns the unicode text for an object or None if the object
doesn't implement the accessible text specialization.
"""
# TODO: eliminate calls to this now-redundant method
text = self.queryNonEmptyText(obj)
if text:
return text.getText(0, -1)
return None
def willEchoCharacter(self, event):
"""Given a keyboard event containing an alphanumeric key,
determine if the script is likely to echo it as a character.
"""
if not orca_state.locusOfFocus or not settings.enableEchoByCharacter:
return False
if len(event.event_string) != 1 \
or event.modifiers & keybindings.ORCA_CTRL_MODIFIER_MASK:
return False
obj = orca_state.locusOfFocus
role = obj.getRole()
if role == pyatspi.ROLE_TERMINAL:
return True
if role == pyatspi.ROLE_PASSWORD_TEXT:
return False
if obj.getState().contains(pyatspi.STATE_EDITABLE):
return True
return False
def wordAtCoords(self, acc, x, y):
"""Get the word at the given coords in the accessible.
Arguments:
- acc: Accessible that supports the Text interface.
- x: X coordinate.
- y: Y coordinate.
Returns a tuple containing the word, start offset, and end offset.
"""
try:
ti = acc.queryText()
except NotImplementedError:
return '', 0, 0
text_contents = ti.getText(0, ti.characterCount)
line_offsets = []
start_offset = 0
while True:
try:
end_offset = text_contents.index('\n', start_offset)
except ValueError:
line_offsets.append((start_offset, len(text_contents)))
break
line_offsets.append((start_offset, end_offset))
start_offset = end_offset + 1
for start, end in line_offsets:
bx, by, bw, bh = \
ti.getRangeExtents(start, end, pyatspi.DESKTOP_COORDS)
bb = mouse_review.BoundingBox(bx, by, bw, bh)
if bb.isInBox(x, y):
start_offset = 0
word_offsets = []
while True:
try:
end_offset = \
text_contents[start:end].index(' ', start_offset)
except ValueError:
word_offsets.append((start_offset,
len(text_contents[start:end])))
break
word_offsets.append((start_offset, end_offset))
start_offset = end_offset + 1
for a, b in word_offsets:
bx, by, bw, bh = \
ti.getRangeExtents(start+a, start+b,
pyatspi.DESKTOP_COORDS)
bb = mouse_review.BoundingBox(bx, by, bw, bh)
if bb.isInBox(x, y):
return text_contents[start+a:start+b], start+a, start+b
return '', 0, 0
#########################################################################
# #
# Debugging and Reporting Utilities #
# #
#########################################################################
def _isInterestingObj(self, obj):
import inspect
interesting = False
if getattr(obj, "__class__", None):
name = obj.__class__.__name__
if name not in ["function",
"type",
"list",
"dict",
"tuple",
"wrapper_descriptor",
"module",
"method_descriptor",
"member_descriptor",
"instancemethod",
"builtin_function_or_method",
"frame",
"classmethod",
"classmethod_descriptor",
"_Environ",
"MemoryError",
"_Printer",
"_Helper",
"getset_descriptor",
"weakref",
"property",
"cell",
"staticmethod",
"EventListener",
"KeystrokeListener",
"KeyBinding",
"InputEventHandler",
"Rolename"]:
try:
filename = inspect.getabsfile(obj.__class__)
if filename.index("orca"):
interesting = True
except:
pass
return interesting
def _detectCycle(self, obj, visitedObjs, indent=""):
"""Attempts to discover a cycle in object references."""
# [[[TODO: WDW - not sure this really works.]]]
import gc
visitedObjs.append(obj)
for referent in gc.get_referents(obj):
try:
if visitedObjs.index(referent):
if self._isInterestingObj(referent):
print(indent, "CYCLE!!!!", repr(referent))
break
except:
pass
self._detectCycle(referent, visitedObjs, " " + indent)
visitedObjs.remove(obj)
def printApps(self):
"""Prints a list of all applications to stdout."""
apps = self.knownApplications()
line = "There are %d Accessible applications" % len(apps)
debug.println(debug.LEVEL_OFF, line)
print(line)
for app in apps:
line = debug.getAccessibleDetails(
debug.LEVEL_OFF, app, " App: ", False)
debug.println(debug.LEVEL_OFF, line)
print(line)
for child in app:
line = debug.getAccessibleDetails(
debug.LEVEL_OFF, child, " Window: ", False)
debug.println(debug.LEVEL_OFF, line)
print(line)
if child.parent != app:
debug.println(debug.LEVEL_OFF,
" WARNING: child's parent is not app!!!")
return True
def scriptInfo(self):
"""Output useful information on the current script via speech
and braille. This information will be helpful to script writers.
"""
infoString = "SCRIPT INFO: Script name='%s'" % self._script.name
app = orca_state.locusOfFocus.getApplication()
if orca_state.locusOfFocus and app:
infoString += " Application name='%s'" \
% app.name
try:
infoString += " Toolkit name='%s'" \
% app.toolkitName
except:
infoString += " Toolkit unknown"
try:
infoString += " Version='%s'" \
% app.toolkitVersion
except:
infoString += " Version unknown"
debug.println(debug.LEVEL_OFF, infoString)
print(infoString)
self._script.speakMessage(infoString)
self._script.displayBrailleMessage(infoString)
return True
#########################################################################
# #
# Miscellaneous Utilities #
# #
#########################################################################
def _addRepeatSegment(self, segment, line, respectPunctuation=True):
"""Add in the latest line segment, adjusting for repeat characters
and punctuation.
Arguments:
- segment: the segment of repeated characters.
- line: the current built-up line to characters to speak.
- respectPunctuation: if False, ignore punctuation level.
Returns: the current built-up line plus the new segment, after
adjusting for repeat character counts and punctuation.
"""
from . import punctuation_settings
from . import chnames
style = settings.verbalizePunctuationStyle
isPunctChar = True
try:
level, action = punctuation_settings.getPunctuationInfo(segment[0])
except:
isPunctChar = False
count = len(segment)
if (count >= settings.repeatCharacterLimit) \
and (not segment[0] in self._script.whitespace):
if (not respectPunctuation) \
or (isPunctChar and (style <= level)):
repeatChar = chnames.getCharacterName(segment[0])
repeatSegment = messages.repeatedCharCount(repeatChar, count)
line = "%s %s" % (line, repeatSegment)
else:
line += segment
else:
line += segment
return line
def adjustForLinks(self, obj, line, startOffset):
"""Adjust line to include the word "link" after any hypertext links.
Arguments:
- obj: the accessible object that this line came from.
- line: the string to adjust for links.
- startOffset: the caret offset at the start of the line.
Returns: a new line adjusted to add the speaking of "link" after
text which is also a link.
"""
from . import punctuation_settings
endOffset = startOffset + len(line)
try:
hyperText = obj.queryHypertext()
nLinks = hyperText.getNLinks()
except:
nLinks = 0
adjustedLine = list(line)
for n in range(nLinks, 0, -1):
link = hyperText.getLink(n - 1)
if not link:
continue
# We only care about links in the string, line:
#
if startOffset < link.endIndex <= endOffset:
index = link.endIndex - startOffset
elif startOffset <= link.startIndex < endOffset:
index = len(line)
if link.endIndex < endOffset:
index -= 1
else:
continue
linkString = " " + messages.LINK
# If the link was not followed by a whitespace or punctuation
# character, then add in a space to make it more presentable.
#
nextChar = ""
if index < len(line):
nextChar = adjustedLine[index]
if not (nextChar in self._script.whitespace \
or punctuation_settings.getPunctuationInfo(nextChar)):
linkString += " "
adjustedLine[index:index] = linkString
return "".join(adjustedLine)
@staticmethod
def _processMultiCaseString(string):
return re.sub(r'(?<=[a-z])(?=[A-Z])', ' ', string)
def adjustForPronunciation(self, line):
"""Adjust the line to replace words in the pronunciation dictionary,
with what those words actually sound like.
Arguments:
- line: the string to adjust for words in the pronunciation dictionary.
Returns: a new line adjusted for words found in the pronunciation
dictionary.
"""
if settings.speakMultiCaseStringsAsWords:
line = self._processMultiCaseString(line)
if not settings.usePronunciationDictionary:
return line
newLine = ""
words = self.WORDS_RE.split(line)
newLine = ''.join(map(pronunciation_dict.getPronunciation, words))
if settings.speakMultiCaseStringsAsWords:
newLine = self._processMultiCaseString(newLine)
return newLine
def adjustForRepeats(self, line):
"""Adjust line to include repeat character counts. As some people
will want this and others might not, there is a setting in
settings.py that determines whether this functionality is enabled.
repeatCharacterLimit = <n>
If <n> is 0, then there would be no repeat characters.
Otherwise <n> would be the number of same characters (or more)
in a row that cause the repeat character count output.
If the value is set to 1, 2 or 3 then it's treated as if it was
zero. In other words, no repeat character count is given.
Arguments:
- line: the string to adjust for repeat character counts.
Returns: a new line adjusted for repeat character counts (if enabled).
"""
if (len(line) < 4) or (settings.repeatCharacterLimit < 4):
return line
newLine = ''
segment = lastChar = line[0]
multipleChars = False
for i in range(1, len(line)):
if line[i] == lastChar:
segment += line[i]
else:
multipleChars = True
newLine = self._addRepeatSegment(segment, newLine)
segment = line[i]
lastChar = line[i]
return self._addRepeatSegment(segment, newLine, multipleChars)
def adjustForDigits(self, string):
"""Adjusts the string to convert digit-like text, such as subscript
and superscript numbers, into actual digits.
Arguments:
- string: the string to be adjusted
Returns: a new string which contains actual digits.
"""
subscripted = set(re.findall(self.SUBSCRIPTS_RE, string))
superscripted = set(re.findall(self.SUPERSCRIPTS_RE, string))
for number in superscripted:
new = [str(self.SUPERSCRIPT_DIGITS.index(d)) for d in number]
newString = messages.DIGITS_SUPERSCRIPT % "".join(new)
string = re.sub(number, newString, string)
for number in subscripted:
new = [str(self.SUBSCRIPT_DIGITS.index(d)) for d in number]
newString = messages.DIGITS_SUBSCRIPT % "".join(new)
string = re.sub(number, newString, string)
return string
@staticmethod
def absoluteMouseCoordinates():
"""Gets the absolute position of the mouse pointer."""
from gi.repository import Gtk
rootWindow = Gtk.Window().get_screen().get_root_window()
window, x, y, modifiers = rootWindow.get_pointer()
return x, y
@staticmethod
def appendString(text, newText, delimiter=" "):
"""Appends the newText to the given text with the delimiter in between
and returns the new string. Edge cases, such as no initial text or
no newText, are handled gracefully."""
if not newText:
return text
if not text:
return newText
return text + delimiter + newText
def isAutoTextEvent(self, event):
"""Returns True if event is associated with text being autocompleted
or autoinserted or autocorrected or autosomethingelsed.
Arguments:
- event: the accessible event being examined
"""
if event.type.startswith("object:text-changed:insert"):
if not event.any_data or not event.source:
return False
state = event.source.getState()
if not state.contains(pyatspi.STATE_EDITABLE):
return False
lastKey, mods = self.lastKeyAndModifiers()
if lastKey == "Tab" and event.any_data != "\t":
return True
if lastKey == "Return" and event.any_data != "\n":
return True
return False
def isSentenceDelimiter(self, currentChar, previousChar):
"""Returns True if we are positioned at the end of a sentence.
This is determined by checking if the current character is a
white space character and the previous character is one of the
normal end-of-sentence punctuation characters.
Arguments:
- currentChar: the current character
- previousChar: the previous character
Returns True if the given character is a sentence delimiter.
"""
if currentChar == '\r' or currentChar == '\n':
return True
return currentChar in self._script.whitespace \
and previousChar in '!.?:;'
def isWordDelimiter(self, character):
"""Returns True if the given character is a word delimiter.
Arguments:
- character: the character in question
Returns True if the given character is a word delimiter.
"""
return character in self._script.whitespace \
or character in '!*+,-./:;<=>?@[\]^_{|}' \
or character == self._script.NO_BREAK_SPACE_CHARACTER
@staticmethod
def containsRegion(ax, ay, awidth, aheight, bx, by, bwidth, bheight):
"""Returns true if any portion of region 'a' is in region 'b'"""
highestBottom = min(ay + aheight, by + bheight)
lowestTop = max(ay, by)
leftMostRightEdge = min(ax + awidth, bx + bwidth)
rightMostLeftEdge = max(ax, bx)
if lowestTop <= highestBottom \
and rightMostLeftEdge <= leftMostRightEdge:
return True
elif aheight == 0:
if awidth == 0:
return lowestTop == highestBottom \
and leftMostRightEdge == rightMostLeftEdge
else:
return leftMostRightEdge <= rightMostLeftEdge
elif awidth == 0:
return lowestTop <= highestBottom
return False
@staticmethod
def lastKeyAndModifiers():
"""Convenience method which returns a tuple containing the event
string and modifiers of the last non-modifier key event or ("", 0)
if there is no such event."""
if isinstance(orca_state.lastInputEvent, input_event.KeyboardEvent) \
and orca_state.lastNonModifierKeyEvent:
event = orca_state.lastNonModifierKeyEvent
if event.keyval_name in ["BackSpace", "Delete"]:
eventStr = event.keyval_name
else:
eventStr = event.event_string
mods = orca_state.lastInputEvent.modifiers
else:
eventStr = ""
mods = 0
return (eventStr, mods)
@staticmethod
def labelFromKeySequence(sequence):
"""Turns a key sequence into a user-presentable label."""
try:
from gi.repository import Gtk
key, mods = Gtk.accelerator_parse(sequence)
newSequence = Gtk.accelerator_get_label(key, mods)
if newSequence and \
(not newSequence.endswith('+') or newSequence.endswith('++')):
sequence = newSequence
except:
if sequence.endswith(" "):
sequence += chnames.getCharacterName(" ")
sequence = sequence.replace("<", "")
sequence = sequence.replace(">", " ").strip()
return keynames.localizeKeySequence(sequence)
def mnemonicShortcutAccelerator(self, obj):
"""Gets the mnemonic, accelerator string and possibly shortcut
for the given object. These are based upon the first accessible
action for the object.
Arguments:
- obj: the Accessible object
Returns: list containing strings: [mnemonic, shortcut, accelerator]
"""
try:
return self._script.generatorCache[self.KEY_BINDING][obj]
except:
if self.KEY_BINDING not in self._script.generatorCache:
self._script.generatorCache[self.KEY_BINDING] = {}
try:
action = obj.queryAction()
except NotImplementedError:
self._script.generatorCache[self.KEY_BINDING][obj] = ["", "", ""]
return self._script.generatorCache[self.KEY_BINDING][obj]
# Action is a string in the format, where the mnemonic and/or
# accelerator can be missing.
#
# <mnemonic>;<full-path>;<accelerator>
#
# The keybindings in <full-path> should be separated by ":"
#
try:
bindingStrings = action.getKeyBinding(0).split(';')
except:
self._script.generatorCache[self.KEY_BINDING][obj] = ["", "", ""]
return self._script.generatorCache[self.KEY_BINDING][obj]
if len(bindingStrings) == 3:
mnemonic = bindingStrings[0]
fullShortcut = bindingStrings[1]
accelerator = bindingStrings[2]
elif len(bindingStrings) > 0:
mnemonic = ""
fullShortcut = bindingStrings[0]
try:
accelerator = bindingStrings[1]
except:
accelerator = ""
else:
mnemonic = ""
fullShortcut = ""
accelerator = ""
fullShortcut = fullShortcut.replace(":", " ").strip()
fullShortcut = self.labelFromKeySequence(fullShortcut)
mnemonic = self.labelFromKeySequence(mnemonic)
accelerator = self.labelFromKeySequence(accelerator)
debug.println(debug.LEVEL_FINEST, "script_utilities.getKeyBinding: " \
+ repr([mnemonic, fullShortcut, accelerator]))
if self.KEY_BINDING not in self._script.generatorCache:
self._script.generatorCache[self.KEY_BINDING] = {}
self._script.generatorCache[self.KEY_BINDING][obj] = \
[mnemonic, fullShortcut, accelerator]
return self._script.generatorCache[self.KEY_BINDING][obj]
@staticmethod
def stringToKeysAndDict(string):
"""Converts a string made up of a series of <key>:<value>; pairs
into a dictionary of keys and values. Text before the colon is the
key and text afterwards is the value. The final semi-colon, if
found, is ignored.
Arguments:
- string: the string of tokens containing <key>:<value>; pairs.
Returns a list containing two items:
A list of the keys in the order they were extracted from the
string and a dictionary of key/value items.
"""
try:
items = [s.strip() for s in string.split(";")]
items = [item for item in items if len(item.split(':')) == 2]
keys = [item.split(':')[0].strip() for item in items]
dictionary = dict([item.split(':') for item in items])
except:
return [], {}
return [keys, dictionary]
def textForValue(self, obj):
"""Returns the text to be displayed for the object's current value.
Arguments:
- obj: the Accessible object that may or may not have a value.
Returns a string representing the value.
"""
# Use ARIA "valuetext" attribute if present. See
# http://bugzilla.gnome.org/show_bug.cgi?id=552965
#
try:
attributes = obj.getAttributes()
except:
return ""
for attribute in attributes:
if attribute.startswith("valuetext"):
return attribute[10:]
try:
value = obj.queryValue()
except NotImplementedError:
return ""
else:
currentValue = value.currentValue
# "The reports of my implementation are greatly exaggerated."
try:
maxValue = value.maximumValue
except (LookupError, RuntimeError):
maxValue = 0.0
debug.println(debug.LEVEL_FINEST, "VALUE WARNING: " \
"Error accessing maximumValue for %s" % obj)
try:
minValue = value.minimumValue
except (LookupError, RuntimeError):
minValue = 0.0
debug.println(debug.LEVEL_FINEST, "VALUE WARNING: " \
"Error accessing minimumValue for %s" % obj)
try:
minIncrement = value.minimumIncrement
except (LookupError, RuntimeError):
minIncrement = (maxValue - minValue) / 100.0
debug.println(debug.LEVEL_FINEST, "VALUE WARNING: " \
"Error accessing minimumIncrement for %s" % obj)
if minIncrement != 0.0:
try:
decimalPlaces = math.ceil(max(0, -math.log10(minIncrement)))
except ValueError:
debug.println(debug.LEVEL_FINEST, "VALUE WARNING: " \
"Error calculating decimal places for %s" % obj)
return ""
elif abs(currentValue) < 1:
decimalPlaces = 1
else:
decimalPlaces = 0
formatter = "%%.%df" % decimalPlaces
return formatter % currentValue
@staticmethod
def unicodeValueString(character):
""" Returns a four hex digit representation of the given character
Arguments:
- The character to return representation
Returns a string representaition of the given character unicode vlue
"""
try:
return "%04x" % ord(character)
except:
debug.printException(debug.LEVEL_WARNING)
return ""
def getLineContentsAtOffset(self, obj, offset, layoutMode=True):
return []
def getObjectsFromEOCs(self, obj, offset=None, boundary=None):
"""Breaks the string containing a mixture of text and embedded object
characters into a list of (obj, startOffset, endOffset, string) tuples.
Arguments
- obj: the object whose EOCs we need to expand into tuples
- offset: the character offset. If None, use the current offset.
- boundary: the pyatspi text boundary type. If None, get all text.
Returns a list of (obj, startOffset, endOffset, string) tuples.
"""
# For now, each script should implement this functionality itself.
return []
@staticmethod
def getHyperlinkRange(obj):
"""Returns the start and end indices associated with the embedded
object, obj."""
try:
hyperlink = obj.queryHyperlink()
except NotImplementedError:
return 0, 0
return hyperlink.startIndex, hyperlink.endIndex
def selectedChildren(self, obj):
try:
selection = obj.querySelection()
except:
return []
children = []
for x in range(selection.nSelectedChildren):
children.append(selection.getSelectedChild(x))
return children
def focusedChild(self, obj):
isFocused = lambda x: x and x.getState().contains(pyatspi.STATE_FOCUSED)
return pyatspi.findDescendant(obj, isFocused)
def _isNonModalPopOver(self, obj):
return False
def rgbFromString(self, attributeValue):
regex = re.compile("rgb|[^\w,]", re.IGNORECASE)
string = re.sub(regex, "", attributeValue)
red, green, blue = string.split(",")
return int(red), int(green), int(blue)
def isClickableElement(self, obj):
return False
def hasLongDesc(self, obj):
return False
def headingLevel(self, obj):
level = 0
if obj is None:
return level
if obj.getRole() == pyatspi.ROLE_HEADING:
attributes = obj.getAttributes()
if attributes is None:
return level
for attribute in attributes:
if attribute.startswith("level:"):
level = int(attribute.split(":")[1])
break
return level
|