/usr/include/libanjuta-3.0/libanjuta/interfaces/libanjuta.idl is in libanjuta-dev 2:3.4.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 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 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 | // -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 4; tab-width: 4 -*- */
// -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 4; tab-width: 4 -*- */
//
// libanjuta interfaces. Generate stubs with anjuta-idl-compiler.pl
//
// Copyright (C) 2004 Naba Kumar <naba@gnome.org>
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Library General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#include <glib-object.h>
/**
* SECTION:ianjuta-file
* @title: IAnjutaFile
* @short_description: Implemented by plugins that can open files.
* @see_also: #IAnjutaFileSavable
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-file.h
*
* Any plugin that can open files should implemented this interface. Along
* with the 'File Loader::SupportedMimeTypes' property of the plugin in
* .plugin file, it will be used by the loader to open files of that type.
*/
interface IAnjutaFile
{
#include <gio/gio.h>
/**
* ianjuta_file_open:
* @obj: Self
* @file: file to open.
* @err: Error propagation and reporting
*
* The implementor opens the given file.
*/
void open (GFile* file);
/**
* IAnjutaFileSavable::saved:
* @obj: Self
*
* This signal is emitted when the content is loaded completely.
*/
void ::opened ();
/**
* ianjuta_file_get_file:
* @obj: Self
* @err: Error propagation and reporting
*
* Returns the file that was opened with ianjuta_file_open().
*
* Return value: (transfer full): The last file opened.
*/
GFile* get_file ();
/**
* SECTION:ianjuta-file-savable
* @title: IAnjutaFileSavable
* @short_description: Implemented by plugins that can save files.
* @see_also: #IAnjutaFile
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-file-savable.h
*
* Plugins implementing #IAnjutaFile inteface that can also save files
* should also implement this interface.
*/
interface IAnjutaFileSavable
{
/**
* IAnjutaFileSavable::update_save_ui:
* @obj: Self
*
* This signal is emitted when the state of the file has
* changed. It could be that the user writes in it
* and the file becomes dirty or the opposite: after using
* undo, the file is back to its saved content. It is triggered
* if the file becomes read-only or give a conflict too.
*/
void ::update_save_ui ();
/**
* IAnjutaFileSavable::saved:
* @obj: Self
* @file: file where the content is saved or NULL if save failed
*
* This signal is emitted when the content is saved.
*/
void ::saved (GFile* file);
/**
* ianjuta_file_savable_save:
* @obj: Self
* @err: Error propagation and reporting
*
* Saves the content to the original file from which it was loaded.
* The signal saved is always emitted even if the save fails.
*/
void save ();
/**
* ianjuta_file_savable_save_as:
* @obj: Self
* @file: File to save the content.
* @err: Error propagation and reporting
*
* Saves the content to a different File.
* The signal saved is always emitted even if the save fails.
*/
void save_as (GFile* file);
/**
* ianjuta_file_savable_set_dirty:
* @obj: Self
* @dirty: Whether the file was edited or not
* @err: Error propagation and reporting
*
* if @dirty is TRUE, sets dirty for the content. Save point will be
* left and the content will be considered not saved. Otherwise,
* content will considered saved and save-point will be entered.
*/
void set_dirty (gboolean dirty);
/**
* ianjuta_file_savable_is_dirty:
* @obj: Self
* @err: Error propagation and reporting
*
* Returns the dirty status of the content.
*
* Return value: TRUE if dirty, FALSE otherwise.
*/
gboolean is_dirty ();
/**
* ianjuta_file_savable_is_read_only:
* @obj: Self
* @err: Error propagation and reporting
*
* Return is the file is read-only
*
* Return value: TRUE if read-only, FALSE otherwise.
*/
gboolean is_read_only ();
/**
* ianjuta_file_savable_is_conflict:
* @obj: Self
* @err: Error propagation and reporting
*
* Return is the file is in conflict. It means the file
* has been modified externally and the user needs to
* tell which version he wants to use.
*
* Return value: TRUE if conflict, FALSE otherwise.
*/
gboolean is_conflict ();
}
}
/**
* SECTION:ianjuta-stream
* @title: IAnjutaStream
* @short_description: Implemented by plugins that can open file streams
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-stream.h
*
*/
interface IAnjutaStream
{
#include <stdio.h>
/**
* ianjuta_stream_open:
* @obj: Self
* @stream: Stream to open from.
* @err: Error propagation and reporting
*
* The implementor opens the given stream.
*/
void open (FILE* stream);
/**
* SECTION:ianjuta-stream-savable
* @title: IAnjutaStreamSavable
* @short_description: Implemented by plugins that can save file streams
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-stream-savable.h
*
*/
interface IAnjutaStreamSavable
{
/**
* ianjuta_stream_save:
* @obj: Self
* @stream: Stream to save to.
* @err: Error propagation and reporting
*
* The implementor saves the content to the given stream.
*/
void save (FILE* stream);
}
}
/**
* SECTION:ianjuta-markable
* @title: IAnjutaMarkable
* @short_description: Implemented by editors (or views) with markers support
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-markable.h
*
*/
interface IAnjutaMarkable
{
enum Error
{
INVALID_LOCATION
}
/**
* IAnjutaMarkableMarker:
* @IANJUTA_MARKABLE_LINEMARKER: Mark a particular line
* @IANJUTA_MARKABLE_BOOKMARK: A bookmark
* @IANJUTA_MARKABLE_MESSAGE: An (error) message
* @IANJUTA_MARKABLE_BREAKPOINT_DISABLED: a disabled breakpoint
* @IANJUTA_MARKABLE_BREAKPOINT_ENABLED: a enabled breakpoint
* @IANJUTA_MARKABLE_PROGRAM_COUNTER: Marks the program counter position
*
* This enumeration is used to specify the pixmap used for the marker
*/
enum Marker
{
LINEMARKER,
BOOKMARK,
MESSAGE,
BREAKPOINT_DISABLED,
BREAKPOINT_ENABLED,
PROGRAM_COUNTER
}
/**
* IAnjutaMarkable::marker-clicked:
* @obj: Self
* @double_click: whether the marker was double clicked
* @location: location of the clicked marker
*
* The signal is emitted when the user clicks on a marker
*/
void ::marker_clicked (gboolean double_click, gint location);
/**
* ianjuta_markable_mark:
* @obj: Self
* @location: Location at which the marker to set.
* @marker: Type of marker to be used
* @tooltip: (allow-none): optional tooltip displayed with the marker
* @err: Error propagation and reporting
*
* Marks the specified location with the given marker type. Location is
* implementation depenedent. For example, for an editor location means
* lines where markers are set.
*
* Return value: Handle of the location marked. Can be used later to obtain
* new location, if it has been moved due to addetions/deletions in the
* implementor object.
*/
gint mark (gint location, Marker marker, const gchar* tooltip);
/**
* ianjuta_markable_location_from_handle:
* @obj: Self
* @handle: Handle of location.
* @err: Error propagation and reporting
*
* Location where a marker is set could have moved by some operation in
* the implementation. To retrieve the correct location where the marker
* has moved, pass the handle retured by ianjuta_markable_mark() to this
* method.
*
* Return value: Current location where the marker was set.
*/
gint location_from_handle (gint handle);
/**
* ianjuta_markable_unmark:
* @obj: Self
* @location: Location where the marker is set.
* @marker: The marker to unset.
* @err: Error propagation and reporting
*
* Clears the @marker at given @location.
*/
void unmark (gint location, Marker marker);
/**
* ianjuta_markable_is_marker_set:
* @obj: Self
* @location: Location to check.
* @marker: Marker to check.
* @err: Error propagation and reporting
*
* Check if the @marker is set at the given @location.
*
* Returns: TRUE if the marker is set at the location, other false.
*/
gboolean is_marker_set (gint location, Marker marker);
/**
* ianjuta_markable_delete_all_markers:
* @obj: Self
* @marker: Marker to delete.
* @err: Error propagation and reporting
*
* Delete the @marker from all locations.
*/
void delete_all_markers (Marker marker);
}
/**
* SECTION:ianjuta-indicable
* @title: IAnjutaIndicable
* @short_description: Implemented by indicate that indicate a range
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-indicable.h
*
*/
interface IAnjutaIndicable
{
#include <libanjuta/interfaces/ianjuta-iterable.h>
/**
* IAnjutaIndicableIndicator:
* @IANJUTA_INDICABLE_NONE: No indicator
* @IANJUTA_INDICABLE_IMPORTANT: Important indicator
* @IANJUTA_INDICABLE_WARNING: Warning indicator
* @IANJUTA_INDICABLE_CRITICAL: Critical indicator
*
* This enumeration is used to specify the appearance of the indicator
*/
enum Indicator
{
NONE,
IMPORTANT,
WARNING,
CRITICAL
}
/**
* ianjuta_indicable_set:
* @obj: Self
* @begin_location: Location where the indication should start
* @end_location: Location where the indication should end
* @indicator: the indicator to use
* @err: Error propagation and reporting
*
* Set an indicator
*
*/
void set (IAnjutaIterable *begin_location, IAnjutaIterable *end_location, Indicator indicator);
/**
* ianjuta_indicable_clear:
* @obj: Self
* @err: Error propagation and reporting
*
* Clear all indicators
*
*/
void clear ();
}
/**
* SECTION:ianjuta-iterable
* @title: IAnjutaIterable
* @short_description: Implemented by objects that can iterate
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-iterable.h
*
*/
interface IAnjutaIterable
{
/**
* ianjuta_iterable_first:
* @obj: Self
* @err: Error propagation and reporting
*
* Set iter to first element position. Returns FALSE if
* there is no element in the iterable (hence does not have first).
* The iter points to the first valid item.
*
* Returns: TRUE if sucessful, other FALSE.
*/
gboolean first ();
/**
* ianjuta_iterable_next:
* @obj: Self
* @err: Error propagation and reporting
*
* Set the iter position to next element position. Iter can go until one
* item past the last item and lands in end-iter. end-iter does not point
* to any valid item and signifies end of the list. Returns FALSE if iter
* was already at end-iter (iter can not go past it) and remains pointed
* to the end-iter.
*
* Returns: TRUE if sucessful, otherwise FALSE if already at end-iter.
*/
gboolean next ();
/**
* ianjuta_iterable_previous:
* @obj: Self
* @err: Error propagation and reporting
*
* Set the iter position to previous element position. Returns FALSE if
* there is no previous element and the iter remains pointed to the first
* element.
*
* Returns: TRUE if sucessful, other FALSE.
*/
gboolean previous ();
/**
* ianjuta_iterable_last:
* @obj: Self
* @err: Error propagation and reporting
*
* Set iter position to end-iter (one past last element) position.
* Returns FALSE if there is no element in the iterable (already
* at end-iter).
*
* Returns: TRUE if sucessful, other FALSE.
*/
gboolean last ();
/**
* ianjuta_iterable_foreach:
* @obj: Self
* @callback: Callback to call for each element.
* @user_data: user data that is passed back to the callback.
* @err: Error propagation and reporting
*
* Call callback for each element in the list. Call back is passed the
* same iter, but with different position set (from first to last). This
* method does not affect current position. i.e. current position is
* restored at the end of this method.
*/
void foreach (GFunc callback, gpointer user_data);
/**
* ianjuta_iterable_set_position:
* @obj: Self
* @position: New position for the iter.
* @err: Error propagation and reporting
*
* Sets the current position of the iter to @position. The given @position
* must be from 0 to length - 1 (#ianjuta_iter_get_length()) to point to
* a valid element. Passing @position < 0 will set it to end-iter. It
* returns TRUE for the above cases. FLASE will be returned, if
* out-of-range @position is passed (@position > length - 1) and iter is
* set to end-iter.
*
* Returns: TRUE if successfully set (i.e. @position is within the range or
* end-iter). otherwise returns FALSE (i.e. @position is out of data range).
*/
gboolean set_position (gint position);
/**
* ianjuta_iterable_get_position:
* @obj: Self
* @err: Error propagation and reporting
*
* Index of the current iter in the iterable. It will be
* from 0 to length - 1 (ianjuta_iter_get_length()) if iter is pointed
* at valid element. It will return -1 if iter is pointed at end-iter.
*
* Returns: integer index, or -1 for end-iter.
*/
gint get_position ();
/**
* ianjuta_iterable_get_length:
* @obj: Self
* @err: Error propagation and reporting
*
* Length of the iterable (number of elements indexable by it).
*
* Returns: total length of the list.
*/
gint get_length ();
/**
* ianjuta_iterable_clone:
* @obj: Self
* @err: Error propagation and reporting
*
* Clones the iterable. The returned iterable object must be unreffed
* when done.
*
* Returns: (transfer full): A new instance of this iterable pointing at the same location.
*/
IAnjutaIterable *clone ();
/**
* ianjuta_iterable_assign:
* @obj: Self
* @src_iter: Source iter from which to copy the assignment.
* @err: Error propagation and reporting
*
* Assigns the iter position from @src_iter.
*
*/
void assign (IAnjutaIterable *src_iter);
/**
* ianjuta_iterable_compare:
* @obj: Self
* @iter2: Second iter to compare.
* @err: Error propagation and reporting
*
* Compares the position of @iter2 with this @obj. Returns -1
* value if this @obj is smaller than @iter2. Returns +1 value
* if this @obj is larger than @iter2. And returns 0 if both are equal.
* If you want difference of the iter positions, use
* #ianjuta_iterable_diff(). This method is meant for fast comparision.
*
* Returns: 0 if equal, -1 if @obj is smaller than @iter2
* or +1 if @obj is larger than @iter2.
*
*/
gint compare (IAnjutaIterable *iter2);
/**
* ianjuta_iterable_diff:
* @obj: Self
* @iter2: Second iter to differenciate.
* @err: Error propagation and reporting
*
* Compares the position of @iter2 with this @obj and returns difference
* in position of the two (@obj - @iter2).
*
* Returns: The position difference of @obj - @iter2
*
*/
gint diff (IAnjutaIterable *iter2);
/**
* SECTION:ianjuta-iterable-tree
* @title: IAnjutaIterableTree
* @short_description: Implemented by tree objects that can iterate
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-iterable-tree.h
*
*/
interface IAnjutaIterableTree
{
/**
* ianjuta_iterable_tree_parent:
* @obj: Self
* @err: Error propagation and reporting
*
* Set iter position to parent of curernt iter. If there is no parent,
* returns FALSE (current iter position is not changed)
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean parent ();
/**
* ianjuta_iterable_tree_children:
* @obj: Self
* @err: Error propagation and reporting
*
* Iter position set to first child of current iter. If there is no
* children, return NULL (iter position is not changed).
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean children ();
/**
* ianjuta_iterable_tree_has_children:
* @obj: Self
* @err: Error propagation and reporting
*
* Returns true if current iter has children
*
* Returns: TRUE if there are children, otherwise FALSE.
*/
gboolean has_children ();
/**
* ianjuta_iterable_tree_foreach_post:
* @obj: Self
* @callback: Callback to call for each element.
* @user_data: User data to pass back to callback.
* @err: Error propagation and reporting
*
* Call callback for each element in post order.
*/
void foreach_post (GFunc callback, gpointer user_data);
/**
* ianjuta_iterable_tree_foreach_pre:
* @obj: Self
* @callback: Callback to call for each element.
* @user_data: User data to pass back to callback.
* @err: Error propagation and reporting
*
* Call callback for each element in pre order.
*/
void foreach_pre (GFunc callback, gpointer user_data);
}
}
/**
* SECTION:ianjuta-builder
* @title: IAnjutaBuilder
* @short_description: Implemented by plugins that can build
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-builder.h
*
*/
interface IAnjutaBuilder
{
/**
* IAnjutaBuilderError:
* @IANJUTA_BUILDER_SUCCEED: Build succeeded
* @IANJUTA_BUILDER_FAILED: Build failed
* @IANJUTA_BUILDER_CANCELED: Build was canceld
* @IANJUTA_BUILDER_ABORTED: Build aborted
* @IANJUTA_BUILDER_INTERRUPTED: Build interruped
* @IANJUTA_BUILDER_TERMINATED: Build interruped
* @IANJUTA_BUILDER_UNKNOWN_TARGET: The specified target is unknown
* @IANJUTA_BUILDER_UNKNOWN_ERROR: Unknown Error
* @IANJUTA_BUILDER_OTHER_ERROR: Other Error (no unknown ;-))
*
* Possible build errors
*/
enum Error
{
SUCCEED = 0,
FAILED,
CANCELED = 256,
ABORTED,
INTERRUPTED,
TERMINATED,
UNKNOWN_TARGET,
UNKNOWN_ERROR,
OTHER_ERROR
}
typedef gpointer Handle;
typedef void (*Callback) (GObject *sender, IAnjutaBuilderHandle command, GError* err, gpointer user_data);
/**
* IANJUTA_BUILDER_ROOT_URI
*
* Build directory uri. It is the same than the project_root_uri for
* in source build.
*/
#define ROOT_URI "build_root_uri"
/**
* IANJUTA_BUILDER_CONFIGURATION_DEBUG
*
* Name of debugging configutation.
*/
#define CONFIGURATION_DEBUG "Debug"
/**
* IANJUTA_BUILDER_CONFIGURATION_OPTIMIZED
*
* Name of optimized configutation.
*/
#define CONFIGURATION_OPTIMIZED "Optimized"
/**
* IANJUTA_BUILDER_CONFIGURATION_PROFILING
*
* Name of profiling configutation.
*/
#define CONFIGURATION_PROFILING "Profiling"
/**
* ianjuta_builder_is_built:
* @obj: Self
* @uri: target uri
* @callback: callback called when command is finished
* @user_data: data passed to the callback
* @err: Error propagation and reporting.
*
* Check if the corresponding target is up to date or not. This
* command doesn't display anything. If this command cannot be
* implemented, it is possible to return always TRUE.
* When the command is finished, the callback function is called
* if defined.
*
* Returns: non null command handle if succeed
*/
Handle is_built (const gchar *uri, Callback callback, gpointer user_data);
/**
* ianjuta_builder_build:
* @obj: Self
* @uri: target uri
* @callback: callback called when command is finished
* @user_data: data passed to the callback
* @err: Error propagation and reporting.
*
* Build the specified target.
* When the command if finished, the callback function is called
* if defined.
*
* Returns: non null command handle if succeed
*/
Handle build (const gchar *uri, Callback callback, gpointer user_data);
/**
* ianjuta_builder_cancel:
* @obj: Self
* @handle: handle of the command to cancel
* @err: Error propagation and reporting.
*
* Cancel specified command. The callback function will not
* be called.
*
*/
void cancel (Handle handle);
/**
* ianjuta_builder_list_configuration:
* @obj: Self
* @err: Error propagation and reporting.
*
* List all defined configuration. These names returned are
* the internal non localized names for the following
* predefined configuration: Debug, Profiling, Optimized.
* The default configuration has no name and is not returned.
*
* Returns: (element-type utf8) (transfer container): a list configuration name. The names are owned
* by the plugin, so only the list has to be free using
* g_list_free.
*/
List<const gchar*> list_configuration();
/**
* ianjuta_builder_get_uri_configuration:
* @obj: Self
* @uri: target uri
* @err: Error propagation and reporting.
*
* Get the configuration corresponding to the target uri.
*
* Returns: The configuration name or NULL if the corresponding
* configuration cannot be found.
*/
const gchar* get_uri_configuration(const gchar *uri);
}
/**
* SECTION:ianjuta-environment
* @title: IAnjutaEnvironment
* @short_description: Implemented by plugins doing cross compilation
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-environment.h
*
*/
interface IAnjutaEnvironment
{
/**
* IAnjutaEnvironmentError:
* @IANJUTA_BUILDER_CONFIG: Configuration of the environment is wrong
* @IANJUTA_BUILDER_OTHER_ERROR: Other Error (no unknown ;-))
*
* Possible build errors
*/
enum Error
{
CONFIG,
OTHER_ERROR
}
/**
* ianjuta_environment_override:
* @obj: Self
* @dirp: a pointer on the working directory
* @argvp: a pointer on a NULL terminated string array
* containing the command name in argv[0] and all
* its argument
* @envp: a pointer on a NULL terminated string array
* containing all additional environment variable
* used by the command
* @err: Error propagation and reporting.
*
* Override a command to work in another build environment
*
* Returns: FALSE if there is an error.
*/
gboolean override (gchar **dirp, gchar ***argvp, gchar ***envp);
/**
* ianjuta_environment_get_real_directory:
* @obj: Self
* @dir: A directory path in the environment
* @err: Error propagation and reporting.
*
* Convert a directory in the environment to a directory outside.
* It is useful when the environment use chroot. Take care that
* the input directory string is freed using g_free but and you need to
* free the output string when not needed.
*
* Returns: The directory path outside the environment
*/
gchar* get_real_directory (gchar *dir);
}
/**
* SECTION:ianjuta-buildable
* @title: IAnjutaBuildable
* @short_description: Implemented by plugins that can build. This interface
* will be replaced by #IAnjutaBuilder (for build functions) and
* #IAnjutaEnvironment for ianjuta_buildable_set_command,
* ianjuta_buildable_reset_command and ianjuta_buildable_get_command.
* @see_also:
* @stability: Obsolete
* @include: libanjuta/interfaces/ianjuta-buildable.h
*
*/
interface IAnjutaBuildable
{
/**
* IAnjutaBuildableCommand:
* @IANJUTA_BUILDABLE_COMMAND_COMPILE: Compile source
* @IANJUTA_BUILDABLE_COMMAND_BUILD: Build file (normally using make)
* @IANJUTA_BUILDABLE_COMMAND_BUILD_TARBALL: make dist
* @IANJUTA_BUILDABLE_COMMAND_INSTALL: make install
* @IANJUTA_BUILDABLE_COMMAND_CONFIGURE: ./configure
* @IANJUTA_BUILDABLE_COMMAND_GENERATE: ./autogen.sh
* @IANJUTA_BUILDABLE_COMMAND_CLEAN: make clean
* @IANJUTA_BUILDABLE_COMMAND_EXECUTE: ./hello
* @IANJUTA_BUILDABLE_COMMAND_IS_BUILT: check whether object files are up-to-date
* @IANJUTA_BUILDABLE_COMMAND_DISTCLEAN: make distclean
* @IANJUTA_BUILDABLE_N_COMMANDS: size of enum
*
* The enumeration is used to speficy the disered build operation
*/
enum Command
{
COMMAND_COMPILE,
COMMAND_BUILD,
COMMAND_BUILD_TARBALL,
COMMAND_INSTALL,
COMMAND_CONFIGURE,
COMMAND_GENERATE,
COMMAND_CLEAN,
COMMAND_EXECUTE,
COMMAND_IS_BUILT,
COMMAND_AUTORECONF,
COMMAND_DISTCLEAN,
N_COMMANDS
}
/**
* ianjuta_buildable_set_command:
* @obj: Self
* @command_id: Command to override.
* @command: Build command to override.
* @err: Error propagation and reporting.
*
* Overrides the default command for the given command.
*/
void set_command (Command command_id, const gchar *command);
/**
* ianjuta_buildable_get_command:
* @obj: Self
* @command_id: Command to get override.
* @err: Error propagation and reporting.
*
* Retrieves the currently set command override.
*
* Returns: The overridden command. NULL if no override set.
*/
const gchar* get_command (Command command_id);
/**
* ianjuta_buildable_reset_commands:
* @obj: Self
* @err: Error propagation and reporting.
*
* Resets the command overrides to defaults.
*/
void reset_commands ();
/**
* ianjuta_buildable_build:
* @obj: Self
* @uri: fixme
* @err: Error propagation and reporting.
*
* fixme
*/
void build (const gchar *uri);
/**
* ianjuta_buildable_clean:
* @obj: Self
* @uri: fixme
* @err: Error propagation and reporting.
*
* fixme
*/
void clean (const gchar *uri);
/**
* ianjuta_buildable_install:
* @obj: Self
* @uri: fixme
* @err: Error propagation and reporting.
*
* fixme
*/
void install (const gchar *uri);
/**
* ianjuta_buildable_configure:
* @obj: Self
* @uri: fixme
* @err: Error propagation and reporting.
*
* fixme
*/
void configure (const gchar *uri);
/**
* ianjuta_buildable_generate:
* @obj: Self
* @uri: fixme
* @err: Error propagation and reporting.
*
* fixme
*/
void generate (const gchar *uri);
/**
* ianjuta_buildable_execute:
* @obj: Self
* @uri: fixme
* @err: Error propagation and reporting.
*
* fixme
*/
void execute (const gchar *uri);
}
/**
* SECTION:ianjuta-help
* @title: IAnjutaHelp
* @short_description: Implemented by plugins that can provide help support
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-help.h
*
*/
interface IAnjutaHelp
{
/**
* ianjuta_help_search:
* @obj: Self
* @query: string to search in the help
* @err: Error propagation and reporting
*
* Search for string @query in the help and display the result
*/
void search (const gchar *query);
}
/**
* SECTION:ianjuta-loader
* @title: IAnjutaLoader
* @short_description: Interface to load file or stream
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-loader.h
*
* Loaders can deterime correct plugin to open a file or stream. They
* themselves can not load it, but will correctly redirect the request to
* an implementor of IAnjutaFile, IAnjutaFileSavable, IAnjutaStream or
* IAnjutaStreamSavable, depending on the mime-type, meta-type or any other
* requirements.
*/
interface IAnjutaLoader
{
#include <libanjuta/anjuta-plugin.h>
/**
* ianjuta_loader_find_plugins:
* @obj: Self
* @err: Error propagation and reporting.
*
* Returns: (element-type AnjutaPlugin): all plugins supporting loader interface.
*/
List<AnjutaPlugin*> find_plugins ();
/**
* SECTION:ianjuta-file-loader
* @title: IAnjutaFileLoader
* @short_description: Loader to load files
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-file-loader.h
*
* Loaders can deterime correct plugin to open a file.
*/
interface IAnjutaFileLoader
{
#include <gio/gio.h>
/**
* ianjuta_file_loader_load:
* @obj: Self
* @file: File to load
* @readonly: Open in readonly mode.
* @err: Error propagation and reporting
*
* Determines a plugin which can open the given file, activates it
* opening the file and returns the interface of the plugin activated.
*
* Return value: Plugin interface used to load the file.
*/
GObject* load (GFile* file, gboolean readonly);
/**
* ianjuta_loader_peek_interface:
* @obj: Self
* @file: Meta file to peek
* @err: Error propagation and reporting
*
* Peeks the file and determines the interface which can load
* this file.
*
* Return value: Plugin interface name that can load the file.
*/
gchar* peek_interface (GFile* file);
}
/**
* SECTION:ianjuta-stream-loader
* @title: IAnjutaStreamLoader
* @short_description: Loader to load streams
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-stream-loader.h
*
* StreamLoaders can deterime correct plugin to open a stream.
*/
interface IAnjutaStreamLoader
{
#include <stdio.h>
/**
* ianjuta_stream_loader_load:
* @obj: Self
* @stream: Stream to load
* @readonly: Open in readonly mode.
* @err: Error propagation and reporting
*
* Determines a plugin which can open the given stream, activates it
* opening the stream and returns the interface of the plugin activated.
*
* Return value: Plugin interface used to load the stream.
*/
GObject* load (FILE *stream, gboolean readonly);
/**
* ianjuta_stream_loader_peek_interface:
* @obj: Self
* @stream: Stream to load
* @err: Error propagation and reporting
*
* Peeks the stream and determines the interface which can load
* this stream.
*
* Return value: Plugin interface name that can load the stream.
*/
gchar* peek_interface (FILE *stream);
}
}
/**
* SECTION:ianjuta-document
* @title: IAnjutaDocument
* @short_description: Interface for all kind of editable resources that
* will be managed by IAnjutaDocumentManager
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-document.h
*
*/
interface IAnjutaDocument
{
/**
* IAnjutaDocument::update-ui:
* @obj: Self
*
* This signal is emitted when the document assumes the UI must be updated
* because some internal state of the document has changed. For example, if
* current line position is changed, it needs to be reflected to the UI.
*/
void ::update_ui ();
/**
* ianjuta_document_get_filename:
* @obj: Self
* @err: Error propagation and reporting
*
* Allows obtaining of the filename the editor was loaded from.
*
* Return value: The name of the file. Not to be freed by caller.
*/
const gchar* get_filename ();
/**
* ianjuta_document_can_undo:
* @obj: Self
* @err: Error propagation and reporting
*
* Can the editor undo the last operation?
*
* Returns: TRUE if editor can undo, else FALSE
*/
gboolean can_undo();
/**
* ianjuta_document_can_redo:
* @obj: Self
* @err: Error propagation and reporting
*
* Can the editor redo the last operation?
*
* Returns: TRUE if editor can redo, else FALSE
*/
gboolean can_redo ();
/**
* ianjuta_document_undo:
* @obj: Self
* @err: Error propagation and reporting
*
* Undo last operation
*/
void undo ();
/**
* ianjuta_document_redo:
* @obj: Self
* @err: Error propagation and reporting
*
* Redo last undo operation
*/
void redo ();
/**
* ianjuta_document_begin_undo_action:
* @obj: Self
* @err: Error propagation and reporting
*
* Begins the mark of undoable action. Calls to this are stacked and
* each must be ended with ianjuta_document_end_action().
*/
void begin_undo_action ();
/**
* ianjuta_document_end_undo_action:
* @obj: Self
* @err: Error propagation and reporting
*
* Ends the mark of undoable action.
*/
void end_undo_action ();
/**
* ianjuta_document_grab_focus:
* @obj: Self
* @err: Error propagation and reporting
*
* Grabs the focus.
*/
void grab_focus ();
/**
* ianjuta_document_cut:
* @obj: Self
* @err: Error propagation and reporting
*
* Cut selection to clipboard.
*/
void cut ();
/**
* ianjuta_document_copy:
* @obj: Self
* @err: Error propagation and reporting
*
* Copy selection to clipboard.
*/
void copy ();
/**
* ianjuta_document_paste:
* @obj: Self
* @err: Error propagation and reporting
*
* Paste clipboard at current position.
*/
void paste ();
/**
* ianjuta_document_clear:
* @obj: Self
* @err: Error propagation and reporting
*
* Clear selection
*/
void clear ();
}
/**
* SECTION:ianjuta-editor
* @title: IAnjutaEditor
* @short_description: Text editor interface
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-editor.h
*
*/
interface IAnjutaEditor
{
#include <gtk/gtk.h>
#include <libanjuta/interfaces/ianjuta-iterable.h>
enum Error
{
DOESNT_EXIST
}
/**
* IAnjutaEditorAttribute:
* @IANJUTA_EDITOR_TEXT: Normal text
* @IANJUTA_EDITOR_KEYWORD: A keyword of the programming language
* @IANJUTA_EDITOR_COMMENT: A comment
* @IANJUTA_EDITOR_STRING: A string
*
* This enumeration is used to specify the type of text. Note that not all
* editors implement this.
*/
enum Attribute
{
TEXT,
KEYWORD,
COMMENT,
STRING
}
/**
* IAnjutaEditor::glade-member-add:
* @widget_typename: Name of the type of the widget that will become a member of the class.
* @widget_name: Name of the widget that will become a member of the class.
* @filename: Path for the .ui file that generated the signal.
* @obj: Self
*
* This signal is emitted when code for a widget must be generated.
*/
void ::glade_member_add (gchar *widget_typename, gchar *widget_name, gchar *filename);
/**
* IAnjutaEditor::glade-member-add:
* @widget_typename: Name of the type of the widget.
* @signal_name: Name of the signal.
* @handler_name: Name of the signal handler.
* @object: Name of the object to be passed.
* @swap: The "swap" signal property.
* @after: The "after" signal property.
* @filename: Path for the .ui file that generated the signal.
* @obj: Self
*
* This signal is emitted when code for a widget must be generated.
*/
void ::glade_callback_add (gchar *widget_typename, gchar *signal_name, gchar *handler_name, gchar *object, gboolean swap, gboolean after, gchar *filename);
/**
* IAnjutaEditor::code-added:
* @position: The iter position where @ch is added.
* @code: The code that has been added.
* @obj: Self
*
* This signal is emitted when code is added inside the editor.
* The newly added code is @code which has been inserted at @position.
*/
void ::code_added (IAnjutaIterable *position, gchar *code);
/**
* IAnjutaEditor::char-added:
* @position: The iter position where @ch is added.
* @ch: The character that has been added.
* @obj: Self
*
* This signal is emitted when any character is added inside the editor.
* The newly added character is @ch which has been inserted at @position.
*/
void ::char_added (IAnjutaIterable *position, gchar ch);
/**
* IAnjutaEditor::backspace:
* @obj: Self
*
* The signal is emitted when the user presses backspace
*/
void ::backspace ();
/**
* IAnjutaEditor::changed:
* @position: The iter position where change happend.
* @added: TRUE if added, FALSE if deleted.
* @length: Length of the text changed.
* @lines: Number of lines added or removed.
* @text: The text added or removed.
* @obj: Self
*
* This signal is emitted when any text change happens in editor.
* The changes begin at @position. @text is not garanteed to be NULL
* terminated. Use @length to read the text. @lines represent the
* number of line breaks in the added or removed text.
*/
void ::changed (IAnjutaIterable *position, gboolean added, gint length, gint lines, const gchar *text);
/**
* IAnjutaEditor::cursor-moved:
* @obj: Self
*
* The signal is a hint that the cursor was moved.
*/
void ::cursor_moved ();
/**
* IAnjutaEditor::line-marks-gutter-clicked:
* @obj: Self
* @double_click: whether the line marks gutter was double clicked
* @location: location of the clicked marker
*
* The signal is emitted when the user clicks on a marker
*/
void ::line_marks_gutter_clicked (gint location);
/**
* ianjuta_editor_get_tabsize:
* @obj: Self
* @err: Error propagation and reporting
*
* Returns the tabsize (in spaces) currently used by the editor.
*
* Returns: tabsize in number of spaces
*/
gint get_tabsize ();
/**
* ianjuta_editor_set_tabsize:
* @obj: Self
* @tabsize: Tabsize in spaces
* @err: Error propagation and reporting
*
* Sets the tabsize of the editor.
*/
void set_tabsize (gint tabsize);
/**
* ianjuta_editor_get_use_spaces:
* @obj: Self
* @err: Error propagation and reporting
*
* Returns if the editor uses spaces for filling up tab characters.
*
* Returns: TRUE if yes, FALSE if no.
*/
gboolean get_use_spaces ();
/**
* ianjuta_editor_set_use_space:
* @obj: Self
* @use_spaces: TRUE to use spaces, FALSE to use tab char directly.
* @err: Error propagation and reporting
*
* Sets if the editor should use spaces for filling up tab characters.
*/
void set_use_spaces (gboolean use_spaces);
/**
* ianjuta_editor_set_auto_indent:
* @obj: Self
* @auto_indent: TRUE to enable auto-indent, FALSE to disable
*
* Sets whether the editor should auto-indent itself. A plugin that does
* custom auto-indent can set this to false and override the preferences
* setting
*/
void set_auto_indent (gboolean auto_indent);
/**
* ianjuta_editor_erase_range:
* @obj: Self
* @position_start: Start position of chars to erase.
* @position_end: End position of chars to erase.
* @err: Error propagation and reporting
*
* Erases the chars between positions pointed by @position_start and
* @position_end. The character pointed by @position_start is included,
* while pointed by @position_end is not include in the range. After
* the erase operation, all active iters, except these two, are no
* longer guranteed to be valid. At the end the operation, these two
* iters point to the same position which is the position where erase
* happend (usually the original @position_start position).
*/
void erase (IAnjutaIterable *position_start, IAnjutaIterable *position_end);
/**
* ianjuta_editor_erase_all:
* @obj: Self
* @err: Error propagation and reporting
*
* Empties the whole editor buffer. There will be zero characters.
* After the erase operation, none of the active iters are guranteed
* to be valid.
*/
void erase_all ();
/**
* ianjuta_editor_insert:
* @obj: Self
* @position: Character position in editor where insert will take place.
* @text: Text to append.
* @length: Length of @text to use.
* @err: Error propagation and reporting
*
* Inserts @length characters from @text buffer at given @position of
* editor buffer. If @length is -1, the whole @text is used.
*/
void insert (IAnjutaIterable *position, const gchar *text, gint length);
/**
* ianjuta_editor_append:
* @obj: Self
* @text: Text to append.
* @length: Length of @text to use.
* @err: Error propagation and reporting
*
* Appends @length characters from @text buffer at the end of editor
* buffer. If @length is -1, the whole @text is used. @length is in bytes.
*/
void append (const gchar *text, gint length);
/**
* ianjuta_editor_goto_line:
* @obj: Self
* @lineno: line number where carat will be moved.
* @err: Error propagation and reporting
*
* Carat is moved to the given @lineno line and text view is scrolled to
* bring it in viewable area of the editor.
*/
void goto_line (gint lineno);
/**
* ianjuta_editor_goto_start:
* @obj: Self
* @err: Error propagation and reporting
*
* Carat is moved to the begining of editor and text view is scrolled to
* bring it in viewable area of the editor.
*/
void goto_start ();
/**
* ianjuta_editor_goto_end:
* @obj: Self
* @err: Error propagation and reporting
*
* Carat is moved to the end of editor and text view is scrolled to
* bring it in viewable area of the editor.
*/
void goto_end ();
/**
* ianjuta_editor_goto_position:
* @obj: Self
* @position: Character position where carat will be moved.
* @err: Error propagation and reporting
*
* Carat is moved to the given @position and text view is scrolled to
* bring @position in viewable area of the editor.
*/
void goto_position (IAnjutaIterable *position);
/**
* ianjuta_editor_get_text:
* @obj: Self
* @begin: Begining iterator
* @end: End iterator
* @err: Error propagation and reporting
*
* Gets text characters beginning from @begin (including char
* pointed by @begin) and ending with @end (excluding character
* pointed by @end). The characters returned are utf-8 encoded.
* The iterators @begin and @end could be in either order. The returned
* text, however, is in right order. If both @begin and @end points
* to the same position, NULL is returned.
*
* Returns: A buffer of utf-8 characters.
* The returned buffer must be freed when no longer required.
*/
gchar* get_text (IAnjutaIterable *begin, IAnjutaIterable *end);
/**
* ianjuta_editor_get_text_all:
* @obj: Self
* @err: Error propagation and reporting
*
* Gets all text characters in the editor.
* The characters returned are utf-8 encoded.
*
* Returns: A buffer of utf-8 characters containing all text from editor.
* The returned buffer must be freed when no longer required.
*/
gchar* get_text_all ();
/**
* ianjuta_editor_line_from_position:
* @obj: Self
* @position: Position you want to know the line from
* @err: Error propagation and reporting
*
* Get the line number in which @position locates.
* Returns: Line which corresponds to @position
*
*/
int get_line_from_position (IAnjutaIterable *position);
/**
* ianjuta_editor_get_lineno:
* @obj: Self
* @err: Error propagation and reporting
*
* Obtains current line number on which carat is.
*
* Return value: Line number.
*/
gint get_lineno ();
/**
* ianjuta_editor_get_length:
* @obj: Self
* @err: Error propagation and reporting
*
* Get length of complete text in editor. This will be the total
* number of bytes in the file or buffer.
*
* Return value: Text length.
*/
gint get_length ();
/**
* ianjuta_editor_get_current_word:
* @obj: Self
* @err: Error propagation and reporting
*
* Obtains the word on which carat is currently on.
*
* Return value: Current word.
*/
gchar* get_current_word ();
/**
* ianjuta_editor_get_current_column:
* @obj: Self
* @err: Error propagation and reporting
*
* Obtains number of the current column in the editor.
*
* Return value: Current column.
*/
gint get_column ();
/**
* ianjuta_editor_get_line_begin_position:
* @obj: Self
* @line: fixme
* @err: Error propagation and reporting.
*
* fixme
*
* Returns: (transfer full): fixme
*/
IAnjutaIterable* get_line_begin_position (gint line);
/**
* ianjuta_editor_get_line_end_position:
* @obj: Self
* @line: fixme
* @err: Error propagation and reporting.
*
* fixme
*
* Returns: (transfer full): fixme
*/
IAnjutaIterable *get_line_end_position (gint line);
/**
* ianjuta_editor_get_overwrite:
* @obj: Self
* @err: Error propagation and reporting
*
* Obtains editor overwirte mode: TRUE = Override, FALSE = Insert.
*
* Return value: editor mode.
*/
gboolean get_overwrite ();
/**
* ianjuta_editor_set_popup_menu:
* @obj: Self
* @menu: Popupmenu
* @err: Error propagation and reporting
*
* Set Editor popup menu. This is the menu shown in the editor when one
* right-clicks on it.
*
*/
void set_popup_menu (GtkWidget *menu);
/*
* ianjuta_editor_get_offset:
* @obj: Self
* @err: Error propagation and reporting
*
* Get current caret position in integer character offset. Deprecated.
* Use ianjuta_editor_get_position() instead.
*
* Returns: Current character position since the begining of file.
*/
gint get_offset ();
/**
* ianjuta_editor_get_position:
* @obj: Self
* @err: Error propagation and reporting
*
* Get current caret position.
*
* Returns: (transfer full): Iterator that points to the current position.
*/
IAnjutaIterable* get_position ();
/**
* ianjuta_editor_get_position_from_offset:
* @obj: Self
* @offset: Character offset position where the iter will be set
* @err: Error propagation and reporting
*
* Creates and returns an iter for editor cells. The iter is
* placed at the unicode character position where the given offset
* @offset happens to fall. The returned iter is cell (character)
* iter and not byte iter, so all iter operations
* on it are character (not byte) iteration, including all position
* and index references in the iter.
*
* The iter must be unreferrenced by the caller when done.
* The iter navigates (next/previous) in step of unicode
* characters (one unicode character == one cell).
*
* Retrun value: a newly created iter of IAnjutaEditorCell placed at the
* given @offset position.
*/
IAnjutaIterable* get_position_from_offset (gint offset);
/**
* ianjuta_editor_get_start_position:
* @obj: Self
* @err: Error propagation and reporting
*
* Gets the iter positioned at the start of the editor buffer.
*
* Return value: (transfer none): Cell iter set to the begining of the editor.
*/
IAnjutaIterable* get_start_position ();
/**
* ianjuta_editor_get_end_position:
* @obj: Self
* @err: Error propagation and reporting
*
* Gets the iter positioned at the end of the editor buffer. The
* returned iter is the end-iter which does not point to any valid
* character in the buffer (it is pointed one step beyond the last
* valid character).
*
* Return value: (transfer none): Cell iter set to the end of the editor (end-iter).
*/
IAnjutaIterable* get_end_position ();
/**
* SECTION:ianjuta-editor-selection
* @title: IAnjutaEditorSelection
* @short_description: Text editor selection interface
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-editor-selection.h
*
*/
interface IAnjutaEditorSelection
{
#include <libanjuta/interfaces/ianjuta-editor-cell.h>
/**
* ianjuta_editor_selection_has_selection:
* @obj: Self
* @err: Error propagation and reporting
*
* Returns TRUE if editor has any text selected. The selection
* positions can be retrieved with ianjuta_editor_selection_get_start()
* and ianjuta_editor_selection_get_end().
*
* Returns: TRUE if there is text selected else FALSE.
*/
gboolean has_selection ();
/**
* ianjuta_editor_selection_get:
* @obj: Self
* @err: Error propagation and reporting
*
* Gets curerntly selected text in editor.
*
* Returns: A newly allocated buffer of currently selected characters.
* NULL if there is no selection. The returned buffer must be freed after
* use.
*/
gchar* get ();
/**
* ianjuta_editor_selection_set:
* @obj: Self
* @start: Begin of selection
* @end: End of selection
* @scroll: Scroll selection onscreen
* @err: Error propagation and reporting
*
* Select characters between start and end. Start and end don't have to
* be ordered.
*/
void set (IAnjutaIterable* start, IAnjutaIterable* end, gboolean scroll);
/**
* ianjuta_editor_selection_get_start:
* @obj: Self
* @err: Error propagation and reporting
*
* Gets start position of selection text.
*
* Return: Start of selection or NULL if there is no selection.
*/
IAnjutaIterable* get_start ();
/**
* ianjuta_editor_selection_get_end:
* @obj: Self
* @err: Error propagation and reporting
*
* Get end position of selection. If there is no selection, returns
* NULL.
*
* Returns: End of selection or NULL if there is no selection.
*/
IAnjutaIterable* get_end ();
/**
* ianjuta_editor_selection_select_block:
* @obj: Self
* @err: Error propagation and reporting
*
* Selects current block of code. The definition of block of code
* depends on highlight mode used (programming language). Some
* highlight mode does not have block concept, in that case this
* method does not do anything.
*/
void select_block ();
/**
* ianjuta_editor_selection_select_function:
* @obj: Self
* @err: Error propagation and reporting
*
* Select current function block. The definition of function block
* depends on highlight mode used (programming language). Some
* highlight mode does not have function concept, in that case this
* method does not do anything.
*/
void select_function ();
/**
* ianjuta_editor_edit_select_all:
* @obj: Self
* @err: Error propagation and reporting
*
* Select whole buffer.
*/
void select_all ();
/**
* ianjuta_editor_selection_replace:
* @obj: Self
* @text: Replacement text.
* @length: Length of the text to used in @text.
* @err: Error propagation and reporting
*
* Replaces currently selected text with the @text. Only @length amount
* of characters are used from @text buffer to replace.
*/
void replace (const gchar *text, gint length);
}
/**
* SECTION:ianjuta-editor-search
* @title: IAnjutaEditorSearch
* @short_description: Text editor search interface
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-editor-search.h
*
*/
interface IAnjutaEditorSearch
{
#include <libanjuta/interfaces/ianjuta-editor-cell.h>
/**
* ianjuta_editor_search_forward:
* @obj: Self
* @search: String to search for
* @start: Where to search from
* @end: Where to stop searching
* @result_start: (out): Will be set to the start of the search_result (or NULL)
* @result_end: (out): Will be set to the end of the search_result (or NULL)
* @err: Error propagation and reporting
*
* Search forward from start to end
*
*/
gboolean forward (const gchar* search, gboolean case_sensitive, IAnjutaEditorCell* start, IAnjutaEditorCell* end, IAnjutaEditorCell** result_start, IAnjutaEditorCell** result_end);
/**
* ianjuta_editor_search_backward:
* @obj: Self
* @search: String to search for
* @start: Where to search from
* @end: Where to stop searching
* @result_start: (out): Will be set to the start of the search_result (or NULL)
* @result_end: (out): Will be set to the end of the search_result (or NULL)
* @err: Error propagation and reporting
*
* Search backward from end to start
*
*/
gboolean backward (const gchar* search, gboolean case_sensitive, IAnjutaEditorCell* start, IAnjutaEditorCell* end, IAnjutaEditorCell** result_start, IAnjutaEditorCell** result_end);
}
/**
* SECTION:ianjuta-editor-convert
* @title: IAnjutaEditorConvert
* @short_description: Text editor convert interface
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-editor-convert.h
*
*/
interface IAnjutaEditorConvert
{
/**
* ianjuta_editor_convert_to_upper:
* @obj: Self
* @start_position: Start position.
* @end_position: End position.
* @err: Error propagation and reporting
*
* change characters from start position to end position to uppercase.
*
*/
void to_upper (IAnjutaIterable *start_position, IAnjutaIterable *end_position);
/**
* ianjuta_editor_convert_to_lower:
* @obj: Self
* @start_position: Start position.
* @end_position: End position.
* @err: Error propagation and reporting
*
* change characters from start position to end position to lowercase
*
*/
void to_lower (IAnjutaIterable *start_position, IAnjutaIterable *end_position);
}
/**
* SECTION:ianjuta-editor-line-mode
* @title: IAnjutaEditorLineMode
* @short_description: Text editor line mode
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-editor-line-mode.h
*
*/
interface IAnjutaEditorLineMode
{
/**
* IAnjutaEditorLineModeType:
* @IANJUTA_EDITOR_LINE_MODE_LF: Line-Feed (Unix)
* @IANJUTA_EDITOR_LINE_MODE_CR: Carat return (Max)
* @IANJUTA_EDITOR_LINE_MODE_CRLF: Caret return + line-feed (Windows)
*
* This enumeration is used to specify the type of text. Note that not all
* editors implement this.
*/
enum Type
{
LF,
CR,
CRLF
}
/**
* ianjuta_editor_line_mode_get:
* @obj: Self
* @err: Error propagation and reporting
*
* Get current line ending mode. It is auto-detected from the
* buffer contents.
*/
Type get ();
/**
* ianjuta_editor_line_mode_set:
* @obj: Self
* @mode: Line mode to set.
* @err: Error propagation and reporting
*
* Set the line ending mode to the given @mode. Existing line end
* characters in the buffer are not touched. Only the newly added
* texts will have @mode line end characters.
*/
void set (Type mode);
/**
* ianjuta_editor_line_mode_convert:
* @obj: Self
* @mode: Line mode to convert.
* @err: Error propagation and reporting
*
* Set the line ending mode to the given @mode and convert all line end
* characters in the buffer to @mode line end characters.
*/
void convert (Type mode);
/**
* ianjuta_editor_line_mode_fix:
* @obj: Self
* @err: Error propagation and reporting
*
* Convert EOL characters to majority of line mode. This is helpful
* when the buffer contains mixed line modes and we want to fix it.
*/
void fix ();
}
/**
* SECTION:ianjuta-editor-tip
* @title: IAnjutaEditorTip
* @short_description: Editor call tips assistance framework
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-editor-tip.h
*
*/
interface IAnjutaEditorTip
{
/**
* ianjuta_editor_tip_show:
* @obj: Self
* @tips: (element-type utf8): list of alternative tips.
* @position: Tip position.
* @err: Error propagation and reporting
*
* Show tips showing more information on current context. No user feedback
* is required when tips are shown. @position indicates
* the position before which is the known context and after which are
* the suggestions. Usually the editor would use this to
* align the choices displayed such that the carat is just at this
* position when the choices are displayed.
*
*/
void show (List<const gchar*> tips, IAnjutaIterable *position);
/**
* ianjuta_editor_tip_cancel
* @obj: Self
* @err: Error propagation and reporting
*
* Cancels the last shown tooltip
*/
void cancel ();
/**
* ianjuta_editor_tip_visible:
* @obj: Self
* @err: Error propagation and reporting
*
* Returns: whether a tooltip is crrently shown
*/
gboolean visible();
}
/**
* SECTION:ianjuta-editor-assist
* @title: IAnjutaEditorAssist
* @short_description: Text editor assist interface
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-editor-assist
*
*/
interface IAnjutaEditorAssist
{
#include <libanjuta/interfaces/ianjuta-provider.h>
struct Proposal
{
gchar* label;
gchar* markup;
gchar* info;
gchar* text;
GdkPixbuf* icon;
gpointer data;
}
/**
* IAnjutaEditorAssist::cancelled
* @obj: Self
*
* This signal is emitted when the autocompletion is cancelled due to various
* reasons. The provider should avoid to call ianjuta_editor_assist_proposals() after
* this signal.
*/
void ::cancelled ();
/*
* ianjuta_editor_assist_add
* @obj: self
* @provider: a IAnjutaProvider
* @err: Error handling
*
* Add a provider to the list of completion providers
*/
void add(IAnjutaProvider* provider);
/*
* ianjuta_editor_assist_remove
* @obj: self
* @provider: a IAnjutaProvider
* @err: Error handling
*
* Remove a provider from the list of completion providers
*/
void remove(IAnjutaProvider* provider);
/*
* ianjuta_editor_assist_invoke
* @obj: self
* @provider: a IAnjutaProvider (can be NULL to use all providers)
* @err: Error handling
*
* Force invokation of a provider at the current cursor position.
* That means that ianjuta_provider_populate() will be called on the
* provider.
*/
void invoke(IAnjutaProvider* provider);
/**
* ianjuta_editor_assist_proposals:
* @obj: self
* @provider: a IAnjutaProvider
* @proposals: (element-type IAnjutaEditorAssistProposal): a list of IAnjutaProposals
* @finished: whether is was the last call in an async operation
* @err: Error handling
*
* Add the list of proposals for the current population. You can add
* proposals async as long as the last call sets finished to TRUE. That
* is usually called by the IAnjutaProvider after it was triggered by
* ianjuta_provider_populate()
*
*/
void proposals(IAnjutaProvider* provider, GList* proposals, gboolean finished);
}
/**
* SECTION:ianjuta-editor-hover
* @title: IAnjutaEditorHover
* @short_description: Text editor hover interface
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-editor-hover
*
*/
interface IAnjutaEditorHover
{
#include <libanjuta/interfaces/ianjuta-iterable.h>
/* IAnjutaEditorHover::hover-over:
* @obj: self
* @position: IAnjutaEditorCell specifying the position the mouse is over
*
* The mouse is held for a moment over @position. This can be used to show
* all tooltip.
*/
void ::hover_over (IAnjutaIterable* position);
/* IAnjutaEditorHover::hover-leave
* @obj: self
* @position: IAnjutaEditorCell specifying the position the mouse was over
*
* User moved the mouse away - can be used to clean up things done in
* #IAnjutaEditorHover::hover-over
*/
void ::hover_leave (IAnjutaIterable* position);
/**
* ianjuta_editor_hover_display:
* @obj: Self
* @info: String to display
* @err: Error propagation and reporting
*
* Show @info as tooltip
*
*/
void display (IAnjutaIterable* position, const gchar *info);
}
/**
* SECTION:ianjuta-editor-language
* @title: IAnjutaEditorLanguage
* @short_description: Text editor language interface
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-editor-language.h
*
*/
interface IAnjutaEditorLanguage
{
/* IAnjutaEditorLanguage::language-changed:
* @obj: self
* @language: new language
*
* the language of the editor changed to @language
*/
void ::language_changed (const gchar *language);
/**
* ianjuta_editor_language_get_supported_languages:
* @obj: Self
* @err: Error propagation and reporting
*
* Return a list of languages supported by the editor
* Note: These list contains the names in the form
* the editor implementation knows them
* Returns: (element-type utf8):
*/
const List<const gchar*> get_supported_languages ();
/**
* ianjuta_editor_language_name:
* @obj: Self
* @err: Error propagation and reporting
*
* Get a list of languages the editor can highlight
*
*/
const gchar *get_language_name (const gchar* language);
/**
* ianjuta_editor_language_get_language:
* @obj: Self
* @err: Error propagation and reporting
*
* Return the name of the currently used language
*
*/
const gchar *get_language ();
/**
* ianjuta_editor_language_set_language:
* @obj: Self
* @language: Language
* @err: Error propagation and reporting
*
* Force the editor to use a given language
*
*/
void set_language (const gchar* language);
}
/**
* SECTION:ianjuta-editor-folds
* @title: IAnjutaEditorFolds
* @short_description: Text editor folds inteface
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-editor-folds.h
*
*/
interface IAnjutaEditorFolds
{
/**
* ianjuta_editor_view_open_folds:
* @obj: Self
* @err: Error propagation and reporting
*
* Open all folds
*
*/
void open_all ();
/**
* ianjuta_editor_view_close_folds:
* @obj: Self
* @err: Error propagation and reporting
*
* Close all folds
*
*/
void close_all ();
/**
* ianjuta_editor_view_toggle_fold:
* @obj: Self
* @err: Error propagation and reporting
*
* Open/Close current fold
*
*/
void toggle_current ();
}
/**
* SECTION:ianjuta-editor-view
* @title: IAnjutaEditorView
* @short_description: Text editor view interface
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-editor-view.h
*
* An editor view is a visual representation of the editor. An editor
* can have multiple views. All views of an editor show the same editor
* content (buffer). Consequently, any change done in one view is
* updated in all other views.
*/
interface IAnjutaEditorView
{
/**
* ianjuta_editor_view_create:
* @obj: Self
* @err: Error propagation and reporting
*
* Creates a new view for the editor. The newly created view gets
* the user focus and scrolls to the same location as last view.
*/
void create ();
/**
* ianjuta_editor_view_remove_current:
* @obj: Self
* @err: Error propagation and reporting
*
* Removes currently focused editor view. It does not remove the
* last view of the editor. That is, if currently there is only
* one view of the editor, this function does nothing.
*/
void remove_current ();
/**
* ianjuta_editor_view_get_count:
* @obj: Self
* @err: Error propagation and reporting
*
* Total number of views currently present. It will never be less
* than 1. Invalid return values are considered error condition.
*/
gint get_count ();
}
/**
* SECTION:ianjuta-editor-comment
* @title: IAnjutaEditorComment
* @short_description: Text editor comment interface
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-editor-comment.h
*
*/
interface IAnjutaEditorComment
{
/**
* ianjuta_editor_comment_block:
* @obj: Self
* @err: Error propagation and reporting
*
* Comment/Uncomment out selected block
*/
void block();
/**
* ianjuta_editor_comment_box:
* @obj: Self
* @err: Error propagation and reporting
*
* Comment/Uncomment out selected block
*/
void box();
/**
* ianjuta_editor_comment_stream:
* @obj: Self
* @err: Error propagation and reporting
*
* Comment/Uncomment out selected block
*/
void stream();
}
/**
* SECTION:ianjuta-editor-zoom
* @title: IAnjutaEditorZoom
* @short_description: Text editor zoom interface
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-editor-zoom.h
*
*/
interface IAnjutaEditorZoom
{
/**
* ianjuta_editor_zoom_in:
* @obj: Self
* @err: Error propagation and reporting
*
* Zoom in
*/
void in ();
/**
* ianjuta_editor_zoom_out:
* @obj: Self
* @err: Error propagation and reporting
*
* Zoom out
*/
void out ();
}
/**
* SECTION:ianjuta-editor-goto
* @title: IAnjutaEditorGoto
* @short_description: Text editor navigation interface
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-editor-goto.h
*
*/
interface IAnjutaEditorGoto
{
/**
* ianjuta_editor_goto_start_block:
* @obj: Self
* @err: Error propagation and reporting
*
* Moves cursor to the start of the current block
*/
void start_block();
/**
* ianjuta_editor_goto_end_block:
* @obj: Self
* @err: Error propagation and reporting
*
* Moves cursor to the end of the current block
*/
void end_block();
/**
* ianjuta_editor_goto_matching_brace:
* @obj: Self
* @err: Error propagation and reporting
*
* Moves cursor to matching brace
*/
void matching_brace();
}
/**
* SECTION:ianjuta-editor-glade-signal
* @title: IAnjutaEditorGladeSignal
* @short_description: Interface for dropping signal handlers
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-editor-goto.h
*
*/
interface IAnjutaEditorGladeSignal
{
/* IAnjutaEditorGladeSignal::drop-possible
* @obj: self
* @iter: a IAnjutaIterable of the position where drop would happen
*
* Emitted when a signal is dragged over the editor
*
* Return value: TRUE if a signal handler can be dropped, FALSE otherwise
*/
gboolean ::drop_possible (IAnjutaIterable* iterator);
/* IAnjutaEditorGladeSignal::drop
* @obj: self
* @iter: a IAnjutaIterable of the position where drop happens
* @signal_data: Signal data in form "widget:signal:handler", e.g.
* "GtkToggleButton:toggled:on_toggle_button_toggled"
*
* Emitted when a signal was received per drag & drop
*
*/
void ::drop (IAnjutaIterable* iterator, const gchar* signal_data);
}
}
/**
* SECTION:ianjuta-editor-cell
* @title: IAnjutaEditorCell
* @short_description: Text editor character cell
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-editor-cell.h
*
* Represents a cell in editor. A cell corresponds to a unicode
* character along with all associated styles (such as colors and font).
* A cell may or may not have style. If style is supported in the
* editor, it is assumed all cells will have styles and hence every
* IAnjutaEditorCell interface instance will have additionally
* IAnjutaEditorCellStyle implemented.
*/
interface IAnjutaEditorCell
{
#include <libanjuta/interfaces/ianjuta-editor.h>
/**
* ianjuta_editor_cell_get_character:
* @obj: Self
* @err: Error propagation and reporting
*
* Returns the unicode character in this cell. A NULL terminated
* string is returned that is the multibyte unicode character.
* NULL is returned if the cell does not have any character.
*
* Returns: a newly created string representing the cell's unicode
* character.
*/
gchar *get_character ();
/**
* ianjuta_editor_cell_get_length:
* @obj: self
* @err: Error propagation and reporting.
*
* Gets the length of the cell in bytes. That is, length of the
* unicode character.
*
* Returns: Length of the unicode character.
*/
gint get_length ();
/**
* ianjuta_editor_cell_get_char:
* @obj: Self
* @err: Error propagation and reporting
*
* Returns the byte of the unicode character in this cell at given
* index @char_index. @char_index can vary from 0 to length of the
* unicode string minus 1. Out of range index is not allowed
* (asserted) and return is undefined.
*
* Since there is dynamic allocation of unicode character string
* involved in ianjuta_editor_cell_get_character(), this function
* is mainly useful for fast iteration (such as copying data).
*
* Returns: a byte character.
*/
gchar get_char (gint char_index);
IAnjutaEditorAttribute get_attribute ();
/**
* SECTION:ianjuta-editor-cell-style
* @title: IAnjutaEditorCellStyle
* @short_description: Text editor cell style interface
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-editor-cell-style.h
*
*/
interface IAnjutaEditorCellStyle
{
gchar* get_font_description ();
gchar* get_color();
gchar* get_background_color();
}
}
/**
* SECTION:ianjuta-editor-factory
* @title: IAnjutaEditorFactory
* @short_description: Text editor factory that creates IAnjutaEditor objects
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-editor-factory.h
*
*/
interface IAnjutaEditorFactory
{
#include "ianjuta-editor.h"
#include <gio/gio.h>
/**
* ianjuta_editor_factory_new_editor:
* @obj: Self
* @file: file to open
* @filename: filename to open
* @err: Error propagation and reporting
*
* Get a new GtkWidget* which implements IAnjutaEditor
*
* Return value: An object implementing IAnjutaEditor
*/
IAnjutaEditor* new_editor (GFile* file, const gchar* filename);
}
/**
* SECTION:ianjuta-provider
* @title: IAnjutaProvider
* @short_description: Provider for autocompletion features
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-provider.h
*/
interface IAnjutaProvider
{
#include "ianjuta-iterable.h"
/**
* ianjuta_provider_populate:
* @obj: Self
* @iter: the text iter where the provider should be populated
* @err: Error propagation and reporting.
*
* Show completion for the context at position @iter. The provider should
* call ianjuta_editor_assist_proposals here to add proposals to the list.
*
* Note that this is called after every character typed and the list of proposals
* has to be completely renewed.
*/
void populate(IAnjutaIterable* iter);
/**
* ianjuta_provider_get_start_iter:
* @obj: Self
* @err: Error propagation and reporting.
*
* Get the iter where the current completion started
*
* Returns: (transfer none): current start iter
*/
IAnjutaIterable* get_start_iter();
/**
* ianjuta_provider_activate:
* @obj: Self
* @iter: position where the completion occurs
* @data: data assigned to the proposal
* @err: Error propagation and reporting.
*
* Show completion for the context at position @iter
*/
void activate(IAnjutaIterable* iter, gpointer data);
/**
* ianjuta_provider_get_name:
* @obj: Self
*
* Return a (translatable) name for the provider
*/
const gchar* get_name();
}
/**
* SECTION:ianjuta-document-manager
* @title: IAnjutaDocumentManager
* @short_description: Interface for plugin that manages all the editors
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-document-manager.h
*
*/
interface IAnjutaDocumentManager
{
#include "ianjuta-document.h"
#include "ianjuta-editor.h"
#include <gio/gio.h>
/**
* IANJUTA_DOCUMENT_MANAGER_CURRENT_DOCUMENT
*
* Anjuta shell value set by document manager to the current document
*/
#define CURRENT_DOCUMENT "document_manager_current_document"
enum Error
{
DOESNT_EXIST
}
/**
* ianjuta_document_manager_get_file:
* @obj: Self
* @filename: short filename
* @err: Error propagation and reporting.
*
* Given the short filename, finds the file of the filename, if the
* editor that has it loaded is found. If there is no editor that has
* this file opened, returns NULL.
*
* Return value: (transfer full): the GFile for the given short filename
*/
GFile* get_file (const gchar *filename);
/**
* ianjuta_document_manager_find_document_with_file:
* @obj: Self
* @file: The file to find.
* @err: Error propagation and reporting.
*
* Finds the document that has the file loaded. Only
* the editor that matches the file will be searched.
*
* Return value: (transfer none): the document that corresponds to given file. NULL if
* there is no editor loaded with this file.
*/
IAnjutaDocument* find_document_with_file (GFile* file);
/**
* ianjuta_document_manager_goto_file_line:
* @obj: Self
* @file: file to go to.
* @lineno: the line number in the file to go to.
* @err: Error propagation and reporting.
*
* Loads the given file if not loaded yet, set its editor as current editor
* and moves cursor to the given line in the editor.
*
* Return value: (transfer none): the editor where the mark has been put. NULL if none.
*/
IAnjutaEditor* goto_file_line (GFile* file, gint lineno);
/**
* ianjuta_document_manager_goto_file_line_mark:
* @obj: Self
* @file: file to go to.
* @lineno: the line number in the file to go to.
* @mark: TRUE if the line should be marked with a marker.
* @err: Error propagation and reporting
*
* Loads the given file if not loaded yet, set its editor as current editor
* and moves cursor to the given line in the editor. Optionally also marks
* the line with line marker if @mark is given TRUE.
*
* Return value: (transfer none): the editor where the mark has been put. NULL if none.
*/
IAnjutaEditor* goto_file_line_mark (GFile* file, gint lineno, gboolean mark);
/**
* ianjuta_document_manager_get_current_document:
* @obj: Self
* @err: Error propagation and reporting.
*
* Gets the current document.
*
* Return value: (transfer none): the currently active document. NULL if none is there.
*/
IAnjutaDocument* get_current_document ();
/**
* ianjuta_document_manager_set_current_document:
* @obj: Self
* @document: the document to set as current.
* @err: Error propagation and reporting.
*
* Sets the given document as current document.
*/
void set_current_document (IAnjutaDocument *document);
/**
* ianjuta_document_manager_get_doc_widgets:
* @obj: Self
* @err: Error propagation and reporting.
*
* Gets a list of widgets for open documents. Each widget is
* a GTK_WIDGET(IAnjutaDocument*)
*
* Return value: (element-type GtkWidget) (transfer container): a list of widgets for
* all open documents. The returned list (but not the data in the list) must be
* freed after use.
*/
List<GtkWidget*> get_doc_widgets ();
/**
* ianjuta_document_manager_add_buffer:
* @obj: Self
* @name: Name of the editor buffer.
* @content: Initial content of the buffer.
* @err: Error propagation and reporting.
*
* Creates a new editor buffer of the given name and sets the given
* content as its initial content.
*
* Return value: (transfer full): the IAnjutaEditor instance that has been added.
*/
IAnjutaEditor* add_buffer (const gchar *name, const gchar* content);
/**
* ianjuta_document_manager_remove_document:
* @obj: Self
* @document: Document to close.
* @save_before: If true, saves the document before closing.
* @err: Error propagation and reporting.
*
* Closes and removes the given document. If @save_before is TRUE, also
* saves the document before closing.
*
* Return value: TRUE if the document was removed, else FALSE.
*/
gboolean remove_document (IAnjutaDocument *document, gboolean save_before);
/**
* ianjuta_document_manager_add_document:
* @obj: Self
* @document: the document to add
* @err: Error propagation and reporting.
*
* Adds a document to the document manager. This will open a new
* Notebook tab and show the document there
*
*/
void add_document (IAnjutaDocument* document);
/*
* ianjuta_document_manager_add_bookmark:
* @obj: Self
* @file: File to add the bookmark
* @line: Line of the bookmark
*
* Add a bookmark
*/
void add_bookmark (GFile* file, gint line);
}
/**
* SECTION:ianjuta-message-view
* @title: IAnjutaMessageView
* @short_description: A view where messages of different kind can be shown
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-message-view.h
*
*/
interface IAnjutaMessageView
{
/**
* IAnjutaMessageViewType:
* @IANJUTA_MESSAGE_VIEW_TYPE_NORMAL: Normal message
* @IANJUTA_MESSAGE_VIEW_TYPE_INFO: Info message (highlighed)
* @IANJUTA_MESSAGE_VIEW_TYPE_ERROR: Error message
* @IANJUTA_MESSAGE_VIEW_TYPE_WARNING: Warning message
*
* Speficy the type ot the message added to the message view
*/
enum Type
{
TYPE_NORMAL,
TYPE_INFO,
TYPE_WARNING,
TYPE_ERROR
}
/**
* IAnjutaMessageView::message-clicked:
* @obj: Self
* @message: text of the clicked message
*
* Emitted when the user clicks on a message
*/
void ::message_clicked (const gchar *message);
/**
* IAnjutaMessageView::buffer-flushed:
* @obj: Self
* @line: the current line
*
* Emitted when #ianjuta_message_view_buffer_append found a newline
*/
void ::buffer_flushed (const gchar *line);
/**
* ianjuta_message_view_buffer_append:
* @obj: Self
* @text: text to show as message
* @err: Error propagation and reporting.
*
* Appends the text in buffer. Flushes the buffer where a newline is found.
* by emiiting buffer_flushed signal. The string is expected to be utf8.
*/
void buffer_append (const gchar *text);
/**
* ianjuta_message_view_append:
* @obj: Self
* @type: type of the message
* @summary: summary of the message
* @details: details of the message
* @err: Error propagation and reporting.
*
* Append the message with summary displayed and details displayed as tooltip
*/
void append (Type type, const gchar *summary, const gchar *details);
/**
* ianjuta_message_view_clear:
* @obj: Self
* @err: Error propagation and reporting.
*
* Clear all messages in buffer
*/
void clear ();
/**
* ianjuta_message_view_select_next:
* @obj: Self
* @err: Error propagation and reporting.
*
* Select next message (of type INFO, WARNING or ERROR)
*/
void select_next ();
/**
* ianjuta_message_view_select_previous:
* @obj: Self
* @err: Error propagation and reporting.
*
* Select previous message
*/
void select_previous ();
/**
* ianjuta_message_view_get_current_message:
* @obj: Self
* @err: Error propagation and reporting.
*
* Get the currently selected message
*/
const gchar* get_current_message ();
/**
* ianjuta_message_view_get_all_messages:
* @obj: Self
* @err: Error propagation and reporting.
*
* Get a list of all messages. The list has to be freed
* Returns: (element-type utf8):
*/
List<const gchar*> get_all_messages ();
}
/**
* SECTION:ianjuta-message-manager
* @title: IAnjutaMessageManager
* @short_description: The plugin that managers all message views
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-message-manager.h
*
*/
interface IAnjutaMessageManager
{
#include "ianjuta-message-view.h"
#include <gdk/gdk.h>
enum Error
{
DOESNT_EXIST
}
/**
* ianjuta_message_manager_add_view:
* @obj: Self
* @name: Name/Title of the new view
* @icon: Path to an icon or ""
* @err: Error propagation and reporting
*
* Adds a new view to the message-manager
*
* Return value: The new message-view
*/
IAnjutaMessageView* add_view (const gchar *name, const gchar *icon);
/**
* ianjuta_message_manager_remove_view:
* @obj: Self
* @view: The view to remove
* @err: Error propagation and reporting
*
* Remove view from the message-manager. The view
* will become invalid.
*/
void remove_view (IAnjutaMessageView *view);
/**
* ianjuta_message_manager_get_current_view:
* @obj: Self
* @err: Error propagation and reporting
*
* Get the view with is currently on top of
* the notebook or NULL if the message-manager is empty.
*
* Return value: Current view; #IAnjutaMessageView object.
* NULL, if there is no views.
*/
IAnjutaMessageView* get_current_view ();
/**
* ianjuta_message_manager_get_view_by_name:
* @obj: Self
* @name: Name/Title of the view
* @err: Error propagation and reporting
*
* Get the view with the given name or NULL if
* it does not exist.
*
* Return value: The message-view or NULL
*/
IAnjutaMessageView* get_view_by_name (const gchar *name);
/**
* ianjuta_message_manager_get_all_views:
* @obj: Self
* @err: Error propagation and reporting
*
* Get all message-views
*
* Return value: (element-type IAnjutaMessageView): A GList* of all views. You must not
* manipulate the list.
*/
List<IAnjutaMessageView*> get_all_views ();
/**
* ianjuta_message_manager_set_current_view:
* @obj: Self
* @view: A message view
* @err: Error propagation and reporting
*
* Set view to be on top of the notebook.
*
*/
void set_current_view (IAnjutaMessageView *view);
/**
* ianjuta_message_manager_set_view_title:
* @obj: Self
* @view: A message view
* @title: Sets the title of view.
* @err: Error propagation and reporting
*
* Sets the title of view.
*
*/
void set_view_title (IAnjutaMessageView *view, const gchar *title);
/**
* ianjuta_message_manager_set_view_icon:
* @obj: Self
* @view: A message view
* @icon: Sets the icon of view.
* @err: Error propagation and reporting
*
* Sets the icon of view.
*
*/
void set_view_icon (IAnjutaMessageView *view, GdkPixbufAnimation *icon);
/**
* ianjuta_message_manager_set_view_icon_from_stock:
* @obj: Self
* @view: A message view
* @icon: Sets the icon of view.
* @err: Error propagation and reporting
*
* Sets the icon of view.
*
*/
void set_view_icon_from_stock (IAnjutaMessageView *view, const gchar *icon);
}
/**
* SECTION:ianjuta-file-manager
* @title: IAnjutaFileManager
* @short_description: File manager plugin
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-file-manager.h
*
*/
interface IAnjutaFileManager
{
#include <gio/gio.h>
/**
* IANJUTA_FILE_MANAGER_SELECTED_FILE
*
* Anjuta shell value set by file manager to the selected file.
*/
#define SELECTED_FILE "file_manager_selected_file"
/**
* IAnjutaFileManager::section-changed:
* @obj: Self
* @err: Error propagation and reporting.
*
* fixme
*/
void ::section_changed (GFile* file);
/**
* ianjuta_file_manager_set_root:
* @obj: Self
* @root_uri: fixme
* @err: Error propagation and reporting.
*
* fixme
*/
void set_root (const gchar *root_uri);
/**
* ianjuta_file_manager_get_selected:
* @obj: Self
* @err: Error propagation and reporting.
*
* fixme
*/
GFile* get_selected ();
/**
* ianjuta_file_manager_set_selected:
* @obj: Self
* @file: File to select
* @err: Error propagation and reporting.
*
* fixme.
*/
void set_selected (GFile* file);
}
/**
* SECTION:ianjuta-terminal
* @title: IAnjutaTerminal
* @short_description: Interface for command line terminals
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-terminal.h
*
*/
interface IAnjutaTerminal
{
#include <sys/types.h>
/**
* IAnjutaTerminal::child_exited:
* @obj: Self
* @pid: pid of terminated child
* @status: status of terminated child as returned by waitpid
*
* This signal is emitted when a child exit.
*/
void ::child_exited (gint pid, gint status);
/**
* ianjuta_terminal_execute_command:
* @obj: Self
* @directory: Working directory
* @command: Command executed followed by arguments
* @environment: List of additional environment variables
* @err: Error propagation and reporting.
*
* Run the command in a terminal, setting the working directory
* and environment variables.
*
* Returns: Process ID
*/
pid_t execute_command (const gchar* directory, const gchar *command, gchar **environment);
}
/**
* SECTION:ianjuta-project
* @title: IAnjutaProject
* @short_description: Interface implemented by project backend
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-project-backend.h
*
* This is the new interface that is replacing Gnome Build.
*/
interface IAnjutaProject
{
#include <libanjuta/anjuta-project.h>
#include <gtk/gtk.h>
/* Types */
enum Error
{
ERROR_SUCCESS = 0,
ERROR_DOESNT_EXIST,
ERROR_ALREADY_EXISTS,
ERROR_VALIDATION_FAILED,
ERROR_PROJECT_MALFORMED,
ERROR_WRONG_PARENT,
ERROR_NOT_SUPPORTED,
ERROR_GENERAL_FAILURE
}
enum Probe
PROBE_FILES = 10,
PROBE_MAKE_FILES = 100,
PROBE_PROJECT_FILES = 200
}
/* Signals */
/**
* IAnjutaProject::file-changed:
* @obj: Self
* @node: Node to be reloaded.
*
* This signal is emitted when the project is changed on the disk. The
* corresponding node has to be reloaded.
*/
void ::file_changed (gpointer node);
/**
* IAnjutaProject::node-changed:
* @obj: Self
* @node: Changed node.
* @error: Error while changing node
*
* This signal is emitted when a node is changed by a function of this
* interface. The error argument is not NULL if the change was not
* possible. The corresponding node need to be saved.
*/
void ::node_changed (gpointer node, GError *error);
/**
* IAnjutaProject::node-saved:
* @obj: Self
* @node: Saved node.
* @error: Error while saving node
*
* This signal is emitted when a node is saved. It returns an error if the
* save operation fail.
*/
void ::node_saved (gpointer node, GError *error);
/**
* IAnjutaProject::node-loaded:
* @obj: Self
* @node: Loaded node.
* @error: Error while loading node
*
* This signal is emitted when a node is loaded. It returns an error if the
* load operation fail.
*/
void ::node_loaded (gpointer node, GError *error);
/**
* ianjuta_project_load_node:
* @obj: Self
* @node: (transfer none): Project node to reload
* @err: Error propagation and reporting
*
* Reload a project node
*
* Return value: TRUE if the node has been loaded without error
*/
gboolean load_node (AnjutaProjectNode *node);
/**
* ianjuta_project_save_node:
* @obj: Self
* @node: (transfer none): Project node to save
* @err: Error propagation and reporting
*
* Save a project node
*
* Return value: TRUE if the node has been saved without error
*/
gboolean save_node (AnjutaProjectNode *node);
/**
* ianjuta_project_add_node_after:
* @obj: Self
* @parent: (transfer none): Parent
* @sibling: (allow-none) (transfer none): Sibling
* @type: Node type
* @file: (allow-none) (transfer none): Optional file object for the node
* @name: (allow-none) (transfer none): Optional name for the node
* @err: Error propagation and reporting
*
* Create a new node and insert it after sibling
*
* Return value: (transfer none): The new node, NULL if error
*/
AnjutaProjectNode *add_node_after (AnjutaProjectNode *parent, AnjutaProjectNode *sibling, AnjutaProjectNodeType type, GFile *file, const gchar *name);
/**
* ianjuta_project_add_node_before:
* @obj: Self
* @parent: (transfer none): Parent
* @sibling: (allow-none) (transfer none): Sibling
* @type: Node type
* @file: (allow-none) (transfer none): Optional file object for the node
* @name: (allow-none) (transfer none): Optional name for the node
* @err: Error propagation and reporting
*
* Create a new node and insert it before sibling
*
* Return value: (transfer none): The new node, NULL if error
*/
AnjutaProjectNode *add_node_before (AnjutaProjectNode *parent, AnjutaProjectNode *sibling, AnjutaProjectNodeType type, GFile *file, const gchar *name);
/**
* ianjuta_project_remove_node:
* @obj: Self
* @node: (transfer none): Node
* @err: Error propagation and reporting
*
* Remove a node
*
* Return value: TRUE if the node can be removed
*/
gboolean remove_node (AnjutaProjectNode *node);
/**
* ianjuta_project_set_property:
* @obj: Self
* @node: (transfer none): Node
* @id: (transfer none): Property
* @name: (allow-none) (transfer none): Name for map property
* @value: (transfer none): Value
* @err: Error propagation and reporting
*
* Change a properties on node.
*
* Return value: (allow-none) (transfer none): The new property of NULL if the property cannot be set
*/
AnjutaProjectProperty *set_property (AnjutaProjectNode *parent, const gchar *id, const gchar *name, const gchar *value);
/**
* ianjuta_project_remove_property:
* @obj: Self
* @node: (transfer none): Node
* @id: (transfer none): Property
* @name: (allow-none) (transfer none): Name for map property
* @err: Error propagation and reporting
*
* Remove a property of the node
*
* Return value: TRUE if the node is removed
*/
gboolean remove_property (AnjutaProjectNode *node, const gchar *id, const gchar *name);
/**
* ianjuta_project_get_root:
* @obj: Self
* @err: Error propagation and reporting
*
* Get root_node
*
* Return value: (transfer none): The root node
*/
AnjutaProjectNode *get_root ();
/**
* ianjuta_project_get_node_info:
* @obj: Self
* @err: Error propagation and reporting
*
* Return a list of possible node;
*
* Return value: (element-type Anjuta.ProjectNodeInfo) (transfer none): A list
* containing information on all node supported by the project.
*/
const List<AnjutaProjectNodeInfo *> get_node_info();
/**
* ianjuta_project_is_loaded:
* @obj: Self
* @err: Error propagation and reporting
*
* Return TRUE if the project is loaded;
*
* Return value: TRUE if the project is completely loaded.
*/
gboolean is_loaded ();
}
/**
* SECTION:ianjuta-project-backend
* @title: IAnjutaProjectBackend
* @short_description: Interface for creating new project
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-project-backend.h
*
*/
interface IAnjutaProjectBackend
{
#include "ianjuta-project.h"
/**
* ianjuta_project_backend_new_project:
* @obj: Self
* @file: (transfer none): Project file or directory
* @err: Error propagation and reporting
*
* Create a new Anjuta project.
*
* Return value: (transfer full): An object implementing the
* #IAnjutaProject interface.
*/
IAnjutaProject* new_project (GFile *file);
/**
* ianjuta_project_backend_probe:
* @obj: Self
* @file: (transfer none): Project file or directory
* @err: Error propagation and reporting
*
* Check if the directory contains a project supported by this
* backend.
*
* Return value: 0 if the project is invalid and > 0 if the project is
* valid.
*/
gint probe (GFile *directory);
}
/**
* SECTION:ianjuta-project-manager
* @title: IAnjutaProjectManager
* @short_description: Interface for project managers
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-project-manager.h
*
*/
interface IAnjutaProjectManager
{
#include <libanjuta/anjuta-project.h>
#include <libanjuta/interfaces/ianjuta-project.h>
/**
* IANJUTA_PROJECT_MANAGER_PROJECT_ROOT_URI
*
* Anjuta shell value set by project manager to the project root uri.
*/
#define PROJECT_ROOT_URI "project_root_uri"
/**
* IANJUTA_PROJECT_MANAGER_CURRENT_PROJECT
*
* Anjuta shell value set by project manager to the current project object
* which implement #IAnjutaProject interface.
*/
#define CURRENT_PROJECT "project_manager_current_project"
/**
* IANJUTA_PROJECT_MANAGER_CURRENT_URI
*
* Anjuta shell value set by project manager to the current uri.
*/
#define CURRENT_URI "project_manager_current_uri"
// Signals
/**
* IAnjutaProjectManager::project_loaded:
* @obj: Self
* @err: Error propagation and reporting.
*
* Emitted when the project is fully loaded. It can takes a quite long
* time if the project is big. The project is loaded in several parts
* in a thread. All functions are available before having the project
* fully loaded.
*/
void ::project_loaded (GError *error);
/**
* IAnjutaProjectManager::element_added:
* @obj: Self
* @element: A #GFile corrresponding to added element
* @err: Error propagation and reporting.
*
* Emitted when a new element is added to the project. It can be
* a source, a target or a group. It does not always correspond
* to an existing file. This signal can be emitted several time for
* the same element.
*/
void ::element_added (GFile *element);
/**
* IAnjutaProjectManager::element_removed:
* @obj: Self
* @element: A #GFile corresponding to removed element
* @err: Error propagation and reporting.
*
* Emitted when an element is removed from a project. It can be
* a source, a target or a group.
*/
void ::element_removed (GFile *element);
/**
* IAnjutaProjectManager::element_selected:
* @obj: Self
* @element_uri: A #GFile corresponding to selected element
* @err: Error propagation and reporting.
*
* Emitted when an element is selected in the project view. It
* can be a source, a target or a group.
*/
void ::element_selected (GFile *element);
// Methods
/**
* ianjuta_project_manager_get_elements:
* @obj: Self
* @element_type: Select one element type: source, group or target
* @err: Error propagation and reporting.
*
* Get a list of all elements of this type in the project.
*
* Returns: (element-type GFile) (transfer full): Get list of #GFile corresponding to
* all valid elements or %NULL if there are no elements of this type. Free the returned
* list with g_list_free() and the files with g_object_unref().
*/
List<GFile *> get_elements (AnjutaProjectNodeType element_type);
/**
* ianjuta_project_manager_get_target_type:
* @obj: Self
* @target: A #GFile corresponding to a target
* @err: Error propagation and reporting.
*
* Get the type of the corresponding target: program, library...
*
* Returns: Return the type of the target.
*/
AnjutaProjectNodeType get_target_type (GFile *target);
/**
* ianjuta_project_manager_get_targets:
* @obj: Self
* @target_type: type of the target
* @err: Error propagation and reporting.
*
* Get a list of targets in the project with the corresponding type.
*
* Returns: (element-type GFile) (transfer full): A list of #GFile corresponding to
* each target of the requested type or %NULL if none exists. Free the returned list
* with g_list_free() and the files with g_object_unref().
*/
List<GFile *> get_targets (AnjutaProjectNodeType target_type);
/**
* ianjuta_project_manager_get_parent:
* @obj: Self
* @element: A #GFile corresponding to one child.
* @err: Error propagation and reporting.
*
* Gets the parent of the corresponding child.
*
* Returns: The parent of the child, or %NULL if the element is the root.
*/
GFile* get_parent (GFile *element);
/**
* ianjuta_project_manager_get_children:
* @obj: Self
* @parent: A #GFile corresponding to the parent.
* @children_type: Select one element type: source, group or target
* @err: Error propagation and reporting.
*
* Recursively gets the list of all children below the corresponding
* parent having the specify type.
*
* Returns: (element-type GFile) (transfer full): The list of #GFile
* corresponding to all children or %NULL if the element has no
* children with the corresponding type. Free the returned * list
* with g_list_free() and the files with g_object_unref().
*/
List<GFile*> get_children (GFile *parent, gint children_type);
/**
* ianjuta_project_manager_get_selected:
* @obj: Self
* @err: Error propagation and reporting.
*
* Gets the currently selected element in the project manager view.
*
* Returns: (transfer full): A #GFile corresponding to the selected element in the project
* view. You own the returned file; use g_object_unref() to release it.
*/
GFile* get_selected ();
/**
* ianjuta_project_manager_get_capabilities:
* @obj: Self
* @err: Error propagation and reporting.
*
* Gets the capabilites of project whether it can add group, target
* sources etc.
*
* Returns: Supported capabilites.
*/
guint get_capabilities ();
/**
* ianjuta_project_manager_add_source:
* @obj: Self.
* @name: Source name or URI.
* @default_target: (allow-none): A #GFile corresponding to the default target or group or
* %NULL if you don't care.
* @err: Error propagation and reporting.
*
* Prompts the user to add a file to the project. If the user selects
* multiple files only the first source file is returned.
*
* You can add non existing file. In this case the element_added
* signal will be emitted with a non existing file. So it is
* up to the caller to reemit this signal later when the file
* is created.
*
* Returns: (transfer full): A #GFile corresponding to the new source file in the
* project view. You own the returned file; use g_object_unref() to release it.
*/
GFile* add_source (const gchar *name, GFile *default_target);
/**
* ianjuta_project_manager_add_source_quiet:
* @obj: Self.
* @name: Source name or URI.
* @target: A #GFile corresponding to the parent target or group.
* @err: Error propagation and reporting.
*
* Adds a file to the project without prompting the user.
*
* You can add non existing file. In this case the element_added
* signal will be emitted with a non existing file. So it is
* up to the caller to reemit this signal later when the file
* is created.
*
* Returns: (transfer full): A #GFile corresponding to the new source file in the project
* view. You own the returned file; use g_object_unref() to release it.
*/
GFile* add_source_quiet (const gchar *name, GFile *target);
/**
* ianjuta_project_manager_add_sources:
* @obj: Self.
* @names: (element-type utf8): Sources name or URI to add.
* @default_target: (allow-none): A #GFile corresponding to the default target or group or
* %NULL if don't care.
* @err: Error propagation and reporting.
*
* Prompts the user to add several files to the project. Depending on the
* project backend, it can be possible that the source files must
* be located in a particular directory.
*
* You can add non existing file. In this case the element_added
* signal will be emitted with a non existing file. So it is
* up to the caller to reemit this signal later when the file
* is created.
*
* Returns: (element-type GFile) (transfer full): A list of #GFile corresponding to all
* new source files added in the project. You own the list with the the returned files;
* use g_list_free() and g_object_unref() on each file to release them.
*/
List<GFile*> add_sources (List<const gchar*> names, GFile *default_target);
/**
* ianjuta_project_manager_add_target:
* @obj: Self
* @name: Target name or URI.
* @default_group: (allow-none): A #GFile corresponding to the default parent group or
* %NULL if don't care.
* @err: Error propagation and reporting.
*
* Prompts the user to add a new target to the project. The user can select
* a parent group different from the one set as default.
*
* Returns: (transfer full): A #GFile corresponding to the new target added in the project.
* You own the returned file; use g_object_unref() to release it.
*/
GFile* add_target (const gchar *name, GFile *default_group);
/**
* ianjuta_project_manager_add_group:
* @obj: Self.
* @name: Group name or URI.
* @default_group: (allow-none): A #GFile corresponding to the default parent group or
* %NULL if don't care.
* @err: Error propagation and reporting.
*
* Prompts the user to add a new group to the project. The user can select
* a parent group different from the one set as default.
*
* Returns: (transfer full): A #GFile corresponding to the new group added in the project.
* You own the returned file; use g_object_unref() to release it.
*/
GFile* add_group (const gchar *name, GFile *default_group);
/**
* ianjuta_project_manager_is_open:
* @obj: Self
* @err: Error propagation and reporting.
*
* Gets whether a project is currently opened.
*
* Returns: %TRUE if a project is opened.
*/
gboolean is_open ();
/**
* ianjuta_project_manager_get_packages:
* @obj: Self
* @err: Error propagation and reporting.
*
* Returns: (element-type utf8) (transfer container): the list of pkg-config packages that the current project
* requires in it's configure.ac. Can be NULL if there is no project
* opened currently or no package is required.
*/
List<gchar*> get_packages();
/**
* ianjuta_project_manager_get_current_project:
* @obj: Self
* @err: Error propagation and reporting.
*
* Gets the current project.
*
* Return value: (transfer none): the currently active project. NULL if none is there.
*/
IAnjutaProject* get_current_project ();
}
/**
* SECTION:ianjuta-project-chooser
* @title: IAnjutaProjectChooser
* @short_description: Interface for selecting project node
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-project-chooser.h
*
*/
interface IAnjutaProjectChooser
{
#include <libanjuta/anjuta-project.h>
#include <libanjuta/interfaces/ianjuta-project-manager.h>
// Signals
/**
* IAnjutaProjectChooser::changed:
* @obj: Self
*
* Emitted when the selected node is changed.
*/
void ::changed ();
// Methods
/**
* ianjuta_project_chooser_set_project_model:
* @obj: Self
* @manager: A project manager
* @child_type: Select one element type: source, group or target
* @err: Error propagation and reporting.
*
* Initialize a project chooser button allowing to select a parent node
* where you can add the nodes of type child_type.
* As special cases with
* <variablelist>
* <varlistentry>
* <term>ANJUTA_PROJECT_ROOT</term>
* <listitem><para>all nodes are included</para></listitem>
* </varlistentry>
* <varlistentry>
* <term>ANJUTA_PROJECT_MODULE</term>
* <listitem><para>only modules are included, this can be used
* to add a new package. While ANJUTA_PROJECT_PACKAGE allows you
* to select a target using a package.</para></listitem>
* </varlistentry>
* </variablelist>
*
* Returns: TRUE if sucessful, other FALSE.
*/
gboolean set_project_model (IAnjutaProjectManager *manager, AnjutaProjectNodeType child_type);
/**
* ianjuta_project_chooser_get_selected:
* @obj: Self
* @err: Error propagation and reporting.
*
* Gets the currently selected element in the project chooser.
*
* Returns: (transfer none): A #GFile corresponding to the selected
* element in the project view or %NULL if no valid node is selected.
* The file is owned by the widget If you want to keep a pointer to
* the file you must add a refcount using g_object_ref().
*/
GFile* get_selected ();
}
/**
* SECTION:ianjuta-todo
* @title: IAnjutaTodo
* @short_description: Task manager interface
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-todo.h
*
*/
interface IAnjutaTodo
{
#include <gio/gio.h>
/**
* ianjuta_to_do_load:
* @obj: Self
* @file: fixme
* @err: Error propagation and reporting.
*
* fixme
*/
void load(GFile *file);
}
/**
* SECTION:ianjuta-wizard
* @title: IAnjutaWizard
* @short_description: Interface for wizards that can create new stuffs
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-wizard.h
*
*/
interface IAnjutaWizard
{
/**
* ianjuta_wizard_activate:
* @obj: Self
* @err: Error propagation and reporting.
*
* Called when the wizard should start after some user action
*/
void activate();
}
/**
* SECTION:ianjuta-debugger
* @title: IAnjutaDebugger
* @short_description: Debugger interface
* @see_also: #IAnjutaDebugManager
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-debugger.h
*
* This interface is implemented by debugger backends, by example the gdb
* backend. It is used by the debug manager plugin which provides the
* graphical interface and a simple wrapper: #IAnjutaDebugManager.
*
* The debugger is in one on these 5 states and emit a signal to the debug
* manager when it changes. Here is figure showing all transitions and
* the signal emitted.
* <figure id="debugger-states">
* <mediaobject>
* <imageobject>
* <imagedata fileref="debugger-states.png" format="PNG"/>
* </imageobject>
* </mediaobject>
* </figure>
*
*/
interface IAnjutaDebugger
{
#include "ianjuta-message-view.h"
#include <sys/types.h>
#include <gio/gio.h>
/* Types */
/**
* IAnjutaDebuggerError:
* @IANJUTA_DEBUGGER_OK: No error
* @IANJUTA_DEBUGGER_NOT_READY: Debugger is not ready to execute the command
* @IANJUTA_DEBUGGER_NOT_RUNNING: Debugger is not is running state
* @IANJUTA_DEBUGGER_NOT_STOPPED: Debugger is not is stopped state
* @IANJUTA_DEBUGGER_NOT_LOADED: Debugger is not is loaded state
* @IANJUTA_DEBUGGER_NOT_STARTED: Debugger is not in started state
* @IANJUTA_DEBUGGER_NOT_CONNECTED: Debugger is not connected:
* @IANJUTA_DEBUGGER_NOT_IMPLEMENTED: Corresponding function is not implemented
* @IANJUTA_DEBUGGER_CANCEL: Operation has been cancelled
* @IANJUTA_DEBUGGER_UNABLE_TO_CREATE_VARIABLE: Debugger cannot create variable
* @IANJUTA_DEBUGGER_UNABLE_TO_ACCESS_MEMORY: Debugger cannot access memory
* @IANJUTA_DEBUGGER_UNABLE_TO_OPEN_FILE: Debugger cannot open file
* @IANJUTA_DEBUGGER_UNSUPPORTED_FILE_TYPE: Debugger cannot debug such file
* @IANJUTA_DEBUGGER_UNSUPPORTED_VERSION: Debugger is too old
* @IANJUTA_DEBUGGER_UNABLE_TO_FIND_DEBUGGER: Debugger cannot be found
* @IANJUTA_DEBUGGER_ALREADY_DONE: Command has already been executed
* @IANJUTA_DEBUGGER_PROGRAM_NOT_FOUND: Program cannot be found
* @IANJUTA_DEBUGGER_UNABLE_TO_CONNECT: Unable to connect to debugger
* @IANJUTA_DEBUGGER_UNKNOWN_ERROR: Unknown error
* @IANJUTA_DEBUGGER_OTHER_ERROR: other error
*
* This enumeration is used to defined the error returned by the debugger
* backend.
*/
enum Error
{
OK = 0,
NOT_READY,
NOT_RUNNING,
NOT_STOPPED,
NOT_LOADED,
NOT_STARTED,
NOT_CONNECTED,
NOT_IMPLEMENTED,
CANCEL,
UNABLE_TO_CREATE_VARIABLE,
UNABLE_TO_ACCESS_MEMORY,
UNABLE_TO_OPEN_FILE,
UNSUPPORTED_FILE_TYPE,
UNSUPPORTED_VERSION,
UNABLE_TO_FIND_DEBUGGER,
ALREADY_DONE,
PROGRAM_NOT_FOUND,
UNABLE_TO_CONNECT,
UNKNOWN_ERROR,
OTHER_ERROR
}
/**
* IAnjutaDebuggerOutputType:
* @IANJUTA_DEBUGGER_OUTPUT: Output from debugger
* @IANJUTA_DEBUGGER_WARNING_OUTPUT: Warning from debugger
* @IANJUTA_DEBUGGER_ERROR_OUTPUT: Error from debugger
* @IANJUTA_DEBUGGER_INFO_OUTPUT: Additional message from debugger
*
* This enumeration is used to defined the kind of output in
* #IAnjutaDebuggerOutputCallback
*/
enum OutputType
{
OUTPUT,
WARNING_OUTPUT,
ERROR_OUTPUT,
INFO_OUTPUT
}
/**
* IAnjutaDebuggerState:
* @IANJUTA_DEBUGGER_BUSY: Debugger is executing a command, it can enter in another
* at the end of the command.
* @IANJUTA_DEBUGGER_STOPPED: Debugger is stopped.
* @IANJUTA_DEBUGGER_STARTED: Debugger is started but no program is loaded.
* @IANJUTA_DEBUGGER_PROGRAM_LOADED: Debugger is started and has a program loaded.
* @IANJUTA_DEBUGGER_PROGRAM_STOPPED: Debugger is started and has a program stopped.
* @IANJUTA_DEBUGGER_PROGRAM_RUNNING: Debugger is started and has a program running.
*
* This enumeration is used to defined the different state of the debugger.
*/
enum State
{
BUSY,
STOPPED,
STARTED,
PROGRAM_LOADED,
PROGRAM_STOPPED,
PROGRAM_RUNNING
}
/**
* IAnjutaDebuggerFrame:
* @thread: Thread identifier.
* @level: Level of the frame, 0 is the topmost one.
* @args: List of argument of the caller.
* @file: Source file name where is the program counter.
* @line: Line number in the file above.
* @function: Function name where is the program counter.
* @library: Library name where is the program counter.
* @address: Address of the program counter.
*
* This structure keeps all information about a stack frame.
*/
struct Frame
{
gint thread;
guint level;
gchar *args;
gchar *file;
guint line;
gchar *function;
gchar *library;
gulong address;
}
/**
* IAnjutaDebuggerCallback:
* @data: data
* @user_data: user data passed to the function
* @error: error
*
* This callback function is used only by #ianjuta_debugger_callback with a
* NULL data.
*/
typedef void (*Callback) (const gpointer data, gpointer user_data, GError* err);
/**
* IAnjutaDebuggerGListCallback:
* @list: (element-type any): list of data
* @user_data: user data passed to the function
* @error: error
*
* This callback function is used by several debugger functions. Depending on
* the function, the kind of elements in the list is different. It is a string
* for #ianjuta_debugger_list_local or a #IAnjutaDebuggerFrame for
* #ianjuta_debugger_list_frame.
*/
typedef void (*GListCallback) (const GList* list, gpointer user_data, GError* err);
/**
* IAnjutaDebuggerGCharCallback:
* @data: string
* @user_data: user data
* @error: error
*
* This callback function is used by several debugger functions. The data is
* a string
*/
typedef void (*GCharCallback) (const gchar *value, gpointer user_data, GError* err);
/**
* IAnjutaDebuggerOutputCallback:
* @data: Self
* @user_data: user data
* @error: error
*
* This callback function is used only by #ianjuta_debugger_callback with a
* NULL data.
*/
typedef void (*OutputCallback) (OutputType type, const gchar *output, gpointer user_data);
/* Signals */
/**
* IAnjutaDebugger::debugger_started:
* @obj: Self
*
* This signal is emitted when the debugger is started.
*/
void ::debugger_started ();
/**
* IAnjutaDebugger::debugger_stopped:
* @obj: Self
* @err: Error propagation and reporting.
*
* This signal is emitted when the debugger is stopped. The error
* parameters allow to check it has run correctly.
*/
void ::debugger_stopped (GError *err);
/**
* IAnjutaDebugger::program_loaded:
* @obj: Self
*
* This signal is emitted when a program is loaded.
*/
void ::program_loaded ();
/**
* IAnjutaDebugger::program_running:
* @obj: Self
*
* This signal is emitted when the program is running.
*/
void ::program_running ();
/**
* IAnjutaDebugger::program_stopped:
* @obj: Self
*
* This signal is emitted when the program is interrupted.
*/
void ::program_stopped ();
/**
* IAnjutaDebugger::program_exited:
* @obj: Self
*
* This signal is emitted when the program exits.
*/
void ::program_exited ();
/**
* IAnjutaDebugger::sharedlib_event:
* @obj: Self
*
* This signal is emitted when the program load a new shared
* library.
*/
void ::sharedlib_event ();
/**
* IAnjutaDebugger::program_moved:
* @obj: Self
* @pid: process id, 0 when unknown
* @tid: thread id, 0 when unknown
* @address: program counter address, 0 when unknown
* @file: source file where is the program counter, NULL when unknown
* @line: line number if file name above is not NULL
*
* This signal is emitted when the debugger know the current program
* location. Most of the time, after the program has stopped but it
* could happen even if it is still running.
*/
void ::program_moved (gint pid, gint tid, gulong address, const gchar* file, guint line);
/**
* IAnjutaDebugger::frame_changed:
* @obj: Self
* @frame: frame number
* @thread: thread number
*
* This signal is emitted when the current frame changes.
*/
void ::frame_changed (guint frame, gint thread);
/**
* IAnjutaDebugger::signal_received:
* @obj: Self
* @name: Signal name
* @description: Signal description
*
* This signal is emitted when the program received a unix signal.
*/
void ::signal_received (const gchar* name, const gchar* description);
/**
* IAnjutaDebugger::debugger_ready:
* @obj: Self
* @state: debugger status
*
* This signal is emitted when the debugger is ready to execute
* a new command.
*/
void ::debugger_ready (State state);
/**
* ianjuta_debugger_get_state:
* @obj: Self
* @err: Error propagation and reporting.
*
* Get the current state of the debugger
*
* Returns: The current debugger state.
*/
State get_state ();
/**
* ianjuta_debugger_load:
* @obj: Self
* @file: filename
* @mime_type: mime type of the file
* @source_search_directories: (element-type utf8): List of directories to search for
* source files.
* @err: Error propagation and reporting.
*
* Load a program in the debugger.
*
* Returns: TRUE if sucessful, other FALSE.
*/
gboolean load (const gchar *file, const gchar *mime_type, const List<const gchar*> source_search_directories);
/**
* ianjuta_debugger_attach:
* @obj: Self
* @pid: pid of the process to debug
* @source_search_directories: (element-type utf8): List of directories to search for
* source files.
* @err: Error propagation and reporting.
*
* Attach to an already running process.
*
* Returns: TRUE if sucessful, other FALSE.
*/
gboolean attach (pid_t pid, const List<const gchar*> source_search_directories);
/**
* ianjuta_debugger_set_working_directory:
* @obj: Self
* @dir: working program directory
* @err: Error propagation and reporting.
*
* Set program working directory.
*
* Returns: TRUE if sucessful, other FALSE.
*/
gboolean set_working_directory (const gchar *dir);
/**
* ianjuta_debugger_set_environment:
* @obj: Self
* @env: List environment variable
* @err: Error propagation and reporting
*
* Set environment variable
*
* Returns: TRUE if sucessfull, other FALSE.
*/
gboolean set_environment (gchar **env);
/**
* ianjuta_debugger_start:
* @obj: Self
* @args: command line argument of the program
* @terminal: TRUE if the program need a terminal
* @stop: TRUE if program is stopped at the beginning
* @err: Error propagation and reporting.
*
* Start a loaded program under debugger control.
*
* Returns: TRUE if sucessful, other FALSE.
*/
gboolean start (const gchar *args, gboolean terminal, gboolean stop);
/**
* ianjuta_debugger_connect:
* @obj: Self
* @server: remote server
* @args: command line argument of the program
* @terminal: TRUE if the program need a terminal
* @stop: TRUE if program is stopped at the beginning
* @err: Error propagation and reporting
*
* Connect to a remote debugger and run program
*
* Returns: TRUE if sucessfull, otherwise FALSE.
*/
gboolean connect (const gchar *server, const gchar *args, gboolean terminal, gboolean stop);
/**
* ianjuta_debugger_unload:
* @obj: Self
* @err: Error propagation and reporting.
*
* Unload a program.
*
* Returns: TRUE if sucessfull, otherwise FALSE.
*/
gboolean unload ();
/**
* ianjuta_debugger_quit:
* @obj: Self
* @err: Error propagation and reporting.
*
* Quit the debugger, can wait until the debugger is ready.
*
* Returns: TRUE if sucessful, other FALSE.
*/
gboolean quit ();
/**
* ianjuta_debugger_abort:
* @obj: Self
* @err: Error propagation and reporting.
*
* Quit the debugger as fast as possible.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean abort ();
/**
* ianjuta_debugger_run:
* @obj: Self
* @err: Error propagation and reporting.
*
* Run the program currently loaded.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean run ();
/**
* ianjuta_debugger_step_in:
* @obj: Self
* @err: Error propagation and reporting.
*
* Execute a single C instruction of the program currently loaded.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean step_in ();
/**
* ianjuta_debugger_step_over:
* @obj: Self
* @err: Error propagation and reporting.
*
* Execute one C instruction, without entering in procedure, of
* the program currently loaded.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean step_over ();
/**
* ianjuta_debugger_step_out:
* @obj: Self
* @err: Error propagation and reporting.
*
* Execute the currently loaded program until it goes out of the
* current procedure.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean step_out ();
/**
* ianjuta_debugger_run_to:
* @obj: Self
* @file: target file name
* @line: target line in file
* @err: Error propagation and reporting.
*
* Execute the currently loaded program until it reachs the target
* line.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean run_to (const gchar* file, gint line);
/**
* ianjuta_debugger_run_from:
* @obj: Self
* @file: target file name
* @line: target line in file
* @err: Error propagation and reporting.
*
* Execute the program from a new position.
* This function is optional.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean run_from (const gchar *file, gint line);
/**
* ianjuta_debugger_exit:
* @obj: Self
* @err: Error propagation and reporting.
*
* Exit from the currently loaded program.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean exit ();
/**
* ianjuta_debugger_interrupt:
* @obj: Self
* @err: Error propagation and reporting.
*
* Interrupt the program currently running.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean interrupt ();
/**
* ianjuta_debugger_inspect:
* @obj: Self
* @name: variable name
* @callback: Callback to call with variable value
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Get back the value of the named variable.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean inspect (const gchar* name, GCharCallback callback, gpointer user_data);
/**
* ianjuta_debugger_evaluate:
* @obj: Self
* @name: variable name
* @value: new variable value
* @callback: Callback to call when the variable has been modified
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Change the value of a variable in the current program.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean evaluate (const gchar* name, const gchar* value, GCharCallback callback, gpointer user_data);
/**
* ianjuta_debugger_print:
* @obj: Self
* @name: variable name
* @callback: Callback to call with variable value
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Display value of a variable, like inspect.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean print (const gchar *variable, GCharCallback callback, gpointer user_data);
/**
* ianjuta_debugger_list_local:
* @obj: Self
* @callback: Callback to call with list of local variable
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Get the list of local variables
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean list_local (GListCallback callback, gpointer user_data);
/**
* ianjuta_debugger_list_argument:
* @obj: Self
* @callback: Callback to call with list of arguments
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Get the list of arguments
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean list_argument (GListCallback callback, gpointer user_data);
/**
* ianjuta_debugger_info_signal:
* @obj: Self
* @callback: Callback to call with list of arguments
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Get some informatin about a signal
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean info_signal (GListCallback callback, gpointer user_data);
/**
* ianjuta_debugger_info_sharedlib:
* @obj: Self
* @callback: Callback to call with list of arguments
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Get information about shared libraries.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean info_sharedlib (GListCallback callback, gpointer user_data);
/**
* ianjuta_debugger_handle_signal:
* @obj: Self
* @name: signal name
* @stop: TRUE if we need to stop signal
* @print: TRUE if we display a message when the signal is emitted
* @ignore: TRUE if we ignore the signal
* @err: Error propagation and reporting.
*
* It defines how to handle signal received by the program.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean handle_signal (const gchar *name, gboolean stop, gboolean print, gboolean ignore);
/**
* ianjuta_debugger_info_frame:
* @obj: Self
* @frame: frame number, the top frame has the number 0
* @callback: Callback to call getting a list of strings with all information
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Get some information about the one stack frame.
* This function has been deprecated and is not used anymore in the
* debugger GUI.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean info_frame (guint frame, GListCallback callback, gpointer user_data);
/**
* ianjuta_debugger_info_args:
* @obj: Self
* @callback: Callback to call getting a list of strings with all information
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Get some informatin about a current functin arguments.
* This function has been deprecated and is not used anymore in the
* debugger GUI.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean info_args (GListCallback callback, gpointer user_data);
/**
* ianjuta_debugger_info_target:
* @obj: Self
* @callback: Callback to call getting a list of strings with all information
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Get back some information about the target
* This function has been deprecated and is not used anymore in the
* debugger GUI.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean info_target (GListCallback callback, gpointer user_data);
/**
* ianjuta_debugger_info_program:
* @obj: Self
* @callback: Callback to call getting a list of strings with all information
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Get some informatin about a current program.
* This function has been deprecated and is not used anymore in the
* debugger GUI.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean info_program (GListCallback callback, gpointer user_data);
/**
* ianjuta_debugger_info_udot:
* @obj: Self
* @callback: Callback to call getting a list of strings with all information
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Get some informatin about OS structures.
* This function has been deprecated and is not used anymore in the
* debugger GUI.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean info_udot (GListCallback callback, gpointer user_data);
/**
* ianjuta_debugger_info_variables:
* @obj: Self
* @callback: Callback to call getting a list of strings with all information
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Get some informatin about variables.
* This function has been deprecated and is not used anymore in the
* debugger GUI.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean info_variables (GListCallback callback, gpointer user_data);
/**
* ianjuta_debugger_list_frame:
* @obj: Self
* @callback: Callback to call getting a list of #IAnjutaDebuggerFrame
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Get the list of frames.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean list_frame (GListCallback callback, gpointer user_data);
/**
* ianjuta_debugger_set_frame:
* @obj: Self
* @frame: frame number
* @err: Error propagation and reporting.
*
* Set the current frame.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean set_frame (guint frame);
/**
* ianjuta_debugger_list_thread:
* @obj: Self
* @callback: Callback to call getting a list of #IAnjutaDebuggerFrame for each thread
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Get the list of threads.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean list_thread (GListCallback callback, gpointer user_data);
/**
* ianjuta_debugger_set_thread:
* @obj: Self
* @thread: thread number
* @err: Error propagation and reporting.
*
* Set the current thread.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean set_thread (gint thread);
/**
* ianjuta_debugger_info_thread:
* @obj: Self
* @thread: thread number
* @callback: Callback to call getting a list of strings with all information
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Get some information about current threads.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean info_thread (gint thread, GListCallback callback, gpointer user_data);
/**
* ianjuta_debugger_send_command:
* @obj: Self
* @command: command
* @err: Error propagation and reporting.
*
* Send a command directly to the debugger. Warning, changing the
* debugger states, by sending a run command by example, will
* probably gives some troubles in the debug manager.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean send_command (const gchar *command);
/**
* ianjuta_debugger_callback:
* @obj: Self
* @callback: Callback to call. the data argument is NULL.
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* All commands are executed asynchronously and give back information
* with callbacks. It is difficult to know when a command is really
* executed. But as all commands are executed in order, you can use
* this command to get a call back when all previous commands have
* been executed.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean callback (Callback callback, gpointer user_data);
/**
* ianjuta_debugger_enable_log:
* @obj: Self
* @log: MessageView used by log
* @err: Error propagation and reporting.
*
* Log all debuggers commands, mainly useful for debugging.
*/
void enable_log (IAnjutaMessageView *log);
/**
* ianjuta_debugger_disable_log:
* @obj: Self
* @err: Error propagation and reporting.
*
* Disable debugger log.
*/
void disable_log ();
/**
* ianjuta_debugger_dump_stack_trace:
* @obj: Self
* @callback: Callback to call getting a list of strings
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Return a stack trace valid for a bug reports.
* This function is optional.
*
* Returns: TRUE if sucessful, otherwise FALSE.
*/
gboolean dump_stack_trace (GListCallback callback, gpointer user_data);
/**
* SECTION:ianjuta-debugger-breakpoint
* @title: IAnjutaDebuggerBreakpoint
* @short_description: Breakpoint Debugger interface
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-debugger-breakpoint.h
*
*/
interface IAnjutaDebuggerBreakpoint
{
/**
* IAnjutaDebuggerBreakpointType:
* @IANJUTA_DEBUGGER_BREAKPOINT_REMOVED: Set for removed breakpoint
* @IANJUTA_DEBUGGER_BREAKPOINT_UPDATED: Set for changed breakpoint
* @IANJUTA_DEBUGGER_BREAKPOINT_ON_LINE: Set on source line
* @IANJUTA_DEBUGGER_BREAKPOINT_ON_ADDRESS: Set on an addresse
* @IANJUTA_DEBUGGER_BREAKPOINT_ON_FUNCTION: Set on a function name
* @IANJUTA_DEBUGGER_BREAKPOINT_ON_READ: Set on read access
* @IANJUTA_DEBUGGER_BREAKPOINT_ON_WRITE: Set on write access
* @IANJUTA_DEBUGGER_BREAKPOINT_WITH_ENABLE: Has enable information
* @IANJUTA_DEBUGGER_BREAKPOINT_WITH_IGNORE: Has ignore information,
* @IANJUTA_DEBUGGER_BREAKPOINT_WITH_TIME: Has counter information
* @IANJUTA_DEBUGGER_BREAKPOINT_WITH_CONDITION: Has a condition
* @IANJUTA_DEBUGGER_BREAKPOINT_WITH_TEMPORARY: Temporary breakpoint, automatically removed when triggered
* @IANJUTA_DEBUGGER_BREAKPOINT_WITH_PENDING: Pending breakpoint
*
* This enumeration defined various characteristics of the breakpoint.
*/
enum Type
{
REMOVED = 1 << 0,
UPDATED = 1 << 17,
ON_LINE = 1 << 1,
ON_ADDRESS = 1 << 2,
ON_FUNCTION = 1 << 3,
ON_READ = 1 << 4,
ON_WRITE = 1 << 5,
WITH_ENABLE = 1 << 16,
WITH_IGNORE = 1 << 15,
WITH_TIME = 1 << 11,
WITH_CONDITION = 1 << 12,
WITH_TEMPORARY = 1 << 13,
WITH_PENDING = 1 << 14,
}
/**
* IAnjutaDebuggerBreakpointItem:
* @type: type see #IAnjutaBreakpointType enumeration
* @id: unique identifier
* @file: source file where is the breakpoint
* @line: corresponding source file line number
* @function: corresponding function name
* @address: corresponding address
* @enable: TRUE if the breakpoint is enabled
* @ignore: TRUE if the breakpoint is ignored
* @times: Count how many time the breakpoint is triggered
* @condition: Additional condition for triggering the breakpoint
* @temporary: TRUE if the breakpoint is temporary
* @pending: TRUE if the breakpoint is pending
*
* This structure keeps all information about a breakpoint.
*/
struct Item
{
gint type;
guint id;
gchar *file;
guint line;
gchar *function;
gulong address;
gboolean enable;
guint ignore;
guint times;
gchar *condition;
gboolean temporary;
gboolean pending;
}
/**
* IAnjutaDebuggerBreakpointMethod:
* @IANJUTA_DEBUGGER_BREAKPOINT_SET_AT_ADDRESS: Allow to set breakpoint on address
* @IANJUTA_DEBUGGER_BREAKPOINT_SET_AT_FUNCTION: Allow to set breakpoint on function name
* @IANJUTA_DEBUGGER_BREAKPOINT_ENABLE: Allow to disable breakpoint
* @IANJUTA_DEBUGGER_BREAKPOINT_IGNORE: Allow to ignore breakpoint
* @IANJUTA_DEBUGGER_BREAKPOINT_CONDITION: Allow to add a condition on breakpoint
*
* Defines which breakpoint characteristics are supported by the debugger
* backend.
*/
enum Method
{
SET_AT_ADDRESS = 1 << 0,
SET_AT_FUNCTION = 1 << 1,
ENABLE = 1 << 2,
IGNORE = 1 << 3,
CONDITION = 1 << 4
}
/**
* IAnjutaDebuggerBreakpointCallback:
* @data: a #IAnjutaBreakpointItem object
* @user_data: user data passed to the function
* @error: error
*
* This callback function is used to return a #IAnjutaBreakpointItem.
*/
typedef void (*Callback) (const Item *data, gpointer user_data, GError* err);
/**
* ianjuta_debugger_breakpoint_implement_breakpoint:
* @obj: Self
* @err: Error propagation and reporting.
*
* Return all implemented methods.
*
* Returns: A OR of #IAnjutaDebuggerBreakpointMethod
* corresponding to all implemented optional methods.
*/
gint implement_breakpoint ();
/**
* ianjuta_debugger_breakpoint_set_breakpoint_at_line:
* @obj: Self
* @file: File containing the breakpoint
* @line: Line number where is the breakpoint
* @callback: Callback to call when the breakpoint has been set
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Set a breakpoint at the specified line in the file.
*
* Returns: TRUE if the request succeed and the callback is called. If
* FALSE, the callback will not be called.
*/
gboolean set_breakpoint_at_line (const gchar* file, guint line, Callback callback, gpointer user_data);
/**
* ianjuta_debugger_breakpoint_set_breakpoint_at_address:
* @obj: Self
* @address: Address of the breakpoint
* @callback: Callback to call when the breakpoint has been set
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Set a breakpoint at the specified address.
* This function is optional.
*
* Returns: TRUE if the request succeed and the callback is called. If
* FALSE, the callback will not be called.
*/
gboolean set_breakpoint_at_address (gulong address, Callback callback, gpointer user_data);
/**
* ianjuta_debugger_breakpoint_set_breakpoint_at_function:
* @obj: Self
* @file: File containing the breakpoint
* @function: Function name where the breakpoint is put
* @callback: Callback to call when the breakpoint has been set
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Set a breakpoint at the beginning of the specified function.
* This function is optional.
*
* Returns: TRUE if the request succeed and the callback is called. If
* FALSE, the callback will not be called.
*/
gboolean set_breakpoint_at_function (const gchar* file, const gchar* function, Callback callback, gpointer user_data);
/**
* ianjuta_debugger_breakpoint_clear_breakpoint:
* @obj: Self
* @id: Breakpoint identification number
* @callback: Callback to call when the breakpoint has been cleared
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Clear a breakpoint put by any set functions. The Id of the breakpoint
* is given in the callback of the set functions.
*
* Returns: TRUE if the request succeed and the callback is called. If
* FALSE, the callback will not be called.
*/
gboolean clear_breakpoint (guint id, Callback callback, gpointer user_data);
/**
* ianjuta_debugger_breakpoint_list_breakpoint:
* @obj: Self
* @callback: Callback to call with the list of #IAnjutaDebuggreBreakpointItem
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* List all breakpoints set in the debugger. It is useful to
* know how many time a breakpoint has been hit.
*
* Returns: TRUE if the request succeed and the callback is called. If
* FALSE, the callback will not be called.
*/
gboolean list_breakpoint (IAnjutaDebuggerGListCallback callback, gpointer user_data);
/**
* ianjuta_debugger_breakpoint_enable_breakpoint:
* @obj: Self
* @id: Breakpoint identification number
* @enable: TRUE to enable the breakpoint, FALSE to disable it
* @callback: Callback to call when the breakpoint has been changed
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Enable of disable a breakpoint. This function is optional.
*
* Returns: TRUE if the request succeed and the callback is called. If
* FALSE, the callback will not be called.
*/
gboolean enable_breakpoint (guint id, gboolean enable, Callback callback, gpointer user_data);
/**
* ianjuta_debugger_breakpoint_ignore_breakpoint:
* @obj: Self
* @id: Breakpoint identification number
* @ignore: Number of time a breakpoint must be ignored
* @callback: Callback to call when the breakpoint has been changed
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* This allow to ignore the breakpoint a number of time before stopping.
* This function is optional.
*
* Returns: TRUE if the request succeed and the callback is called. If
* FALSE, the callback will not be called.
*/
gboolean ignore_breakpoint (guint id, guint ignore, Callback callback, gpointer user_data);
/**
* ianjuta_debugger_breakpoint_condition_breakpoint:
* @obj: Self
* @id: Breakpoint identification number
* @condition: expression that has to be true
* @callback: Callback to call when the breakpoint has been changed
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Add a condition, evaluate in the program context, on the breakpoint,
* the program will stop when it reachs the breakpoint only if the
* condition is true. This function is optional.
*
* Returns: TRUE if the request succeed and the callback is called. If
* FALSE, the callback will not be called.
*/
gboolean condition_breakpoint (guint id, const gchar* condition, Callback callback, gpointer user_data);
}
/**
* SECTION:ianjuta-debugger-variable
* @title: IAnjutaDebuggerVariable
* @short_description: Variables interface for debuggers
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-debugger-variable.h
*
* This interface is used to examine and change values of expression.
* It is based on the MI2 variable object interface of gdb. A
* variable needs to be created before being able to get or set its
* value and list its children.
*/
interface IAnjutaDebuggerVariable
{
/**
* IAnjutaDebuggerVariableObject:
* @name: unique variable object name created by backend
* @expression: corresponding variable name or expression
* @type: variable type
* @value: variable value
* @changed: TRUE if the variable has changed
* @exited: TRUE if the variable is outside current scope
* @deleted: TRUE if the variable has been removed
* @children: Number of variable children, -1 if unknown
* @has_more: TRUE if the children value is wrong
*
* Defines a variable object.
*/
struct Object
{
gchar *name;
gchar *expression;
gchar *type;
gchar *value;
gboolean changed;
gboolean exited;
gboolean deleted;
gint children;
gboolean has_more;
}
/**
* IAnjutaDebuggerVariableCallback:
* @data: a #IAnjutaDebuggerVariableObject object
* @user_data: user data passed to the function
* @error: error
*
* This callback function is used to return a #IAnjutaDebuggerVariableObject.
*/
typedef void (*Callback) (const Object *data, gpointer user_data, GError* err);
/**
* ianjuta_debugger_variable_create:
* @obj: Self
* @expression: Variable expression
* @callback: Callback to call when the variable has been created
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Create a new variable object in the current thread and frame.
*
* Returns: TRUE if the request succeed and the callback is
* called. If FALSE, the callback will not be called.
*/
gboolean create (const gchar *expression, Callback callback, gpointer user_data);
/**
* ianjuta_debugger_variable_list_children:
* @obj: Self
* @name: Variable name
* @from: Starting from this children (zero-based)
* @callback: Callback to call when the children have been
* created with a list of variable objects
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* List and create objects for variable object's children.
* The backend can returns only a part of the children, in
* this case a last variable with a NULL name is added to
* the list given to the callback function.
* If the remaining children are wanted, this
* function must be called again with a from argument
* corresponding to the first missing children.
*
* Returns: TRUE if the request succeed and the callback is
* called. If FALSE, the callback will not be called.
*/
gboolean list_children (const gchar *name, guint from, IAnjutaDebuggerGListCallback callback, gpointer user_data);
/**
* ianjuta_debugger_variable_evaluate:
* @obj: Self
* @name: Variable name
* @callback: Callback to call with the variable value
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Get the value of one variable or child object.
*
* Returns: TRUE if the request succeed and the callback is
* called. If FALSE, the callback will not be called.
*/
gboolean evaluate (const gchar *name, IAnjutaDebuggerGCharCallback callback, gpointer user_data);
/**
* ianjuta_debugger_variable_assign:
* @obj: Self
* @name: Variable name
* @value: Variable value
* @err: Error propagation and reporting.
*
* Set the value of one variable or child object.
*
* Returns: TRUE if the request succeed and the callback is
* called. If FALSE, the callback will not be called.
*/
gboolean assign (const gchar *name, const gchar *value);
/**
* ianjuta_debugger_variable_update:
* @obj: Self
* @callback: Callback to call with the list of all changed
* variable names
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* List all changed variable objects since the last call.
*
* Returns: TRUE if the request succeed and the callback is
* called. If FALSE, the callback will not be called.
*/
gboolean update (IAnjutaDebuggerGListCallback callback, gpointer user_data);
/**
* ianjuta_debugger_variable_destroy:
* @obj: Self
* @name: Variable name
* @err: Error propagation and reporting.
*
* Delete a previously created variable or child object
* including its own children.
*
* Returns: TRUE if the request succeed and the callback is
* called. If FALSE, the callback will not be called.
*/
gboolean destroy (const gchar *name);
}
/**
* SECTION:ianjuta-debugger-register
* @title: IAnjutaDebuggerRegister
* @short_description: Register interface for debuggers
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-debugger-register.h
*
* This interface is used to examine and change values of CPU registers.
*/
interface IAnjutaDebuggerRegister
{
/**
* IAnjutaDebuggerRegisterData:
* @num: register identifier
* @name: register name
* @value: register value
*
* Defines a register data.
*/
struct Data
{
guint num;
gchar *name;
gchar *value;
}
/**
* ianjuta_debugger_register_list_register:
* @obj: Self
* @callback: Callback to call with the #IAnjutaDebuggerRegisterData list
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* List all registers of the target. This function can be called without
* a program loaded, the value field of register structure is not filled.
*
* Returns: TRUE if the request succeed and the callback is
* called. If FALSE, the callback will not be called.
*/
gboolean list_register (IAnjutaDebuggerGListCallback callback, gpointer user_data);
/**
* ianjuta_debugger_register_update_register:
* @obj: Self
* @callback: Callback call with the list of all modified #IAnjutaDebuggerRegisterData
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Return all modified registers since the last call. Only the num and
* value field are used.
*
* Returns: TRUE if the request succeed and the callback is
* called. If FALSE, the callback will not be called.
*/
gboolean update_register (IAnjutaDebuggerGListCallback callback, gpointer user_data);
/**
* ianjuta_debugger_register_write_register:
* @obj: Self
* @value: Modified register with a new value
* @err: Error propagation and reporting.
*
* Change the value of one register. Only the num and value field are used.
*
* Returns: TRUE if the request succeed.
*/
gboolean write_register (Data *value);
}
/**
* SECTION:ianjuta-debugger-memory
* @title: IAnjutaDebuggerMemory
* @short_description: Memory interface for debuggers
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-debugger-memory.h
*
* This interface is used to examine the target memory.
*/
interface IAnjutaDebuggerMemory
{
/**
* IAnjutaDebuggerRegisterMemoryBlock:
* @address: start address of memory block
* @length: size of memory block
* @data: memory block data
*
* Represent a block of memory.
*/
struct Block
{
gulong address;
guint length;
gchar *data;
}
/**
* IAnjutaDebuggerMemoryCallback:
* @data: a #IAnjutaDebuggerMemoryBlock object
* @user_data: user data passed to the function
* @error: error
*
* This callback function is used to return a #IAnjutaDebuggerMemoryBlock.
*/
typedef void (*Callback) (const Block *data, gpointer user_data, GError* err);
/**
* ianjuta_debugger_memory_inspect:
* @obj: Self
* @address: Start address of the memory block
* @length: Length of memory block
* @callback: Call back with a IAnjutaDebuggerMemoryBlock as argument
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Read a block of the target memory.
*
* Returns: TRUE if the request succeed and the callback is
* called. If FALSE, the callback will not be called.
*/
gboolean inspect (gulong address, guint length, Callback callback, gpointer user_data);
}
/**
* SECTION:ianjuta-debugger-instruction
* @title: IAnjutaDebuggerInstruction
* @short_description: Debugger interface for machine instruction
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-debugger-instruction.h
*
* This interface is used to debuger as machine instruction level.
*/
interface IAnjutaDebuggerInstruction
{
/**
* IAnjutaDebuggerInstructionALine:
* @address: Address of the line
* @label: Optional label
* @text: Diassembled instruction on the line
*
* Defines a disassembled line
*/
struct ALine
{
gulong address;
const gchar *label;
const gchar *text;
}
/**
* IAnjutaDebuggerInstructionDisassembly:
* @size: Number of line
* @data: Array of all lines
*
* Represents a block of diassembled instructions
*/
struct Disassembly
{
guint size;
ALine data[];
}
/**
* IAnjutaDebuggerInstructionCallback:
* @data: a #IAnjutaDebuggerInstructionDisassembly object
* @user_data: user data passed to the function
* @error: error
*
* This callback function is used to return a #IAnjutaDebuggerInstructionDisassembly.
*/
typedef void (*Callback) (const Disassembly *data, gpointer user_data, GError* err);
/**
* ianjuta_debugger_instruction_disassemble:
* @obj: Self
* @address: Start address of the memory block
* @length: Length of memory block
* @callback: Call back with a IAnjutaDebuggerInstructionDisassembly as argument
* @user_data: User data that is passed back to the callback
* @err: Error propagation and reporting.
*
* Disassemble a part of the memory
*
* Returns: TRUE if the request succeed and the callback is
* called. If FALSE, the callback will not be called.
*/
gboolean disassemble (gulong address, guint length, Callback callback, gpointer user_data);
/**
* ianjuta_debugger_instruction_step_in_instruction:
* @obj: Self
* @err: Error propagation and reporting.
*
* Execute one assembler instruction in the program.
*
* Returns: TRUE if the request succeed and the callback is called. If
* FALSE, the callback will not be called.
*/
gboolean step_in_instruction ();
/**
* ianjuta_debugger_instruction_step_over_instruction:
* @obj: Self
* @err: Error propagation and reporting.
*
* Execute one assembler instruction in the program, if the instruction
* is a function call, continues until the function returns.
*
* Returns: TRUE if the request succeed and the callback is called. If
* FALSE, the callback will not be called.
*/
gboolean step_over_instruction ();
/**
* ianjuta_debugger_instruction_run_to_address:
* @obj: Self
* @address: Run to this addresss
* @err: Error propagation and reporting.
*
* Start the program until it reachs the address address
*
* Returns: TRUE if the request succeed and the callback is called. If
* FALSE, the callback will not be called.
*/
gboolean run_to_address (gulong address);
/**
* ianjuta_debugger_instruction_run_from_address:
* @obj: Self
* @address: Run from this addresss
* @err: Error propagation and reporting.
*
* Restart the program starting from address address
*
* Returns: TRUE if the request succeed and the callback is called. If
* FALSE, the callback will not be called.
*/
gboolean run_from_address (gulong address);
}
}
/**
* SECTION:ianjuta-debug-manager
* @title: IAnjutaDebugManager
* @short_description: Common graphical interface to all debugger
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-debug-manager.h
*
* This interface wrap the real debugger plugin and provide a
* common graphical user interface.
*/
interface IAnjutaDebugManager
{
#include "ianjuta-debugger.h"
#include "ianjuta-debugger-breakpoint.h"
#include <gio/gio.h>
/* Signals */
/**
* IAnjutaDebugManager::debugger_started:
* @obj: Self
*
* This signal is emitted when the debugger is started.
*/
void ::debugger_started ();
/**
* IAnjutaDebugManager::debugger_stopped:
* @obj: Self
* @err: Error propagation and reporting.
*
* This signal is emitted when the debugger is stopped.
*/
void ::debugger_stopped (GError *err);
/**
* IAnjutaDebugManager::program_loaded:
* @obj: Self
*
* This signal is emitted when a program is loaded most of the
* time just before the first program_stopped signal.
*/
void ::program_loaded ();
/**
* IAnjutaDebugManager::program_unloaded:
* @obj: Self
*
* This signal is emitted when a program is unloaded. If the
* debugger is stopped while a program is loaded, this signal
* is emitted before the debugger_stopped signal.
*/
void ::program_unloaded ();
/**
* IAnjutaDebugManager::program_started:
* @obj: Self
*
* This signal is emitted when the program is started. If the
* program starts and is stopped by the debugger, a program-stopped
* signal will be emitted too. If the program starts is not stopped
* by the debugger a program-running signal will be emitted.
*/
void ::program_started ();
/**
* IAnjutaDebugManager::program_exited:
* @obj: Self
*
* This signal is emitted when the program is unloaded. If the
* debugger is stopped while a program is running or stopped, this
* signal is emitted before the program_unloaded signal.
*/
void ::program_exited ();
/**
* IAnjutaDebugManager::program_stopped:
* @obj: Self
*
* This signal is emitted when the program is stopped.
*/
void ::program_stopped ();
/**
* IAnjutaDebugManager::program_running:
* @obj: Self
*
* This signal is emitted when the program is running.
*/
void ::program_running ();
/**
* IAnjutaDebugManager::sharedlib_event:
* @obj: Self
*
* This signal is emitted when a new shared library is loaded. It
* is useful to try to set pending breakpoints those could be in
* the newly loaded library.
*/
void ::sharedlib_event ();
/**
* IAnjutaDebugManager::program_moved:
* @obj: Self
* @pid: process id, 0 when unknown
* @tid: thread id, 0 when unknown
* @address: program counter address, 0 when unknown
* @file: source file where is the program counter, NULL when unknown
* @line: line number if file name above is not NULL
*
* This signal is emitted when the debugger know the current program
* location. Most of the time, after the program has stopped but it
* could happen even if it is still running.
*/
void ::program_moved (gint pid, gint tid, gulong address, const gchar* file, guint line);
/**
* IAnjutaDebugManager::frame_changed:
* @obj: Self
* @frame: frame
* @thread: thread
*
* This signal is emitted when the current frame is changed. It is
* equal to the top frame in the interrupted thread when the
* program stops but can be changed afterward by the user.
* Several commands use this current frame, by example the register
* window display the register values for the current thread only.
*/
void ::frame_changed (guint frame, gint thread);
/**
* IAnjutaDebugManager::location_changed:
* @obj: Self
* @address: program counter address, 0 when unknown
* @uri: source file where is the program counter, NULL when unknown
* @line: line number if file name above is not NULL
*
* This signal is emitted when the current location is changed. It is
* equal to the program location when the program stops but can be
* changed afterward by the user.
*/
void ::location_changed (gulong address, const gchar* uri, guint line);
/**
* IAnjutaDebugManager::signal_received:
* @obj: Self
* @name: Signal name
* @description: Signal description
*
* This signal is emitted when the debugged program receives a
* unix signal.
*/
void ::signal_received (const gchar* name, const gchar* description);
/**
* IAnjutaDebugManager::breakpoint_changed:
* @obj: Self
* @breakpoint: Breakpoint
* @err: Error propagation and reporting.
*
* This signal is emitted when a breakpoint is changed. It includes
* new breakpoint and deleted breakpoint.
*/
void ::breakpoint_changed (IAnjutaDebuggerBreakpointItem *breakpoint);
/**
* ianjuta_debug_manager_start:
* @obj: Self
* @uri: uri of the target
* @err: Error propagation and reporting.
*
* Start the debugger of the given uri
*
* Returns: TRUE if sucessful, other FALSE.
*/
gboolean start (const gchar *uri);
/**
* ianjuta_debug_manager_start_remote:
* @obj: Self
* @server: server (IP address:port)
* @uri: uri of the local target
* @err: Error propagation and reporting.
*
* Start the debugger of the given uri
*
* Returns: TRUE if sucessful, other FALSE.
*/
gboolean start_remote (const gchar *server, const gchar *uri);
/**
* ianjuta_debug_manager_quit:
* @obj: Self
* @err: Error propagation and reporting.
*
* Quit the debugger, can wait until the debugger is ready.
*
* Returns: TRUE if sucessful, other FALSE.
*/
gboolean quit ();
}
/**
* SECTION:ianjuta-vcs
* @title: IAnjutaVcs
* @short_description: Version control system interface
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-vcs.h
*
*/
interface IAnjutaVcs
{
#include <gio/gio.h>
#include <libanjuta/anjuta-vcs-status.h>
#include <libanjuta/anjuta-async-notify.h>
/**
* IAnjutaVcsError:
* @IANJUTA_VCS_UNKNOWN_ERROR: Unkown error
*
* These enumeration is used to specify errors.
*/
enum Error
{
UNKOWN_ERROR
}
/**
* IAnjutaVcsStatus
* @obj: Self
*
* This signal is emited when the git pull command is finished, and refreshes the tree of files with the new pulled files without the need to
* fold- unfold the tree.
*/
void ::status_changed();
/**
* ianjuta_vcs_add:
* @obj: Self
* @files: (element-type GFile): List of List of files, represented as #Gfile objects, to add
* @notify: #AnjutaAsyncNotify object for finish notification and error
* reporting.
*
* Add files to the VCS repository.
*/
void add(List<GFile*> files, AnjutaAsyncNotify *notify);
/**
* ianjuta_vcs_remove:
* @obj: Self
* @files: (element-type GFile): List of files, represented as #Gfile objects, to remove
* @notify: #AnjutaAsyncNotify object for finish notification and error
* reporting.
*
* Remove files from the VCS repository.
*/
void remove(List<GFile*> files, AnjutaAsyncNotify *notify);
/**
* ianjuta_vcs_checkout:
* @obj: Self
* @repository_location: Location of repository to check out
* @dest: Destination of checked out copy
* @cancel: An optional #GCancellable object to cancel the operation, or NULL
* @notify: #AnjutaAsyncNotify object for finish notification and error
* reporting.
*
* Check out a copy of a code repository.
*/
void checkout(const gchar *repository_location, GFile *dest, GCancellable *cancel, AnjutaAsyncNotify *notify);
/**
* ianjuta_vcs_query_status:
* @obj: Self
* @file: File/directory to query
* @callback: callback to call when data for a particular file is available
* @user_data: User data passed to callback
* @cancel: An optional #GCancellable object to cancel the operation, or NULL
* @notify: #AnjutaAsyncNotify object for finish notification and error
* reporting.
*
* Querys the status of files in the repository.
*/
void query_status (GFile* file, StatusCallback callback, gpointer user_data, GCancellable* cancel, AnjutaAsyncNotify *notify);
/**
* IAnjutaVcsStatusCallback:
* @file: File representing the file for which status is given
* @status: #AnjutaVcsStatus for the file represented by @file.
* @user_data: User data
*
* Callback called for each status record returned by
* ianjuta_vcs_query_status.
*/
typedef void (*StatusCallback) (GFile* file, AnjutaVcsStatus status, gpointer user_data);
/**
* ianjuta_vcs_diff:
* @obj: Self
* @file: File to diff
* @callback: Callback to call when diff data becomes available
* @user_data: User data passed to @callback
* @cancel: An optional #GCancellable object to cancel the operation, or NULL
* @notify: #AnjutaAsyncNotify object for finish notification and error
* reporting.
*
* Generates a unified diff of the file represented by @file.
*/
void diff(GFile* file, DiffCallback callback, gpointer user_data, GCancellable* cancel, AnjutaAsyncNotify *notify);
/**
* IAnjutaVcsDiffCallback:
* @file: File being diffed
* @diff: Diff data
* @user_data: User data
*
* Called when diff data comes from ianjuta_vcs_diff.
*/
typedef void (*DiffCallback) (GFile* file, const gchar* diff, gpointer user_data);
}
/**
* SECTION:ianjuta-snippets-manager
* @title: IAnjutaSnippetsManager
* @short_description: Snippets Manager interface
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-macro.h
*
*/
interface IAnjutaSnippetsManager
{
/**
* ianjuta_snippets_manager_insert:
* @key: Trigger-key of the snippet
* @editing_session: If after inserting the snippet there should be an editing
* session. Mark as FALSE if not interested in the dynamic capabilities of the
* snippet.
* @obj: Self
* @err: Error propagation and reporting
*
* Insert snippet in the current editor.
*/
gboolean insert (const gchar* key, gboolean editing_session);
}
/**
* SECTION:ianjuta-symbol
* @title: IAnjutaSymbol
* @short_description: Source code symbol interface
* @see_also: #IAnjutaSymbolQuery, #IAnjutaSymbolManager
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-symbol.h
*
* This interface is used to define a symbol, normally got from symbol
* queries. A symbol has various fields that can be retrieved by using
* their get methods. A symbol will have only those fields which have
* been selected to be included in their respective queries, so make sure
* the needed fields are correctly specified during query creation.
*/
interface IAnjutaSymbol
{
#include <gdk/gdk.h>
#include <gio/gio.h>
/**
* IAnjutaSymbolType:
* @IANJUTA_SYMBOL_TYPE_NONE: None spedified.
* @IANJUTA_SYMBOL_TYPE_UNDEF: Unknown type.
* @IANJUTA_SYMBOL_TYPE_CLASS: Class declaration
* @IANJUTA_SYMBOL_TYPE_ENUM: Enum declaration
* @IANJUTA_SYMBOL_TYPE_ENUMERATOR: Enumerator value
* @IANJUTA_SYMBOL_TYPE_FIELD: Field (Java only)
* @IANJUTA_SYMBOL_TYPE_FUNCTION: Function definition
* @IANJUTA_SYMBOL_TYPE_INTERFACE: Interface (Java only)
* @IANJUTA_SYMBOL_TYPE_MEMBER: Member variable of class/struct
* @IANJUTA_SYMBOL_TYPE_METHOD: Class method (Java only)
* @IANJUTA_SYMBOL_TYPE_NAMESPACE: Namespace declaration
* @IANJUTA_SYMBOL_TYPE_PACKAGE: Package (Java only)
* @IANJUTA_SYMBOL_TYPE_PROTOTYPE: Function prototype
* @IANJUTA_SYMBOL_TYPE_STRUCT: Struct declaration
* @IANJUTA_SYMBOL_TYPE_TYPEDEF: Typedef
* @IANJUTA_SYMBOL_TYPE_UNION: Union
* @IANJUTA_SYMBOL_TYPE_VARIABLE: Variable
* @IANJUTA_SYMBOL_TYPE_EXTERNVAR: Extern or forward declaration
* @IANJUTA_SYMBOL_TYPE_MACRO: Macro (without arguments)
* @IANJUTA_SYMBOL_TYPE_MACRO_WITH_ARG: Parameterized macro
* @IANJUTA_SYMBOL_TYPE_FILE: File (Pseudo tag)
* @IANJUTA_SYMBOL_TYPE_OTHER: Other (non C/C++/Java tag)
* @IANJUTA_SYMBOL_TYPE_SCOPE_CONTAINER: types which are subjected to create a scope.
* @IANJUTA_SYMBOL_TYPE_MAX: Maximum value, used as end marker.
*/
enum Type
{
TYPE_NONE = 0,
TYPE_UNDEF = 1,
TYPE_CLASS = 2,
TYPE_ENUM = 4,
TYPE_ENUMERATOR = 8,
TYPE_FIELD = 16,
TYPE_FUNCTION = 32,
TYPE_INTERFACE = 64,
TYPE_MEMBER = 128,
TYPE_METHOD = 256,
TYPE_NAMESPACE = 512,
TYPE_PACKAGE = 1024,
TYPE_PROTOTYPE = 2048,
TYPE_STRUCT = 4096,
TYPE_TYPEDEF = 8192,
TYPE_UNION = 16384,
TYPE_VARIABLE = 32768,
TYPE_EXTERNVAR = 65536,
TYPE_MACRO = 131072,
TYPE_MACRO_WITH_ARG = 262144,
TYPE_FILE = 524288,
TYPE_OTHER = 1048576,
TYPE_SCOPE_CONTAINER = IANJUTA_SYMBOL_TYPE_CLASS | IANJUTA_SYMBOL_TYPE_ENUM | IANJUTA_SYMBOL_TYPE_INTERFACE | IANJUTA_SYMBOL_TYPE_NAMESPACE | IANJUTA_SYMBOL_TYPE_PACKAGE | IANJUTA_SYMBOL_TYPE_STRUCT | IANJUTA_SYMBOL_TYPE_UNION,
TYPE_MAX = 2097151
}
/**
* IAnjutaSymbolField:
* @IANJUTA_SYMBOL_FIELD_ID: Integer. A unique ID of the symbol
* @IANJUTA_SYMBOL_FIELD_NAME: String. Name of the symbol
* @IANJUTA_SYMBOL_FIELD_FILE_POS: Integer. The file line number where the symbol is found.
* @IANJUTA_SYMBOL_FIELD_SCOPE_DEF_ID: Integer. A unique ID to define scope created by this symbol.
* @IANJUTA_SYMBOL_FIELD_FILE_SCOPE: Boolean: TRUE if symbol is within file scope,
* otherwise FALSE.
* @IANJUTA_SYMBOL_FIELD_SIGNATURE: String. Signature of a method, if symbol is a funtion.
* Namely, the arguments list of the funtion.
* @IANJUTA_SYMBOL_FIELD_RETURNTYPE: String. Return type of a method, if symbol is a function.
* @IANJUTA_SYMBOL_FIELD_FILE_PATH: String. The relative path to the file where the symbol is found.
* @IANJUTA_SYMBOL_FIELD_PROJECT_NAME: String. The project name to which the symbol belongs to.
* @IANJUTA_SYMBOL_FIELD_PROJECT_VERSION: String. The project version to which the symbol belongs to.
* @IANJUTA_SYMBOL_FIELD_IMPLEMENTATION: String. Implementation attribute of a symbol. It may be
* "pure virtual", "virtual", etc.
* @IANJUTA_SYMBOL_FIELD_ACCESS: String. Access attribute of a symbol.
* It may be "public", "private" etc.
* @IANJUTA_SYMBOL_FIELD_KIND: Kind attribute of a symbol, such as
* "enumerator", "namespace", "class" etc.
* @IANJUTA_SYMBOL_FIELD_TYPE: Both string and Integer. Type attribute of a symbol.
* In string form, it is name of the type in string form.
* In integer form, it is IAnjutaSymbolType enumerator value.
* @IANJUTA_SYMBOL_FIELD_TYPE_NAME: type_name attribute of a symbol.
* If a type could be "class" then its type_name may be "MyFooClass" etc.
* @IANJUTA_SYMBOL_FIELD_IS_CONTAINER: Boolean. TRUE if symbol is
* a scope container, such as namespace, class, struct etc., otherwise
* FALSE.
* @IANJUTA_SYMBOL_FIELD_END: The end marker.
*
* Symbol Fields. Used to define and retrieve results from query. Each of
* these fields are either integer or string. Use the right method to
* retrieve them. That is, for integer use ianjuta_symbol_get_int(),
* for string use ianjuta_symbol_get_string(), and for boolean use
* ianjuta_symbol_get_boolean(). Some fields can be in both forms,
* e.g. #IANJUTA_SYMBOL_FIELD_TYPE.
*/
enum Field
{
FIELD_ID,
FIELD_NAME,
FIELD_FILE_POS,
FILED_SCOPE_DEF_ID,
FIELD_FILE_SCOPE,
FIELD_SIGNATURE,
FIELD_RETURNTYPE,
FIELD_TYPE,
FIELD_TYPE_NAME,
FIELD_FILE_PATH,
FIELD_PROJECT_NAME,
FIELD_PROJECT_VERSION,
FIELD_IMPLEMENTATION,
FIELD_ACCESS,
FIELD_KIND,
FIELD_IS_CONTAINER,
FIELD_END
}
/**
* ianjuta_symbol_get_boolean:
* @obj: Self
* @field: The field to retrieve.
* @err: Error propagation and reporting.
*
* Retreives the boolean value of a boolean @field.
*
* Returns: The boolean
*/
gboolean get_boolean (Field field);
/**
* ianjuta_symbol_get_int:
* @obj: Self
* @field: The field to retrieve.
* @err: Error propagation and reporting.
*
* Retreives the integer value of an integer @field.
*
* Returns: The integer
*/
gint get_int (Field field);
/**
* ianjuta_symbol_get_string:
* @obj: Self
* @field: The field to retrieve.
* @err: Error propagation and reporting.
*
* Retreives the string value of a string @field.
*
* Returns: The string
*/
const gchar* get_string (Field field);
/**
* ianjuta_symbol_get_file:
* @obj: Self
* @err: Error propagation and reporting.
*
* A convenience method to get GFile object for
* #IANJUTA_SYMBOL_FIELD_FILE_PATH field. The file where the
* symbol is declared. It contains the absolute path of the file
* unlike raw value of field #IANJUTA_SYMBOL_FIELD_FILE_PATH.
*
* Returns: A GFile object. It must be unrefed after use.
*/
GFile* get_file();
/**
* ianjuta_symbol_get_sym_type:
* @obj: Self
* @err: Error propagation and reporting.
*
* A convenience method to get value of #IANJUTA_SYMBOL_FIELD_TYPE
* field typecasted to IAnjutaSymbolType. Numerical value is unchanged.
*
* Returns: a #IAnjutaSymbolType
*/
Type get_sym_type ();
/**
* ianjuta_symbol_get_icon:
* @obj: Self
* @err: Error propagation and reporting.
*
* A convenience method to get a small icon (16x16) representing the symbol
* kind. You *need* a query with fields #IANJUTA_SYMBOL_FIELD_ACCESS and
* #IANJUTA_SYMBOL_FIELD_KIND selected.
*
* Returns: a Pixbuf icon representing the symbol. Ref the icon if you
* need to keep it.
*/
const GdkPixbuf *get_icon ();
}
/**
* SECTION:ianjuta-symbol-query
* @title: IAnjutaSymbolQuery
* @short_description: Source code symbol query interface
* @see_also: #IAnjutaSymbolManager, #IAnjutaSymbol
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-symbol-query.h
*
* A query object will have this interface that allows to tweak various
* query parameters. Except for the #IAnjutaSymbolQueryName and
* #IAnjutaSymbolQueryDb parameters, everything else is changable
* post-creation.
*
* Note that chaning a query parameter, except for limit and offset will
* result in re-preparing the query the next time it is executed, so it is
* not advisable to change it each time the query is executed. For such
* cases, create different queries with different parameters.
*
* A query is signified by a name enumeration (#IAnjutaSymbolQueryName) which
* practically determines the query type and its execution condition. Each
* query name is assigned to pre-defined query statement and can only be
* set during creation time. Then only its specific ianjuta_symbol_query_search_*()
* can be used to execute the query. These specific execution methods are
* provided to make it convenient to pass query parameters easily and to
* ensure all the needed parameters are given.
*
* A query can run in different modes, defined by #IAnjutaSymbolQueryMode, by
* default it is executed in synchrounous mode #IANJUTA_SYMBOL_QUERY_MODE_SYNC
* and can be changed using ianjuta_symbol_query_set_mode().
* #IANJUTA_SYMBOL_QUERY_MODE_ASYNC runs it in asynchronous mode in a separate
* thread and can be canceled with ianjuta_symbol_query_cancel().
*
* A query runs on a database, defined by #IAnjutaSymbolQueryDb, and can be
* only selected at creatation time.
*
* In addition, there are many other filters that can be set to the query
* to refine the query results. For example, ianjuta_symbol_query_set_fields()
* is used to set the needed symbol fields to retrieve, ianjuta_symbol_query_set_filters()
* is used to filter the results with symbol types, ianjuta_symbol_query_set_file_scope()
* limits the results to either public or private scope within the source file,
* ianjuta_symbol_query_set_group_by() is used to group the results on a given
* field, ianjuta_symbol_query_set_order_by is used to order the results on a
* given field.
*
* ianjuta_symbol_query_set_limit() and ianjuta_symbol_query_set_offset() are
* used to change limit and offset of the resultset. Note again that these
* parameters do not require re-preparation of query, so can be safely used
* any time without performance hit.
*/
interface IAnjutaSymbolQuery
{
#include "ianjuta-iterable.h"
#include "ianjuta-symbol.h"
/**
* IAnjutaSymbolQueryMode:
* @IANJUTA_SYMBOL_QUERY_MODE_SYNC: Syncronous query. The result is immediately
* available as retrun value of search call.
* @IANJUTA_SYMBOL_QUERY_MODE_ASYNC: Asynchronous query. The search call
* return immediately and result delievered as a signal later. The actual
* query is done in a separate thread.
* @IANJUTA_SYMBOL_QUERY_MODE_QUEUED: If the database is busy
* scanning, then the query is performed later when database is ready.
* It returns NULL and result is delivered through async-result signal.
* Only query can stay queued, so calling search multiple times would
* result in only the last one being active.
*
* This parameter determines the mode of query execution. By default,
* IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected.
*/
enum Mode
{
MODE_SYNC,
MODE_ASYNC,
MODE_QUEUED
}
/**
* IAnjutaSymbolQueryDb:
* @IANJUTA_SYMBOL_QUERY_DB_PROJECT: Select project database.
* @IANJUTA_SYMBOL_QUERY_DB_SYSTEM: Select system database.
*
* Sets the database to use for the query. System database is where
* all system library symbols are found. While project database is where
* currently open project's symbols are found.
*/
enum Db
{
DB_PROJECT,
DB_SYSTEM
}
/**
* IAnjutaSymbolQueryName:
* @IANJUTA_SYMBOL_QUERY_SEARCH: Query to perform basic substring search.
* @IANJUTA_SYMBOL_QUERY_SEARCH_ALL: Query to get all symbols
* @IANJUTA_SYMBOL_QUERY_SEARCH_FILE: Query to perform substring search in a file.
* @IANJUTA_SYMBOL_QUERY_SEARCH_IN_SCOPE: Query to perform substring search in a scope.
* @IANJUTA_SYMBOL_QUERY_SEARCH_ID: Query to find the symbol of given ID.
* @IANJUTA_SYMBOL_QUERY_SEARCH_MEMBERS: Query to find members of a scope (eg. class).
* @IANJUTA_SYMBOL_QUERY_SEARCH_CLASS_PARENTS: Query to get parents of a class.
* @IANJUTA_SYMBOL_QUERY_SEARCH_SCOPE: Query to find scope name of a file position.
* @IANJUTA_SYMBOL_QUERY_SEARCH_PARENT_SCOPE: Query to get the parent scope of a symbol.
* @IANJUTA_SYMBOL_QUERY_SEARCH_PARENT_SCOPE_FILE: Query to get the parent scope of a symbol in the file.
*
* Names of query that defined what kind of query it is.
*/
enum Name
{
SEARCH,
SEARCH_ALL,
SEARCH_FILE,
SEARCH_IN_SCOPE,
SEARCH_ID,
SEARCH_MEMBERS,
SEARCH_CLASS_PARENTS,
SEARCH_SCOPE,
SEARCH_PARENT_SCOPE,
SEARCH_PARENT_SCOPE_FILE
}
/**
* IAnjutaSymbolQueryFileScope:
* @IANJUTA_SYMBOL_QUERY_SEARCH_FS_IGNORE: Ignore file scope
* @IANJUTA_SYMBOL_QUERY_SEARCH_FS_PUBLIC: Only public symbols visible to rest of project.
* @IANJUTA_SYMBOL_QUERY_SEARCH_FS_PRIVATE: Only private symbols visible inside a file.
*
* Defines file scope of symbols to query.
*/
enum FileScope
{
SEARCH_FS_IGNORE,
SEARCH_FS_PUBLIC,
SEARCH_FS_PRIVATE
}
/**
* IAnjutaSymbolQuery::async_result:
* @ianjutasymbolquery: Self
* @arg1: Query result (IAnjutaIterable, IAnjutaSymbol) of an async
* or queued search. NULL if no result is found or some error happened.
*
* This signal is emitted for every search of the Query involved in async
* mode, unless cancled by ianjuta_symbol_query_cancel(). For single queued
* query, only result of the last search is emitted (if it wasn't database
* was busy when search was invoked). Unlike in sync counterpart,
* do not unref @result after use.
*/
void ::async_result (GObject* result);
/**
* ianjuta_symbol_query_set_mode:
* @obj: Self
* @mode: The mode of query.
* @err: Error propagation and reporting.
*
* Sets the mode of Query.
*/
void set_mode (IAnjutaSymbolQueryMode mode);
/**
* ianjuta_symbol_query_set_fields:
* @obj: Self
* @n_fields: Then number of fields to retrieve.
* @fields: The fields to retrieve in the query. The array length must
* be @n_fields.
* @err: Error propagation and reporting.
*
* Sets the fields of Query.
*/
void set_fields (gint n_fields, IAnjutaSymbolField *fields);
/**
* ianjuta_symbol_query_set_filters:
* @obj: Self
* @filters: The mode of query.
* @include_types: TRUE if filter is positive, FALSE if reversed.
* @err: Error propagation and reporting.
*
* Sets the bit mask of symbol type filters. if @include_types is TRUE,
* symbols satisfying the given symbol types are selected, otherwise
* they are excluded.
*/
void set_filters (IAnjutaSymbolType filters, gboolean includes_types);
/**
* ianjuta_symbol_query_set_file_scope:
* @obj: Self
* @filescope_search: The filescope to search.
* @err: Error propagation and reporting.
*
* Sets the filescope search of Query.
*/
void set_file_scope (IAnjutaSymbolQueryFileScope filescope_search);
/**
* ianjuta_symbol_query_set_offset:
* @obj: Self
* @offset: Offset of the resultset.
* @err: Error propagation and reporting.
*
* Sets the offset index of Query results.
*/
void set_offset (gint offset);
/**
* ianjuta_symbol_query_set_limit:
* @obj: Self
* @limit: The limit of query.
* @err: Error propagation and reporting.
*
* Sets the limit of Query results. No more than @limit results are
* returned.
*/
void set_limit (gint limit);
/**
* ianjuta_symbol_query_set_group_by:
* @obj: Self
* @field: The field to group results.
* @err: Error propagation and reporting.
*
* Sets the field with which result of query is grouped. As a result
* there will be no duplicates of with this field.
*/
void set_group_by (IAnjutaSymbolField field);
/**
* ianjuta_symbol_query_set_order_by:
* @obj: Self
* @field: The field to order the result.
* @err: Error propagation and reporting.
*
* Sets the field with which result of query is ordered.
*/
void set_order_by (IAnjutaSymbolField field);
/**
* ianjuta_symbol_query_set_cancel:
* @obj: Self
* @err: Error propagation and reporting.
*
* Cancels any pending non-sync searches. After calling this, it is
* guaranteed that "async-result" will not be called any more for any
* past searches. New searches will have their results signaled as
* normal.
*/
void cancel ();
/**
* ianjuta_symbol_query_search:
* @obj: Self
* @pattern: Search pattern in compliance with SQL LIKE syntax
* @err: Error propagation and reporting.
*
* Executes #IANJUTA_SYMBOL_QUERY_SEARCH query.
*/
IAnjutaIterable* search (const gchar *pattern);
/**
* ianjuta_symbol_query_search_all:
* @obj: Self
* @err: Error propagation and reporting.
*
* Executes #IANJUTA_SYMBOL_QUERY_SEARCH_ALL query.
*/
IAnjutaIterable* search_all ();
/**
* ianjuta_symbol_query_search_file:
* @obj: Self
* @pattern: Search pattern in compliance with SQL LIKE syntax
* @file: The file whose symbols are searched.
* @err: Error propagation and reporting.
*
* Executes #IANJUTA_SYMBOL_QUERY_SEARCH_FILE query.
*/
IAnjutaIterable* search_file (const gchar *pattern, const GFile *file);
/**
* ianjuta_symbol_query_search_in_scope:
* @obj: Self
* @pattern: Search pattern in compliance with SQL LIKE syntax
* @scope: The scope inside which symbols are searched.
* @err: Error propagation and reporting.
*
* Executes #IANJUTA_SYMBOL_QUERY_SEARCH_IN_SCOPE query.
*/
IAnjutaIterable* search_in_scope (const gchar *pattern, IAnjutaSymbol *scope);
/**
* ianjuta_symbol_query_search_members:
* @obj: Self
* @symbol: The symbol whose members to get.
* @err: Error propagation and reporting.
*
* Executes #IANJUTA_SYMBOL_QUERY_SEARCH_MEMBERS query.
*/
IAnjutaIterable* search_members (IAnjutaSymbol *symbol);
/**
* ianjuta_symbol_query_search_class_parents:
* @obj: Self
* @symbol: The class symbol whose parents to get.
* @err: Error propagation and reporting.
*
* Executes #IANJUTA_SYMBOL_QUERY_SEARCH_CLASS_PARENTS query.
*/
IAnjutaIterable* search_class_parents (IAnjutaSymbol *symbol);
/**
* ianjuta_symbol_query_search_id:
* @obj: Self
* @symbol: The symbol id whose details to get.
* @err: Error propagation and reporting.
*
* Executes #IANJUTA_SYMBOL_QUERY_SEARCH_ID query.
*/
IAnjutaIterable* search_id (gint symbol_id);
/**
* ianjuta_symbol_query_search_scope:
* @obj: Self
* @file_path: The file where the scope is.
* @line: The line where the scope is.
* @err: Error propagation and reporting.
*
* Executes #IANJUTA_SYMBOL_QUERY_SEARCH_SCOPE query.
*/
IAnjutaIterable* search_scope (const gchar *file_path, gint line);
/**
* ianjuta_symbol_query_search_parent_scope:
* @obj: Self
* @symbol: The symbol whose parent scope is to be found.
* @err: Error propagation and reporting.
*
* Executes #IANJUTA_SYMBOL_QUERY_SEARCH_PARENT_SCOPE query.
*/
IAnjutaIterable* search_parent_scope (IAnjutaSymbol *symbol);
/**
* ianjuta_symbol_query_search_parent_scope_file:
* @symbol: The symbol whose parent scope is to be found.
* @obj: Self
* @file_path: The file where the parent scope is to be found.
* @err: Error propagation and reporting.
*
* Executes #IANJUTA_SYMBOL_QUERY_SEARCH_PARENT_SCOPE_FILE query.
*/
IAnjutaIterable* search_parent_scope_file (IAnjutaSymbol *symbol, const gchar *file_path);
}
/**
* SECTION:ianjuta-symbol-manager
* @title: IAnjutaSymbolManager
* @short_description: Source code symbols manager inteface
* @see_also: #IAnjutaSymbol
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-symbol-manager.h
*
*/
interface IAnjutaSymbolManager
{
#include <libanjuta/anjuta-async-notify.h>
#include "ianjuta-iterable.h"
#include "ianjuta-symbol.h"
#include "ianjuta-symbol-query.h"
/**
* IAnjutaSymbolManager::prj_scan_end:
* @obj: Self
*
* This signal is emitted when a scanning of one or more files on project db
* ends.
*/
void ::prj_scan_end (gint process_id);
/**
* IAnjutaSymbolManager::sys_scan_end:
* @obj: Self
*
* This signal is emitted when a scanning of one or more packages on system db
* ends. This signal doesn't mean that all the scan process for the packages
* is ended, but that just one (or more) is (are).
*/
void ::sys_scan_end (gint process_id);
/**
* ianjuta_symbol_manager_create_query:
* @obj: Self
* @name: Name of the query. It decides what query type it is.
* @db: The database to use.
* @err: Error propagation and reporting.
*
* Create a query object. By default only #IANJUTA_SYMBOL_FIELD_ID and
* and #IANJUTA_SYMBOL_FIELD_NAME are selected, limit is set to infinity,
* offset is set to 0, no filters are set and mode is set to
* #IANJUTA_SYMBOL_QUERY_MODE_SYNC.
*
* Returns: A #IAnjutaSymbolQuery object
*/
IAnjutaSymbolQuery* create_query (IAnjutaSymbolQueryName name, IAnjutaSymbolQueryDb db);
/**
* ianjuta_symbol_manager_add_package:
* @obj: Self
* @pkg_name: Name of the package to scan. Should be the name given by
* pkg-config. The colon char must be avoided.
* @pkg_version: Version of the package. The colon char must be avoided.
* or by the language implementation (Python, Javascript, etc.)
* @files: A list of GFile's to scan for this package
*
* Reads the package files into the database asynchronously.
*
* Returns: TRUE if the package will be loaded into the db, FALSE if the package
* already exists
*/
gboolean add_package (const gchar* pkg_name, const gchar* pkg_version, GList* files);
/**
* ianjuta_symbol_manager_activate_package:
* @obj: Self
* @pkg_name: Name of the package to activate. The colon char must be avoided.
* @pkg_version: Version of the package. The colon char must be avoided.
*
* Activates the package for searches in the global symbol database.
*
* Returns: TRUE if the package was loaded (or will be loaded once scanned).
* FALSE if the version given was newer than the version in the database or the
* package was not found. In this case, add_package() should be called.
*/
gboolean activate_package (const gchar *pkg_name, const gchar* pkg_version);
/**
* ianjuta_symbol_manager_deactivate_package:
* @obj: Self
* @pkg_name: name of the package. The colon char must be avoided.
* @pkg_version: Version of the package. The colon char must be avoided.
*
* Deactivates the package if it was found. If package is NULL, deactivate all
* packages.
*
*/
void deactivate_package (const gchar* pkg_name, const gchar* pkg_version);
/**
* ianjuta_symbol_manager_deactivate_all:
* @obj: Self
*
* Deactivates all activate packages
*
*/
void deactivate_all ();
}
/**
* SECTION:ianjuta-print
* @title: IAnjutaPrint
* @short_description: Print interface
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-print.h
*
*/
interface IAnjutaPrint
{
/**
* ianjuta_print_print:
* @obj: Self
* @err: Error propagation and reporting.
*
* Print the plugin (the file in case of the editor). In most cases this will show
* a print dialog
*/
void print();
/**
* ianjuta_print_print:
* @obj: Self
* @err: Error propagation and reporting.
*
* Show print preview dialog
*/
void print_preview();
}
/**
* SECTION:ianjuta-preferences
* @title: IAnjutaPreferences
* @short_description: Preferences interface
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-preferences
*
*/
interface IAnjutaPreferences
{
#include <libanjuta/anjuta-preferences.h>
/**
* ianjuta_preferences_merge:
* @obj: Self
* @prefs: AnjutaPreferences to install to
* @err: Error propagation and reporting.
*
* When called, the plugin should install it's preferences
*/
void merge(AnjutaPreferences* prefs);
/**
* ianjuta_preferences_unmerge:
* @obj: Self
* @prefs: AnjutaPreferences to install to
* @err: Error propagation and reporting.
*
* When called, the plugin should uninstall it's preferences
*/
void unmerge(AnjutaPreferences* prefs);
}
/**
* SECTION:ianjuta-plugin-factory
* @title: IAnjutaPluginFactory
* @short_description: Create Anjuta plugin objects
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-plugin-factory.h
*
* This interface is used to create all Anjuta plugin objects. It is
* already implemented inside Anjuta by an object able to load plugins written
* in C. In order to load plugins in other languages (or in a different way),
* a loader plugin implementing this interface must be written first, probably
* in C.
*/
interface IAnjutaPluginFactory
{
#include <libanjuta/anjuta-plugin.h>
#include <libanjuta/anjuta-shell.h>
#include <libanjuta/anjuta-plugin-handle.h>
/**
* IAnjutaPluginFactoryError:
* @IANJUTA_PLUGIN_FACTORY_MISSING_LOCATION: Module file location is
* missing in .plugin file
* @IANJUTA_PLUGIN_FACTORY_MISSING_TYPE: Plugin type (just after
* double colon following location) is missing in .plugin file
* @IANJUTA_PLUGIN_FACTORY_MISSING_MODULE: Module file name not found,
* plugin module is probably not installed
* @IANJUTA_PLUGIN_FACTORY_INVALID_MODULE: Module file cannot be
* loaded, not a shared library perhaps
* @IANJUTA_PLUGIN_FACTORY_MISSING_FUNCTION: Module does not contain
* registration function, library is not an anjuta plugin or
* is not for the right version
* @IANJUTA_PLUGIN_FACTORY_INVALID_TYPE: Module has not registered
* plugin type, library is not an anjuta plugin or not for
* the right version
* @IANJUTA_PLUGIN_FACTORY_UNKNOWN_ERROR: Another error
*
* These enumeration is used to specify errors.
*/
enum Error
{
OK = 0,
MISSING_LOCATION,
MISSING_TYPE,
MISSING_MODULE,
INVALID_MODULE,
MISSING_FUNCTION,
INVALID_TYPE,
UNKNOWN_ERROR,
}
/**
* ianjuta_plugin_factory_new_plugin:
* @obj: Self
* @handle: Plugin information
* @shell: Anjuta shell
* @err: Error propagation and reporting.
*
* Create a new AnjutaPlugin object from the plugin information handle,
* give it the AnjutaShell object as argument.
*
* Return value: a new plugin object
*/
AnjutaPlugin* new_plugin (AnjutaPluginHandle* handle, AnjutaShell *shell);
}
/**
* SECTION:ianjuta-language
* @title: IAnjutaLanguage
* @short_description: Interface to manage multiple programming languages
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-language.h
*
*/
interface IAnjutaLanguage
{
#include <libanjuta/interfaces/ianjuta-editor-language.h>
typedef gint Id;
/**
* ianjuta_language_from_mime_type:
* @obj: Self
* @mime_type: A mime type to get the language for
*
* Returns: A language Id or 0 in case no language was found
*/
Id get_from_mime_type (const gchar* mime_type);
/**
* ianjuta_language_from_string:
* @obj: Self
* @string: A string representation of the language. Note that multiple
* strings may describe the language like C++ and Cpp
*
* Returns: A language Id or 0 in case no language was found
*/
Id get_from_string (const gchar* string);
/**
* ianjuta_language_get_name:
* @obj: Self
* @id: A valid language id
*
* Returns: The main name of the language. When you call ianjuta_language_from_string()
* before that method the string you get here might be different to the one you passed
* because the language might have multiple string representations
*/
const gchar* get_name(Id id);
/**
* ianjuta_language_get_make_target:
* @obj: Self
* @id: A valid language id
*
* Returns: The suffix for the file thats needs to be passed to
* make to compile the file, e.g. ".o" for C
*/
const gchar* get_make_target (Id id);
/**
* ianjuta_language_get_strings:
* @obj: Self
* @id: A valid language id
*
* Returns: (element-type utf8): A list of strings that represent this language
*/
List<const gchar*> get_strings(Id id);
/**
* ianjuta_language_get_mime_types:
* @obj: Self
* @id: A valid language id
*
* Returns: (element-type utf8): A list of mime-types that represent this language
*/
List<const gchar*> get_mime_types(Id id);
/**
* ianjuta_language_get_from_editor:
* @obj: Self
* @editor: An object implementing IAnjutaEditorLanguage
* @err: Error propagation
*
* Conviniece method to get the id directly from the editor
*
* Returns: A valid language id or 0
*/
IAnjutaLanguageId get_from_editor (IAnjutaEditorLanguage* editor);
/**
* ianjuta_language_get_name_from_editor:
* @obj: Self
* @editor: An object implementing IAnjutaEditorLanguage
* @err: Error propagation
*
* Conviniece method to get the name directly from the editor
*
* Returns: A language name or NULL
*/
const gchar* get_name_from_editor (IAnjutaEditorLanguage* editor);
/**
* ianjuta_language_get_languages:
* @obj: Self
* @err: Error propagation
*
* Returns: (element-type int) (transfer container): a list of ids of the available
* languages. Use GPOINTER_TO_INT() to receive them. The list but not the
* values should be free'd with g_list_free()
*/
GList* get_languages ();
}
/**
* SECTION:ianjuta-indenter
* @title: IAnjutaIndenter
* @short_description: Interface for automatic indentation
* @see_also:
* @stability: Unstable
* @include: libanjuta/interfaces/ianjuta-indenter.h
*
*/
interface IAnjutaIndenter
{
#include <libanjuta/interfaces/ianjuta-iterable.h>
/**
* ianjuta_indenter_indent
* @obj: Self
* @start: Start of the area to indent
* @end: End of the area to indent
* @error: Error propagation
*
* Indent the area between @start and @end according to the indentation rules
* of the programming language. Usually implemented by language support plugins.
* Only one indenter can be loaded at a time.
* Note: Indenters always affect full lines, so start and end will be moved
* according to the next line start/end.
*/
void indent (IAnjutaIterable* start, IAnjutaIterable* end);
}
|