/usr/lib/python2.7/dist-packages/wxglade/codegen/__init__.py is in python-wxglade 0.6.8-2.2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 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 | """\
Common code used by all code generators
@copyright: 2011-2012 Carsten Grohmann <mail@carstengrohmann.de>
@license: MIT (see license.txt) - THIS PROGRAM COMES WITH NO WARRANTY
"""
import cStringIO
import os
import os.path
import random
import re
import sys
import time
import types
import common
import config
import misc
from xml_parse import XmlParsingError
class DummyPropertyHandler(object):
"""Empty handler for properties that do not need code"""
def __init__(self):
self.handlers = {}
self.event_name = None
self.curr_handler = []
def start_elem(self, name, attrs):
pass
def end_elem(self, name, code_obj):
return True
def char_data(self, data):
pass
# end of class DummyPropertyHandler
class EventsPropertyHandler(DummyPropertyHandler):
"""\
Handler for event properties
"""
def start_elem(self, name, attrs):
if name == 'handler':
self.event_name = attrs['event']
def end_elem(self, name, code_obj):
if name == 'handler':
if self.event_name and self.curr_handler:
self.handlers[self.event_name] = ''.join(self.curr_handler)
self.event_name = None
self.curr_handler = []
elif name == 'events':
code_obj.properties['events'] = self.handlers
return True
def char_data(self, data):
data = data.strip()
if data:
self.curr_handler.append(data)
# end of class EventsPropertyHandler
class ExtraPropertiesPropertyHandler(DummyPropertyHandler):
def __init__(self):
DummyPropertyHandler.__init__(self)
self.props = {}
self.curr_prop = []
self.prop_name = None
def start_elem(self, name, attrs):
if name == 'property':
name = attrs['name']
if name and name[0].islower():
name = name[0].upper() + name[1:]
self.prop_name = name
def end_elem(self, name, code_obj):
if name == 'property':
if self.prop_name and self.curr_prop:
self.props[self.prop_name] = ''.join(self.curr_prop)
self.prop_name = None
self.curr_prop = []
elif name == 'extraproperties':
code_obj.properties['extraproperties'] = self.props
return True # to remove this handler
def char_data(self, data):
data = data.strip()
if data:
self.curr_prop.append(data)
# end of class ExtraPropertiesPropertyHandler
# custom property handlers
class FontPropertyHandler(object):
"""Handler for font properties"""
font_families = {'default': 'wxDEFAULT', 'decorative': 'wxDECORATIVE',
'roman': 'wxROMAN', 'swiss': 'wxSWISS',
'script': 'wxSCRIPT', 'modern': 'wxMODERN',
'teletype': 'wxTELETYPE'}
font_styles = {'normal': 'wxNORMAL', 'slant': 'wxSLANT',
'italic': 'wxITALIC'}
font_weights = {'normal': 'wxNORMAL', 'light': 'wxLIGHT',
'bold': 'wxBOLD'}
def __init__(self):
self.dicts = {'family': self.font_families, 'style': self.font_styles,
'weight': self.font_weights}
self.attrs = {'size': '0', 'style': '0', 'weight': '0', 'family': '0',
'underlined': '0', 'face': ''}
self.current = None
self.curr_data = []
def start_elem(self, name, attrs):
self.curr_data = []
if name != 'font' and name in self.attrs:
self.current = name
else:
self.current = None
def end_elem(self, name, code_obj):
if name == 'font':
code_obj.properties['font'] = self.attrs
return True
elif self.current is not None:
decode = self.dicts.get(self.current)
if decode:
val = decode.get("".join(self.curr_data), '0')
else:
val = "".join(self.curr_data)
self.attrs[self.current] = val
def char_data(self, data):
self.curr_data.append(data)
# end of class FontPropertyHandler
class BaseSourceFileContent(object):
"""\
Keeps info about an existing file that has to be updated, to replace only
the lines inside a wxGlade block, an to keep the rest of the file as it was
@ivar classes: Classes declared in the file
@ivar class_name: Name of the current processed class
@ivar content: Content of the source file, if it existed
before this session of code generation
@ivar event_handlers: List of event handlers for each class
@ivar name: Name of the file
@type name: String
@ivar new_classes: New classes to add to the file (they are inserted
BEFORE the old ones)
@ivar new_classes_inserted: Flag if the placeholder for new classes has
been inserted in source file already
@type new_classes_inserted: Boolean
@ivar code_writer: Reference to the parent code writer object
@type code_writer: Instance of L{BaseCodeWriter} or of a derived class
@ivar spaces: Indentation level for each class
@type spaces: String
@cvar rec_block_start: Regexp to match the begin of a wxglade block
@cvar rec_block_end: Regexp to match the end of a wxGlade block
@cvar rec_class_decl: Regexp to match class declarations
@cvar rec_event_handler: Regexp to match event handlers
"""
def __init__(self, name, code_writer):
self.name = name
self.code_writer = code_writer
self.content = None
self.new_classes = []
self.classes = {}
self.spaces = {}
self.event_handlers = {}
self.nonce = code_writer.nonce
self.out_dir = code_writer.out_dir
self.multiple_files = code_writer.multiple_files
if not self.content:
self.build_untouched_content()
self.class_name = None
self.new_classes_inserted = False
def build_untouched_content(self):
"""\
Builds a string with the contents of the file that must be left as is,
and replaces the wxGlade blocks with tags that in turn will be replaced
by the new wxGlade blocks
"""
self.class_name = None
self.new_classes_inserted = False
def format_classname(self, class_name):
"""\
Format class name read from existing source file
@param class_name: Class name
@type class_name: String
@rtype: String
@note: You may overwrite this function in the derivated class
"""
return class_name
def is_end_of_class(self, line):
"""\
True if the line is the marker for class end.
@rtype: Boolean
"""
return line.strip().startswith('# end of class ')
def is_import_line(self, line):
"""\
True if the line imports wx
@note: You may overwrite this function in the derivated class
@rtype: Boolean
"""
return False
def _load_file(self, filename):
"""\
Load a file and return the content
@note: Separated for debugging purposes
@rtype: List of strings
"""
fh = open(filename)
lines = fh.readlines()
fh.close()
return lines
# end of class BaseSourceFileContent
class BaseWidgetHandler(object):
"""\
Interface the various code generators for the widgets must implement
"""
import_modules = []
"""\
List of modules to import (eg. ['use Wx::Grid;\n'])
"""
def __init__(self):
"""\
Initialise instance variables
"""
self.import_modules = []
def get_code(self, obj):
"""\
Handler for normal widgets (non-toplevel): returns 3 lists of strings,
init, properties and layout, that contain the code for the
corresponding methods of the class to generate
"""
return [], [], []
def get_properties_code(self, obj):
"""\
Handler for the code of the set_properties method of toplevel objects.
Returns a list of strings containing the code to generate
"""
return []
def get_init_code(self, obj):
"""\
Handler for the code of the constructor of toplevel objects. Returns a
list of strings containing the code to generate. Usually the default
implementation is ok (i.e. there are no extra lines to add). The
generated lines are appended at the end of the constructor
"""
return []
def get_layout_code(self, obj):
"""\
Handler for the code of the do_layout method of toplevel objects.
Returns a list of strings containing the code to generate.
Usually the default implementation is ok (i.e. there are no
extra lines to add)
"""
return []
# end of class BaseWidgetHandler
class BaseCodeWriter(object):
"""\
Dictionary of objects used to generate the code in a given language.
A code writer object B{must} implement those interface and set those
variables:
- L{initialize()}
- L{finalize()}
- L{language}
- L{add_app()}
- L{add_class()}
- L{add_object()}
- L{add_property_handler()}
- L{add_sizeritem()}
- L{add_widget_handler()}
- L{generate_code_background()}
- L{generate_code_font()}
- L{generate_code_foreground()}
- L{generate_code_id()}
- L{generate_code_size()}
- L{_get_code_name()}
- L{code_statements}
A code writer object B{could} implement those interfaces and set those
variables:
- L{setup()}
- L{quote_str()}
- L{quote_path()}
- L{cn()}
- L{cn_f()}
@ivar app_encoding: Encoding of the application; will be initialised with
L{config.default_encoding}
@type app_encoding: String
@ivar app_filename: File name to store the application start code within
multi file projects
@type app_filename: String
@ivar app_mapping: Default mapping of template variables for substituting
in templates (see L{lang_mapping}, L{add_app()})
@type app_mapping: Dictionary
@ivar lang_mapping: Language specific mapping of template variables for
substituting in templates (see L{app_mapping},
L{add_app()})
@type lang_mapping: Dictionary
@ivar app_name: Application name
@type app_name: String
@ivar blacklisted_widgets: Don't add those widgets to sizers because they
are not supported for the requested wx version or there is no code
generator available.
@type blacklisted_widgets: Dictionary
@ivar classes: Dictionary that maps the lines of code of a class to the
name of such class:
the lines are divided in 3 categories: '__init__',
'__set_properties' and '__do_layout'
@type classes: Dictionary
@ivar curr_tab: Current indentation level
@type curr_tab: Integer
@ivar for_version: wx version we are generating code for (e.g. C{(2, 6)})
@type for_version: Tuple of major and minor version number
@ivar header_lines: Lines common to all the generated files
(import of wxCL, ...)
@type header_lines: List of strings
@ivar indent_amount: An indentation level is L{indent_symbol} *
L{indent_amount}; will be initialised
with L{config.default_indent_amount}
@type indent_amount: Integer
@ivar indent_symbol: Character to use for identation; will be initialised
with L{config.default_indent_symbol}
@type indent_symbol: String
@ivar multiple_files: If True, generate a file for each custom class
@type multiple_files: Boolean
@ivar nonce: Random number used to be sure that the replaced tags in the
sources are the right ones (see L{BaseSourceFileContent},
L{add_class} and L{create_nonce})
@type nonce: String
@ivar obj_builders: "writers" for the various objects
@type obj_builders: Dictionary
@ivar obj_properties: "property writer" functions, used to set the
properties of a toplevel object
@type obj_properties: Dictionary
@ivar out_dir: If not None, it is the directory inside which the output
files are saved
@type out_dir: None or string
@ivar output_file: Output string buffer for the code
@type output_file: None or StringIO
@ivar output_file_name: Name of the output file
@type output_file_name: String
@ivar previous_source: If not None, it is an instance of
L{BaseSourceFileContent} that keeps info about the
previous version of the source to generate
@type previous_source: None or a derivated class of
L{BaseSourceFileContent}
@ivar _app_added: True after wxApp instance has been generated
@type _app_added: Boolean
@ivar _current_extra_code: Set of lines for extra code to add to the
current file
@type _current_extra_code: List of strings
@ivar _current_extra_modules: Set of lines of extra modules to add to the
current file
@type _current_extra_modules: List of strings
@ivar _overwrite: If True, overwrite any previous version of the source
file instead of updating only the wxGlade blocks;
will be initialised with L{config.default_overwrite}
@type _overwrite: Boolean
@ivar _property_writers: Dictionary of dictionaries of property handlers
specific for a widget the keys are the class
names of the widgets (E.g.
_property_writers['wxRadioBox'] = {'choices',
choices_handler})
@type _property_writers: Dictionary
@ivar _use_gettext: If True, enable gettext support; will be initialised
with L{config.default_use_gettext}
@type _use_gettext: Boolean
@ivar _widget_extra_modules: Map of widget class names to a list of extra
modules needed for the widget (e.g.
C{'wxGrid': 'from wxLisp.grid import *\\n'}).
@type _widget_extra_modules: Dictionary
"""
code_statements = {}
"""\
Language specific code templates for for small statements
@type: Dictionary of strings
@see: L{_generic_code()}
@see: L{generate_code_extraproperties()}
"""
classattr_always = []
"""\
List of classes to store always as class attributes
@type: List of strings
@see: L{test_attribute()}
"""
class_separator = ''
"""\
Separator between class and attribute or between different name space
elements.
E.g "." for Python or "->" for Perl.
@type: String
"""
comment_sign = ''
"""\
Character(s) to start a comment (e.g. C{#} for Python and Perl or
C{;;;} for lisp).
@type: String
"""
default_extensions = []
"""\
Default extensions for generated files: a list of file extensions
@type: List of strings
"""
global_property_writers = {}
"""\
Custom handlers for widget properties
@type: Dictionary
"""
indent_level_func_body = 1
"""\
Indentation level for bodies of class functions.
@type: Integer
"""
language = None
"""\
Language generated by this code generator
@type: String
"""
language_note = ""
"""\
Language specific notice written into every file header
@note: Please add a newline sequence to the end of the language note.
@type: String
@see: L{save_file()}
"""
name_ctor = ''
"""\
Name of the constructor. E.g. "__init__" in Python or "new" in Perl.
@type: String
"""
shebang = None
"""\
Shebang line, the first line of the generated main files.
@note: Please add a newline sequence to the end of the shebang.
@type: String
@see: L{save_file()}
"""
SourceFileContent = None
"""\
Just a reference to the language specific instance of SourceFileContent
@type: L{BaseSourceFileContent} or a derived class
"""
tmpl_encoding = None
"""\
Template of the encoding notices
The file encoding will be added to the output in L{save_file()}.
@type: String
"""
tmpl_block_begin = \
'%(tab)s%(comment_sign)s begin wxGlade: ' \
'%(klass)s%(class_separator)s%(function)s\n'
tmpl_cfunc_end = ''
"""\
Statement to add at the end of a class function. e.g.
'return $self;' for Perl.
@type: String
"""
tmpl_class_end = ''
"""\
Statement to add at the end of a class.
@type: String
"""
tmpl_ctor_call_layout = ''
"""\
Code add to the contructor to call '__do_layout()' and
'__set_properties()'.
@type: String
"""
tmpl_name_do_layout = ''
"""\
Name of the function __do_layout() in wxGlade begin tag.
This name differs between the various code generators.
@type: String
@see: L{generate_code_do_layout()}
"""
tmpl_name_set_properties = ''
"""\
Name of the function __set_properties() in wxGlade begin tag.
This name differs between the various code generators.
@type: String
@see: L{generate_code_set_properties()}
"""
tmpl_func_empty = ''
"""\
Statement for an empty function e.g. "pass" for Python or "return;" for
perl.
@note: This statement differs between the various code generators.
@type: String
"""
tmpl_func_do_layout = ''
"""\
Statement for the __do_layout() function.
@note: This statement differs between the various code generators.
@type: String
@see: L{generate_code_do_layout()}
"""
tmpl_func_event_stub = ''
"""\
Statement for a event handler stub.
@note: This statement differs between the various code generators.
@type: String
@see: L{generate_code_event_handler()}
"""
tmpl_func_set_properties = ''
"""\
Statement for the __set_properties() function.
@note: This statement differs between the various code generators.
@type: String
@see: L{generate_code_set_properties()}
"""
tmpl_generated_by = \
"%(comment_sign)s %(generated_by)s\n%(comment_sign)s\n"
"""\
Template of the "generated by ..." message
@type: String
@see: L{create_generated_by()}
@see: L{save_file()}
"""
tmpl_overwrite = \
"%(comment_sign)s This is an automatically generated file.\n" \
"%(comment_sign)s Manual changes will be overwritten without " \
"warning!\n\n"
"""\
Template of the overwrite message in all standalone app files.
@type: String
@see: L{add_app()}
"""
tmpl_sizeritem = ''
"""\
Template for adding a widget to a sizer.
@type: String
@see: L{add_sizeritem()}
"""
tmpl_style = ''
"""\
Template for setting style in constructor
@type: String
@see: L{_format_style()}
"""
tmpl_appfile = None
"""\
Template of the file header for standalone files with application start
code.
A standalone file will be created if a separate file for each class is
selected.
@type: None or string
@see: L{add_app}
"""
tmpl_detailed = None
"""\
Template for detailed application start code without gettext support
@type: None or string
@see: L{add_app}
"""
tmpl_gettext_detailed = None
"""\
Template for detailed application start code with gettext support
@type: None or string
@see: L{add_app}
"""
tmpl_simple = None
"""\
Template for simplified application start code without gettext support
@type: None or string
@see: L{add_app}
"""
tmpl_gettext_simple = None
"""\
Template for simplified application start code with gettext support
@type: None or string
@see: L{add_app}
"""
_quote_str_pattern = re.compile(r'\\[natbv"]?')
_show_warnings = True
"""\
Enable or disable printing of warning messages
@type: Boolean
@see: L{self.warning()}
"""
class ClassLines(object):
"""\
Stores the lines of source code for a custom class
@ivar dependencies: Names of the modules this class depends on
@ivar event_handlers: Lines to bind events
@ivar extra_code: Extra code to output before this class
@ivar done: If True, the code for this class has already
been generated
@ivar init: Lines of code to insert in the __init__ method
(for children widgets)
@ivar layout: Lines to insert in the __do_layout method
@ivar parents_init: Lines of code to insert in the __init__ for
container widgets (panels, splitters, ...)
@ivar props: Lines to insert in the __set_properties method
@ivar sizers_init : Lines related to sizer objects declarations
"""
def __init__(self):
self.child_order = []
self.dependencies = {}
self.deps = []
self.done = False
self.event_handlers = []
self.extra_code = []
self.init = []
self.init_lines = {}
self.layout = []
self.parents_init = []
self.props = []
self.sizers_init = []
# end of class ClassLines
DummyPropertyHandler = DummyPropertyHandler
EventsPropertyHandler = EventsPropertyHandler
ExtraPropertiesPropertyHandler = ExtraPropertiesPropertyHandler
FontPropertyHandler = FontPropertyHandler
def __init__(self):
"""\
Initialise only instance variables using there defaults.
"""
self.obj_builders = {}
self.obj_properties = {}
self._property_writers = {}
self._init_vars()
def _init_vars(self):
"""\
Set instance variables (back) to default values during class
instantiation (L{__init__}) and before loading new data
(L{initialize()}).
"""
self.app_encoding = config.default_encoding
self.app_filename = None
self.app_mapping = {}
self.app_name = None
self.classes = {}
self.curr_tab = 0
self.dependencies = {}
self.for_version = (2, 6)
self.header_lines = []
self.indent_symbol = config.default_indent_symbol
self.indent_amount = config.default_indent_amount
self.blacklisted_widgets = {}
self.lang_mapping = {}
self.multiple_files = False
# this is to be more sure to replace the right tags
self.nonce = self.create_nonce()
self.out_dir = None
self.output_file_name = None
self.output_file = None
self.previous_source = None
self._app_added = False
self._current_extra_code = []
self._current_extra_modules = {}
self._overwrite = config.default_overwrite
self._use_gettext = config.default_use_gettext
self._widget_extra_modules = {}
def initialize(self, app_attrs):
"""\
Code generator initialization function.
@see: L{_initialize_stage2()}
"""
# set (most of) instance variables back to default values
self._init_vars()
self.multiple_files = app_attrs['option']
# application name
self.app_name = app_attrs.get('name')
if not self.app_name:
self.app_name = 'app'
self.app_filename = '%s.%s' % (
self.app_name,
self.default_extensions[0],
)
# file encoding
try:
self.app_encoding = app_attrs['encoding'].upper()
# wx doesn't like latin-1
if self.app_encoding == 'latin-1':
self.app_encoding = 'ISO-8859-1'
except (KeyError, ValueError):
# set back to default
self.app_encoding = config.default_encoding
# Inentation level based on the project options
try:
self.indent_symbol = app_attrs['indent_symbol']
if self.indent_symbol == 'tab':
self.indent_symbol = '\t'
elif self.indent_symbol == 'space':
self.indent_symbol = ' '
else:
self.indent_symbol = config.default_indent_symbol
except (KeyError, ValueError):
self.indent_symbol = config.default_indent_symbol
try:
self.indent_amount = int(app_attrs['indent_amount'])
except (KeyError, ValueError):
self.indent_amount = config.default_indent_amount
try:
self._use_gettext = int(app_attrs['use_gettext'])
except (KeyError, ValueError):
self._use_gettext = config.default_use_gettext
try:
self._overwrite = int(app_attrs['overwrite'])
except (KeyError, ValueError):
self._overwrite = config.default_overwrite
try:
self.for_version = tuple([int(t) for t in
app_attrs['for_version'].split('.')[:2]])
except (KeyError, ValueError):
if common.app_tree is not None:
self.for_version = common.app_tree.app.for_version
def _initialize_stage2(self, out_path):
"""\
Second stage for code generator initialization.
@param out_path: Output path
@type out_path: String
@see: L{initialize()}
"""
if self.multiple_files:
self.previous_source = None
if not os.path.isdir(out_path):
raise IOError("'path' must be a directory when generating"\
" multiple output files")
self.out_dir = out_path
else:
if not self._overwrite and self._file_exists(out_path):
# the file exists, we must keep all the lines not inside a
# wxGlade block. NOTE: this may cause troubles if out_path is
# not a valid source file, so be careful!
self.previous_source = self.SourceFileContent(out_path, self)
else:
# if the file doesn't exist, create it and write the ``intro''
self.previous_source = None
self.output_file = cStringIO.StringIO()
self.output_file_name = out_path
for line in self.header_lines:
self.output_file.write(line)
self.output_file.write('<%swxGlade extra_modules>\n' % self.nonce)
self.output_file.write('\n')
self.output_file.write('<%swxGlade replace dependencies>\n' % self.nonce)
self.output_file.write('<%swxGlade replace extracode>\n' % self.nonce)
def finalize(self):
"""\
Code generator finalization function.
"""
if self.previous_source:
# insert all the new custom classes inside the old file
tag = '<%swxGlade insert new_classes>' % self.nonce
if self.previous_source.new_classes:
code = "".join(self.previous_source.new_classes)
else:
code = ""
self.previous_source.content = self.previous_source.content.replace(tag, code)
tag = '<%swxGlade extra_modules>\n' % self.nonce
code = "".join(self._current_extra_modules.keys())
self.previous_source.content = self.previous_source.content.replace(tag, code)
# module dependecies of all classes
tag = '<%swxGlade replace dependencies>' % self.nonce
dep_list = self.dependencies.keys()
dep_list.sort()
code = self._tagcontent('dependencies', dep_list)
self.previous_source.content = \
self.previous_source.content.replace(tag, code)
# extra code (see the 'extracode' property of top-level widgets)
tag = '<%swxGlade replace extracode>' % self.nonce
code = self._tagcontent(
'extracode',
self._current_extra_code
)
self.previous_source.content = \
self.previous_source.content.replace(tag, code)
# now remove all the remaining <123415wxGlade ...> tags from the
# source: this may happen if we're not generating multiple files,
# and one of the container class names is changed
self.previous_source.content = self._content_notfound(
self.previous_source.content
)
tags = re.findall(
'<%swxGlade event_handlers \w+>' % self.nonce,
self.previous_source.content
)
for tag in tags:
self.previous_source.content = self.previous_source.content.replace(tag, "")
# write the new file contents to disk
self.save_file(
self.previous_source.name,
self.previous_source.content,
content_only=True
)
elif not self.multiple_files:
em = "".join(self._current_extra_modules.keys())
content = self.output_file.getvalue().replace(
'<%swxGlade extra_modules>\n' % self.nonce, em)
# module dependecies of all classes
tag = '<%swxGlade replace dependencies>' % self.nonce
dep_list = self.dependencies.keys()
dep_list.sort()
code = self._tagcontent('dependencies', dep_list)
content = content.replace(tag, code)
# extra code (see the 'extracode' property of top-level widgets)
tag = '<%swxGlade replace extracode>' % self.nonce
code = self._tagcontent('extracode', self._current_extra_code)
content = content.replace(tag, code)
self.output_file.close()
self.save_file(self.output_file_name, content, self._app_added)
del self.output_file
def add_app(self, app_attrs, top_win_class):
"""\
Generates the code for a wxApp instance.
If the file to write into already exists, this function does nothing.
If gettext support is requested and there is not template with
gettext support but there is a template without gettext support,
template without gettext support will be used.
This fallback mechanism works bidirectional.
L{app_mapping} will be reset to default values and updated with
L{lang_mapping}.
@see: L{tmpl_appfile}
@see: L{tmpl_detailed}
@see: L{tmpl_gettext_detailed}
@see: L{tmpl_simple}
@see: L{tmpl_gettext_simple}
@see: L{app_mapping}
@see: L{lang_mapping}
"""
self._app_added = True
if not self.multiple_files:
prev_src = self.previous_source
else:
# overwrite apps file always
prev_src = None
# do nothing if the file exists
if prev_src:
return
klass = app_attrs.get('class')
top_win = app_attrs.get('top_window')
# do nothing if there is no top window
if not top_win:
return
# check for templates for detailed startup code
if klass and self._use_gettext:
if self.tmpl_gettext_detailed:
tmpl = self.tmpl_gettext_detailed
elif self.tmpl_detailed:
tmpl = self.tmpl_detailed
else:
self.warning(
_("Skip generating detailed startup code "
"because no suitable template found.")
)
return
elif klass and not self._use_gettext:
if self.tmpl_detailed:
tmpl = self.tmpl_detailed
elif self.tmpl_gettext_detailed:
tmpl = self.tmpl_gettext_detailed
else:
self.warning(
_("Skip generating detailed startup code "
"because no suitable template found.")
)
return
# check for templates for simple startup code
elif not klass and self._use_gettext:
if self.tmpl_gettext_simple:
tmpl = self.tmpl_gettext_simple
elif self.tmpl_simple:
tmpl = self.tmpl_simple
else:
self.warning(
_("Skip generating simple startup code "
"because no suitable template found.")
)
return
elif not klass and not self._use_gettext:
if self.tmpl_simple:
tmpl = self.tmpl_simple
elif self.tmpl_gettext_simple:
tmpl = self.tmpl_gettext_simple
else:
self.warning(
_("Skip generating simple startup code "
"because no suitable template found.")
)
return
else:
self.warning(
_('No application code template for klass "%(klass)s" '
'and gettext "%(gettext)s" found!' % {
'klass': klass,
'gettext': self._use_gettext,
}
))
return
# map to substitude template variables
self.app_mapping = {
'comment_sign': self.comment_sign,
'header_lines': ''.join(self.header_lines),
'klass': klass,
'name': self.app_name,
'overwrite': self.tmpl_overwrite % {'comment_sign': self.comment_sign},
'tab': self.tabs(1),
'top_win_class': top_win_class,
'top_win': top_win,
}
# extend default mapping with language specific mapping
if self.lang_mapping:
self.app_mapping.update(self.lang_mapping)
code = tmpl % (self.app_mapping)
if self.multiple_files:
filename = os.path.join(self.out_dir, self.app_filename)
code = "%s%s" % (
self.tmpl_appfile % (self.app_mapping),
code,
)
# write the wxApp code
self.save_file(filename, code, True)
else:
self.output_file.write(code)
def add_class(self, code_obj):
"""\
Add class behaves very differently for XRC output than for other
lanaguages (i.e. pyhton): since custom classes are not supported in
XRC, this has effect only for true toplevel widgets, i.e. frames and
dialogs. For other kinds of widgets, this is equivalent to add_object
"""
if self.classes.has_key(code_obj.klass) and \
self.classes[code_obj.klass].done:
return # the code has already been generated
if self.multiple_files:
# let's see if the file to generate exists, and in this case
# create a SourceFileContent instance
filename = self._get_class_filename(code_obj.klass)
if self._overwrite or not self._file_exists(filename):
prev_src = None
else:
prev_src = self.SourceFileContent(filename, self)
self._current_extra_modules = {}
else:
# in this case, previous_source is the SourceFileContent instance
# that keeps info about the single file to generate
prev_src = self.previous_source
try:
builder = self.obj_builders[code_obj.base]
mycn = getattr(builder, 'cn', self.cn)
mycn_f = getattr(builder, 'cn_f', self.cn_f)
except KeyError:
print code_obj
raise # this is an error, let the exception be raised
if prev_src and prev_src.classes.has_key(code_obj.klass):
is_new = False
indentation = prev_src.spaces[code_obj.klass]
else:
# this class wasn't in the previous version of the source (if any)
is_new = True
indentation = self.tabs(self.indent_level_func_body)
mods = getattr(builder, 'extra_modules', [])
if mods:
for m in mods:
self._current_extra_modules[m] = 1
buffer = []
write = buffer.append
if not self.classes.has_key(code_obj.klass):
# if the class body was empty, create an empty ClassLines
self.classes[code_obj.klass] = self.ClassLines()
# collect all event handlers
event_handlers = self.classes[code_obj.klass].event_handlers
if hasattr(builder, 'get_events'):
for id, event, handler in builder.get_events(code_obj):
event_handlers.append((id, mycn(event), handler))
# try to see if there's some extra code to add to this class
if not code_obj.preview:
extra_code = getattr(builder, 'extracode',
code_obj.properties.get('extracode', ""))
if extra_code:
extra_code = re.sub(r'\\n', '\n', extra_code)
self.classes[code_obj.klass].extra_code.append(extra_code)
if not is_new:
self.warning(
'%s has extra code, but you are not overwriting '
'existing sources: please check that the resulting '
'code is correct!' % code_obj.name
)
# Don't add extra_code to self._current_extra_code here, that is
# handled later. Otherwise we'll emit duplicate extra code for
# frames.
tab = indentation
# generate code for first constructor stage
code_lines = self.generate_code_ctor(code_obj, is_new, tab)
buffer.extend(code_lines)
# now check if there are extra lines to add to the constructor
if hasattr(builder, 'get_init_code'):
for l in builder.get_init_code(code_obj):
write(tab + l)
write(self.tmpl_ctor_call_layout % {
'tab': tab,
})
# generate code for binding events
code_lines = self.generate_code_event_bind(
code_obj,
tab,
event_handlers,
)
buffer.extend(code_lines)
# end tag
write('%s%s end wxGlade\n' % (tab, self.comment_sign))
# write class function end statement
if self.tmpl_cfunc_end and is_new:
write(self.tmpl_cfunc_end % {
'tab': tab,
})
# end of ctor generation
# replace code inside existing constructor block
if prev_src and not is_new:
# replace the lines inside the ctor wxGlade block
# with the new ones
tag = '<%swxGlade replace %s %s>' % (self.nonce, code_obj.klass,
self.name_ctor)
if prev_src.content.find(tag) < 0:
# no __init__ tag found, issue a warning and do nothing
self.warning(
"wxGlade %(ctor)s block not found for %(name)s, %(ctor)s code "
"NOT generated" % {
'name': code_obj.name,
'ctor': self.name_ctor,
}
)
else:
prev_src.content = prev_src.content.replace(tag, "".join(buffer))
buffer = []
write = buffer.append
# generate code for __set_properties()
code_lines = self.generate_code_set_properties(
builder,
code_obj,
is_new,
tab
)
buffer.extend(code_lines)
# replace code inside existing __set_properties() function
if prev_src and not is_new:
# replace the lines inside the __set_properties wxGlade block
# with the new ones
tag = '<%swxGlade replace %s %s>' % (self.nonce, code_obj.klass,
'__set_properties')
if prev_src.content.find(tag) < 0:
# no __set_properties tag found, issue a warning and do nothing
self.warning(
"wxGlade __set_properties block not found for %s, "
"__set_properties code NOT generated" % code_obj.name
)
else:
prev_src.content = prev_src.content.replace(tag, "".join(buffer))
buffer = []
write = buffer.append
# generate code for __do_layout()
code_lines = self.generate_code_do_layout(
builder,
code_obj,
is_new,
tab
)
buffer.extend(code_lines)
# replace code inside existing __do_layout() function
if prev_src and not is_new:
# replace the lines inside the __do_layout wxGlade block
# with the new ones
tag = '<%swxGlade replace %s %s>' % (self.nonce, code_obj.klass,
'__do_layout')
if prev_src.content.find(tag) < 0:
# no __do_layout tag found, issue a warning and do nothing
self.warning(
"wxGlade __do_layout block not found for %s, __do_layout "
"code NOT generated" % code_obj.name
)
else:
prev_src.content = prev_src.content.replace(tag, "".join(buffer))
# generate code for event handler stubs
code_lines = self.generate_code_event_handler(
code_obj,
is_new,
tab,
prev_src,
event_handlers,
)
# replace code inside existing event handlers
if prev_src and not is_new:
tag = \
'<%swxGlade event_handlers %s>' % (self.nonce, code_obj.klass)
if prev_src.content.find(tag) < 0:
# no event_handlers tag found, issue a warning and do nothing
self.warning(
"wxGlade event_handlers block not found for %s, "
"event_handlers code NOT generated" % code_obj.name
)
else:
prev_src.content = prev_src.content.replace(
tag,
"".join(code_lines),
)
else:
buffer.extend(code_lines)
# the code has been generated
self.classes[code_obj.klass].done = True
# write "end of class" statement
if self.tmpl_class_end:
write(
self.tmpl_class_end % {
'klass': self.cn_class(code_obj.klass),
'comment': self.comment_sign,
}
)
if self.multiple_files:
if prev_src:
tag = '<%swxGlade insert new_classes>' % self.nonce
prev_src.content = prev_src.content.replace(tag, "")
# insert the extra modules
tag = '<%swxGlade extra_modules>\n' % self.nonce
code = "".join(self._current_extra_modules.keys())
prev_src.content = prev_src.content.replace(tag, code)
# insert the module dependencies of this class
tag = '<%swxGlade replace dependencies>' % self.nonce
dep_list = self.classes[code_obj.klass].dependencies.keys()
dep_list.extend(self.dependencies.keys())
dep_list.sort()
code = self._tagcontent('dependencies', dep_list)
prev_src.content = prev_src.content.replace(tag, code)
# insert the extra code of this class
extra_code = "".join(self.classes[code_obj.klass].extra_code[::-1])
# if there's extra code but we are not overwriting existing
# sources, warn the user
if extra_code:
self.warning(
'%s (or one of its chilren) has extra code classes, '
'but you are not overwriting existing sources: please '
'check that the resulting code is correct!' % \
code_obj.name
)
tag = '<%swxGlade replace extracode>' % self.nonce
code = self._tagcontent('extracode', extra_code)
prev_src.content = prev_src.content.replace(tag, code)
# store the new file contents to disk
self.save_file(filename, prev_src.content, content_only=True)
return
# create the new source file
filename = self._get_class_filename(code_obj.klass)
out = cStringIO.StringIO()
write = out.write
# write the common lines
for line in self.header_lines:
write(line)
# write the module dependecies for this class
dep_list = self.classes[code_obj.klass].dependencies.keys()
dep_list.extend(self.dependencies.keys())
dep_list.sort()
code = self._tagcontent('dependencies', dep_list, True)
write(code)
# insert the extra code of this class
code = self._tagcontent(
'extracode',
self.classes[code_obj.klass].extra_code[::-1],
True
)
write(code)
# write the class body
for line in buffer:
write(line)
# store the contents to filename
self.save_file(filename, out.getvalue())
out.close()
else: # not self.multiple_files
if prev_src:
# if this is a new class, add its code to the new_classes
# list of the SourceFileContent instance
if is_new:
prev_src.new_classes.append("".join(buffer))
elif self.classes[code_obj.klass].extra_code:
self._current_extra_code.extend(self.classes[code_obj.klass].extra_code[::-1])
return
else:
# write the class body onto the single source file
for dep in self.classes[code_obj.klass].dependencies:
self._current_extra_modules[dep] = 1
if self.classes[code_obj.klass].extra_code:
self._current_extra_code.extend(self.classes[code_obj.klass].extra_code[::-1])
write = self.output_file.write
for line in buffer:
write(line)
def add_object(self, top_obj, sub_obj):
"""\
Adds the code to build 'sub_obj' to the class body of 'top_obj'.
@see: L{_add_object_init()}
@see: L{_add_object_format_name()}
"""
sub_obj.name = self._format_name(sub_obj.name)
sub_obj.parent.name = self._format_name(sub_obj.parent.name)
# get top level source code object and the widget builder instance
klass, builder = self._add_object_init(top_obj, sub_obj)
if not klass or not builder:
return
try:
init, props, layout = builder.get_code(sub_obj)
except:
print sub_obj
raise # this shouldn't happen
if sub_obj.in_windows: # the object is a wxWindow instance
if sub_obj.is_container and not sub_obj.is_toplevel:
init.reverse()
klass.parents_init.extend(init)
else:
klass.init.extend(init)
# Add a dependency of the current object on its parent
klass.deps.append((sub_obj, sub_obj.parent))
klass.child_order.append(sub_obj)
klass.init_lines[sub_obj] = init
mycn = getattr(builder, 'cn', self.cn)
if hasattr(builder, 'get_events'):
evts = builder.get_events(sub_obj)
for id, event, handler in evts:
klass.event_handlers.append((id, mycn(event), handler))
elif 'events' in sub_obj.properties:
id_name, id = self.generate_code_id(sub_obj)
if id == '-1' or id == self.cn('wxID_ANY'):
id = self._add_object_format_name(sub_obj.name)
for event, handler in sub_obj.properties['events'].iteritems():
klass.event_handlers.append((id, mycn(event), handler))
# try to see if there's some extra code to add to this class
if not sub_obj.preview:
extra_code = getattr(builder, 'extracode',
sub_obj.properties.get('extracode', ""))
if extra_code:
extra_code = re.sub(r'\\n', '\n', extra_code)
klass.extra_code.append(extra_code)
# if we are not overwriting existing source, warn the user
# about the presence of extra code
if not self.multiple_files and self.previous_source:
self.warning(
'%s has extra code, but you are not '
'overwriting existing sources: please check '
'that the resulting code is correct!' % \
sub_obj.name
)
else: # the object is a sizer
if sub_obj.base == 'wxStaticBoxSizer':
i = init.pop(0)
klass.parents_init.insert(1, i)
# Add a dependency of the current object on its parent
klass.deps.append((sub_obj, sub_obj.parent))
klass.child_order.append(sub_obj)
klass.init_lines[sub_obj] = [i]
klass.sizers_init.extend(init)
klass.props.extend(props)
klass.layout.extend(layout)
if self.multiple_files and \
(sub_obj.is_toplevel and sub_obj.base != sub_obj.klass):
key = self._format_import(sub_obj.klass)
klass.dependencies[key] = 1
for dep in getattr(self.obj_builders.get(sub_obj.base),
'import_modules', []):
klass.dependencies[dep] = 1
def _add_object_init(self, top_obj, sub_obj):
"""\
Perform some initial actions for L{add_object()}
Widgets without code generator or widget that are not supporting the
requested wx version are blacklisted at L{blacklisted_widgets}.
@return: Top level source code object and the widget builder instance
or C{None, None} in case of errors.
"""
# initialise internal variables first
klass = None
builder = None
# Check for proper source code instance
if top_obj.klass in self.classes:
klass = self.classes[top_obj.klass]
else:
klass = self.classes[top_obj.klass] = self.ClassLines()
# Check for widget builder object
try:
builder = self.obj_builders[sub_obj.base]
except KeyError:
# no code generator found: write a comment about it
msg = _("""\
Code for instance "%s" of "%s" not generated: no suitable writer found""") % (
sub_obj.name,
sub_obj.klass,
)
self._source_warning(klass, msg, sub_obj)
self.warning(msg)
# ignore widget later too
self.blacklisted_widgets[sub_obj] = 1
return None, None
# check for supported versions
supported_by = getattr(builder, 'supported_by', ())
if supported_by and self.for_version not in supported_by:
supported_versions = ', '.join(
[misc.format_for_version(version) for version in supported_by]
)
msg = _("""\
Code for instance "%(name)s" of "%(klass)s" was
not created, because the widget is not available for wx version %(requested_version)s.
It is available for wx versions %(supported_versions)s only.""") % {
'name': sub_obj.name,
'klass': sub_obj.klass,
'requested_version': str(misc.format_for_version(self.for_version)),
'supported_versions': str(supported_versions),
}
self._source_warning(klass, msg, sub_obj)
self.warning(msg)
# ignore widget later too
self.blacklisted_widgets[sub_obj] = 1
return None, None
return klass, builder
def add_property_handler(self, property_name, handler, widget_name=None):
"""\
Sets a function to parse a portion of XML to get the value of the
property property_name. If widget_name is not None, the function is
called only if the property in inside a widget whose class is
widget_name.
"""
if not widget_name:
self.global_property_writers[property_name] = handler
else:
try:
self._property_writers[widget_name][property_name] = handler
except KeyError:
self._property_writers[widget_name] = {property_name: handler}
def add_sizeritem(self, toplevel, sizer, obj, option, flag, border):
"""\
Writes the code to add the object 'obj' to the sizer 'sizer' in the
'toplevel' object.
All widgets in L{blacklisted_widgets} are ignored.
@see: L{tmpl_sizeritem}
"""
# don't process widgets listed in blacklisted_widgets
if obj in self.blacklisted_widgets:
return
# the name attribute of a spacer is already formatted
# "<width>, <height>". This string can simply inserted in Add() call.
obj_name = self._format_classattr(obj)
if toplevel.klass in self.classes:
klass = self.classes[toplevel.klass]
else:
klass = self.classes[toplevel.klass] = self.ClassLines()
# check if sizer has to store as a class attribute
sizer_name = self._format_classattr(sizer)
stmt = self.tmpl_sizeritem % (
sizer_name,
obj_name,
option,
self.cn_f(flag),
border,
)
klass.layout.append(stmt)
def add_widget_handler(self, widget_name, handler, *args, **kwds):
self.obj_builders[widget_name] = handler
def create_generated_by(self):
"""\
Create I{generated by wxGlade} string without leading comment
characters and without tailing new lines
@rtype: String
"""
if config.preferences.write_timestamp:
msg = 'generated by wxGlade %s on %s%s' % (
common.version,
time.asctime(),
common.generated_from(),
)
else:
msg = 'generated by wxGlade %s%s' % (
common.version,
common.generated_from(),
)
return msg
def create_nonce(self):
"""\
Create a random number used to be sure that the replaced tags in the
sources are the right ones (see SourceFileContent and add_class)
@return: A random nonce
@rtype: String
"""
nonce = '%s%s' % (str(time.time()).replace('.', ''),
random.randrange(10 ** 6, 10 ** 7))
return nonce
def get_property_handler(self, property_name, widget_name):
"""\
Return the widget specific property handler
@see: L{add_property_handler}
@see: L{global_property_writers}
@see: L{_property_writers}
"""
try:
cls = self._property_writers[widget_name][property_name]
except KeyError:
cls = self.global_property_writers.get(property_name, None)
if cls:
return cls()
return None
def generate_code_background(self, obj):
"""\
Returns the code fragment that sets the background colour of
the given object.
@rtype: String
@see: L{_get_colour()}
"""
# check if there is an code template for this property
if 'backgroundcolour' not in self.code_statements:
msg = " %s WARNING: no code template for property '%s' " \
"registered!\n" % (self.comment_sign, 'backgroundcolour')
self.warning(msg)
return msg
objname = self._get_code_name(obj)
color = self._get_colour(obj.properties['background'])
tmpl = self.code_statements['backgroundcolour']
stmt = tmpl % {
'objname': objname,
'value': color,
}
return stmt
def generate_code_ctor(self, code_obj, is_new, tab):
"""\
Generate constructor code for top-level object
@param code_obj: Object to generate code for
@type code_obj: Instance of L{CodeObject}
@param is_new: Flag if a new file is creating
@type is_new: Boolean
@param tab: Indentation
@type tab: String
@rtype: List of strings
"""
return []
def generate_code_disabled(self, obj):
"""\
Returns the code fragment that disables the given object.
@rtype: String
"""
return self._generic_code(obj, 'disabled')
def generate_code_do_layout(self, builder, code_obj, is_new, tab):
"""\
Generate code for the function C{__do_layout()}.
If C{is_new} is set, this function returns source code for the whole
function. Otherwise it returns just the function body framed by
"begin wxGlade" and "end wxGlade".
@param builder: Widget specific builder
@param code_obj: Object to generate code for
@type code_obj: Instance of L{CodeObject}
@param is_new: Indicates if previous source code exists
@type is_new: Boolean
@param tab: Indentation of function body
@type tab: String
@rtype: List of strings
@see: L{tmpl_name_do_layout}
@see: L{tmpl_func_do_layout}
@see: L{tmpl_func_empty}
@see: L{_generate_function()}
"""
code_lines = []
write = code_lines.append
# generate content of function body first
layout_lines = self.classes[code_obj.klass].layout
sizers_init_lines = self.classes[code_obj.klass].sizers_init
# check if there are extra layout lines to add
if hasattr(builder, 'get_layout_code'):
extra_layout_lines = builder.get_layout_code(code_obj)
else:
extra_layout_lines = []
if layout_lines or sizers_init_lines or extra_layout_lines:
sizers_init_lines.reverse()
for l in sizers_init_lines:
write(l)
for l in layout_lines:
write(l)
for l in extra_layout_lines:
write(l)
code_lines = self._generate_function(
code_obj,
is_new,
tab,
self.tmpl_name_do_layout,
self.tmpl_func_do_layout,
code_lines,
)
return code_lines
def generate_code_event_bind(self, code_obj, tab, event_handlers):
"""\
Generate to bind event handlers.
This function is used for interpreted languages only.
@param code_obj: Object to generate code for
@type code_obj: Instance of L{CodeObject}
@param tab: Indentation of function body
@type tab: String
@param event_handlers: List of event handlers
@rtype: List of strings
"""
return []
def generate_code_event_handler(self, code_obj, is_new, tab, prev_src, \
event_handlers):
"""\
Generate the event handler stubs
@param code_obj: Object to generate code for
@type code_obj: Instance of L{CodeObject}
@param is_new: Indicates if previous source code exists
@type is_new: Boolean
@param tab: Indentation of function body
@type tab: String
@param prev_src: Previous source code
@type prev_src: Language specific instance of SourceFileContent
@param event_handlers: List of event handlers
@rtype: List of strings
@see: L{tmpl_func_event_stub}
"""
code_lines = []
write = code_lines.append
if prev_src and not is_new:
already_there = prev_src.event_handlers.get(code_obj.klass, {})
else:
already_there = {}
for name, event, handler in event_handlers:
# don't create handler twice
if handler in already_there:
continue
# add an empty line for
# TODO: Remove later
if self.language in ['python', 'lisp',]:
if not (prev_src and not is_new):
write('\n')
write(self.tmpl_func_event_stub % {
'tab': tab,
'klass': self.cn_class(code_obj.klass),
'handler': handler,
})
already_there[handler] = 1
return code_lines
def generate_code_extraproperties(self, obj):
"""\
Returns a code fragment that set extra properties for the given object
@rtype: List of strings
"""
if not 'extraproperties' in self.code_statements:
return []
objname = self._get_code_name(obj)
prop = obj.properties['extraproperties']
ret = []
for name in sorted(prop):
tmpl = self.code_statements['extraproperties']
stmt = tmpl % {
'klass': obj.klass,
'objname': objname,
'propname': name,
'value': prop[name],
}
ret.append(stmt)
return ret
def generate_code_focused(self, obj):
"""\
Returns the code fragment that get the focus to the given object.
@rtype: String
"""
return self._generic_code(obj, 'focused')
def generate_code_font(self, obj):
"""\
Returns the code fragment that sets the font of the given object.
@rtype: String
"""
stmt = None
# check if there is an code template for this property
if 'setfont' not in self.code_statements:
msg = " %s WARNING: no code template for property '%s' " \
"registered!\n" % (self.comment_sign, 'setfont')
self.warning(msg)
return msg
objname = self._get_code_name(obj)
cnfont = self.cn('wxFont')
font = obj.properties['font']
family = self.cn(font['family'])
face = '"%s"' % font['face'].replace('"', r'\"')
size = font['size']
style = self.cn(font['style'])
underlined = font['underlined']
weight = self.cn(font['weight'])
tmpl = self.code_statements['setfont']
stmt = tmpl % {
'objname': objname,
'cnfont': cnfont,
'face': face,
'family': family,
'size': size,
'style': style,
'underlined': underlined,
'weight': weight,
}
return stmt
def generate_code_foreground(self, obj):
"""\
Returns the code fragment that sets the foreground colour of
the given object.
@rtype: String
@see: L{_get_colour()}
"""
# check if there is an code template for this property
if 'foregroundcolour' not in self.code_statements:
msg = " %s WARNING: no code template for property '%s' " \
"registered!\n" % (self.comment_sign, 'foregroundcolour')
self.warning(msg)
return msg
objname = self._get_code_name(obj)
color = self._get_colour(obj.properties['foreground'])
tmpl = self.code_statements['foregroundcolour']
stmt = tmpl % {
'objname': objname,
'value': color,
}
return stmt
def generate_code_hidden(self, obj):
"""\
Returns the code fragment that hides the given object.
@rtype: String
"""
return self._generic_code(obj, 'hidden')
def generate_code_id(self, obj, id=None):
"""\
Generate the code for the widget ID.
The parameter C{id} is evaluated first. An empty string for
C{id} returns C{'', 'wxID_ANY'}.
Returns a tuple of two string. The two strings are:
1. A line to the declare the variable. It's empty if the object id
is a constant
2. The value of the id
@param obj: An instance of L{xml_parse.CodeObject}
@param id: Widget ID definition as String.
@rtype: Tuple of two strings
"""
raise NotImplementedError
def generate_code_set_properties(self, builder, code_obj, is_new, tab):
"""\
Generate code for the function C{__set_properties()}.
If C{is_new} is set, this function returns source code for the whole
function. Otherwise it returns just the function body framed by
"begin wxGlade" and "end wxGlade".
@param builder: Widget specific builder
@param code_obj: Object to generate code for
@type code_obj: Instance of L{CodeObject}
@param is_new: Indicates if previous source code exists
@type is_new: Boolean
@param tab: Indentation of function body
@type tab: String
@rtype: List of strings
@see: L{tmpl_name_set_properties}
@see: L{tmpl_func_set_properties}
@see: L{tmpl_func_empty}
@see: L{_generate_function()}
"""
# check if there are property lines to add
_get_properties = getattr(
builder,
'get_properties_code',
self.generate_common_properties)
property_lines = _get_properties(code_obj)
property_lines.extend(self.classes[code_obj.klass].props)
code_lines = self._generate_function(
code_obj,
is_new,
tab,
self.tmpl_name_set_properties,
self.tmpl_func_set_properties,
property_lines,
)
return code_lines
def generate_code_size(self, obj):
"""\
Returns the code fragment that sets the size of the given object.
@rtype: String
"""
raise NotImplementedError
def generate_code_tooltip(self, obj):
"""\
Returns the code fragment that sets the tooltip of the given object.
@rtype: String
"""
return self._generic_code(obj, 'tooltip')
def generate_common_properties(self, widget):
"""\
generates the code for various properties common to all widgets
(background and foreground colors, font, ...)
@return: a list of strings containing the generated code
@rtype: List of strings
@see: L{generate_code_background()}
@see: L{generate_code_disabled()}
@see: L{generate_code_extraproperties()}
@see: L{generate_code_focused()}
@see: L{generate_code_font()}
@see: L{generate_code_foreground()}
@see: L{generate_code_hidden()}
@see: L{generate_code_size()}
@see: L{generate_code_tooltip()}
"""
prop = widget.properties
out = []
if prop.get('size', '').strip():
out.append(self.generate_code_size(widget))
if prop.get('background'):
out.append(self.generate_code_background(widget))
if prop.get('foreground'):
out.append(self.generate_code_foreground(widget))
if prop.get('font'):
out.append(self.generate_code_font(widget))
# tooltip
if prop.get('tooltip'):
out.append(self.generate_code_tooltip(widget))
# trivial boolean properties
if prop.get('disabled'):
out.append(self.generate_code_disabled(widget))
if prop.get('focused'):
out.append(self.generate_code_focused(widget))
if prop.get('hidden'):
out.append(self.generate_code_hidden(widget))
if prop.get('extraproperties') and not widget.preview:
out.extend(self.generate_code_extraproperties(widget))
return out
def cn(self, name):
"""\
Return the class name properly formatted for the selected name space.
@see: L{cn_f()}
@see: L{cn_class}
"""
return name
def cn_f(self, flags):
"""\
Return the flags properly formatted for the selected name space.
"""
return flags
def cn_class(self, klass):
"""\
Return the klass name
@see: L{cn()}
"""
return klass
def quote_str(self, s, translate=True, escape_chars=True):
"""\
returns a quoted version of 's', suitable to insert in a python source
file as a string object. Takes care also of gettext support
@param s: String to quote
@param translate: Encapsulate string into a gettext statement,
if L{_use_gettext} is True
@param escape_chars: Escape special meaning characters like backspace
or quotes
@rtype: String
"""
raise NotImplementedError
def quote_path(self, s):
"""\
escapes all quotation marks and backslashes,
thus making a path suitable to insert in a list source file
@note: You may overwrite this function in the derivated class
@rtype: String
""" # " ALB: to avoid emacs going insane with colorization..
s = s.replace('\\', '\\\\')
s = s.replace('"', r'\"')
s = s.replace('$', r'\$') # sigh
s = s.replace('@', r'\@')
return '"%s"' % s
def save_file(self, filename, content, mainfile=False, content_only=False):
"""\
Store the content in a file.
A L{shebang} is added in top of all mainfiles. The permissions
of mainfiles will be set to C{0755} too.
L{common.save_file()} is used for storing content.
@param filename: File name
@type filename: String
@param content: File content
@type content: String
@param mainfile: Mainfiles gets a L{shebang} and C{0755} permissions.
@type mainfile: Boolean
@param content_only: Write only content to the file
@type content_only: Boolean
@see: L{common.save_file()}
"""
# create an temporary StringIO file to add header
tmp = ""
# write additional information to file header
if not content_only:
# add shebang to main file
if self.shebang and mainfile or self.language == 'C++':
tmp += self.shebang
# add file encoding notice
if self.tmpl_encoding and self.app_encoding:
tmp += self.tmpl_encoding % self.app_encoding
# add created by notice
if self.tmpl_generated_by:
tmp += self.tmpl_generated_by % {
'comment_sign': self.comment_sign,
'generated_by': self.create_generated_by(),
}
# add language specific note
if self.language_note:
tmp += "%s" % self.language_note
# add a empty line
tmp += "\n"
# add original file content
tmp += content
# check for sub necessary directories e.g. for Perl or Python modules
dirname = os.path.dirname(filename)
if dirname and not os.path.isdir(dirname):
try:
os.makedirs(dirname)
except:
common.message.exception(
_('Can not create output directory "%s"'), dirname
)
# save the file now
try:
common.save_file(filename, tmp, 'codegen')
except IOError, e:
raise XmlParsingError(str(e))
except:
common.message.exception(_('Internal Error'))
if mainfile and sys.platform in ['linux2', 'darwin']:
try:
# make the file executable
os.chmod(filename, 0755)
except OSError, e:
# this isn't necessarily a bad errror
self.warning(
_('Changing permission of main file "%s" failed: %s') % (
filename, str(e)
)
)
def test_attribute(self, obj):
"""\
Returns True if 'obj' should be added as an attribute of its parent's
class, False if it should be created as a local variable of
C{__do_layout}.
The function returns True of the object klass is listed in
L{classattr_always}.
The function returns True for all widgets except sizers, if
- the property exists and is an integer greater equal 1
- the property does not exists
- the property contains a non-integer value
The function returns True for sizers, if
- the property exists and is an integer greater equal 1
@rtype: Boolean
@see: L{classattr_always}
"""
if obj.klass in self.classattr_always:
return True
try:
return int(obj.properties['attribute'])
except (KeyError, ValueError):
if obj.in_sizers:
return False
return True # this is the default
def tabs(self, number):
"""\
Return a proper formatted string for indenting lines
@rtype: String
"""
return self.indent_symbol * self.indent_amount * number
def warning(self, msg):
"""\
Show a warning message
@param msg: Warning message
@type msg: String
@see: L{common.MessageLogger.warn()}
"""
if self._show_warnings:
common.message.warn(msg)
def _content_notfound(self, source):
"""\
Remove all the remaining <123415wxGlade ...> tags from the source
and add a warning instead.
This may happen if we're not generating multiple files, and one of
the container class names is changed.
The indentation of the string depends values detected during the
initial parsing of the source file. Those values are stored in
L{BaseSourceFileContent.spaces}.
@param source: Source content with tags to replace
@type source: String
@return: Changed content
@rtype: String
"""
tags = re.findall(
'(<%swxGlade replace ([a-zA-Z_]\w*) +[.\w]+>)' % self.nonce,
source
)
for tag in tags:
# re.findall() returned a list of tuples (caused by grouping)
# first element in tuple: the whole match
# second element in tuple: the class / block name
indent = self.previous_source.spaces.get(tag[1], "")
comment = '%(indent)s%(comment_sign)s Content of this block not found. ' \
'Did you rename this class?\n'
if 'contentnotfound' in self.code_statements:
comment += '%(indent)s%(command)s\n'
command = self.code_statements['contentnotfound']
else:
command = ""
comment = comment % {
'command': command,
'comment_sign': self.comment_sign,
'indent': indent,
}
source = source.replace(tag[0], comment)
return source
def _do_replace(self, match):
"""\
Escape double backslashed in first RE match group
"""
if match.group(0) == '\\':
return '\\\\'
else:
return match.group(0)
def _file_exists(self, filename):
"""\
Check if the file exists
@note: Separated for debugging purposes
@rtype: Boolean
"""
return os.path.isfile(filename)
def _add_object_format_name(self, name):
"""\
Format a widget name to use in L{add_object()}.
@note: This function is for use in L{add_object()} only!
@param name: Widget name
@type name: String
@rtype: String
@see: L{add_object()}
"""
return name
def _format_classattr(self, obj):
"""\
Format the object name to store as a class attribute.
@param obj: Instance of L{xml_parse.CodeObject}
@rtype: String
"""
if not obj:
return ''
elif not getattr(obj, 'name', None):
return ''
return obj.name
def _format_comment(self, msg):
"""\
Return message formatted to add as a comment string in generating
source code.
Trailing spaces will be removed. Leading spaces e.g. identation won't
be added.
@type msg: String
@rtype: String
"""
return "%s %s" % (self.comment_sign, msg.rstrip())
def _format_import(self, klass):
"""\
Return formatted import statement for the given class
@param klass: Class name
@type klass: String
@rtype: String
"""
return klass
def _format_name(self, name):
"""\
Format a class or a widget name by replacing forbidden characters.
@rtype: String
"""
return name
def _format_style(self, style, code_obj):
"""\
Return the formatted styles to insert into constructor code.
The function just returned L{tmpl_style}. Write a derived version
implementation if more logic is needed.
@see: L{tmpl_style}
@rtype: String
"""
return self.tmpl_style
def _generic_code(self, obj, prop_name):
"""\
Create a code statement for calling a method e.g. to hide a widget.
@param obj: Instance of L{xml_parse.CodeObject}
@param prop_name: Name of the property to set
@type prop_name: String
@return: Code statement or None
@rtype: String
@see: L{code_statements}
"""
stmt = None
value = None
# check if there is an code template for this prop_name
if prop_name not in self.code_statements:
msg = " %s WARNING: no code template for property '%s' " \
"registered!\n" % (self.comment_sign, prop_name)
self.warning(msg)
return msg
# collect detail informaton
if prop_name in ['disabled', 'focused', 'hidden']:
try:
value = int(obj.properties[prop_name])
except (KeyError, ValueError):
# nothing to do
return None
elif prop_name == 'tooltip':
value = self.quote_str(obj.properties['tooltip'])
else:
raise AssertionError("Unknown property name: %s" % prop_name)
objname = self._get_code_name(obj)
tmpl = self.code_statements[prop_name]
stmt = tmpl % {
'objname': objname,
'tooltip': value,
}
return stmt
def _get_code_name(self, obj):
"""\
Returns the language specific name of the variable e.g. C{self}
or C{$self}.
@rtype: String
"""
raise NotImplementedError
def _get_colour(self, colourvalue):
"""\
Returns the language specific colour statement
@rtype: String
"""
# check if there is an code template for this properties
if 'wxcolour' not in self.code_statements:
msg = " %s WARNING: no code template for property '%s' " \
"registered!\n" % (self.comment_sign, 'wxcolour')
self.warning(msg)
return msg
if 'wxsystemcolour' not in self.code_statements:
msg = " %s WARNING: no code template for property '%s' " \
"registered!\n" % (self.comment_sign, 'wxsystemcolour')
self.warning(msg)
return msg
try:
value = self._string_to_colour(colourvalue)
func = self.cn(self.code_statements['wxcolour'])
except (IndexError, ValueError): # the color is from system settings
value = self.cn(colourvalue)
func = self.cn(self.code_statements['wxsystemcolour'])
stmt = func % {
'value': value,
}
return stmt
def _get_class_filename(self, klass):
"""\
Returns the filename to store a single class in multi file projects.
@param klass: Class name
@type klass: String
@rtype: String
"""
return ''
def _generate_function(self, code_obj, is_new, tab, fname, ftmpl, body):
"""\
Generic function to generate a complete function from given parts.
@param code_obj: Object to generate code for
@type code_obj: Instance of L{CodeObject}
@param is_new: Indicates if previous source code exists
@type is_new: Boolean
@param tab: Indentation of function body
@type tab: String
@param fname: Name of the function
@type fname: String
@param ftmpl: Template of the function
@type ftmpl: String
@param body: Content of the function
@type body: List of strings
@rtype: List of strings
"""
code_lines = []
write = code_lines.append
# begin tag
write(self.tmpl_block_begin % {
'class_separator': self.class_separator,
'comment_sign': self.comment_sign,
'function': fname,
'klass': self.cn_class(code_obj.klass),
'tab': tab,
})
if body:
for l in body:
write(tab + l)
else:
write(self.tmpl_func_empty % {'tab': tab})
# end tag
write('%s%s end wxGlade\n' % (tab, self.comment_sign))
# embed the content into function template
if is_new:
stmt = ftmpl % {
'tab': tab,
'klass': code_obj.klass,
'content': ''.join(code_lines),
}
code_lines = ["%s\n" % line.rstrip() for line in stmt.split('\n')]
# remove newline at last line
code_lines[-1] = code_lines[-1].rstrip()
return code_lines
def _setup(self):
"""\
Load language specific code generators
"""
# scan widgets.txt for widgets, load language specific code generators
widgets_file = os.path.join(common.widgets_path, 'widgets.txt')
if not os.path.isfile(widgets_file):
self.warning("widgets file (%s) doesn't exist" % widgets_file)
return
sys.path.append(common.widgets_path)
modules = open(widgets_file)
for line in modules:
module_name = line.strip()
if not module_name or module_name.startswith('#'):
continue
module_name = module_name.split('#')[0].strip()
try:
fqmn = "%s.%s_codegen" % (module_name, self.language)
m = __import__(
fqmn, {}, {}, ['initialize'])
m.initialize()
except (ImportError, AttributeError):
pass
## print 'ERROR loading "%s"' % module_name
## common.message.exception(_('Internal Error'))
## else:
## print 'initialized %s generator for %s' % (self.language, module_name)
modules.close()
def _source_warning(self, klass, msg, sub_obj):
"""\
Format and add a warning message to the source code.
The message msg will be split into single lines and every line will
be proberly formatted added to the source code.
@param klass: Instance of L{ClassLines} to add the code in
@param msg: Multiline message
@type msg: String
@param sub_obj: Object to generate code for
@type sub_obj: Instance of L{CodeObject}
@see: L{_format_comment()}
"""
code_lines = []
# add leading empty line
code_lines.append('\n')
# add a leading "WARNING:" to the message
if not msg.upper().startswith(_('WARNING:')):
msg = "%s %s" % (_('WARNING:'), msg)
# add message text
for line in msg.split('\n'):
code_lines.append(
"%s\n" % self._format_comment(line.rstrip())
)
# add tailing empty line
code_lines.append('\n')
# Add warning message to source code
# TODO: Remove next three lines after C++ code gen uses dependencies
# like Python, Perl and Lisp
if self.language == 'C++':
klass.init.extend(code_lines)
else:
klass.deps.append((sub_obj, sub_obj.parent))
klass.child_order.append(sub_obj)
klass.init_lines[sub_obj] = code_lines
def _string_to_colour(self, s):
"""\
Convert a colour values out of a hex string to comma separated
decimal values.
Example::
>>> self._string_to_colour('#FFFFFF')
'255, 255, 255'
>>> self._string_to_colour('#ABCDEF')
'171, 205, 239'
@rtype: String
"""
return '%d, %d, %d' % (
int(s[1:3], 16),
int(s[3:5], 16),
int(s[5:], 16)
)
def _tagcontent(self, tag, content, newline=False):
"""\
Content embeded between C{begin wxGlade} and C{end wxGlade} sequence.
@return: Embedded content
@rtype: String
@param tag: Tag is used in C{begin wxGlade} statement for
separate different blocks
@type tag: String
@param content: Content to enter
@type content: String or List of strings
@param newline: Add a tailing empty line
@type newline: Boolean
"""
code_list = []
code_list.append(
'%s begin wxGlade: %s' % (self.comment_sign, tag)
)
if type(content) == types.ListType:
for entry in content:
code_list.append(entry.rstrip())
elif type(content) in types.StringTypes:
# don't append empty content
_content = content.rstrip()
if _content:
code_list.append(_content)
else:
raise AssertionError('Unknown content type: %s' % type(content))
code_list.append(
'%s end wxGlade' % self.comment_sign
)
# newline for "end wxGlade" line
code_list.append('')
if newline:
code_list.append('')
return "\n".join(code_list)
# end of class BaseCodeWriter
|