/usr/share/doc/gnat-4.6-doc/gnat_ugn.html is in gnat-4.6-doc 4.6.3-1ubuntu3.
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 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359 9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520 9521 9522 9523 9524 9525 9526 9527 9528 9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 9548 9549 9550 9551 9552 9553 9554 9555 9556 9557 9558 9559 9560 9561 9562 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580 9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595 9596 9597 9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626 9627 9628 9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 9733 9734 9735 9736 9737 9738 9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749 9750 9751 9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 9879 9880 9881 9882 9883 9884 9885 9886 9887 9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928 9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969 9970 9971 9972 9973 9974 9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999 10000 10001 10002 10003 10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037 10038 10039 10040 10041 10042 10043 10044 10045 10046 10047 10048 10049 10050 10051 10052 10053 10054 10055 10056 10057 10058 10059 10060 10061 10062 10063 10064 10065 10066 10067 10068 10069 10070 10071 10072 10073 10074 10075 10076 10077 10078 10079 10080 10081 10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136 10137 10138 10139 10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160 10161 10162 10163 10164 10165 10166 10167 10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183 10184 10185 10186 10187 10188 10189 10190 10191 10192 10193 10194 10195 10196 10197 10198 10199 10200 10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230 10231 10232 10233 10234 10235 10236 10237 10238 10239 10240 10241 10242 10243 10244 10245 10246 10247 10248 10249 10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339 10340 10341 10342 10343 10344 10345 10346 10347 10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 10380 10381 10382 10383 10384 10385 10386 10387 10388 10389 10390 10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414 10415 10416 10417 10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500 10501 10502 10503 10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549 10550 10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 10570 10571 10572 10573 10574 10575 10576 10577 10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588 10589 10590 10591 10592 10593 10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 10611 10612 10613 10614 10615 10616 10617 10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652 10653 10654 10655 10656 10657 10658 10659 10660 10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 10706 10707 10708 10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733 10734 10735 10736 10737 10738 10739 10740 10741 10742 10743 10744 10745 10746 10747 10748 10749 10750 10751 10752 10753 10754 10755 10756 10757 10758 10759 10760 10761 10762 10763 10764 10765 10766 10767 10768 10769 10770 10771 10772 10773 10774 10775 10776 10777 10778 10779 10780 10781 10782 10783 10784 10785 10786 10787 10788 10789 10790 10791 10792 10793 10794 10795 10796 10797 10798 10799 10800 10801 10802 10803 10804 10805 10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851 10852 10853 10854 10855 10856 10857 10858 10859 10860 10861 10862 10863 10864 10865 10866 10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 10884 10885 10886 10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897 10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937 10938 10939 10940 10941 10942 10943 10944 10945 10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956 10957 10958 10959 10960 10961 10962 10963 10964 10965 10966 10967 10968 10969 10970 10971 10972 10973 10974 10975 10976 10977 10978 10979 10980 10981 10982 10983 10984 10985 10986 10987 10988 10989 10990 10991 10992 10993 10994 10995 10996 10997 10998 10999 11000 11001 11002 11003 11004 11005 11006 11007 11008 11009 11010 11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027 11028 11029 11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044 11045 11046 11047 11048 11049 11050 11051 11052 11053 11054 11055 11056 11057 11058 11059 11060 11061 11062 11063 11064 11065 11066 11067 11068 11069 11070 11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085 11086 11087 11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127 11128 11129 11130 11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148 11149 11150 11151 11152 11153 11154 11155 11156 11157 11158 11159 11160 11161 11162 11163 11164 11165 11166 11167 11168 11169 11170 11171 11172 11173 11174 11175 11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197 11198 11199 11200 11201 11202 11203 11204 11205 11206 11207 11208 11209 11210 11211 11212 11213 11214 11215 11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264 11265 11266 11267 11268 11269 11270 11271 11272 11273 11274 11275 11276 11277 11278 11279 11280 11281 11282 11283 11284 11285 11286 11287 11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301 11302 11303 11304 11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320 11321 11322 11323 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333 11334 11335 11336 11337 11338 11339 11340 11341 11342 11343 11344 11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362 11363 11364 11365 11366 11367 11368 11369 11370 11371 11372 11373 11374 11375 11376 11377 11378 11379 11380 11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409 11410 11411 11412 11413 11414 11415 11416 11417 11418 11419 11420 11421 11422 11423 11424 11425 11426 11427 11428 11429 11430 11431 11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 11451 11452 11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475 11476 11477 11478 11479 11480 11481 11482 11483 11484 11485 11486 11487 11488 11489 11490 11491 11492 11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510 11511 11512 11513 11514 11515 11516 11517 11518 11519 11520 11521 11522 11523 11524 11525 11526 11527 11528 11529 11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540 11541 11542 11543 11544 11545 11546 11547 11548 11549 11550 11551 11552 11553 11554 11555 11556 11557 11558 11559 11560 11561 11562 11563 11564 11565 11566 11567 11568 11569 11570 11571 11572 11573 11574 11575 11576 11577 11578 11579 11580 11581 11582 11583 11584 11585 11586 11587 11588 11589 11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638 11639 11640 11641 11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663 11664 11665 11666 11667 11668 11669 11670 11671 11672 11673 11674 11675 11676 11677 11678 11679 11680 11681 11682 11683 11684 11685 11686 11687 11688 11689 11690 11691 11692 11693 11694 11695 11696 11697 11698 11699 11700 11701 11702 11703 11704 11705 11706 11707 11708 11709 11710 11711 11712 11713 11714 11715 11716 11717 11718 11719 11720 11721 11722 11723 11724 11725 11726 11727 11728 11729 11730 11731 11732 11733 11734 11735 11736 11737 11738 11739 11740 11741 11742 11743 11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754 11755 11756 11757 11758 11759 11760 11761 11762 11763 11764 11765 11766 11767 11768 11769 11770 11771 11772 11773 11774 11775 11776 11777 11778 11779 11780 11781 11782 11783 11784 11785 11786 11787 11788 11789 11790 11791 11792 11793 11794 11795 11796 11797 11798 11799 11800 11801 11802 11803 11804 11805 11806 11807 11808 11809 11810 11811 11812 11813 11814 11815 11816 11817 11818 11819 11820 11821 11822 11823 11824 11825 11826 11827 11828 11829 11830 11831 11832 11833 11834 11835 11836 11837 11838 11839 11840 11841 11842 11843 11844 11845 11846 11847 11848 11849 11850 11851 11852 11853 11854 11855 11856 11857 11858 11859 11860 11861 11862 11863 11864 11865 11866 11867 11868 11869 11870 11871 11872 11873 11874 11875 11876 11877 11878 11879 11880 11881 11882 11883 11884 11885 11886 11887 11888 11889 11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900 11901 11902 11903 11904 11905 11906 11907 11908 11909 11910 11911 11912 11913 11914 11915 11916 11917 11918 11919 11920 11921 11922 11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962 11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976 11977 11978 11979 11980 11981 11982 11983 11984 11985 11986 11987 11988 11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002 12003 12004 12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015 12016 12017 12018 12019 12020 12021 12022 12023 12024 12025 12026 12027 12028 12029 12030 12031 12032 12033 12034 12035 12036 12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058 12059 12060 12061 12062 12063 12064 12065 12066 12067 12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078 12079 12080 12081 12082 12083 12084 12085 12086 12087 12088 12089 12090 12091 12092 12093 12094 12095 12096 12097 12098 12099 12100 12101 12102 12103 12104 12105 12106 12107 12108 12109 12110 12111 12112 12113 12114 12115 12116 12117 12118 12119 12120 12121 12122 12123 12124 12125 12126 12127 12128 12129 12130 12131 12132 12133 12134 12135 12136 12137 12138 12139 12140 12141 12142 12143 12144 12145 12146 12147 12148 12149 12150 12151 12152 12153 12154 12155 12156 12157 12158 12159 12160 12161 12162 12163 12164 12165 12166 12167 12168 12169 12170 12171 12172 12173 12174 12175 12176 12177 12178 12179 12180 12181 12182 12183 12184 12185 12186 12187 12188 12189 12190 12191 12192 12193 12194 12195 12196 12197 12198 12199 12200 12201 12202 12203 12204 12205 12206 12207 12208 12209 12210 12211 12212 12213 12214 12215 12216 12217 12218 12219 12220 12221 12222 12223 12224 12225 12226 12227 12228 12229 12230 12231 12232 12233 12234 12235 12236 12237 12238 12239 12240 12241 12242 12243 12244 12245 12246 12247 12248 12249 12250 12251 12252 12253 12254 12255 12256 12257 12258 12259 12260 12261 12262 12263 12264 12265 12266 12267 12268 12269 12270 12271 12272 12273 12274 12275 12276 12277 12278 12279 12280 12281 12282 12283 12284 12285 12286 12287 12288 12289 12290 12291 12292 12293 12294 12295 12296 12297 12298 12299 12300 12301 12302 12303 12304 12305 12306 12307 12308 12309 12310 12311 12312 12313 12314 12315 12316 12317 12318 12319 12320 12321 12322 12323 12324 12325 12326 12327 12328 12329 12330 12331 12332 12333 12334 12335 12336 12337 12338 12339 12340 12341 12342 12343 12344 12345 12346 12347 12348 12349 12350 12351 12352 12353 12354 12355 12356 12357 12358 12359 12360 12361 12362 12363 12364 12365 12366 12367 12368 12369 12370 12371 12372 12373 12374 12375 12376 12377 12378 12379 12380 12381 12382 12383 12384 12385 12386 12387 12388 12389 12390 12391 12392 12393 12394 12395 12396 12397 12398 12399 12400 12401 12402 12403 12404 12405 12406 12407 12408 12409 12410 12411 12412 12413 12414 12415 12416 12417 12418 12419 12420 12421 12422 12423 12424 12425 12426 12427 12428 12429 12430 12431 12432 12433 12434 12435 12436 12437 12438 12439 12440 12441 12442 12443 12444 12445 12446 12447 12448 12449 12450 12451 12452 12453 12454 12455 12456 12457 12458 12459 12460 12461 12462 12463 12464 12465 12466 12467 12468 12469 12470 12471 12472 12473 12474 12475 12476 12477 12478 12479 12480 12481 12482 12483 12484 12485 12486 12487 12488 12489 12490 12491 12492 12493 12494 12495 12496 12497 12498 12499 12500 12501 12502 12503 12504 12505 12506 12507 12508 12509 12510 12511 12512 12513 12514 12515 12516 12517 12518 12519 12520 12521 12522 12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 12542 12543 12544 12545 12546 12547 12548 12549 12550 12551 12552 12553 12554 12555 12556 12557 12558 12559 12560 12561 12562 12563 12564 12565 12566 12567 12568 12569 12570 12571 12572 12573 12574 12575 12576 12577 12578 12579 12580 12581 12582 12583 12584 12585 12586 12587 12588 12589 12590 12591 12592 12593 12594 12595 12596 12597 12598 12599 12600 12601 12602 12603 12604 12605 12606 12607 12608 12609 12610 12611 12612 12613 12614 12615 12616 12617 12618 12619 12620 12621 12622 12623 12624 12625 12626 12627 12628 12629 12630 12631 12632 12633 12634 12635 12636 12637 12638 12639 12640 12641 12642 12643 12644 12645 12646 12647 12648 12649 12650 12651 12652 12653 12654 12655 12656 12657 12658 12659 12660 12661 12662 12663 12664 12665 12666 12667 12668 12669 12670 12671 12672 12673 12674 12675 12676 12677 12678 12679 12680 12681 12682 12683 12684 12685 12686 12687 12688 12689 12690 12691 12692 12693 12694 12695 12696 12697 12698 12699 12700 12701 12702 12703 12704 12705 12706 12707 12708 12709 12710 12711 12712 12713 12714 12715 12716 12717 12718 12719 12720 12721 12722 12723 12724 12725 12726 12727 12728 12729 12730 12731 12732 12733 12734 12735 12736 12737 12738 12739 12740 12741 12742 12743 12744 12745 12746 12747 12748 12749 12750 12751 12752 12753 12754 12755 12756 12757 12758 12759 12760 12761 12762 12763 12764 12765 12766 12767 12768 12769 12770 12771 12772 12773 12774 12775 12776 12777 12778 12779 12780 12781 12782 12783 12784 12785 12786 12787 12788 12789 12790 12791 12792 12793 12794 12795 12796 12797 12798 12799 12800 12801 12802 12803 12804 12805 12806 12807 12808 12809 12810 12811 12812 12813 12814 12815 12816 12817 12818 12819 12820 12821 12822 12823 12824 12825 12826 12827 12828 12829 12830 12831 12832 12833 12834 12835 12836 12837 12838 12839 12840 12841 12842 12843 12844 12845 12846 12847 12848 12849 12850 12851 12852 12853 12854 12855 12856 12857 12858 12859 12860 12861 12862 12863 12864 12865 12866 12867 12868 12869 12870 12871 12872 12873 12874 12875 12876 12877 12878 12879 12880 12881 12882 12883 12884 12885 12886 12887 12888 12889 12890 12891 12892 12893 12894 12895 12896 12897 12898 12899 12900 12901 12902 12903 12904 12905 12906 12907 12908 12909 12910 12911 12912 12913 12914 12915 12916 12917 12918 12919 12920 12921 12922 12923 12924 12925 12926 12927 12928 12929 12930 12931 12932 12933 12934 12935 12936 12937 12938 12939 12940 12941 12942 12943 12944 12945 12946 12947 12948 12949 12950 12951 12952 12953 12954 12955 12956 12957 12958 12959 12960 12961 12962 12963 12964 12965 12966 12967 12968 12969 12970 12971 12972 12973 12974 12975 12976 12977 12978 12979 12980 12981 12982 12983 12984 12985 12986 12987 12988 12989 12990 12991 12992 12993 12994 12995 12996 12997 12998 12999 13000 13001 13002 13003 13004 13005 13006 13007 13008 13009 13010 13011 13012 13013 13014 13015 13016 13017 13018 13019 13020 13021 13022 13023 13024 13025 13026 13027 13028 13029 13030 13031 13032 13033 13034 13035 13036 13037 13038 13039 13040 13041 13042 13043 13044 13045 13046 13047 13048 13049 13050 13051 13052 13053 13054 13055 13056 13057 13058 13059 13060 13061 13062 13063 13064 13065 13066 13067 13068 13069 13070 13071 13072 13073 13074 13075 13076 13077 13078 13079 13080 13081 13082 13083 13084 13085 13086 13087 13088 13089 13090 13091 13092 13093 13094 13095 13096 13097 13098 13099 13100 13101 13102 13103 13104 13105 13106 13107 13108 13109 13110 13111 13112 13113 13114 13115 13116 13117 13118 13119 13120 13121 13122 13123 13124 13125 13126 13127 13128 13129 13130 13131 13132 13133 13134 13135 13136 13137 13138 13139 13140 13141 13142 13143 13144 13145 13146 13147 13148 13149 13150 13151 13152 13153 13154 13155 13156 13157 13158 13159 13160 13161 13162 13163 13164 13165 13166 13167 13168 13169 13170 13171 13172 13173 13174 13175 13176 13177 13178 13179 13180 13181 13182 13183 13184 13185 13186 13187 13188 13189 13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202 13203 13204 13205 13206 13207 13208 13209 13210 13211 13212 13213 13214 13215 13216 13217 13218 13219 13220 13221 13222 13223 13224 13225 13226 13227 13228 13229 13230 13231 13232 13233 13234 13235 13236 13237 13238 13239 13240 13241 13242 13243 13244 13245 13246 13247 13248 13249 13250 13251 13252 13253 13254 13255 13256 13257 13258 13259 13260 13261 13262 13263 13264 13265 13266 13267 13268 13269 13270 13271 13272 13273 13274 13275 13276 13277 13278 13279 13280 13281 13282 13283 13284 13285 13286 13287 13288 13289 13290 13291 13292 13293 13294 13295 13296 13297 13298 13299 13300 13301 13302 13303 13304 13305 13306 13307 13308 13309 13310 13311 13312 13313 13314 13315 13316 13317 13318 13319 13320 13321 13322 13323 13324 13325 13326 13327 13328 13329 13330 13331 13332 13333 13334 13335 13336 13337 13338 13339 13340 13341 13342 13343 13344 13345 13346 13347 13348 13349 13350 13351 13352 13353 13354 13355 13356 13357 13358 13359 13360 13361 13362 13363 13364 13365 13366 13367 13368 13369 13370 13371 13372 13373 13374 13375 13376 13377 13378 13379 13380 13381 13382 13383 13384 13385 13386 13387 13388 13389 13390 13391 13392 13393 13394 13395 13396 13397 13398 13399 13400 13401 13402 13403 13404 13405 13406 13407 13408 13409 13410 13411 13412 13413 13414 13415 13416 13417 13418 13419 13420 13421 13422 13423 13424 13425 13426 13427 13428 13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 13451 13452 13453 13454 13455 13456 13457 13458 13459 13460 13461 13462 13463 13464 13465 13466 13467 13468 13469 13470 13471 13472 13473 13474 13475 13476 13477 13478 13479 13480 13481 13482 13483 13484 13485 13486 13487 13488 13489 13490 13491 13492 13493 13494 13495 13496 13497 13498 13499 13500 13501 13502 13503 13504 13505 13506 13507 13508 13509 13510 13511 13512 13513 13514 13515 13516 13517 13518 13519 13520 13521 13522 13523 13524 13525 13526 13527 13528 13529 13530 13531 13532 13533 13534 13535 13536 13537 13538 13539 13540 13541 13542 13543 13544 13545 13546 13547 13548 13549 13550 13551 13552 13553 13554 13555 13556 13557 13558 13559 13560 13561 13562 13563 13564 13565 13566 13567 13568 13569 13570 13571 13572 13573 13574 13575 13576 13577 13578 13579 13580 13581 13582 13583 13584 13585 13586 13587 13588 13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 13610 13611 13612 13613 13614 13615 13616 13617 13618 13619 13620 13621 13622 13623 13624 13625 13626 13627 13628 13629 13630 13631 13632 13633 13634 13635 13636 13637 13638 13639 13640 13641 13642 13643 13644 13645 13646 13647 13648 13649 13650 13651 13652 13653 13654 13655 13656 13657 13658 13659 13660 13661 13662 13663 13664 13665 13666 13667 13668 13669 13670 13671 13672 13673 13674 13675 13676 13677 13678 13679 13680 13681 13682 13683 13684 13685 13686 13687 13688 13689 13690 13691 13692 13693 13694 13695 13696 13697 13698 13699 13700 13701 13702 13703 13704 13705 13706 13707 13708 13709 13710 13711 13712 13713 13714 13715 13716 13717 13718 13719 13720 13721 13722 13723 13724 13725 13726 13727 13728 13729 13730 13731 13732 13733 13734 13735 13736 13737 13738 13739 13740 13741 13742 13743 13744 13745 13746 13747 13748 13749 13750 13751 13752 13753 13754 13755 13756 13757 13758 13759 13760 13761 13762 13763 13764 13765 13766 13767 13768 13769 13770 13771 13772 13773 13774 13775 13776 13777 13778 13779 13780 13781 13782 13783 13784 13785 13786 13787 13788 13789 13790 13791 13792 13793 13794 13795 13796 13797 13798 13799 13800 13801 13802 13803 13804 13805 13806 13807 13808 13809 13810 13811 13812 13813 13814 13815 13816 13817 13818 13819 13820 13821 13822 13823 13824 13825 13826 13827 13828 13829 13830 13831 13832 13833 13834 13835 13836 13837 13838 13839 13840 13841 13842 13843 13844 13845 13846 13847 13848 13849 13850 13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 13871 13872 13873 13874 13875 13876 13877 13878 13879 13880 13881 13882 13883 13884 13885 13886 13887 13888 13889 13890 13891 13892 13893 13894 13895 13896 13897 13898 13899 13900 13901 13902 13903 13904 13905 13906 13907 13908 13909 13910 13911 13912 13913 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 13931 13932 13933 13934 13935 13936 13937 13938 13939 13940 13941 13942 13943 13944 13945 13946 13947 13948 13949 13950 13951 13952 13953 13954 13955 13956 13957 13958 13959 13960 13961 13962 13963 13964 13965 13966 13967 13968 13969 13970 13971 13972 13973 13974 13975 13976 13977 13978 13979 13980 13981 13982 13983 13984 13985 13986 13987 13988 13989 13990 13991 13992 13993 13994 13995 13996 13997 13998 13999 14000 14001 14002 14003 14004 14005 14006 14007 14008 14009 14010 14011 14012 14013 14014 14015 14016 14017 14018 14019 14020 14021 14022 14023 14024 14025 14026 14027 14028 14029 14030 14031 14032 14033 14034 14035 14036 14037 14038 14039 14040 14041 14042 14043 14044 14045 14046 14047 14048 14049 14050 14051 14052 14053 14054 14055 14056 14057 14058 14059 14060 14061 14062 14063 14064 14065 14066 14067 14068 14069 14070 14071 14072 14073 14074 14075 14076 14077 14078 14079 14080 14081 14082 14083 14084 14085 14086 14087 14088 14089 14090 14091 14092 14093 14094 14095 14096 14097 14098 14099 14100 14101 14102 14103 14104 14105 14106 14107 14108 14109 14110 14111 14112 14113 14114 14115 14116 14117 14118 14119 14120 14121 14122 14123 14124 14125 14126 14127 14128 14129 14130 14131 14132 14133 14134 14135 14136 14137 14138 14139 14140 14141 14142 14143 14144 14145 14146 14147 14148 14149 14150 14151 14152 14153 14154 14155 14156 14157 14158 14159 14160 14161 14162 14163 14164 14165 14166 14167 14168 14169 14170 14171 14172 14173 14174 14175 14176 14177 14178 14179 14180 14181 14182 14183 14184 14185 14186 14187 14188 14189 14190 14191 14192 14193 14194 14195 14196 14197 14198 14199 14200 14201 14202 14203 14204 14205 14206 14207 14208 14209 14210 14211 14212 14213 14214 14215 14216 14217 14218 14219 14220 14221 14222 14223 14224 14225 14226 14227 14228 14229 14230 14231 14232 14233 14234 14235 14236 14237 14238 14239 14240 14241 14242 14243 14244 14245 14246 14247 14248 14249 14250 14251 14252 14253 14254 14255 14256 14257 14258 14259 14260 14261 14262 14263 14264 14265 14266 14267 14268 14269 14270 14271 14272 14273 14274 14275 14276 14277 14278 14279 14280 14281 14282 14283 14284 14285 14286 14287 14288 14289 14290 14291 14292 14293 14294 14295 14296 14297 14298 14299 14300 14301 14302 14303 14304 14305 14306 14307 14308 14309 14310 14311 14312 14313 14314 14315 14316 14317 14318 14319 14320 14321 14322 14323 14324 14325 14326 14327 14328 14329 14330 14331 14332 14333 14334 14335 14336 14337 14338 14339 14340 14341 14342 14343 14344 14345 14346 14347 14348 14349 14350 14351 14352 14353 14354 14355 14356 14357 14358 14359 14360 14361 14362 14363 14364 14365 14366 14367 14368 14369 14370 14371 14372 14373 14374 14375 14376 14377 14378 14379 14380 14381 14382 14383 14384 14385 14386 14387 14388 14389 14390 14391 14392 14393 14394 14395 14396 14397 14398 14399 14400 14401 14402 14403 14404 14405 14406 14407 14408 14409 14410 14411 14412 14413 14414 14415 14416 14417 14418 14419 14420 14421 14422 14423 14424 14425 14426 14427 14428 14429 14430 14431 14432 14433 14434 14435 14436 14437 14438 14439 14440 14441 14442 14443 14444 14445 14446 14447 14448 14449 14450 14451 14452 14453 14454 14455 14456 14457 14458 14459 14460 14461 14462 14463 14464 14465 14466 14467 14468 14469 14470 14471 14472 14473 14474 14475 14476 14477 14478 14479 14480 14481 14482 14483 14484 14485 14486 14487 14488 14489 14490 14491 14492 14493 14494 14495 14496 14497 14498 14499 14500 14501 14502 14503 14504 14505 14506 14507 14508 14509 14510 14511 14512 14513 14514 14515 14516 14517 14518 14519 14520 14521 14522 14523 14524 14525 14526 14527 14528 14529 14530 14531 14532 14533 14534 14535 14536 14537 14538 14539 14540 14541 14542 14543 14544 14545 14546 14547 14548 14549 14550 14551 14552 14553 14554 14555 14556 14557 14558 14559 14560 14561 14562 14563 14564 14565 14566 14567 14568 14569 14570 14571 14572 14573 14574 14575 14576 14577 14578 14579 14580 14581 14582 14583 14584 14585 14586 14587 14588 14589 14590 14591 14592 14593 14594 14595 14596 14597 14598 14599 14600 14601 14602 14603 14604 14605 14606 14607 14608 14609 14610 14611 14612 14613 14614 14615 14616 14617 14618 14619 14620 14621 14622 14623 14624 14625 14626 14627 14628 14629 14630 14631 14632 14633 14634 14635 14636 14637 14638 14639 14640 14641 14642 14643 14644 14645 14646 14647 14648 14649 14650 14651 14652 14653 14654 14655 14656 14657 14658 14659 14660 14661 14662 14663 14664 14665 14666 14667 14668 14669 14670 14671 14672 14673 14674 14675 14676 14677 14678 14679 14680 14681 14682 14683 14684 14685 14686 14687 14688 14689 14690 14691 14692 14693 14694 14695 14696 14697 14698 14699 14700 14701 14702 14703 14704 14705 14706 14707 14708 14709 14710 14711 14712 14713 14714 14715 14716 14717 14718 14719 14720 14721 14722 14723 14724 14725 14726 14727 14728 14729 14730 14731 14732 14733 14734 14735 14736 14737 14738 14739 14740 14741 14742 14743 14744 14745 14746 14747 14748 14749 14750 14751 14752 14753 14754 14755 14756 14757 14758 14759 14760 14761 14762 14763 14764 14765 14766 14767 14768 14769 14770 14771 14772 14773 14774 14775 14776 14777 14778 14779 14780 14781 14782 14783 14784 14785 14786 14787 14788 14789 14790 14791 14792 14793 14794 14795 14796 14797 14798 14799 14800 14801 14802 14803 14804 14805 14806 14807 14808 14809 14810 14811 14812 14813 14814 14815 14816 14817 14818 14819 14820 14821 14822 14823 14824 14825 14826 14827 14828 14829 14830 14831 14832 14833 14834 14835 14836 14837 14838 14839 14840 14841 14842 14843 14844 14845 14846 14847 14848 14849 14850 14851 14852 14853 14854 14855 14856 14857 14858 14859 14860 14861 14862 14863 14864 14865 14866 14867 14868 14869 14870 14871 14872 14873 14874 14875 14876 14877 14878 14879 14880 14881 14882 14883 14884 14885 14886 14887 14888 14889 14890 14891 14892 14893 14894 14895 14896 14897 14898 14899 14900 14901 14902 14903 14904 14905 14906 14907 14908 14909 14910 14911 14912 14913 14914 14915 14916 14917 14918 14919 14920 14921 14922 14923 14924 14925 14926 14927 14928 14929 14930 14931 14932 14933 14934 14935 14936 14937 14938 14939 14940 14941 14942 14943 14944 14945 14946 14947 14948 14949 14950 14951 14952 14953 14954 14955 14956 14957 14958 14959 14960 14961 14962 14963 14964 14965 14966 14967 14968 14969 14970 14971 14972 14973 14974 14975 14976 14977 14978 14979 14980 14981 14982 14983 14984 14985 14986 14987 14988 14989 14990 14991 14992 14993 14994 14995 14996 14997 14998 14999 15000 15001 15002 15003 15004 15005 15006 15007 15008 15009 15010 15011 15012 15013 15014 15015 15016 15017 15018 15019 15020 15021 15022 15023 15024 15025 15026 15027 15028 15029 15030 15031 15032 15033 15034 15035 15036 15037 15038 15039 15040 15041 15042 15043 15044 15045 15046 15047 15048 15049 15050 15051 15052 15053 15054 15055 15056 15057 15058 15059 15060 15061 15062 15063 15064 15065 15066 15067 15068 15069 15070 15071 15072 15073 15074 15075 15076 15077 15078 15079 15080 15081 15082 15083 15084 15085 15086 15087 15088 15089 15090 15091 15092 15093 15094 15095 15096 15097 15098 15099 15100 15101 15102 15103 15104 15105 15106 15107 15108 15109 15110 15111 15112 15113 15114 15115 15116 15117 15118 15119 15120 15121 15122 15123 15124 15125 15126 15127 15128 15129 15130 15131 15132 15133 15134 15135 15136 15137 15138 15139 15140 15141 15142 15143 15144 15145 15146 15147 15148 15149 15150 15151 15152 15153 15154 15155 15156 15157 15158 15159 15160 15161 15162 15163 15164 15165 15166 15167 15168 15169 15170 15171 15172 15173 15174 15175 15176 15177 15178 15179 15180 15181 15182 15183 15184 15185 15186 15187 15188 15189 15190 15191 15192 15193 15194 15195 15196 15197 15198 15199 15200 15201 15202 15203 15204 15205 15206 15207 15208 15209 15210 15211 15212 15213 15214 15215 15216 15217 15218 15219 15220 15221 15222 15223 15224 15225 15226 15227 15228 15229 15230 15231 15232 15233 15234 15235 15236 15237 15238 15239 15240 15241 15242 15243 15244 15245 15246 15247 15248 15249 15250 15251 15252 15253 15254 15255 15256 15257 15258 15259 15260 15261 15262 15263 15264 15265 15266 15267 15268 15269 15270 15271 15272 15273 15274 15275 15276 15277 15278 15279 15280 15281 15282 15283 15284 15285 15286 15287 15288 15289 15290 15291 15292 15293 15294 15295 15296 15297 15298 15299 15300 15301 15302 15303 15304 15305 15306 15307 15308 15309 15310 15311 15312 15313 15314 15315 15316 15317 15318 15319 15320 15321 15322 15323 15324 15325 15326 15327 15328 15329 15330 15331 15332 15333 15334 15335 15336 15337 15338 15339 15340 15341 15342 15343 15344 15345 15346 15347 15348 15349 15350 15351 15352 15353 15354 15355 15356 15357 15358 15359 15360 15361 15362 15363 15364 15365 15366 15367 15368 15369 15370 15371 15372 15373 15374 15375 15376 15377 15378 15379 15380 15381 15382 15383 15384 15385 15386 15387 15388 15389 15390 15391 15392 15393 15394 15395 15396 15397 15398 15399 15400 15401 15402 15403 15404 15405 15406 15407 15408 15409 15410 15411 15412 15413 15414 15415 15416 15417 15418 15419 15420 15421 15422 15423 15424 15425 15426 15427 15428 15429 15430 15431 15432 15433 15434 15435 15436 15437 15438 15439 15440 15441 15442 15443 15444 15445 15446 15447 15448 15449 15450 15451 15452 15453 15454 15455 15456 15457 15458 15459 15460 15461 15462 15463 15464 15465 15466 15467 15468 15469 15470 15471 15472 15473 15474 15475 15476 15477 15478 15479 15480 15481 15482 15483 15484 15485 15486 15487 15488 15489 15490 15491 15492 15493 15494 15495 15496 15497 15498 15499 15500 15501 15502 15503 15504 15505 15506 15507 15508 15509 15510 15511 15512 15513 15514 15515 15516 15517 15518 15519 15520 15521 15522 15523 15524 15525 15526 15527 15528 15529 15530 15531 15532 15533 15534 15535 15536 15537 15538 15539 15540 15541 15542 15543 15544 15545 15546 15547 15548 15549 15550 15551 15552 15553 15554 15555 15556 15557 15558 15559 15560 15561 15562 15563 15564 15565 15566 15567 15568 15569 15570 15571 15572 15573 15574 15575 15576 15577 15578 15579 15580 15581 15582 15583 15584 15585 15586 15587 15588 15589 15590 15591 15592 15593 15594 15595 15596 15597 15598 15599 15600 15601 15602 15603 15604 15605 15606 15607 15608 15609 15610 15611 15612 15613 15614 15615 15616 15617 15618 15619 15620 15621 15622 15623 15624 15625 15626 15627 15628 15629 15630 15631 15632 15633 15634 15635 15636 15637 15638 15639 15640 15641 15642 15643 15644 15645 15646 15647 15648 15649 15650 15651 15652 15653 15654 15655 15656 15657 15658 15659 15660 15661 15662 15663 15664 15665 15666 15667 15668 15669 15670 15671 15672 15673 15674 15675 15676 15677 15678 15679 15680 15681 15682 15683 15684 15685 15686 15687 15688 15689 15690 15691 15692 15693 15694 15695 15696 15697 15698 15699 15700 15701 15702 15703 15704 15705 15706 15707 15708 15709 15710 15711 15712 15713 15714 15715 15716 15717 15718 15719 15720 15721 15722 15723 15724 15725 15726 15727 15728 15729 15730 15731 15732 15733 15734 15735 15736 15737 15738 15739 15740 15741 15742 15743 15744 15745 15746 15747 15748 15749 15750 15751 15752 15753 15754 15755 15756 15757 15758 15759 15760 15761 15762 15763 15764 15765 15766 15767 15768 15769 15770 15771 15772 15773 15774 15775 15776 15777 15778 15779 15780 15781 15782 15783 15784 15785 15786 15787 15788 15789 15790 15791 15792 15793 15794 15795 15796 15797 15798 15799 15800 15801 15802 15803 15804 15805 15806 15807 15808 15809 15810 15811 15812 15813 15814 15815 15816 15817 15818 15819 15820 15821 15822 15823 15824 15825 15826 15827 15828 15829 15830 15831 15832 15833 15834 15835 15836 15837 15838 15839 15840 15841 15842 15843 15844 15845 15846 15847 15848 15849 15850 15851 15852 15853 15854 15855 15856 15857 15858 15859 15860 15861 15862 15863 15864 15865 15866 15867 15868 15869 15870 15871 15872 15873 15874 15875 15876 15877 15878 15879 15880 15881 15882 15883 15884 15885 15886 15887 15888 15889 15890 15891 15892 15893 15894 15895 15896 15897 15898 15899 15900 15901 15902 15903 15904 15905 15906 15907 15908 15909 15910 15911 15912 15913 15914 15915 15916 15917 15918 15919 15920 15921 15922 15923 15924 15925 15926 15927 15928 15929 15930 15931 15932 15933 15934 15935 15936 15937 15938 15939 15940 15941 15942 15943 15944 15945 15946 15947 15948 15949 15950 15951 15952 15953 15954 15955 15956 15957 15958 15959 15960 15961 15962 15963 15964 15965 15966 15967 15968 15969 15970 15971 15972 15973 15974 15975 15976 15977 15978 15979 15980 15981 15982 15983 15984 15985 15986 15987 15988 15989 15990 15991 15992 15993 15994 15995 15996 15997 15998 15999 16000 16001 16002 16003 16004 16005 16006 16007 16008 16009 16010 16011 16012 16013 16014 16015 16016 16017 16018 16019 16020 16021 16022 16023 16024 16025 16026 16027 16028 16029 16030 16031 16032 16033 16034 16035 16036 16037 16038 16039 16040 16041 16042 16043 16044 16045 16046 16047 16048 16049 16050 16051 16052 16053 16054 16055 16056 16057 16058 16059 16060 16061 16062 16063 16064 16065 16066 16067 16068 16069 16070 16071 16072 16073 16074 16075 16076 16077 16078 16079 16080 16081 16082 16083 16084 16085 16086 16087 16088 16089 16090 16091 16092 16093 16094 16095 16096 16097 16098 16099 16100 16101 16102 16103 16104 16105 16106 16107 16108 16109 16110 16111 16112 16113 16114 16115 16116 16117 16118 16119 16120 16121 16122 16123 16124 16125 16126 16127 16128 16129 16130 16131 16132 16133 16134 16135 16136 16137 16138 16139 16140 16141 16142 16143 16144 16145 16146 16147 16148 16149 16150 16151 16152 16153 16154 16155 16156 16157 16158 16159 16160 16161 16162 16163 16164 16165 16166 16167 16168 16169 16170 16171 16172 16173 16174 16175 16176 16177 16178 16179 16180 16181 16182 16183 16184 16185 16186 16187 16188 16189 16190 16191 16192 16193 16194 16195 16196 16197 16198 16199 16200 16201 16202 16203 16204 16205 16206 16207 16208 16209 16210 16211 16212 16213 16214 16215 16216 16217 16218 16219 16220 16221 16222 16223 16224 16225 16226 16227 16228 16229 16230 16231 16232 16233 16234 16235 16236 16237 16238 16239 16240 16241 16242 16243 16244 16245 16246 16247 16248 16249 16250 16251 16252 16253 16254 16255 16256 16257 16258 16259 16260 16261 16262 16263 16264 16265 16266 16267 16268 16269 16270 16271 16272 16273 16274 16275 16276 16277 16278 16279 16280 16281 16282 16283 16284 16285 16286 16287 16288 16289 16290 16291 16292 16293 16294 16295 16296 16297 16298 16299 16300 16301 16302 16303 16304 16305 16306 16307 16308 16309 16310 16311 16312 16313 16314 16315 16316 16317 16318 16319 16320 16321 16322 16323 16324 16325 16326 16327 16328 16329 16330 16331 16332 16333 16334 16335 16336 16337 16338 16339 16340 16341 16342 16343 16344 16345 16346 16347 16348 16349 16350 16351 16352 16353 16354 16355 16356 16357 16358 16359 16360 16361 16362 16363 16364 16365 16366 16367 16368 16369 16370 16371 16372 16373 16374 16375 16376 16377 16378 16379 16380 16381 16382 16383 16384 16385 16386 16387 16388 16389 16390 16391 16392 16393 16394 16395 16396 16397 16398 16399 16400 16401 16402 16403 16404 16405 16406 16407 16408 16409 16410 16411 16412 16413 16414 16415 16416 16417 16418 16419 16420 16421 16422 16423 16424 16425 16426 16427 16428 16429 16430 16431 16432 16433 16434 16435 16436 16437 16438 16439 16440 16441 16442 16443 16444 16445 16446 16447 16448 16449 16450 16451 16452 16453 16454 16455 16456 16457 16458 16459 16460 16461 16462 16463 16464 16465 16466 16467 16468 16469 16470 16471 16472 16473 16474 16475 16476 16477 16478 16479 16480 16481 16482 16483 16484 16485 16486 16487 16488 16489 16490 16491 16492 16493 16494 16495 16496 16497 16498 16499 16500 16501 16502 16503 16504 16505 16506 16507 16508 16509 16510 16511 16512 16513 16514 16515 16516 16517 16518 16519 16520 16521 16522 16523 16524 16525 16526 16527 16528 16529 16530 16531 16532 16533 16534 16535 16536 16537 16538 16539 16540 16541 16542 16543 16544 16545 16546 16547 16548 16549 16550 16551 16552 16553 16554 16555 16556 16557 16558 16559 16560 16561 16562 16563 16564 16565 16566 16567 16568 16569 16570 16571 16572 16573 16574 16575 16576 16577 16578 16579 16580 16581 16582 16583 16584 16585 16586 16587 16588 16589 16590 16591 16592 16593 16594 16595 16596 16597 16598 16599 16600 16601 16602 16603 16604 16605 16606 16607 16608 16609 16610 16611 16612 16613 16614 16615 16616 16617 16618 16619 16620 16621 16622 16623 16624 16625 16626 16627 16628 16629 16630 16631 16632 16633 16634 16635 16636 16637 16638 16639 16640 16641 16642 16643 16644 16645 16646 16647 16648 16649 16650 16651 16652 16653 16654 16655 16656 16657 16658 16659 16660 16661 16662 16663 16664 16665 16666 16667 16668 16669 16670 16671 16672 16673 16674 16675 16676 16677 16678 16679 16680 16681 16682 16683 16684 16685 16686 16687 16688 16689 16690 16691 16692 16693 16694 16695 16696 16697 16698 16699 16700 16701 16702 16703 16704 16705 16706 16707 16708 16709 16710 16711 16712 16713 16714 16715 16716 16717 16718 16719 16720 16721 16722 16723 16724 16725 16726 16727 16728 16729 16730 16731 16732 16733 16734 16735 16736 16737 16738 16739 16740 16741 16742 16743 16744 16745 16746 16747 16748 16749 16750 16751 16752 16753 16754 16755 16756 16757 16758 16759 16760 16761 16762 16763 16764 16765 16766 16767 16768 16769 16770 16771 16772 16773 16774 16775 16776 16777 16778 16779 16780 16781 16782 16783 16784 16785 16786 16787 16788 16789 16790 16791 16792 16793 16794 16795 16796 16797 16798 16799 16800 16801 16802 16803 16804 16805 16806 16807 16808 16809 16810 16811 16812 16813 16814 16815 16816 16817 16818 16819 16820 16821 16822 16823 16824 16825 16826 16827 16828 16829 16830 16831 16832 16833 16834 16835 16836 16837 16838 16839 16840 16841 16842 16843 16844 16845 16846 16847 16848 16849 16850 16851 16852 16853 16854 16855 16856 16857 16858 16859 16860 16861 16862 16863 16864 16865 16866 16867 16868 16869 16870 16871 16872 16873 16874 16875 16876 16877 16878 16879 16880 16881 16882 16883 16884 16885 16886 16887 16888 16889 16890 16891 16892 16893 16894 16895 16896 16897 16898 16899 16900 16901 16902 16903 16904 16905 16906 16907 16908 16909 16910 16911 16912 16913 16914 16915 16916 16917 16918 16919 16920 16921 16922 16923 16924 16925 16926 16927 16928 16929 16930 16931 16932 16933 16934 16935 16936 16937 16938 16939 16940 16941 16942 16943 16944 16945 16946 16947 16948 16949 16950 16951 16952 16953 16954 16955 16956 16957 16958 16959 16960 16961 16962 16963 16964 16965 16966 16967 16968 16969 16970 16971 16972 16973 16974 16975 16976 16977 16978 16979 16980 16981 16982 16983 16984 16985 16986 16987 16988 16989 16990 16991 16992 16993 16994 16995 16996 16997 16998 16999 17000 17001 17002 17003 17004 17005 17006 17007 17008 17009 17010 17011 17012 17013 17014 17015 17016 17017 17018 17019 17020 17021 17022 17023 17024 17025 17026 17027 17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043 17044 17045 17046 17047 17048 17049 17050 17051 17052 17053 17054 17055 17056 17057 17058 17059 17060 17061 17062 17063 17064 17065 17066 17067 17068 17069 17070 17071 17072 17073 17074 17075 17076 17077 17078 17079 17080 17081 17082 17083 17084 17085 17086 17087 17088 17089 17090 17091 17092 17093 17094 17095 17096 17097 17098 17099 17100 17101 17102 17103 17104 17105 17106 17107 17108 17109 17110 17111 17112 17113 17114 17115 17116 17117 17118 17119 17120 17121 17122 17123 17124 17125 17126 17127 17128 17129 17130 17131 17132 17133 17134 17135 17136 17137 17138 17139 17140 17141 17142 17143 17144 17145 17146 17147 17148 17149 17150 17151 17152 17153 17154 17155 17156 17157 17158 17159 17160 17161 17162 17163 17164 17165 17166 17167 17168 17169 17170 17171 17172 17173 17174 17175 17176 17177 17178 17179 17180 17181 17182 17183 17184 17185 17186 17187 17188 17189 17190 17191 17192 17193 17194 17195 17196 17197 17198 17199 17200 17201 17202 17203 17204 17205 17206 17207 17208 17209 17210 17211 17212 17213 17214 17215 17216 17217 17218 17219 17220 17221 17222 17223 17224 17225 17226 17227 17228 17229 17230 17231 17232 17233 17234 17235 17236 17237 17238 17239 17240 17241 17242 17243 17244 17245 17246 17247 17248 17249 17250 17251 17252 17253 17254 17255 17256 17257 17258 17259 17260 17261 17262 17263 17264 17265 17266 17267 17268 17269 17270 17271 17272 17273 17274 17275 17276 17277 17278 17279 17280 17281 17282 17283 17284 17285 17286 17287 17288 17289 17290 17291 17292 17293 17294 17295 17296 17297 17298 17299 17300 17301 17302 17303 17304 17305 17306 17307 17308 17309 17310 17311 17312 17313 17314 17315 17316 17317 17318 17319 17320 17321 17322 17323 17324 17325 17326 17327 17328 17329 17330 17331 17332 17333 17334 17335 17336 17337 17338 17339 17340 17341 17342 17343 17344 17345 17346 17347 17348 17349 17350 17351 17352 17353 17354 17355 17356 17357 17358 17359 17360 17361 17362 17363 17364 17365 17366 17367 17368 17369 17370 17371 17372 17373 17374 17375 17376 17377 17378 17379 17380 17381 17382 17383 17384 17385 17386 17387 17388 17389 17390 17391 17392 17393 17394 17395 17396 17397 17398 17399 17400 17401 17402 17403 17404 17405 17406 17407 17408 17409 17410 17411 17412 17413 17414 17415 17416 17417 17418 17419 17420 17421 17422 17423 17424 17425 17426 17427 17428 17429 17430 17431 17432 17433 17434 17435 17436 17437 17438 17439 17440 17441 17442 17443 17444 17445 17446 17447 17448 17449 17450 17451 17452 17453 17454 17455 17456 17457 17458 17459 17460 17461 17462 17463 17464 17465 17466 17467 17468 17469 17470 17471 17472 17473 17474 17475 17476 17477 17478 17479 17480 17481 17482 17483 17484 17485 17486 17487 17488 17489 17490 17491 17492 17493 17494 17495 17496 17497 17498 17499 17500 17501 17502 17503 17504 17505 17506 17507 17508 17509 17510 17511 17512 17513 17514 17515 17516 17517 17518 17519 17520 17521 17522 17523 17524 17525 17526 17527 17528 17529 17530 17531 17532 17533 17534 17535 17536 17537 17538 17539 17540 17541 17542 17543 17544 17545 17546 17547 17548 17549 17550 17551 17552 17553 17554 17555 17556 17557 17558 17559 17560 17561 17562 17563 17564 17565 17566 17567 17568 17569 17570 17571 17572 17573 17574 17575 17576 17577 17578 17579 17580 17581 17582 17583 17584 17585 17586 17587 17588 17589 17590 17591 17592 17593 17594 17595 17596 17597 17598 17599 17600 17601 17602 17603 17604 17605 17606 17607 17608 17609 17610 17611 17612 17613 17614 17615 17616 17617 17618 17619 17620 17621 17622 17623 17624 17625 17626 17627 17628 17629 17630 17631 17632 17633 17634 17635 17636 17637 17638 17639 17640 17641 17642 17643 17644 17645 17646 17647 17648 17649 17650 17651 17652 17653 17654 17655 17656 17657 17658 17659 17660 17661 17662 17663 17664 17665 17666 17667 17668 17669 17670 17671 17672 17673 17674 17675 17676 17677 17678 17679 17680 17681 17682 17683 17684 17685 17686 17687 17688 17689 17690 17691 17692 17693 17694 17695 17696 17697 17698 17699 17700 17701 17702 17703 17704 17705 17706 17707 17708 17709 17710 17711 17712 17713 17714 17715 17716 17717 17718 17719 17720 17721 17722 17723 17724 17725 17726 17727 17728 17729 17730 17731 17732 17733 17734 17735 17736 17737 17738 17739 17740 17741 17742 17743 17744 17745 17746 17747 17748 17749 17750 17751 17752 17753 17754 17755 17756 17757 17758 17759 17760 17761 17762 17763 17764 17765 17766 17767 17768 17769 17770 17771 17772 17773 17774 17775 17776 17777 17778 17779 17780 17781 17782 17783 17784 17785 17786 17787 17788 17789 17790 17791 17792 17793 17794 17795 17796 17797 17798 17799 17800 17801 17802 17803 17804 17805 17806 17807 17808 17809 17810 17811 17812 17813 17814 17815 17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 17844 17845 17846 17847 17848 17849 17850 17851 17852 17853 17854 17855 17856 17857 17858 17859 17860 17861 17862 17863 17864 17865 17866 17867 17868 17869 17870 17871 17872 17873 17874 17875 17876 17877 17878 17879 17880 17881 17882 17883 17884 17885 17886 17887 17888 17889 17890 17891 17892 17893 17894 17895 17896 17897 17898 17899 17900 17901 17902 17903 17904 17905 17906 17907 17908 17909 17910 17911 17912 17913 17914 17915 17916 17917 17918 17919 17920 17921 17922 17923 17924 17925 17926 17927 17928 17929 17930 17931 17932 17933 17934 17935 17936 17937 17938 17939 17940 17941 17942 17943 17944 17945 17946 17947 17948 17949 17950 17951 17952 17953 17954 17955 17956 17957 17958 17959 17960 17961 17962 17963 17964 17965 17966 17967 17968 17969 17970 17971 17972 17973 17974 17975 17976 17977 17978 17979 17980 17981 17982 17983 17984 17985 17986 17987 17988 17989 17990 17991 17992 17993 17994 17995 17996 17997 17998 17999 18000 18001 18002 18003 18004 18005 18006 18007 18008 18009 18010 18011 18012 18013 18014 18015 18016 18017 18018 18019 18020 18021 18022 18023 18024 18025 18026 18027 18028 18029 18030 18031 18032 18033 18034 18035 18036 18037 18038 18039 18040 18041 18042 18043 18044 18045 18046 18047 18048 18049 18050 18051 18052 18053 18054 18055 18056 18057 18058 18059 18060 18061 18062 18063 18064 18065 18066 18067 18068 18069 18070 18071 18072 18073 18074 18075 18076 18077 18078 18079 18080 18081 18082 18083 18084 18085 18086 18087 18088 18089 18090 18091 18092 18093 18094 18095 18096 18097 18098 18099 18100 18101 18102 18103 18104 18105 18106 18107 18108 18109 18110 18111 18112 18113 18114 18115 18116 18117 18118 18119 18120 18121 18122 18123 18124 18125 18126 18127 18128 18129 18130 18131 18132 18133 18134 18135 18136 18137 18138 18139 18140 18141 18142 18143 18144 18145 18146 18147 18148 18149 18150 18151 18152 18153 18154 18155 18156 18157 18158 18159 18160 18161 18162 18163 18164 18165 18166 18167 18168 18169 18170 18171 18172 18173 18174 18175 18176 18177 18178 18179 18180 18181 18182 18183 18184 18185 18186 18187 18188 18189 18190 18191 18192 18193 18194 18195 18196 18197 18198 18199 18200 18201 18202 18203 18204 18205 18206 18207 18208 18209 18210 18211 18212 18213 18214 18215 18216 18217 18218 18219 18220 18221 18222 18223 18224 18225 18226 18227 18228 18229 18230 18231 18232 18233 18234 18235 18236 18237 18238 18239 18240 18241 18242 18243 18244 18245 18246 18247 18248 18249 18250 18251 18252 18253 18254 18255 18256 18257 18258 18259 18260 18261 18262 18263 18264 18265 18266 18267 18268 18269 18270 18271 18272 18273 18274 18275 18276 18277 18278 18279 18280 18281 18282 18283 18284 18285 18286 18287 18288 18289 18290 18291 18292 18293 18294 18295 18296 18297 18298 18299 18300 18301 18302 18303 18304 18305 18306 18307 18308 18309 18310 18311 18312 18313 18314 18315 18316 18317 18318 18319 18320 18321 18322 18323 18324 18325 18326 18327 18328 18329 18330 18331 18332 18333 18334 18335 18336 18337 18338 18339 18340 18341 18342 18343 18344 18345 18346 18347 18348 18349 18350 18351 18352 18353 18354 18355 18356 18357 18358 18359 18360 18361 18362 18363 18364 18365 18366 18367 18368 18369 18370 18371 18372 18373 18374 18375 18376 18377 18378 18379 18380 18381 18382 18383 18384 18385 18386 18387 18388 18389 18390 18391 18392 18393 18394 18395 18396 18397 18398 18399 18400 18401 18402 18403 18404 18405 18406 18407 18408 18409 18410 18411 18412 18413 18414 18415 18416 18417 18418 18419 18420 18421 18422 18423 18424 18425 18426 18427 18428 18429 18430 18431 18432 18433 18434 18435 18436 18437 18438 18439 18440 18441 18442 18443 18444 18445 18446 18447 18448 18449 18450 18451 18452 18453 18454 18455 18456 18457 18458 18459 18460 18461 18462 18463 18464 18465 18466 18467 18468 18469 18470 18471 18472 18473 18474 18475 18476 18477 18478 18479 18480 18481 18482 18483 18484 18485 18486 18487 18488 18489 18490 18491 18492 18493 18494 18495 18496 18497 18498 18499 18500 18501 18502 18503 18504 18505 18506 18507 18508 18509 18510 18511 18512 18513 18514 18515 18516 18517 18518 18519 18520 18521 18522 18523 18524 18525 18526 18527 18528 18529 18530 18531 18532 18533 18534 18535 18536 18537 18538 18539 18540 18541 18542 18543 18544 18545 18546 18547 18548 18549 18550 18551 18552 18553 18554 18555 18556 18557 18558 18559 18560 18561 18562 18563 18564 18565 18566 18567 18568 18569 18570 18571 18572 18573 18574 18575 18576 18577 18578 18579 18580 18581 18582 18583 18584 18585 18586 18587 18588 18589 18590 18591 18592 18593 18594 18595 18596 18597 18598 18599 18600 18601 18602 18603 18604 18605 18606 18607 18608 18609 18610 18611 18612 18613 18614 18615 18616 18617 18618 18619 18620 18621 18622 18623 18624 18625 18626 18627 18628 18629 18630 18631 18632 18633 18634 18635 18636 18637 18638 18639 18640 18641 18642 18643 18644 18645 18646 18647 18648 18649 18650 18651 18652 18653 18654 18655 18656 18657 18658 18659 18660 18661 18662 18663 18664 18665 18666 18667 18668 18669 18670 18671 18672 18673 18674 18675 18676 18677 18678 18679 18680 18681 18682 18683 18684 18685 18686 18687 18688 18689 18690 18691 18692 18693 18694 18695 18696 18697 18698 18699 18700 18701 18702 18703 18704 18705 18706 18707 18708 18709 18710 18711 18712 18713 18714 18715 18716 18717 18718 18719 18720 18721 18722 18723 18724 18725 18726 18727 18728 18729 18730 18731 18732 18733 18734 18735 18736 18737 18738 18739 18740 18741 18742 18743 18744 18745 18746 18747 18748 18749 18750 18751 18752 18753 18754 18755 18756 18757 18758 18759 18760 18761 18762 18763 18764 18765 18766 18767 18768 18769 18770 18771 18772 18773 18774 18775 18776 18777 18778 18779 18780 18781 18782 18783 18784 18785 18786 18787 18788 18789 18790 18791 18792 18793 18794 18795 18796 18797 18798 18799 18800 18801 18802 18803 18804 18805 18806 18807 18808 18809 18810 18811 18812 18813 18814 18815 18816 18817 18818 18819 18820 18821 18822 18823 18824 18825 18826 18827 18828 18829 18830 18831 18832 18833 18834 18835 18836 18837 18838 18839 18840 18841 18842 18843 18844 18845 18846 18847 18848 18849 18850 18851 18852 18853 18854 18855 18856 18857 18858 18859 18860 18861 18862 18863 18864 18865 18866 18867 18868 18869 18870 18871 18872 18873 18874 18875 18876 18877 18878 18879 18880 18881 18882 18883 18884 18885 18886 18887 18888 18889 18890 18891 18892 18893 18894 18895 18896 18897 18898 18899 18900 18901 18902 18903 18904 18905 18906 18907 18908 18909 18910 18911 18912 18913 18914 18915 18916 18917 18918 18919 18920 18921 18922 18923 18924 18925 18926 18927 18928 18929 18930 18931 18932 18933 18934 18935 18936 18937 18938 18939 18940 18941 18942 18943 18944 18945 18946 18947 18948 18949 18950 18951 18952 18953 18954 18955 18956 18957 18958 18959 18960 18961 18962 18963 18964 18965 18966 18967 18968 18969 18970 18971 18972 18973 18974 18975 18976 18977 18978 18979 18980 18981 18982 18983 18984 18985 18986 18987 18988 18989 18990 18991 18992 18993 18994 18995 18996 18997 18998 18999 19000 19001 19002 19003 19004 19005 19006 19007 19008 19009 19010 19011 19012 19013 19014 19015 19016 19017 19018 19019 19020 19021 19022 19023 19024 19025 19026 19027 19028 19029 19030 19031 19032 19033 19034 19035 19036 19037 19038 19039 19040 19041 19042 19043 19044 19045 19046 19047 19048 19049 19050 19051 19052 19053 19054 19055 19056 19057 19058 19059 19060 19061 19062 19063 19064 19065 19066 19067 19068 19069 19070 19071 19072 19073 19074 19075 19076 19077 19078 19079 19080 19081 19082 19083 19084 19085 19086 19087 19088 19089 19090 19091 19092 19093 19094 19095 19096 19097 19098 19099 19100 19101 19102 19103 19104 19105 19106 19107 19108 19109 19110 19111 19112 19113 19114 19115 19116 19117 19118 19119 19120 19121 19122 19123 19124 19125 19126 19127 19128 19129 19130 19131 19132 19133 19134 19135 19136 19137 19138 19139 19140 19141 19142 19143 19144 19145 19146 19147 19148 19149 19150 19151 19152 19153 19154 19155 19156 19157 19158 19159 19160 19161 19162 19163 19164 19165 19166 19167 19168 19169 19170 19171 19172 19173 19174 19175 19176 19177 19178 19179 19180 19181 19182 19183 19184 19185 19186 19187 19188 19189 19190 19191 19192 19193 19194 19195 19196 19197 19198 19199 19200 19201 19202 19203 19204 19205 19206 19207 19208 19209 19210 19211 19212 19213 19214 19215 19216 19217 19218 19219 19220 19221 19222 19223 19224 19225 19226 19227 19228 19229 19230 19231 19232 19233 19234 19235 19236 19237 19238 19239 19240 19241 19242 19243 19244 19245 19246 19247 19248 19249 19250 19251 19252 19253 19254 19255 19256 19257 19258 19259 19260 19261 19262 19263 19264 19265 19266 19267 19268 19269 19270 19271 19272 19273 19274 19275 19276 19277 19278 19279 19280 19281 19282 19283 19284 19285 19286 19287 19288 19289 19290 19291 19292 19293 19294 19295 19296 19297 19298 19299 19300 19301 19302 19303 19304 19305 19306 19307 19308 19309 19310 19311 19312 19313 19314 19315 19316 19317 19318 19319 19320 19321 19322 19323 19324 19325 19326 19327 19328 19329 19330 19331 19332 19333 19334 19335 19336 19337 19338 19339 19340 19341 19342 19343 19344 19345 19346 19347 19348 19349 19350 19351 19352 19353 19354 19355 19356 19357 19358 19359 19360 19361 19362 19363 19364 19365 19366 19367 19368 19369 19370 19371 19372 19373 19374 19375 19376 19377 19378 19379 19380 19381 19382 19383 19384 19385 19386 19387 19388 19389 19390 19391 19392 19393 19394 19395 19396 19397 19398 19399 19400 19401 19402 19403 19404 19405 19406 19407 19408 19409 19410 19411 19412 19413 19414 19415 19416 19417 19418 19419 19420 19421 19422 19423 19424 19425 19426 19427 19428 19429 19430 19431 19432 19433 19434 19435 19436 19437 19438 19439 19440 19441 19442 19443 19444 19445 19446 19447 19448 19449 19450 19451 19452 19453 19454 19455 19456 19457 19458 19459 19460 19461 19462 19463 19464 19465 19466 19467 19468 19469 19470 19471 19472 19473 19474 19475 19476 19477 19478 19479 19480 19481 19482 19483 19484 19485 19486 19487 19488 19489 19490 19491 19492 19493 19494 19495 19496 19497 19498 19499 19500 19501 19502 19503 19504 19505 19506 19507 19508 19509 19510 19511 19512 19513 19514 19515 19516 19517 19518 19519 19520 19521 19522 19523 19524 19525 19526 19527 19528 19529 19530 19531 19532 19533 19534 19535 19536 19537 19538 19539 19540 19541 19542 19543 19544 19545 19546 19547 19548 19549 19550 19551 19552 19553 19554 19555 19556 19557 19558 19559 19560 19561 19562 19563 19564 19565 19566 19567 19568 19569 19570 19571 19572 19573 19574 19575 19576 19577 19578 19579 19580 19581 19582 19583 19584 19585 19586 19587 19588 19589 19590 19591 19592 19593 19594 19595 19596 19597 19598 19599 19600 19601 19602 19603 19604 19605 19606 19607 19608 19609 19610 19611 19612 19613 19614 19615 19616 19617 19618 19619 19620 19621 19622 19623 19624 19625 19626 19627 19628 19629 19630 19631 19632 19633 19634 19635 19636 19637 19638 19639 19640 19641 19642 19643 19644 19645 19646 19647 19648 19649 19650 19651 19652 19653 19654 19655 19656 19657 19658 19659 19660 19661 19662 19663 19664 19665 19666 19667 19668 19669 19670 19671 19672 19673 19674 19675 19676 19677 19678 19679 19680 19681 19682 19683 19684 19685 19686 19687 19688 19689 19690 19691 19692 19693 19694 19695 19696 19697 19698 19699 19700 19701 19702 19703 19704 19705 19706 19707 19708 19709 19710 19711 19712 19713 19714 19715 19716 19717 19718 19719 19720 19721 19722 19723 19724 19725 19726 19727 19728 19729 19730 19731 19732 19733 19734 19735 19736 19737 19738 19739 19740 19741 19742 19743 19744 19745 19746 19747 19748 19749 19750 19751 19752 19753 19754 19755 19756 19757 19758 19759 19760 19761 19762 19763 19764 19765 19766 19767 19768 19769 19770 19771 19772 19773 19774 19775 19776 19777 19778 19779 19780 19781 19782 19783 19784 19785 19786 19787 19788 19789 19790 19791 19792 19793 19794 19795 19796 19797 19798 19799 19800 19801 19802 19803 19804 19805 19806 19807 19808 19809 19810 19811 19812 19813 19814 19815 19816 19817 19818 19819 19820 19821 19822 19823 19824 19825 19826 19827 19828 19829 19830 19831 19832 19833 19834 19835 19836 19837 19838 19839 19840 19841 19842 19843 19844 19845 19846 19847 19848 19849 19850 19851 19852 19853 19854 19855 19856 19857 19858 19859 19860 19861 19862 19863 19864 19865 19866 19867 19868 19869 19870 19871 19872 19873 19874 19875 19876 19877 19878 19879 19880 19881 19882 19883 19884 19885 19886 19887 19888 19889 19890 19891 19892 19893 19894 19895 19896 19897 19898 19899 19900 19901 19902 19903 19904 19905 19906 19907 19908 19909 19910 19911 19912 19913 19914 19915 19916 19917 19918 19919 19920 19921 19922 19923 19924 19925 19926 19927 19928 19929 19930 19931 19932 19933 19934 19935 19936 19937 19938 19939 19940 19941 19942 19943 19944 19945 19946 19947 19948 19949 19950 19951 19952 19953 19954 19955 19956 19957 19958 19959 19960 19961 19962 19963 19964 19965 19966 19967 19968 19969 19970 19971 19972 19973 19974 19975 19976 19977 19978 19979 19980 19981 19982 19983 19984 19985 19986 19987 19988 19989 19990 19991 19992 19993 19994 19995 19996 19997 19998 19999 20000 20001 20002 20003 20004 20005 20006 20007 20008 20009 20010 20011 20012 20013 20014 20015 20016 20017 20018 20019 20020 20021 20022 20023 20024 20025 20026 20027 20028 20029 20030 20031 20032 20033 20034 20035 20036 20037 20038 20039 20040 20041 20042 20043 20044 20045 20046 20047 20048 20049 20050 20051 20052 20053 20054 20055 20056 20057 20058 20059 20060 20061 20062 20063 20064 20065 20066 20067 20068 20069 20070 20071 20072 20073 20074 20075 20076 20077 20078 20079 20080 20081 20082 20083 20084 20085 20086 20087 20088 20089 20090 20091 20092 20093 20094 20095 20096 20097 20098 20099 20100 20101 20102 20103 20104 20105 20106 20107 20108 20109 20110 20111 20112 20113 20114 20115 20116 20117 20118 20119 20120 20121 20122 20123 20124 20125 20126 20127 20128 20129 20130 20131 20132 20133 20134 20135 20136 20137 20138 20139 20140 20141 20142 20143 20144 20145 20146 20147 20148 20149 20150 20151 20152 20153 20154 20155 20156 20157 20158 20159 20160 20161 20162 20163 20164 20165 20166 20167 20168 20169 20170 20171 20172 20173 20174 20175 20176 20177 20178 20179 20180 20181 20182 20183 20184 20185 20186 20187 20188 20189 20190 20191 20192 20193 20194 20195 20196 20197 20198 20199 20200 20201 20202 20203 20204 20205 20206 20207 20208 20209 20210 20211 20212 20213 20214 20215 20216 20217 20218 20219 20220 20221 20222 20223 20224 20225 20226 20227 20228 20229 20230 20231 20232 20233 20234 20235 20236 20237 20238 20239 20240 20241 20242 20243 20244 20245 20246 20247 20248 20249 20250 20251 20252 20253 20254 20255 20256 20257 20258 20259 20260 20261 20262 20263 20264 20265 20266 20267 20268 20269 20270 20271 20272 20273 20274 20275 20276 20277 20278 20279 20280 20281 20282 20283 20284 20285 20286 20287 20288 20289 20290 20291 20292 20293 20294 20295 20296 20297 20298 20299 20300 20301 20302 20303 20304 20305 20306 20307 20308 20309 20310 20311 20312 20313 20314 20315 20316 20317 20318 20319 20320 20321 20322 20323 20324 20325 20326 20327 20328 20329 20330 20331 20332 20333 20334 20335 20336 20337 20338 20339 20340 20341 20342 20343 20344 20345 20346 20347 20348 20349 20350 20351 20352 20353 20354 20355 20356 20357 20358 20359 20360 20361 20362 20363 20364 20365 20366 20367 20368 20369 20370 20371 20372 20373 20374 20375 20376 20377 20378 20379 20380 20381 20382 20383 20384 20385 20386 20387 20388 20389 20390 20391 20392 20393 20394 20395 20396 20397 20398 20399 20400 20401 20402 20403 20404 20405 20406 20407 20408 20409 20410 20411 20412 20413 20414 20415 20416 20417 20418 20419 20420 20421 20422 20423 20424 20425 20426 20427 20428 20429 20430 20431 20432 20433 20434 20435 20436 20437 20438 20439 20440 20441 20442 20443 20444 20445 20446 20447 20448 20449 20450 20451 20452 20453 20454 20455 20456 20457 20458 20459 20460 20461 20462 20463 20464 20465 20466 20467 20468 20469 20470 20471 20472 20473 20474 20475 20476 20477 20478 20479 20480 20481 20482 20483 20484 20485 20486 20487 20488 20489 20490 20491 20492 20493 20494 20495 20496 20497 20498 20499 20500 20501 20502 20503 20504 20505 20506 20507 20508 20509 20510 20511 20512 20513 20514 20515 20516 20517 20518 20519 20520 20521 20522 20523 20524 20525 20526 20527 20528 20529 20530 20531 20532 20533 20534 20535 20536 20537 20538 20539 20540 20541 20542 20543 20544 20545 20546 20547 20548 20549 20550 20551 20552 20553 20554 20555 20556 20557 20558 20559 20560 20561 20562 20563 20564 20565 20566 20567 20568 20569 20570 20571 20572 20573 20574 20575 20576 20577 20578 20579 20580 20581 20582 20583 20584 20585 20586 20587 20588 20589 20590 20591 20592 20593 20594 20595 20596 20597 20598 20599 20600 20601 20602 20603 20604 20605 20606 20607 20608 20609 20610 20611 20612 20613 20614 20615 20616 20617 20618 20619 20620 20621 20622 20623 20624 20625 20626 20627 20628 20629 20630 20631 20632 20633 20634 20635 20636 20637 20638 20639 20640 20641 20642 20643 20644 20645 20646 20647 20648 20649 20650 20651 20652 20653 20654 20655 20656 20657 20658 20659 20660 20661 20662 20663 20664 20665 20666 20667 20668 20669 20670 20671 20672 20673 20674 20675 20676 20677 20678 20679 20680 20681 20682 20683 20684 20685 20686 20687 20688 20689 20690 20691 20692 20693 20694 20695 20696 20697 20698 20699 20700 20701 20702 20703 20704 20705 20706 20707 20708 20709 20710 20711 20712 20713 20714 20715 20716 20717 20718 20719 20720 20721 20722 20723 20724 20725 20726 20727 20728 20729 20730 20731 20732 20733 20734 20735 20736 20737 20738 20739 20740 20741 20742 20743 20744 20745 20746 20747 20748 20749 20750 20751 20752 20753 20754 20755 20756 20757 20758 20759 20760 20761 20762 20763 20764 20765 20766 20767 20768 20769 20770 20771 20772 20773 20774 20775 20776 20777 20778 20779 20780 20781 20782 20783 20784 20785 20786 20787 20788 20789 20790 20791 20792 20793 20794 20795 20796 20797 20798 20799 20800 20801 20802 20803 20804 20805 20806 20807 20808 20809 20810 20811 20812 20813 20814 20815 20816 20817 20818 20819 20820 20821 20822 20823 20824 20825 20826 20827 20828 20829 20830 20831 20832 20833 20834 20835 20836 20837 20838 20839 20840 20841 20842 20843 20844 20845 20846 20847 20848 20849 20850 20851 20852 20853 20854 20855 20856 20857 20858 20859 20860 20861 20862 20863 20864 20865 20866 20867 20868 20869 20870 20871 20872 20873 20874 20875 20876 20877 20878 20879 20880 20881 20882 20883 20884 20885 20886 20887 20888 20889 20890 20891 20892 20893 20894 20895 20896 20897 20898 20899 20900 20901 20902 20903 20904 20905 20906 20907 20908 20909 20910 20911 20912 20913 20914 20915 20916 20917 20918 20919 20920 20921 20922 20923 20924 20925 20926 20927 20928 20929 20930 20931 20932 20933 20934 20935 20936 20937 20938 20939 20940 20941 20942 20943 20944 20945 20946 20947 20948 20949 20950 20951 20952 20953 20954 20955 20956 20957 20958 20959 20960 20961 20962 20963 20964 20965 20966 20967 20968 20969 20970 20971 20972 20973 20974 20975 20976 20977 20978 20979 20980 20981 20982 20983 20984 20985 20986 20987 20988 20989 20990 20991 20992 20993 20994 20995 20996 20997 20998 20999 21000 21001 21002 21003 21004 21005 21006 21007 21008 21009 21010 21011 21012 21013 21014 21015 21016 21017 21018 21019 21020 21021 21022 21023 21024 21025 21026 21027 21028 21029 21030 21031 21032 21033 21034 21035 21036 21037 21038 21039 21040 21041 21042 21043 21044 21045 21046 21047 21048 21049 21050 21051 21052 21053 21054 21055 21056 21057 21058 21059 21060 21061 21062 21063 21064 21065 21066 21067 21068 21069 21070 21071 21072 21073 21074 21075 21076 21077 21078 21079 21080 21081 21082 21083 21084 21085 21086 21087 21088 21089 21090 21091 21092 21093 21094 21095 21096 21097 21098 21099 21100 21101 21102 21103 21104 21105 21106 21107 21108 21109 21110 21111 21112 21113 21114 21115 21116 21117 21118 21119 21120 21121 21122 21123 21124 21125 21126 21127 21128 21129 21130 21131 21132 21133 21134 21135 21136 21137 21138 21139 21140 21141 21142 21143 21144 21145 21146 21147 21148 21149 21150 21151 21152 21153 21154 21155 21156 21157 21158 21159 21160 21161 21162 21163 21164 21165 21166 21167 21168 21169 21170 21171 21172 21173 21174 21175 21176 21177 21178 21179 21180 21181 21182 21183 21184 21185 21186 21187 21188 21189 21190 21191 21192 21193 21194 21195 21196 21197 21198 21199 21200 21201 21202 21203 21204 21205 21206 21207 21208 21209 21210 21211 21212 21213 21214 21215 21216 21217 21218 21219 21220 21221 21222 21223 21224 21225 21226 21227 21228 21229 21230 21231 21232 21233 21234 21235 21236 21237 21238 21239 21240 21241 21242 21243 21244 21245 21246 21247 21248 21249 21250 21251 21252 21253 21254 21255 21256 21257 21258 21259 21260 21261 21262 21263 21264 21265 21266 21267 21268 21269 21270 21271 21272 21273 21274 21275 21276 21277 21278 21279 21280 21281 21282 21283 21284 21285 21286 21287 21288 21289 21290 21291 21292 21293 21294 21295 21296 21297 21298 21299 21300 21301 21302 21303 21304 21305 21306 21307 21308 21309 21310 21311 21312 21313 21314 21315 21316 21317 21318 21319 21320 21321 21322 21323 21324 21325 21326 21327 21328 21329 21330 21331 21332 21333 21334 21335 21336 21337 21338 21339 21340 21341 21342 21343 21344 21345 21346 21347 21348 21349 21350 21351 21352 21353 21354 21355 21356 21357 21358 21359 21360 21361 21362 21363 21364 21365 21366 21367 21368 21369 21370 21371 21372 21373 21374 21375 21376 21377 21378 21379 21380 21381 21382 21383 21384 21385 21386 21387 21388 21389 21390 21391 21392 21393 21394 21395 21396 21397 21398 21399 21400 21401 21402 21403 21404 21405 21406 21407 21408 21409 21410 21411 21412 21413 21414 21415 21416 21417 21418 21419 21420 21421 21422 21423 21424 21425 21426 21427 21428 21429 21430 21431 21432 21433 21434 21435 21436 21437 21438 21439 21440 21441 21442 21443 21444 21445 21446 21447 21448 21449 21450 21451 21452 21453 21454 21455 21456 21457 21458 21459 21460 21461 21462 21463 21464 21465 21466 21467 21468 21469 21470 21471 21472 21473 21474 21475 21476 21477 21478 21479 21480 21481 21482 21483 21484 21485 21486 21487 21488 21489 21490 21491 21492 21493 21494 21495 21496 21497 21498 21499 21500 21501 21502 21503 21504 21505 21506 21507 21508 21509 21510 21511 21512 21513 21514 21515 21516 21517 21518 21519 21520 21521 21522 21523 21524 21525 21526 21527 21528 21529 21530 21531 21532 21533 21534 21535 21536 21537 21538 21539 21540 21541 21542 21543 21544 21545 21546 21547 21548 21549 21550 21551 21552 21553 21554 21555 21556 21557 21558 21559 21560 21561 21562 21563 21564 21565 21566 21567 21568 21569 21570 21571 21572 21573 21574 21575 21576 21577 21578 21579 21580 21581 21582 21583 21584 21585 21586 21587 21588 21589 21590 21591 21592 21593 21594 21595 21596 21597 21598 21599 21600 21601 21602 21603 21604 21605 21606 21607 21608 21609 21610 21611 21612 21613 21614 21615 21616 21617 21618 21619 21620 21621 21622 21623 21624 21625 21626 21627 21628 21629 21630 21631 21632 21633 21634 21635 21636 21637 21638 21639 21640 21641 21642 21643 21644 21645 21646 21647 21648 21649 21650 21651 21652 21653 21654 21655 21656 21657 21658 21659 21660 21661 21662 21663 21664 21665 21666 21667 21668 21669 21670 21671 21672 21673 21674 21675 21676 21677 21678 21679 21680 21681 21682 21683 21684 21685 21686 21687 21688 21689 21690 21691 21692 21693 21694 21695 21696 21697 21698 21699 21700 21701 21702 21703 21704 21705 21706 21707 21708 21709 21710 21711 21712 21713 21714 21715 21716 21717 21718 21719 21720 21721 21722 21723 21724 21725 21726 21727 21728 21729 21730 21731 21732 21733 21734 21735 21736 21737 21738 21739 21740 21741 21742 21743 21744 21745 21746 21747 21748 21749 21750 21751 21752 21753 21754 21755 21756 21757 21758 21759 21760 21761 21762 21763 21764 21765 21766 21767 21768 21769 21770 21771 21772 21773 21774 21775 21776 21777 21778 21779 21780 21781 21782 21783 21784 21785 21786 21787 21788 21789 21790 21791 21792 21793 21794 21795 21796 21797 21798 21799 21800 21801 21802 21803 21804 21805 21806 21807 21808 21809 21810 21811 21812 21813 21814 21815 21816 21817 21818 21819 21820 21821 21822 21823 21824 21825 21826 21827 21828 21829 21830 21831 21832 21833 21834 21835 21836 21837 21838 21839 21840 21841 21842 21843 21844 21845 21846 21847 21848 21849 21850 21851 21852 21853 21854 21855 21856 21857 21858 21859 21860 21861 21862 21863 21864 21865 21866 21867 21868 21869 21870 21871 21872 21873 21874 21875 21876 21877 21878 21879 21880 21881 21882 21883 21884 21885 21886 21887 21888 21889 21890 21891 21892 21893 21894 21895 21896 21897 21898 21899 21900 21901 21902 21903 21904 21905 21906 21907 21908 21909 21910 21911 21912 21913 21914 21915 21916 21917 21918 21919 21920 21921 21922 21923 21924 21925 21926 21927 21928 21929 21930 21931 21932 21933 21934 21935 21936 21937 21938 21939 21940 21941 21942 21943 21944 21945 21946 21947 21948 21949 21950 21951 21952 21953 21954 21955 21956 21957 21958 21959 21960 21961 21962 21963 21964 21965 21966 21967 21968 21969 21970 21971 21972 21973 21974 21975 21976 21977 21978 21979 21980 21981 21982 21983 21984 21985 21986 21987 21988 21989 21990 21991 21992 21993 21994 21995 21996 21997 21998 21999 22000 22001 22002 22003 22004 22005 22006 22007 22008 22009 22010 22011 22012 22013 22014 22015 22016 22017 22018 22019 22020 22021 22022 22023 22024 22025 22026 22027 22028 22029 22030 22031 22032 22033 22034 22035 22036 22037 22038 22039 22040 22041 22042 22043 22044 22045 22046 22047 22048 22049 22050 22051 22052 22053 22054 22055 22056 22057 22058 22059 22060 22061 22062 22063 22064 22065 22066 22067 22068 22069 22070 22071 22072 22073 22074 22075 22076 22077 22078 22079 22080 22081 22082 22083 22084 22085 22086 22087 22088 22089 22090 22091 22092 22093 22094 22095 22096 22097 22098 22099 22100 22101 22102 22103 22104 22105 22106 22107 22108 22109 22110 22111 22112 22113 22114 22115 22116 22117 22118 22119 22120 22121 22122 22123 22124 22125 22126 22127 22128 22129 22130 22131 22132 22133 22134 22135 22136 22137 22138 22139 22140 22141 22142 22143 22144 22145 22146 22147 22148 22149 22150 22151 22152 22153 22154 22155 22156 22157 22158 22159 22160 22161 22162 22163 22164 22165 22166 22167 22168 22169 22170 22171 22172 22173 22174 22175 22176 22177 22178 22179 22180 22181 22182 22183 22184 22185 22186 22187 22188 22189 22190 22191 22192 22193 22194 22195 22196 22197 22198 22199 22200 22201 22202 22203 22204 22205 22206 22207 22208 22209 22210 22211 22212 22213 22214 22215 22216 22217 22218 22219 22220 22221 22222 22223 22224 22225 22226 22227 22228 22229 22230 22231 22232 22233 22234 22235 22236 22237 22238 22239 22240 22241 22242 22243 22244 22245 22246 22247 22248 22249 22250 22251 22252 22253 22254 22255 22256 22257 22258 22259 22260 22261 22262 22263 22264 22265 22266 22267 22268 22269 22270 22271 22272 22273 22274 22275 22276 22277 22278 22279 22280 22281 22282 22283 22284 22285 22286 22287 22288 22289 22290 22291 22292 22293 22294 22295 22296 22297 22298 22299 22300 22301 22302 22303 22304 22305 22306 22307 22308 22309 22310 22311 22312 22313 22314 22315 22316 22317 22318 22319 22320 22321 22322 22323 22324 22325 22326 22327 22328 22329 22330 22331 22332 22333 22334 22335 22336 22337 22338 22339 22340 22341 22342 22343 22344 22345 22346 22347 22348 22349 22350 22351 22352 22353 22354 22355 22356 22357 22358 22359 22360 22361 22362 22363 22364 22365 22366 22367 22368 22369 22370 22371 22372 22373 22374 22375 22376 22377 22378 22379 22380 22381 22382 22383 22384 22385 22386 22387 22388 22389 22390 22391 22392 22393 22394 22395 22396 22397 22398 22399 22400 22401 22402 22403 22404 22405 22406 22407 22408 22409 22410 22411 22412 22413 22414 22415 22416 22417 22418 22419 22420 22421 22422 22423 22424 22425 22426 22427 22428 22429 22430 22431 22432 22433 22434 22435 22436 22437 22438 22439 22440 22441 22442 22443 22444 22445 22446 22447 22448 22449 22450 22451 22452 22453 22454 22455 22456 22457 22458 22459 22460 22461 22462 22463 22464 22465 22466 22467 22468 22469 22470 22471 22472 22473 22474 22475 22476 22477 22478 22479 22480 22481 22482 22483 22484 22485 22486 22487 22488 22489 22490 22491 22492 22493 22494 22495 22496 22497 22498 22499 22500 22501 22502 22503 22504 22505 22506 22507 22508 22509 22510 22511 22512 22513 22514 22515 22516 22517 22518 22519 22520 22521 22522 22523 22524 22525 22526 22527 22528 22529 22530 22531 22532 22533 22534 22535 22536 22537 22538 22539 22540 22541 22542 22543 22544 22545 22546 22547 22548 22549 22550 22551 22552 22553 22554 22555 22556 22557 22558 22559 22560 22561 22562 22563 22564 22565 22566 22567 22568 22569 22570 22571 22572 22573 22574 22575 22576 22577 22578 22579 22580 22581 22582 22583 22584 22585 22586 22587 22588 22589 22590 22591 22592 22593 22594 22595 22596 22597 22598 22599 22600 22601 22602 22603 22604 22605 22606 22607 22608 22609 22610 22611 22612 22613 22614 22615 22616 22617 22618 22619 22620 22621 22622 22623 22624 22625 22626 22627 22628 22629 22630 22631 22632 22633 22634 22635 22636 22637 22638 22639 22640 22641 22642 22643 22644 22645 22646 22647 22648 22649 22650 22651 22652 22653 22654 22655 22656 22657 22658 22659 22660 22661 22662 22663 22664 22665 22666 22667 22668 22669 22670 22671 22672 22673 22674 22675 22676 22677 22678 22679 22680 22681 22682 22683 22684 22685 22686 22687 22688 22689 22690 22691 22692 22693 22694 22695 22696 22697 22698 22699 22700 22701 22702 22703 22704 22705 22706 22707 22708 22709 22710 22711 22712 22713 22714 22715 22716 22717 22718 22719 22720 22721 22722 22723 22724 22725 22726 22727 22728 22729 22730 22731 22732 22733 22734 22735 22736 22737 22738 22739 22740 22741 22742 22743 22744 22745 22746 22747 22748 22749 22750 22751 22752 22753 22754 22755 22756 22757 22758 22759 22760 22761 22762 22763 22764 22765 22766 22767 22768 22769 22770 22771 22772 22773 22774 22775 22776 22777 22778 22779 22780 22781 22782 22783 22784 22785 22786 22787 22788 22789 22790 22791 22792 22793 22794 22795 22796 22797 22798 22799 22800 22801 22802 22803 22804 22805 22806 22807 22808 22809 22810 22811 22812 22813 22814 22815 22816 22817 22818 22819 22820 22821 22822 22823 22824 22825 22826 22827 22828 22829 22830 22831 22832 22833 22834 22835 22836 22837 22838 22839 22840 22841 22842 22843 22844 22845 22846 22847 22848 22849 22850 22851 22852 22853 22854 22855 22856 22857 22858 22859 22860 22861 22862 22863 22864 22865 22866 22867 22868 22869 22870 22871 22872 22873 22874 22875 22876 22877 22878 22879 22880 22881 22882 22883 22884 22885 22886 22887 22888 22889 22890 22891 22892 22893 22894 22895 22896 22897 22898 22899 22900 22901 22902 22903 22904 22905 22906 22907 22908 22909 22910 22911 22912 22913 22914 22915 22916 22917 22918 22919 22920 22921 22922 22923 22924 22925 22926 22927 22928 22929 22930 22931 22932 22933 22934 22935 22936 22937 22938 22939 22940 22941 22942 22943 22944 22945 22946 22947 22948 22949 22950 22951 22952 22953 22954 22955 22956 22957 22958 22959 22960 22961 22962 22963 22964 22965 22966 22967 22968 22969 22970 22971 22972 22973 22974 22975 22976 22977 22978 22979 22980 22981 22982 22983 22984 22985 22986 22987 22988 22989 22990 22991 22992 22993 22994 22995 22996 22997 22998 22999 23000 23001 23002 23003 23004 23005 23006 23007 23008 23009 23010 23011 23012 23013 23014 23015 23016 23017 23018 23019 23020 23021 23022 23023 23024 23025 23026 23027 23028 23029 23030 23031 23032 23033 23034 23035 23036 23037 23038 23039 23040 23041 23042 23043 23044 23045 23046 23047 23048 23049 23050 23051 23052 23053 23054 23055 23056 23057 23058 23059 23060 23061 23062 23063 23064 23065 23066 23067 23068 23069 23070 23071 23072 23073 23074 23075 23076 23077 23078 23079 23080 23081 23082 23083 23084 23085 23086 23087 23088 23089 23090 23091 23092 23093 23094 23095 23096 23097 23098 23099 23100 23101 23102 23103 23104 23105 23106 23107 23108 23109 23110 23111 23112 23113 23114 23115 23116 23117 23118 23119 23120 23121 23122 23123 23124 23125 23126 23127 23128 23129 23130 23131 23132 23133 23134 23135 23136 23137 23138 23139 23140 23141 23142 23143 23144 23145 23146 23147 23148 23149 23150 23151 23152 23153 23154 23155 23156 23157 23158 23159 23160 23161 23162 23163 23164 23165 23166 23167 23168 23169 23170 23171 23172 23173 23174 23175 23176 23177 23178 23179 23180 23181 23182 23183 23184 23185 23186 23187 23188 23189 23190 23191 23192 23193 23194 23195 23196 23197 23198 23199 23200 23201 23202 23203 23204 23205 23206 23207 23208 23209 23210 23211 23212 23213 23214 23215 23216 23217 23218 23219 23220 23221 23222 23223 23224 23225 23226 23227 23228 23229 23230 23231 23232 23233 23234 23235 23236 23237 23238 23239 23240 23241 23242 23243 23244 23245 23246 23247 23248 23249 23250 23251 23252 23253 23254 23255 23256 23257 23258 23259 23260 23261 23262 23263 23264 23265 23266 23267 23268 23269 23270 23271 23272 23273 23274 23275 23276 23277 23278 23279 23280 23281 23282 23283 23284 23285 23286 23287 23288 23289 23290 23291 23292 23293 23294 23295 23296 23297 23298 23299 23300 23301 23302 23303 23304 23305 23306 23307 23308 23309 23310 23311 23312 23313 23314 23315 23316 23317 23318 23319 23320 23321 23322 23323 23324 23325 23326 23327 23328 23329 23330 23331 23332 23333 23334 23335 23336 23337 23338 23339 23340 23341 23342 23343 23344 23345 23346 23347 23348 23349 23350 23351 23352 23353 23354 23355 23356 23357 23358 23359 23360 23361 23362 23363 23364 23365 23366 23367 23368 23369 23370 23371 23372 23373 23374 23375 23376 23377 23378 23379 23380 23381 23382 23383 23384 23385 23386 23387 23388 23389 23390 23391 23392 23393 23394 23395 23396 23397 23398 23399 23400 23401 23402 23403 23404 23405 23406 23407 23408 23409 23410 23411 23412 23413 23414 23415 23416 23417 23418 23419 23420 23421 23422 23423 23424 23425 23426 23427 23428 23429 23430 23431 23432 23433 23434 23435 23436 23437 23438 23439 23440 23441 23442 23443 23444 23445 23446 23447 23448 23449 23450 23451 23452 23453 23454 23455 23456 23457 23458 23459 23460 23461 23462 23463 23464 23465 23466 23467 23468 23469 23470 23471 23472 23473 23474 23475 23476 23477 23478 23479 23480 23481 23482 23483 23484 23485 23486 23487 23488 23489 23490 23491 23492 23493 23494 23495 23496 23497 23498 23499 23500 23501 23502 23503 23504 23505 23506 23507 23508 23509 23510 23511 23512 23513 23514 23515 23516 23517 23518 23519 23520 23521 23522 23523 23524 23525 23526 23527 23528 23529 23530 23531 23532 23533 23534 23535 23536 23537 23538 23539 23540 23541 23542 23543 23544 23545 23546 23547 23548 23549 23550 23551 23552 23553 23554 23555 23556 23557 23558 23559 23560 23561 23562 23563 23564 23565 23566 23567 23568 23569 23570 23571 23572 23573 23574 23575 23576 23577 23578 23579 23580 23581 23582 23583 23584 23585 23586 23587 23588 23589 23590 23591 23592 23593 23594 23595 23596 23597 23598 23599 23600 23601 23602 23603 23604 23605 23606 23607 23608 23609 23610 23611 23612 23613 23614 23615 23616 23617 23618 23619 23620 23621 23622 23623 23624 23625 23626 23627 23628 23629 23630 23631 23632 23633 23634 23635 23636 23637 23638 23639 23640 23641 23642 23643 23644 23645 23646 23647 23648 23649 23650 23651 23652 23653 23654 23655 23656 23657 23658 23659 23660 23661 23662 23663 23664 23665 23666 23667 23668 23669 23670 23671 23672 23673 23674 23675 23676 23677 23678 23679 23680 23681 23682 23683 23684 23685 23686 23687 23688 23689 23690 23691 23692 23693 23694 23695 23696 23697 23698 23699 23700 23701 23702 23703 23704 23705 23706 23707 23708 23709 23710 23711 23712 23713 23714 23715 23716 23717 23718 23719 23720 23721 23722 23723 23724 23725 23726 23727 23728 23729 23730 23731 23732 23733 23734 23735 23736 23737 23738 23739 23740 23741 23742 23743 23744 23745 23746 23747 23748 23749 23750 23751 23752 23753 23754 23755 23756 23757 23758 23759 23760 23761 23762 23763 23764 23765 23766 23767 23768 23769 23770 23771 23772 23773 23774 23775 23776 23777 23778 23779 23780 23781 23782 23783 23784 23785 23786 23787 23788 23789 23790 23791 23792 23793 23794 23795 23796 23797 23798 23799 23800 23801 23802 23803 23804 23805 23806 23807 23808 23809 23810 23811 23812 23813 23814 23815 23816 23817 23818 23819 23820 23821 23822 23823 23824 23825 23826 23827 23828 23829 23830 23831 23832 23833 23834 23835 23836 23837 23838 23839 23840 23841 23842 23843 23844 23845 23846 23847 23848 23849 23850 23851 23852 23853 23854 23855 23856 23857 23858 23859 23860 23861 23862 23863 23864 23865 23866 23867 23868 23869 23870 23871 23872 23873 23874 23875 23876 23877 23878 23879 23880 23881 23882 23883 23884 23885 23886 23887 23888 23889 23890 23891 23892 23893 23894 23895 23896 23897 23898 23899 23900 23901 23902 23903 23904 23905 23906 23907 23908 23909 23910 23911 23912 23913 23914 23915 23916 23917 23918 23919 23920 23921 23922 23923 23924 23925 23926 23927 23928 23929 23930 23931 23932 23933 23934 23935 23936 23937 23938 23939 23940 23941 23942 23943 23944 23945 23946 23947 23948 23949 23950 23951 23952 23953 23954 23955 23956 23957 23958 23959 23960 23961 23962 23963 23964 23965 23966 23967 23968 23969 23970 23971 23972 23973 23974 23975 23976 23977 23978 23979 23980 23981 23982 23983 23984 23985 23986 23987 23988 23989 23990 23991 23992 23993 23994 23995 23996 23997 23998 23999 24000 24001 24002 24003 24004 24005 24006 24007 24008 24009 24010 24011 24012 24013 24014 24015 24016 24017 24018 24019 24020 24021 24022 24023 24024 24025 24026 24027 24028 24029 24030 24031 24032 24033 24034 24035 24036 24037 24038 24039 24040 24041 24042 24043 24044 24045 24046 24047 24048 24049 24050 24051 24052 24053 24054 24055 24056 24057 24058 24059 24060 24061 24062 24063 24064 24065 24066 24067 24068 24069 24070 24071 24072 24073 24074 24075 24076 24077 24078 24079 24080 24081 24082 24083 24084 24085 24086 24087 24088 24089 24090 24091 24092 24093 24094 24095 24096 24097 24098 24099 24100 24101 24102 24103 24104 24105 24106 24107 24108 24109 24110 24111 24112 24113 24114 24115 24116 24117 24118 24119 24120 24121 24122 24123 24124 24125 24126 24127 24128 24129 24130 24131 24132 24133 24134 24135 24136 24137 24138 24139 24140 24141 24142 24143 24144 24145 24146 24147 24148 24149 24150 24151 24152 24153 24154 24155 24156 24157 24158 24159 24160 24161 24162 24163 24164 24165 24166 24167 24168 24169 24170 24171 24172 24173 24174 24175 24176 24177 24178 24179 24180 24181 24182 24183 24184 24185 24186 24187 24188 24189 24190 24191 24192 24193 24194 24195 24196 24197 24198 24199 24200 24201 24202 24203 24204 24205 24206 24207 24208 24209 24210 24211 24212 24213 24214 24215 24216 24217 24218 24219 24220 24221 24222 24223 24224 24225 24226 24227 24228 24229 24230 24231 24232 24233 24234 24235 24236 24237 24238 24239 24240 24241 24242 24243 24244 24245 24246 24247 24248 24249 24250 24251 24252 24253 24254 24255 24256 24257 24258 24259 24260 24261 24262 24263 24264 24265 24266 24267 24268 24269 24270 24271 24272 24273 24274 24275 24276 24277 24278 24279 24280 24281 24282 24283 24284 24285 24286 24287 24288 24289 24290 24291 24292 24293 24294 24295 24296 24297 24298 24299 24300 24301 24302 24303 24304 24305 24306 24307 24308 24309 24310 24311 24312 24313 24314 24315 24316 24317 24318 24319 24320 24321 24322 24323 24324 24325 24326 24327 24328 24329 24330 24331 24332 24333 24334 24335 24336 24337 24338 24339 24340 24341 24342 24343 24344 24345 24346 24347 24348 24349 24350 24351 24352 24353 24354 24355 24356 24357 24358 24359 24360 24361 24362 24363 24364 24365 24366 24367 24368 24369 24370 24371 24372 24373 24374 24375 24376 24377 24378 24379 24380 24381 24382 24383 24384 24385 24386 24387 24388 24389 24390 24391 24392 24393 24394 24395 24396 24397 24398 24399 24400 24401 24402 24403 24404 24405 24406 24407 24408 24409 24410 24411 24412 24413 24414 24415 24416 24417 24418 24419 24420 24421 24422 24423 24424 24425 24426 24427 24428 24429 24430 24431 24432 24433 24434 24435 24436 24437 24438 24439 24440 24441 24442 24443 24444 24445 24446 24447 24448 24449 24450 24451 24452 24453 24454 24455 24456 24457 24458 24459 24460 24461 24462 24463 24464 24465 24466 24467 24468 24469 24470 24471 24472 24473 24474 24475 24476 24477 24478 24479 24480 24481 24482 24483 24484 24485 24486 24487 24488 24489 24490 24491 24492 24493 24494 24495 24496 24497 24498 24499 24500 24501 24502 24503 24504 24505 24506 24507 24508 24509 24510 24511 24512 24513 24514 24515 24516 24517 24518 24519 24520 24521 24522 24523 24524 24525 24526 24527 24528 24529 24530 24531 24532 24533 24534 24535 24536 24537 24538 24539 24540 24541 24542 24543 24544 24545 24546 24547 24548 24549 24550 24551 24552 24553 24554 24555 24556 24557 24558 24559 24560 24561 24562 24563 24564 24565 24566 24567 24568 24569 24570 24571 24572 24573 24574 24575 24576 24577 24578 24579 24580 24581 24582 24583 24584 24585 24586 24587 24588 24589 24590 24591 24592 24593 24594 24595 24596 24597 24598 24599 24600 24601 24602 24603 24604 24605 24606 24607 24608 24609 24610 24611 24612 24613 24614 24615 24616 24617 24618 24619 24620 24621 24622 24623 24624 24625 24626 24627 24628 24629 24630 24631 24632 24633 24634 24635 24636 24637 24638 24639 24640 24641 24642 24643 24644 24645 24646 24647 24648 24649 24650 24651 24652 24653 24654 24655 24656 24657 24658 24659 24660 24661 24662 24663 24664 24665 24666 24667 24668 24669 24670 24671 24672 24673 24674 24675 24676 24677 24678 24679 24680 24681 24682 24683 24684 24685 24686 24687 24688 24689 24690 24691 24692 24693 24694 24695 24696 24697 24698 24699 24700 24701 24702 24703 24704 24705 24706 24707 24708 24709 24710 24711 24712 24713 24714 24715 24716 24717 24718 24719 24720 24721 24722 24723 24724 24725 24726 24727 24728 24729 24730 24731 24732 24733 24734 24735 24736 24737 24738 24739 24740 24741 24742 24743 24744 24745 24746 24747 24748 24749 24750 24751 24752 24753 24754 24755 24756 24757 24758 24759 24760 24761 24762 24763 24764 24765 24766 24767 24768 24769 24770 24771 24772 24773 24774 24775 24776 24777 24778 24779 24780 24781 24782 24783 24784 24785 24786 24787 24788 24789 24790 24791 24792 24793 24794 24795 24796 24797 24798 24799 24800 24801 24802 24803 24804 24805 24806 24807 24808 24809 24810 24811 24812 24813 24814 24815 24816 24817 24818 24819 24820 24821 24822 24823 24824 24825 24826 24827 24828 24829 24830 24831 24832 24833 24834 24835 24836 24837 24838 24839 24840 24841 24842 24843 24844 24845 24846 24847 24848 24849 24850 24851 24852 24853 24854 24855 24856 24857 24858 24859 24860 24861 24862 24863 24864 24865 24866 24867 24868 24869 24870 24871 24872 24873 24874 24875 24876 24877 24878 24879 24880 24881 24882 24883 24884 24885 24886 24887 24888 24889 24890 24891 24892 24893 24894 24895 24896 24897 24898 24899 24900 24901 24902 24903 24904 24905 24906 24907 24908 24909 24910 24911 24912 24913 24914 24915 24916 24917 24918 24919 24920 24921 24922 24923 24924 24925 24926 24927 24928 24929 24930 24931 24932 24933 24934 24935 24936 24937 24938 24939 24940 24941 24942 24943 24944 24945 24946 24947 24948 24949 24950 24951 24952 24953 24954 24955 24956 24957 24958 24959 24960 24961 24962 24963 24964 24965 24966 24967 24968 24969 24970 24971 24972 24973 24974 24975 24976 24977 24978 24979 24980 24981 24982 24983 24984 24985 24986 24987 24988 24989 24990 24991 24992 24993 24994 24995 24996 24997 24998 24999 25000 25001 25002 25003 25004 25005 25006 25007 25008 25009 25010 25011 25012 25013 25014 25015 25016 25017 25018 25019 25020 25021 25022 25023 25024 25025 25026 25027 25028 25029 25030 25031 25032 25033 25034 25035 25036 25037 25038 25039 25040 25041 25042 25043 25044 25045 25046 25047 25048 25049 25050 25051 25052 25053 25054 25055 25056 25057 25058 25059 25060 25061 25062 25063 25064 25065 25066 25067 25068 25069 25070 25071 25072 25073 25074 25075 25076 25077 25078 25079 25080 25081 25082 25083 25084 25085 25086 25087 25088 25089 25090 25091 25092 25093 25094 25095 25096 25097 25098 25099 25100 25101 25102 25103 25104 25105 25106 25107 25108 25109 25110 25111 25112 25113 25114 25115 25116 25117 25118 25119 25120 25121 25122 25123 25124 25125 25126 25127 25128 25129 25130 25131 25132 25133 25134 25135 25136 25137 25138 25139 25140 25141 25142 25143 25144 25145 25146 25147 25148 25149 25150 25151 25152 25153 25154 25155 25156 25157 25158 25159 25160 25161 25162 25163 25164 25165 25166 25167 25168 25169 25170 25171 25172 25173 25174 25175 25176 25177 25178 25179 25180 25181 25182 25183 25184 25185 25186 25187 25188 25189 25190 25191 25192 25193 25194 25195 25196 25197 25198 25199 25200 25201 25202 25203 25204 25205 25206 25207 25208 25209 25210 25211 25212 25213 25214 25215 25216 25217 25218 25219 25220 25221 25222 25223 25224 25225 25226 25227 25228 25229 25230 25231 25232 25233 25234 25235 25236 25237 25238 25239 25240 25241 25242 25243 25244 25245 25246 25247 25248 25249 25250 25251 25252 25253 25254 25255 25256 25257 25258 25259 25260 25261 25262 25263 25264 25265 25266 25267 25268 25269 25270 25271 25272 25273 25274 25275 25276 25277 25278 25279 25280 25281 25282 25283 25284 25285 25286 25287 25288 25289 25290 25291 25292 25293 25294 25295 25296 25297 25298 25299 25300 25301 25302 25303 25304 25305 25306 25307 25308 25309 25310 25311 25312 25313 25314 25315 25316 25317 25318 25319 25320 25321 25322 25323 25324 25325 25326 25327 25328 25329 25330 25331 25332 25333 25334 25335 25336 25337 25338 25339 25340 25341 25342 25343 25344 25345 25346 25347 25348 25349 25350 25351 25352 25353 25354 25355 25356 25357 25358 25359 25360 25361 25362 25363 25364 25365 25366 25367 25368 25369 25370 25371 25372 25373 25374 25375 25376 25377 25378 25379 25380 25381 25382 25383 25384 25385 25386 25387 25388 25389 25390 25391 25392 25393 25394 25395 25396 25397 25398 25399 25400 25401 25402 25403 25404 25405 25406 25407 25408 25409 25410 25411 25412 25413 25414 25415 25416 25417 25418 25419 25420 25421 25422 25423 25424 25425 25426 25427 25428 25429 25430 25431 25432 25433 25434 25435 25436 25437 25438 25439 25440 25441 25442 25443 25444 25445 25446 25447 25448 25449 25450 25451 25452 25453 25454 25455 25456 25457 25458 25459 25460 25461 25462 25463 25464 25465 25466 25467 25468 25469 25470 25471 25472 25473 25474 25475 25476 25477 25478 25479 25480 25481 25482 25483 25484 25485 25486 25487 25488 25489 25490 25491 25492 25493 25494 25495 25496 25497 25498 25499 25500 25501 25502 25503 25504 25505 25506 25507 25508 25509 25510 25511 25512 25513 25514 25515 25516 25517 25518 25519 25520 25521 25522 25523 25524 25525 25526 25527 25528 25529 25530 25531 25532 25533 25534 25535 25536 25537 25538 25539 25540 25541 25542 25543 25544 25545 25546 25547 25548 25549 25550 25551 25552 25553 25554 25555 25556 25557 25558 25559 25560 25561 25562 25563 25564 25565 25566 25567 25568 25569 25570 25571 25572 25573 25574 25575 25576 25577 25578 25579 25580 25581 25582 25583 25584 25585 25586 25587 25588 25589 25590 25591 25592 25593 25594 25595 25596 25597 25598 25599 25600 25601 25602 25603 25604 25605 25606 25607 25608 25609 25610 25611 25612 25613 25614 25615 25616 25617 25618 25619 25620 25621 25622 25623 25624 25625 25626 25627 25628 25629 25630 25631 25632 25633 25634 25635 25636 25637 25638 25639 25640 25641 25642 25643 25644 25645 25646 25647 25648 25649 25650 25651 25652 25653 25654 25655 25656 25657 25658 25659 25660 25661 25662 25663 25664 25665 25666 25667 25668 25669 25670 25671 25672 25673 25674 25675 25676 25677 25678 25679 25680 25681 25682 25683 25684 25685 25686 25687 25688 25689 25690 25691 25692 25693 25694 25695 25696 25697 25698 25699 25700 25701 25702 25703 25704 25705 25706 25707 25708 25709 25710 25711 25712 25713 25714 25715 25716 25717 25718 25719 25720 25721 25722 25723 25724 25725 25726 25727 25728 25729 25730 25731 25732 25733 25734 25735 25736 25737 25738 25739 25740 25741 25742 25743 25744 25745 25746 25747 25748 25749 25750 25751 25752 25753 25754 25755 25756 25757 25758 25759 25760 25761 25762 25763 25764 25765 25766 25767 25768 25769 25770 25771 25772 25773 25774 25775 25776 25777 25778 25779 25780 25781 25782 25783 25784 25785 25786 25787 25788 25789 25790 25791 25792 25793 25794 25795 25796 25797 25798 25799 25800 25801 25802 25803 25804 25805 25806 25807 25808 25809 25810 25811 25812 25813 25814 25815 25816 25817 25818 25819 25820 25821 25822 25823 25824 25825 25826 25827 25828 25829 25830 25831 25832 25833 25834 25835 25836 25837 25838 25839 25840 25841 25842 25843 25844 25845 25846 25847 25848 25849 25850 25851 25852 25853 25854 25855 25856 25857 25858 25859 25860 25861 25862 25863 25864 25865 25866 25867 25868 25869 25870 25871 25872 25873 25874 25875 25876 25877 25878 25879 25880 25881 25882 25883 25884 25885 25886 25887 25888 25889 25890 25891 25892 25893 25894 25895 25896 25897 25898 25899 25900 25901 25902 25903 25904 25905 25906 25907 25908 25909 25910 25911 25912 25913 25914 25915 25916 25917 25918 25919 25920 25921 25922 25923 25924 25925 25926 25927 25928 25929 25930 25931 25932 25933 25934 25935 25936 25937 25938 25939 25940 25941 25942 25943 25944 25945 25946 25947 25948 25949 25950 25951 25952 25953 25954 25955 25956 25957 25958 25959 25960 25961 25962 25963 25964 25965 25966 25967 25968 25969 25970 25971 25972 25973 25974 25975 25976 25977 25978 25979 25980 25981 25982 25983 25984 25985 25986 25987 25988 25989 25990 25991 25992 25993 25994 25995 25996 25997 25998 25999 26000 26001 26002 26003 26004 26005 26006 26007 26008 26009 26010 26011 26012 26013 26014 26015 26016 26017 26018 26019 26020 26021 26022 26023 26024 26025 26026 26027 26028 26029 26030 26031 26032 26033 26034 26035 26036 26037 26038 26039 26040 26041 26042 26043 26044 26045 26046 26047 26048 26049 26050 26051 26052 26053 26054 26055 26056 26057 26058 26059 26060 26061 26062 26063 26064 26065 26066 26067 26068 26069 26070 26071 26072 26073 26074 26075 26076 26077 26078 26079 26080 26081 26082 26083 26084 26085 26086 26087 26088 26089 26090 26091 26092 26093 26094 26095 26096 26097 26098 26099 26100 26101 26102 26103 26104 26105 26106 26107 26108 26109 26110 26111 26112 26113 26114 26115 26116 26117 26118 26119 26120 26121 26122 26123 26124 26125 26126 26127 26128 26129 26130 26131 26132 26133 26134 26135 26136 26137 26138 26139 26140 26141 26142 26143 26144 26145 26146 26147 26148 26149 26150 26151 26152 26153 26154 26155 26156 26157 26158 26159 26160 26161 26162 26163 26164 26165 26166 26167 26168 26169 26170 26171 26172 26173 26174 26175 26176 26177 26178 26179 26180 26181 26182 26183 26184 26185 26186 26187 26188 26189 26190 26191 26192 26193 26194 26195 26196 26197 26198 26199 26200 26201 26202 26203 26204 26205 26206 26207 26208 26209 26210 26211 26212 26213 26214 26215 26216 26217 26218 26219 26220 26221 26222 26223 26224 26225 26226 26227 26228 26229 26230 26231 26232 26233 26234 26235 26236 26237 26238 26239 26240 26241 26242 26243 26244 26245 26246 26247 26248 26249 26250 26251 26252 26253 26254 26255 26256 26257 26258 26259 26260 26261 26262 26263 26264 26265 26266 26267 26268 26269 26270 26271 26272 26273 26274 26275 26276 26277 26278 26279 26280 26281 26282 26283 26284 26285 26286 26287 26288 26289 26290 26291 26292 26293 26294 26295 26296 26297 26298 26299 26300 26301 26302 26303 26304 26305 26306 26307 26308 26309 26310 26311 26312 26313 26314 26315 26316 26317 26318 26319 26320 26321 26322 26323 26324 26325 26326 26327 26328 26329 26330 26331 26332 26333 26334 26335 26336 26337 26338 26339 26340 26341 26342 26343 26344 26345 26346 26347 26348 26349 26350 26351 26352 26353 26354 26355 26356 26357 26358 26359 26360 26361 26362 26363 26364 26365 26366 26367 26368 26369 26370 26371 26372 26373 26374 26375 26376 26377 26378 26379 26380 26381 26382 26383 26384 26385 26386 26387 26388 26389 26390 26391 26392 26393 26394 26395 26396 26397 26398 26399 26400 26401 26402 26403 26404 26405 26406 26407 26408 26409 26410 26411 26412 26413 26414 26415 26416 26417 26418 26419 26420 26421 26422 26423 26424 26425 26426 26427 26428 26429 26430 26431 26432 26433 26434 26435 26436 26437 26438 26439 26440 26441 26442 26443 26444 26445 26446 26447 26448 26449 26450 26451 26452 26453 26454 26455 26456 26457 26458 26459 26460 26461 26462 26463 26464 26465 26466 26467 26468 26469 26470 26471 26472 26473 26474 26475 26476 26477 26478 26479 26480 26481 26482 26483 26484 26485 26486 26487 26488 26489 26490 26491 26492 26493 26494 26495 26496 26497 26498 26499 26500 26501 26502 26503 26504 26505 26506 26507 26508 26509 26510 26511 26512 26513 26514 26515 26516 26517 26518 26519 26520 26521 26522 26523 26524 26525 26526 26527 26528 26529 26530 26531 26532 26533 26534 26535 26536 26537 26538 26539 26540 26541 26542 26543 26544 26545 26546 26547 26548 26549 26550 26551 26552 26553 26554 26555 26556 26557 26558 26559 26560 26561 26562 26563 26564 26565 26566 26567 26568 26569 26570 26571 26572 26573 26574 26575 26576 26577 26578 26579 26580 26581 26582 26583 26584 26585 26586 26587 26588 26589 26590 26591 26592 26593 26594 26595 26596 26597 26598 26599 26600 26601 26602 26603 26604 26605 26606 26607 26608 26609 26610 26611 26612 26613 26614 26615 26616 26617 26618 26619 26620 26621 26622 26623 26624 26625 26626 26627 26628 26629 26630 26631 26632 26633 26634 26635 26636 26637 26638 26639 26640 26641 26642 26643 26644 26645 26646 26647 26648 26649 26650 26651 26652 26653 26654 26655 26656 26657 26658 26659 26660 26661 26662 26663 26664 26665 26666 26667 26668 26669 26670 26671 26672 26673 26674 26675 26676 26677 26678 26679 26680 26681 26682 26683 26684 26685 26686 26687 26688 26689 26690 26691 26692 26693 26694 26695 26696 26697 26698 26699 26700 26701 26702 26703 26704 26705 26706 26707 26708 26709 26710 26711 26712 26713 26714 26715 26716 26717 26718 26719 26720 26721 26722 26723 26724 26725 26726 26727 26728 26729 26730 26731 26732 26733 26734 26735 26736 26737 26738 26739 26740 26741 26742 26743 26744 26745 26746 26747 26748 26749 26750 26751 26752 26753 26754 26755 26756 26757 26758 26759 26760 26761 26762 26763 26764 26765 26766 26767 26768 26769 26770 26771 26772 26773 26774 26775 26776 26777 26778 26779 26780 26781 26782 26783 26784 26785 26786 26787 26788 26789 26790 26791 26792 26793 26794 26795 26796 26797 26798 26799 26800 26801 26802 26803 26804 26805 26806 26807 26808 26809 26810 26811 26812 26813 26814 26815 26816 26817 26818 26819 26820 26821 26822 26823 26824 26825 26826 26827 26828 26829 26830 26831 26832 26833 26834 26835 26836 26837 26838 26839 26840 26841 26842 26843 26844 26845 26846 26847 26848 26849 26850 26851 26852 26853 26854 26855 26856 26857 26858 26859 26860 26861 26862 26863 26864 26865 26866 26867 26868 26869 26870 26871 26872 26873 26874 26875 26876 26877 26878 26879 26880 26881 26882 26883 26884 26885 26886 26887 26888 26889 26890 26891 26892 26893 26894 26895 26896 26897 26898 26899 26900 26901 26902 26903 26904 26905 26906 26907 26908 26909 26910 26911 26912 26913 26914 26915 26916 26917 26918 26919 26920 26921 26922 26923 26924 26925 26926 26927 26928 26929 26930 26931 26932 26933 26934 26935 26936 26937 26938 26939 26940 26941 26942 26943 26944 26945 26946 26947 26948 26949 26950 26951 26952 26953 26954 26955 26956 26957 26958 26959 26960 26961 26962 26963 26964 26965 26966 26967 26968 26969 26970 26971 26972 26973 26974 26975 26976 26977 26978 26979 26980 26981 26982 26983 26984 26985 26986 26987 26988 26989 26990 26991 26992 26993 26994 26995 26996 26997 26998 26999 27000 27001 27002 27003 27004 27005 27006 27007 27008 27009 27010 27011 27012 27013 27014 27015 27016 27017 27018 27019 27020 27021 27022 27023 27024 27025 27026 27027 27028 27029 27030 27031 27032 27033 27034 27035 27036 27037 27038 27039 27040 27041 27042 27043 27044 27045 27046 27047 27048 27049 27050 27051 27052 27053 27054 27055 27056 27057 27058 27059 27060 27061 27062 27063 27064 27065 27066 27067 27068 27069 27070 27071 27072 27073 27074 27075 27076 27077 27078 27079 27080 27081 27082 27083 27084 27085 27086 27087 27088 27089 27090 27091 27092 27093 27094 27095 27096 27097 27098 27099 27100 27101 27102 27103 27104 27105 27106 27107 27108 27109 27110 27111 27112 27113 27114 27115 27116 27117 27118 27119 27120 27121 27122 27123 27124 27125 27126 27127 27128 27129 27130 27131 27132 27133 27134 27135 27136 27137 27138 27139 27140 27141 27142 27143 27144 27145 27146 27147 27148 27149 27150 27151 27152 27153 27154 27155 27156 27157 27158 27159 27160 27161 27162 27163 27164 27165 27166 27167 27168 27169 27170 27171 27172 27173 27174 27175 27176 27177 27178 27179 27180 27181 27182 27183 27184 27185 27186 27187 27188 27189 27190 27191 27192 27193 27194 27195 27196 27197 27198 27199 27200 27201 27202 27203 27204 27205 27206 27207 27208 27209 27210 27211 27212 27213 27214 27215 27216 27217 27218 27219 27220 27221 27222 27223 27224 27225 27226 27227 27228 27229 27230 27231 27232 27233 27234 27235 27236 27237 27238 27239 27240 27241 27242 27243 27244 27245 27246 27247 27248 27249 27250 27251 27252 27253 27254 27255 27256 27257 27258 27259 27260 27261 27262 27263 27264 27265 27266 27267 27268 27269 27270 27271 27272 27273 27274 27275 27276 27277 27278 27279 27280 27281 27282 27283 27284 27285 27286 27287 27288 27289 27290 27291 27292 27293 27294 27295 27296 27297 27298 27299 27300 27301 27302 27303 27304 27305 27306 27307 27308 27309 27310 27311 27312 27313 27314 27315 27316 27317 27318 27319 27320 27321 27322 27323 27324 27325 27326 27327 27328 27329 27330 27331 27332 27333 27334 27335 27336 27337 27338 27339 27340 27341 27342 27343 27344 27345 27346 27347 27348 27349 27350 27351 27352 27353 27354 27355 27356 27357 27358 27359 27360 27361 27362 27363 27364 27365 27366 27367 27368 27369 27370 27371 27372 27373 27374 27375 27376 27377 27378 27379 27380 27381 27382 27383 27384 27385 27386 27387 27388 27389 27390 27391 27392 27393 27394 27395 27396 27397 27398 27399 27400 27401 27402 27403 27404 27405 27406 27407 27408 27409 27410 27411 27412 27413 27414 27415 27416 27417 27418 27419 27420 27421 27422 27423 27424 27425 27426 27427 27428 27429 27430 27431 27432 27433 27434 27435 27436 27437 27438 27439 27440 27441 27442 27443 27444 27445 27446 27447 27448 27449 27450 27451 27452 27453 27454 27455 27456 27457 27458 27459 27460 27461 27462 27463 27464 27465 27466 27467 27468 27469 27470 27471 27472 27473 27474 27475 27476 27477 27478 27479 27480 27481 27482 27483 27484 27485 27486 27487 27488 27489 27490 27491 27492 27493 27494 27495 27496 27497 27498 27499 27500 27501 27502 27503 27504 27505 27506 27507 27508 27509 27510 27511 27512 27513 27514 27515 27516 27517 27518 27519 27520 27521 27522 27523 27524 27525 27526 27527 27528 27529 27530 27531 27532 27533 27534 27535 27536 27537 27538 27539 27540 27541 27542 27543 27544 27545 27546 27547 27548 27549 27550 27551 27552 27553 27554 27555 27556 27557 27558 27559 27560 27561 27562 27563 27564 27565 27566 27567 27568 27569 27570 27571 27572 27573 27574 27575 27576 27577 27578 27579 27580 27581 27582 27583 27584 27585 27586 27587 27588 27589 27590 27591 27592 27593 27594 27595 27596 27597 27598 27599 27600 27601 27602 27603 27604 27605 27606 27607 27608 27609 27610 27611 27612 27613 27614 27615 27616 27617 27618 27619 27620 27621 27622 27623 27624 27625 27626 27627 27628 27629 27630 27631 27632 27633 27634 27635 27636 27637 27638 27639 27640 27641 27642 27643 27644 27645 27646 27647 27648 27649 27650 27651 27652 27653 27654 27655 27656 27657 27658 27659 27660 27661 27662 27663 27664 27665 27666 27667 27668 27669 27670 27671 27672 27673 27674 27675 27676 27677 27678 27679 27680 27681 27682 27683 27684 27685 27686 27687 27688 27689 27690 27691 27692 27693 27694 27695 27696 27697 27698 27699 27700 27701 27702 27703 27704 27705 27706 27707 27708 27709 27710 27711 27712 27713 27714 27715 27716 27717 27718 27719 27720 27721 27722 27723 27724 27725 27726 27727 27728 27729 27730 27731 27732 27733 27734 27735 27736 27737 27738 27739 27740 27741 27742 27743 27744 27745 27746 27747 27748 27749 27750 27751 27752 27753 27754 27755 27756 27757 27758 27759 27760 27761 27762 27763 27764 27765 27766 27767 27768 27769 27770 27771 27772 27773 27774 27775 27776 27777 27778 27779 27780 27781 27782 27783 27784 27785 27786 27787 27788 27789 27790 27791 27792 27793 27794 27795 27796 27797 27798 27799 27800 27801 27802 27803 27804 27805 27806 27807 27808 27809 27810 27811 27812 27813 27814 27815 27816 27817 27818 27819 27820 27821 27822 27823 27824 27825 27826 27827 27828 27829 27830 27831 27832 27833 27834 27835 27836 27837 27838 27839 27840 27841 27842 27843 27844 27845 27846 27847 27848 27849 27850 27851 27852 27853 27854 27855 27856 27857 27858 27859 27860 27861 27862 27863 27864 27865 27866 27867 27868 27869 27870 27871 27872 27873 27874 27875 27876 27877 27878 27879 27880 27881 27882 27883 27884 27885 27886 27887 27888 27889 27890 27891 27892 27893 27894 27895 27896 27897 27898 27899 27900 27901 27902 27903 27904 27905 27906 27907 27908 27909 27910 27911 27912 27913 27914 27915 27916 27917 27918 27919 27920 27921 27922 27923 27924 27925 27926 27927 27928 27929 27930 27931 27932 27933 27934 27935 27936 27937 27938 27939 27940 27941 27942 27943 27944 27945 27946 27947 27948 27949 27950 27951 27952 27953 27954 27955 27956 27957 27958 27959 27960 27961 27962 27963 27964 27965 27966 27967 27968 27969 27970 27971 27972 27973 27974 27975 27976 27977 27978 27979 27980 27981 27982 27983 27984 27985 27986 27987 27988 27989 27990 27991 27992 27993 27994 27995 27996 27997 27998 27999 28000 28001 28002 28003 28004 28005 28006 28007 28008 28009 28010 28011 28012 28013 28014 28015 28016 28017 28018 28019 28020 28021 28022 28023 28024 28025 28026 28027 28028 28029 28030 28031 28032 28033 28034 28035 28036 28037 28038 28039 28040 28041 28042 28043 28044 28045 28046 28047 28048 28049 28050 28051 28052 28053 28054 28055 28056 28057 28058 28059 28060 28061 28062 28063 28064 28065 28066 28067 28068 28069 28070 28071 28072 28073 28074 28075 28076 28077 28078 28079 28080 28081 28082 28083 28084 28085 28086 28087 28088 28089 28090 28091 28092 28093 28094 28095 28096 28097 28098 28099 28100 28101 28102 28103 28104 28105 28106 28107 28108 28109 28110 28111 28112 28113 28114 28115 28116 28117 28118 28119 28120 28121 28122 28123 28124 28125 28126 28127 28128 28129 28130 28131 28132 28133 28134 28135 28136 28137 28138 28139 28140 28141 28142 28143 28144 28145 28146 28147 28148 28149 28150 28151 28152 28153 28154 28155 28156 28157 28158 28159 28160 28161 28162 28163 28164 28165 28166 28167 28168 28169 28170 28171 28172 28173 28174 28175 28176 28177 28178 28179 28180 28181 28182 28183 28184 28185 28186 28187 28188 28189 28190 28191 28192 28193 28194 28195 28196 28197 28198 28199 28200 28201 28202 28203 28204 28205 28206 28207 28208 28209 28210 28211 28212 28213 28214 28215 28216 28217 28218 28219 28220 28221 28222 28223 28224 28225 28226 28227 28228 28229 28230 28231 28232 28233 28234 28235 28236 28237 28238 28239 28240 28241 28242 28243 28244 28245 28246 28247 28248 28249 28250 28251 28252 28253 28254 28255 28256 28257 28258 28259 28260 28261 28262 28263 28264 28265 28266 28267 28268 28269 28270 28271 28272 28273 28274 28275 28276 28277 28278 28279 28280 28281 28282 28283 28284 28285 28286 28287 28288 28289 28290 28291 28292 28293 28294 28295 28296 28297 28298 28299 28300 28301 28302 28303 28304 28305 28306 28307 28308 28309 28310 28311 28312 28313 28314 28315 28316 28317 28318 28319 28320 28321 28322 28323 28324 28325 28326 28327 28328 28329 28330 28331 28332 28333 28334 28335 28336 28337 28338 28339 28340 28341 28342 28343 28344 28345 28346 28347 28348 28349 28350 28351 28352 28353 28354 28355 28356 28357 28358 28359 28360 28361 28362 28363 28364 28365 28366 28367 28368 28369 28370 28371 28372 28373 28374 28375 28376 28377 28378 28379 28380 28381 28382 28383 28384 28385 28386 28387 28388 28389 28390 28391 28392 28393 28394 28395 28396 28397 28398 28399 28400 28401 28402 28403 28404 28405 28406 28407 28408 28409 28410 28411 28412 28413 28414 28415 28416 28417 28418 28419 28420 28421 28422 28423 28424 28425 28426 28427 28428 28429 28430 28431 28432 28433 28434 28435 28436 28437 28438 28439 28440 28441 28442 28443 28444 28445 28446 28447 28448 28449 28450 28451 28452 28453 28454 28455 28456 28457 28458 28459 28460 28461 28462 28463 28464 28465 28466 28467 28468 28469 28470 28471 28472 28473 28474 28475 28476 28477 28478 28479 28480 28481 28482 28483 28484 28485 28486 28487 28488 28489 28490 28491 28492 28493 28494 28495 28496 28497 28498 28499 28500 28501 28502 28503 28504 28505 28506 28507 28508 28509 28510 28511 28512 28513 28514 28515 28516 28517 28518 28519 28520 28521 28522 28523 28524 28525 28526 28527 28528 28529 28530 28531 28532 28533 28534 28535 28536 28537 28538 28539 28540 28541 28542 28543 28544 28545 28546 28547 28548 28549 28550 28551 28552 28553 28554 28555 28556 28557 28558 28559 28560 28561 28562 28563 28564 28565 28566 28567 28568 28569 28570 28571 28572 28573 28574 28575 28576 28577 28578 28579 28580 28581 28582 28583 28584 28585 28586 28587 28588 28589 28590 28591 28592 28593 28594 28595 28596 28597 28598 28599 28600 28601 28602 28603 28604 28605 28606 28607 28608 28609 28610 28611 28612 28613 28614 28615 28616 28617 28618 28619 28620 28621 28622 28623 28624 28625 28626 28627 28628 28629 28630 28631 28632 28633 28634 28635 28636 28637 28638 28639 28640 28641 28642 28643 28644 28645 28646 28647 28648 28649 28650 28651 28652 28653 28654 28655 28656 28657 28658 28659 28660 28661 28662 28663 28664 28665 28666 28667 28668 28669 28670 28671 28672 28673 28674 28675 28676 28677 28678 28679 28680 28681 28682 28683 28684 28685 28686 28687 28688 28689 28690 28691 28692 28693 28694 28695 28696 28697 28698 28699 28700 28701 28702 28703 28704 28705 28706 28707 28708 28709 28710 28711 28712 28713 28714 28715 28716 28717 28718 28719 28720 28721 28722 28723 28724 28725 28726 28727 28728 28729 28730 28731 28732 28733 28734 28735 28736 28737 28738 28739 28740 28741 28742 28743 28744 28745 28746 28747 28748 28749 28750 28751 28752 28753 28754 28755 28756 28757 28758 28759 28760 28761 28762 28763 28764 28765 28766 28767 28768 28769 28770 28771 28772 28773 28774 28775 28776 28777 28778 28779 28780 28781 28782 28783 28784 28785 28786 28787 28788 28789 28790 28791 28792 28793 28794 28795 28796 28797 28798 28799 28800 28801 28802 28803 28804 28805 28806 28807 28808 28809 28810 28811 28812 28813 28814 28815 28816 28817 28818 28819 28820 28821 28822 28823 28824 28825 28826 28827 28828 28829 28830 28831 28832 28833 28834 28835 28836 28837 28838 28839 28840 28841 28842 28843 28844 28845 28846 28847 28848 28849 28850 28851 28852 28853 28854 28855 28856 28857 28858 28859 28860 28861 28862 28863 28864 28865 28866 28867 28868 28869 28870 28871 28872 28873 28874 28875 28876 28877 28878 28879 28880 28881 28882 28883 28884 28885 28886 28887 28888 28889 28890 28891 28892 28893 28894 28895 28896 28897 28898 28899 28900 28901 28902 28903 28904 28905 28906 28907 28908 28909 28910 28911 28912 28913 28914 28915 28916 28917 28918 28919 28920 28921 28922 28923 28924 28925 28926 28927 28928 28929 28930 28931 28932 28933 28934 28935 28936 28937 28938 28939 28940 28941 28942 28943 28944 28945 28946 28947 28948 28949 28950 28951 28952 28953 28954 28955 28956 28957 28958 28959 28960 28961 28962 28963 28964 28965 28966 28967 28968 28969 28970 28971 28972 28973 28974 28975 28976 28977 28978 28979 28980 28981 28982 28983 28984 28985 28986 28987 28988 28989 28990 28991 28992 28993 28994 28995 28996 28997 28998 28999 29000 29001 29002 29003 29004 29005 29006 29007 29008 29009 29010 29011 29012 29013 29014 29015 29016 29017 29018 29019 29020 29021 29022 29023 29024 29025 29026 29027 29028 29029 29030 29031 29032 29033 29034 29035 29036 29037 29038 29039 29040 29041 29042 29043 29044 29045 29046 29047 29048 29049 29050 29051 29052 29053 29054 29055 29056 29057 29058 29059 29060 29061 29062 29063 29064 29065 29066 29067 29068 29069 29070 29071 29072 29073 29074 29075 29076 29077 29078 29079 29080 29081 29082 29083 29084 29085 29086 29087 29088 29089 29090 29091 29092 29093 29094 29095 29096 29097 29098 29099 29100 29101 29102 29103 29104 29105 29106 29107 29108 29109 29110 29111 29112 29113 29114 29115 29116 29117 29118 29119 29120 29121 29122 29123 29124 29125 29126 29127 29128 29129 29130 29131 29132 29133 29134 29135 29136 29137 29138 29139 29140 29141 29142 29143 29144 29145 29146 29147 29148 29149 29150 29151 29152 29153 29154 29155 29156 29157 29158 29159 29160 29161 29162 29163 29164 29165 29166 29167 29168 29169 29170 29171 29172 29173 29174 29175 29176 29177 29178 29179 29180 29181 29182 29183 29184 29185 29186 29187 29188 29189 29190 29191 29192 29193 29194 29195 29196 29197 29198 29199 29200 29201 29202 29203 29204 29205 29206 29207 29208 29209 29210 29211 29212 29213 29214 29215 29216 29217 29218 29219 29220 29221 29222 29223 29224 29225 29226 29227 29228 29229 29230 29231 29232 29233 29234 29235 29236 29237 29238 29239 29240 29241 29242 29243 29244 29245 29246 29247 29248 29249 29250 29251 29252 29253 29254 29255 29256 29257 29258 29259 29260 29261 29262 29263 29264 29265 29266 29267 29268 29269 29270 29271 29272 29273 29274 29275 29276 29277 29278 29279 29280 29281 29282 29283 29284 29285 29286 29287 29288 29289 29290 29291 29292 29293 29294 29295 29296 29297 29298 29299 29300 29301 29302 29303 29304 29305 29306 29307 29308 29309 29310 29311 29312 29313 29314 29315 29316 29317 29318 29319 29320 29321 29322 29323 29324 29325 29326 29327 29328 29329 29330 29331 29332 29333 29334 29335 29336 29337 29338 29339 29340 29341 29342 29343 29344 29345 29346 29347 29348 29349 29350 | <html lang="en">
<head>
<title>GNAT User's Guide </title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="GNAT User's Guide ">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="top" href="#Top">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 1995-2009 Free Software Foundation,
Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts and with no Back-Cover
Texts. A copy of the license is included in the section entitled
``GNU Free Documentation License''.-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<h1 class="settitle">GNAT User's Guide </h1>
<div class="node">
<a name="Top"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#About-This-Guide">About This Guide</a>,
Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>,
Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
</div>
<h2 class="unnumbered">GNAT User's Guide</h2>
<p class="noindent">GNAT User's Guide
<p class="noindent">GNAT, The GNU Ada Compiler<br>
GCC version 4.6.3<br>
<p class="noindent">AdaCore<br>
<ul class="menu">
<li><a accesskey="1" href="#About-This-Guide">About This Guide</a>
<li><a accesskey="2" href="#Getting-Started-with-GNAT">Getting Started with GNAT</a>
<li><a accesskey="3" href="#The-GNAT-Compilation-Model">The GNAT Compilation Model</a>
<li><a accesskey="4" href="#Compiling-Using-gcc">Compiling Using gcc</a>
<li><a accesskey="5" href="#Binding-Using-gnatbind">Binding Using gnatbind</a>
<li><a accesskey="6" href="#Linking-Using-gnatlink">Linking Using gnatlink</a>
<li><a accesskey="7" href="#The-GNAT-Make-Program-gnatmake">The GNAT Make Program gnatmake</a>
<li><a accesskey="8" href="#Improving-Performance">Improving Performance</a>
<li><a accesskey="9" href="#Renaming-Files-Using-gnatchop">Renaming Files Using gnatchop</a>
<li><a href="#Configuration-Pragmas">Configuration Pragmas</a>
<li><a href="#Handling-Arbitrary-File-Naming-Conventions-Using-gnatname">Handling Arbitrary File Naming Conventions Using gnatname</a>
<li><a href="#GNAT-Project-Manager">GNAT Project Manager</a>
<li><a href="#Tools-Supporting-Project-Files">Tools Supporting Project Files</a>
<li><a href="#The-Cross_002dReferencing-Tools-gnatxref-and-gnatfind">The Cross-Referencing Tools gnatxref and gnatfind</a>
<li><a href="#The-GNAT-Pretty_002dPrinter-gnatpp">The GNAT Pretty-Printer gnatpp</a>
<li><a href="#The-GNAT-Metric-Tool-gnatmetric">The GNAT Metric Tool gnatmetric</a>
<li><a href="#File-Name-Krunching-Using-gnatkr">File Name Krunching Using gnatkr</a>
<li><a href="#Preprocessing-Using-gnatprep">Preprocessing Using gnatprep</a>
<li><a href="#The-GNAT-Library-Browser-gnatls">The GNAT Library Browser gnatls</a>
<li><a href="#Cleaning-Up-Using-gnatclean">Cleaning Up Using gnatclean</a>
<li><a href="#GNAT-and-Libraries">GNAT and Libraries</a>
<li><a href="#Using-the-GNU-make-Utility">Using the GNU make Utility</a>
<li><a href="#Memory-Management-Issues">Memory Management Issues</a>
<li><a href="#Stack-Related-Facilities">Stack Related Facilities</a>
<li><a href="#Verifying-Properties-Using-gnatcheck">Verifying Properties Using gnatcheck</a>
<li><a href="#Creating-Sample-Bodies-Using-gnatstub">Creating Sample Bodies Using gnatstub</a>
<li><a href="#Generating-Ada-Bindings-for-C-and-C_002b_002b-headers">Generating Ada Bindings for C and C++ headers</a>
<li><a href="#Other-Utility-Programs">Other Utility Programs</a>
<li><a href="#Running-and-Debugging-Ada-Programs">Running and Debugging Ada Programs</a>
<li><a href="#Code-Coverage-and-Profiling">Code Coverage and Profiling</a>
<li><a href="#Platform_002dSpecific-Information-for-the-Run_002dTime-Libraries">Platform-Specific Information for the Run-Time Libraries</a>
<li><a href="#Example-of-Binder-Output-File">Example of Binder Output File</a>
<li><a href="#Elaboration-Order-Handling-in-GNAT">Elaboration Order Handling in GNAT</a>
<li><a href="#Conditional-Compilation">Conditional Compilation</a>
<li><a href="#Inline-Assembler">Inline Assembler</a>
<li><a href="#Compatibility-and-Porting-Guide">Compatibility and Porting Guide</a>
<li><a href="#Microsoft-Windows-Topics">Microsoft Windows Topics</a>
<li><a href="#GNU-Free-Documentation-License">GNU Free Documentation License</a>
<li><a href="#Index">Index</a>
</li></ul>
<p>--- The Detailed Node Listing ---
<p>About This Guide
</p>
<ul class="menu">
<li><a href="#What-This-Guide-Contains">What This Guide Contains</a>
<li><a href="#What-You-Should-Know-before-Reading-This-Guide">What You Should Know before Reading This Guide</a>
<li><a href="#Related-Information">Related Information</a>
<li><a href="#Conventions">Conventions</a>
</li></ul>
<p>Getting Started with GNAT
</p>
<ul class="menu">
<li><a href="#Running-GNAT">Running GNAT</a>
<li><a href="#Running-a-Simple-Ada-Program">Running a Simple Ada Program</a>
<li><a href="#Running-a-Program-with-Multiple-Units">Running a Program with Multiple Units</a>
<li><a href="#Using-the-gnatmake-Utility">Using the gnatmake Utility</a>
<li><a href="#Introduction-to-GPS">Introduction to GPS</a>
</li></ul>
<p>The GNAT Compilation Model
</p>
<ul class="menu">
<li><a href="#Source-Representation">Source Representation</a>
<li><a href="#Foreign-Language-Representation">Foreign Language Representation</a>
<li><a href="#File-Naming-Rules">File Naming Rules</a>
<li><a href="#Using-Other-File-Names">Using Other File Names</a>
<li><a href="#Alternative-File-Naming-Schemes">Alternative File Naming Schemes</a>
<li><a href="#Generating-Object-Files">Generating Object Files</a>
<li><a href="#Source-Dependencies">Source Dependencies</a>
<li><a href="#The-Ada-Library-Information-Files">The Ada Library Information Files</a>
<li><a href="#Binding-an-Ada-Program">Binding an Ada Program</a>
<li><a href="#Mixed-Language-Programming">Mixed Language Programming</a>
<li><a href="#Building-Mixed-Ada-_0026-C_002b_002b-Programs">Building Mixed Ada & C++ Programs</a>
<li><a href="#Comparison-between-GNAT-and-C_002fC_002b_002b-Compilation-Models">Comparison between GNAT and C/C++ Compilation Models</a>
<li><a href="#Comparison-between-GNAT-and-Conventional-Ada-Library-Models">Comparison between GNAT and Conventional Ada Library Models</a>
</li></ul>
<p>Foreign Language Representation
</p>
<ul class="menu">
<li><a href="#Latin_002d1">Latin-1</a>
<li><a href="#Other-8_002dBit-Codes">Other 8-Bit Codes</a>
<li><a href="#Wide-Character-Encodings">Wide Character Encodings</a>
</li></ul>
<p>Compiling Ada Programs With gcc
</p>
<ul class="menu">
<li><a href="#Compiling-Programs">Compiling Programs</a>
<li><a href="#Switches-for-gcc">Switches for gcc</a>
<li><a href="#Search-Paths-and-the-Run_002dTime-Library-_0028RTL_0029">Search Paths and the Run-Time Library (RTL)</a>
<li><a href="#Order-of-Compilation-Issues">Order of Compilation Issues</a>
<li><a href="#Examples">Examples</a>
</li></ul>
<p>Switches for gcc
</p>
<ul class="menu">
<li><a href="#Output-and-Error-Message-Control">Output and Error Message Control</a>
<li><a href="#Warning-Message-Control">Warning Message Control</a>
<li><a href="#Debugging-and-Assertion-Control">Debugging and Assertion Control</a>
<li><a href="#Validity-Checking">Validity Checking</a>
<li><a href="#Style-Checking">Style Checking</a>
<li><a href="#Run_002dTime-Checks">Run-Time Checks</a>
<li><a href="#Using-gcc-for-Syntax-Checking">Using gcc for Syntax Checking</a>
<li><a href="#Using-gcc-for-Semantic-Checking">Using gcc for Semantic Checking</a>
<li><a href="#Compiling-Different-Versions-of-Ada">Compiling Different Versions of Ada</a>
<li><a href="#Character-Set-Control">Character Set Control</a>
<li><a href="#File-Naming-Control">File Naming Control</a>
<li><a href="#Subprogram-Inlining-Control">Subprogram Inlining Control</a>
<li><a href="#Auxiliary-Output-Control">Auxiliary Output Control</a>
<li><a href="#Debugging-Control">Debugging Control</a>
<li><a href="#Exception-Handling-Control">Exception Handling Control</a>
<li><a href="#Units-to-Sources-Mapping-Files">Units to Sources Mapping Files</a>
<li><a href="#Integrated-Preprocessing">Integrated Preprocessing</a>
</li></ul>
<p>Binding Ada Programs With gnatbind
</p>
<ul class="menu">
<li><a href="#Running-gnatbind">Running gnatbind</a>
<li><a href="#Switches-for-gnatbind">Switches for gnatbind</a>
<li><a href="#Command_002dLine-Access">Command-Line Access</a>
<li><a href="#Search-Paths-for-gnatbind">Search Paths for gnatbind</a>
<li><a href="#Examples-of-gnatbind-Usage">Examples of gnatbind Usage</a>
</li></ul>
<p>Switches for gnatbind
</p>
<ul class="menu">
<li><a href="#Consistency_002dChecking-Modes">Consistency-Checking Modes</a>
<li><a href="#Binder-Error-Message-Control">Binder Error Message Control</a>
<li><a href="#Elaboration-Control">Elaboration Control</a>
<li><a href="#Output-Control">Output Control</a>
<li><a href="#Binding-with-Non_002dAda-Main-Programs">Binding with Non-Ada Main Programs</a>
<li><a href="#Binding-Programs-with-No-Main-Subprogram">Binding Programs with No Main Subprogram</a>
</li></ul>
<p>Linking Using gnatlink
</p>
<ul class="menu">
<li><a href="#Running-gnatlink">Running gnatlink</a>
<li><a href="#Switches-for-gnatlink">Switches for gnatlink</a>
</li></ul>
<p>The GNAT Make Program gnatmake
</p>
<ul class="menu">
<li><a href="#Running-gnatmake">Running gnatmake</a>
<li><a href="#Switches-for-gnatmake">Switches for gnatmake</a>
<li><a href="#Mode-Switches-for-gnatmake">Mode Switches for gnatmake</a>
<li><a href="#Notes-on-the-Command-Line">Notes on the Command Line</a>
<li><a href="#How-gnatmake-Works">How gnatmake Works</a>
<li><a href="#Examples-of-gnatmake-Usage">Examples of gnatmake Usage</a>
</li></ul>
<p>Improving Performance
</p>
<ul class="menu">
<li><a href="#Performance-Considerations">Performance Considerations</a>
<li><a href="#Text_005fIO-Suggestions">Text_IO Suggestions</a>
<li><a href="#Reducing-Size-of-Ada-Executables-with-gnatelim">Reducing Size of Ada Executables with gnatelim</a>
<li><a href="#Reducing-Size-of-Executables-with-unused-subprogram_002fdata-elimination">Reducing Size of Executables with unused subprogram/data elimination</a>
</li></ul>
<p>Performance Considerations
</p>
<ul class="menu">
<li><a href="#Controlling-Run_002dTime-Checks">Controlling Run-Time Checks</a>
<li><a href="#Use-of-Restrictions">Use of Restrictions</a>
<li><a href="#Optimization-Levels">Optimization Levels</a>
<li><a href="#Debugging-Optimized-Code">Debugging Optimized Code</a>
<li><a href="#Inlining-of-Subprograms">Inlining of Subprograms</a>
<li><a href="#Other-Optimization-Switches">Other Optimization Switches</a>
<li><a href="#Optimization-and-Strict-Aliasing">Optimization and Strict Aliasing</a>
</li></ul>
<p>Reducing Size of Ada Executables with gnatelim
</p>
<ul class="menu">
<li><a href="#About-gnatelim">About gnatelim</a>
<li><a href="#Running-gnatelim">Running gnatelim</a>
<li><a href="#Processing-Precompiled-Libraries">Processing Precompiled Libraries</a>
<li><a href="#Correcting-the-List-of-Eliminate-Pragmas">Correcting the List of Eliminate Pragmas</a>
<li><a href="#Making-Your-Executables-Smaller">Making Your Executables Smaller</a>
<li><a href="#Summary-of-the-gnatelim-Usage-Cycle">Summary of the gnatelim Usage Cycle</a>
</li></ul>
<p>Reducing Size of Executables with unused subprogram/data elimination
</p>
<ul class="menu">
<li><a href="#About-unused-subprogram_002fdata-elimination">About unused subprogram/data elimination</a>
<li><a href="#Compilation-options">Compilation options</a>
</li></ul>
<p>Renaming Files Using gnatchop
</p>
<ul class="menu">
<li><a href="#Handling-Files-with-Multiple-Units">Handling Files with Multiple Units</a>
<li><a href="#Operating-gnatchop-in-Compilation-Mode">Operating gnatchop in Compilation Mode</a>
<li><a href="#Command-Line-for-gnatchop">Command Line for gnatchop</a>
<li><a href="#Switches-for-gnatchop">Switches for gnatchop</a>
<li><a href="#Examples-of-gnatchop-Usage">Examples of gnatchop Usage</a>
</li></ul>
<p>Configuration Pragmas
</p>
<ul class="menu">
<li><a href="#Handling-of-Configuration-Pragmas">Handling of Configuration Pragmas</a>
<li><a href="#The-Configuration-Pragmas-Files">The Configuration Pragmas Files</a>
</li></ul>
<p>Handling Arbitrary File Naming Conventions Using gnatname
</p>
<ul class="menu">
<li><a href="#Arbitrary-File-Naming-Conventions">Arbitrary File Naming Conventions</a>
<li><a href="#Running-gnatname">Running gnatname</a>
<li><a href="#Switches-for-gnatname">Switches for gnatname</a>
<li><a href="#Examples-of-gnatname-Usage">Examples of gnatname Usage</a>
</li></ul>
<p>The Cross-Referencing Tools gnatxref and gnatfind
</p>
<ul class="menu">
<li><a href="#Switches-for-gnatxref">Switches for gnatxref</a>
<li><a href="#Switches-for-gnatfind">Switches for gnatfind</a>
<li><a href="#Project-Files-for-gnatxref-and-gnatfind">Project Files for gnatxref and gnatfind</a>
<li><a href="#Regular-Expressions-in-gnatfind-and-gnatxref">Regular Expressions in gnatfind and gnatxref</a>
<li><a href="#Examples-of-gnatxref-Usage">Examples of gnatxref Usage</a>
<li><a href="#Examples-of-gnatfind-Usage">Examples of gnatfind Usage</a>
</li></ul>
<p>The GNAT Pretty-Printer gnatpp
</p>
<ul class="menu">
<li><a href="#Switches-for-gnatpp">Switches for gnatpp</a>
<li><a href="#Formatting-Rules">Formatting Rules</a>
</li></ul>
<p>The GNAT Metrics Tool gnatmetric
</p>
<ul class="menu">
<li><a href="#Switches-for-gnatmetric">Switches for gnatmetric</a>
</li></ul>
<p>File Name Krunching Using gnatkr
</p>
<ul class="menu">
<li><a href="#About-gnatkr">About gnatkr</a>
<li><a href="#Using-gnatkr">Using gnatkr</a>
<li><a href="#Krunching-Method">Krunching Method</a>
<li><a href="#Examples-of-gnatkr-Usage">Examples of gnatkr Usage</a>
</li></ul>
<p>Preprocessing Using gnatprep
</p>
<ul class="menu">
<li><a href="#Preprocessing-Symbols">Preprocessing Symbols</a>
<li><a href="#Using-gnatprep">Using gnatprep</a>
<li><a href="#Switches-for-gnatprep">Switches for gnatprep</a>
<li><a href="#Form-of-Definitions-File">Form of Definitions File</a>
<li><a href="#Form-of-Input-Text-for-gnatprep">Form of Input Text for gnatprep</a>
</li></ul>
<p>The GNAT Library Browser gnatls
</p>
<ul class="menu">
<li><a href="#Running-gnatls">Running gnatls</a>
<li><a href="#Switches-for-gnatls">Switches for gnatls</a>
<li><a href="#Examples-of-gnatls-Usage">Examples of gnatls Usage</a>
</li></ul>
<p>Cleaning Up Using gnatclean
</p>
<ul class="menu">
<li><a href="#Running-gnatclean">Running gnatclean</a>
<li><a href="#Switches-for-gnatclean">Switches for gnatclean</a>
<!-- * Examples of gnatclean Usage:: -->
</li></ul>
<p>GNAT and Libraries
</p>
<ul class="menu">
<li><a href="#Introduction-to-Libraries-in-GNAT">Introduction to Libraries in GNAT</a>
<li><a href="#General-Ada-Libraries">General Ada Libraries</a>
<li><a href="#Stand_002dalone-Ada-Libraries">Stand-alone Ada Libraries</a>
<li><a href="#Rebuilding-the-GNAT-Run_002dTime-Library">Rebuilding the GNAT Run-Time Library</a>
</li></ul>
<p>Using the GNU make Utility
</p>
<ul class="menu">
<li><a href="#Using-gnatmake-in-a-Makefile">Using gnatmake in a Makefile</a>
<li><a href="#Automatically-Creating-a-List-of-Directories">Automatically Creating a List of Directories</a>
<li><a href="#Generating-the-Command-Line-Switches">Generating the Command Line Switches</a>
<li><a href="#Overcoming-Command-Line-Length-Limits">Overcoming Command Line Length Limits</a>
</li></ul>
<p>Memory Management Issues
</p>
<ul class="menu">
<li><a href="#Some-Useful-Memory-Pools">Some Useful Memory Pools</a>
<li><a href="#The-GNAT-Debug-Pool-Facility">The GNAT Debug Pool Facility</a>
<li><a href="#The-gnatmem-Tool">The gnatmem Tool</a>
</li></ul>
<p>Stack Related Facilities
</p>
<ul class="menu">
<li><a href="#Stack-Overflow-Checking">Stack Overflow Checking</a>
<li><a href="#Static-Stack-Usage-Analysis">Static Stack Usage Analysis</a>
<li><a href="#Dynamic-Stack-Usage-Analysis">Dynamic Stack Usage Analysis</a>
</li></ul>
<p>Some Useful Memory Pools
<p>The GNAT Debug Pool Facility
<p>The gnatmem Tool
</p>
<ul class="menu">
<li><a href="#Running-gnatmem">Running gnatmem</a>
<li><a href="#Switches-for-gnatmem">Switches for gnatmem</a>
<li><a href="#Example-of-gnatmem-Usage">Example of gnatmem Usage</a>
</li></ul>
<p>Verifying Properties Using gnatcheck
<p>Sample Bodies Using gnatstub
</p>
<ul class="menu">
<li><a href="#Running-gnatstub">Running gnatstub</a>
<li><a href="#Switches-for-gnatstub">Switches for gnatstub</a>
</li></ul>
<p>Other Utility Programs
</p>
<ul class="menu">
<li><a href="#Using-Other-Utility-Programs-with-GNAT">Using Other Utility Programs with GNAT</a>
<li><a href="#The-External-Symbol-Naming-Scheme-of-GNAT">The External Symbol Naming Scheme of GNAT</a>
<li><a href="#Converting-Ada-Files-to-html-with-gnathtml">Converting Ada Files to html with gnathtml</a>
</li></ul>
<p>Code Coverage and Profiling
</p>
<ul class="menu">
<li><a href="#Code-Coverage-of-Ada-Programs-using-gcov">Code Coverage of Ada Programs using gcov</a>
<li><a href="#Profiling-an-Ada-Program-using-gprof">Profiling an Ada Program using gprof</a>
</li></ul>
<p>Running and Debugging Ada Programs
</p>
<ul class="menu">
<li><a href="#The-GNAT-Debugger-GDB">The GNAT Debugger GDB</a>
<li><a href="#Running-GDB">Running GDB</a>
<li><a href="#Introduction-to-GDB-Commands">Introduction to GDB Commands</a>
<li><a href="#Using-Ada-Expressions">Using Ada Expressions</a>
<li><a href="#Calling-User_002dDefined-Subprograms">Calling User-Defined Subprograms</a>
<li><a href="#Using-the-Next-Command-in-a-Function">Using the Next Command in a Function</a>
<li><a href="#Ada-Exceptions">Ada Exceptions</a>
<li><a href="#Ada-Tasks">Ada Tasks</a>
<li><a href="#Debugging-Generic-Units">Debugging Generic Units</a>
<li><a href="#Remote-Debugging-using-gdbserver">Remote Debugging using gdbserver</a>
<li><a href="#GNAT-Abnormal-Termination-or-Failure-to-Terminate">GNAT Abnormal Termination or Failure to Terminate</a>
<li><a href="#Naming-Conventions-for-GNAT-Source-Files">Naming Conventions for GNAT Source Files</a>
<li><a href="#Getting-Internal-Debugging-Information">Getting Internal Debugging Information</a>
<li><a href="#Stack-Traceback">Stack Traceback</a>
</li></ul>
<p>Platform-Specific Information for the Run-Time Libraries
</p>
<ul class="menu">
<li><a href="#Summary-of-Run_002dTime-Configurations">Summary of Run-Time Configurations</a>
<li><a href="#Specifying-a-Run_002dTime-Library">Specifying a Run-Time Library</a>
<li><a href="#Choosing-the-Scheduling-Policy">Choosing the Scheduling Policy</a>
<li><a href="#Solaris_002dSpecific-Considerations">Solaris-Specific Considerations</a>
<li><a href="#Linux_002dSpecific-Considerations">Linux-Specific Considerations</a>
<li><a href="#AIX_002dSpecific-Considerations">AIX-Specific Considerations</a>
<li><a href="#Irix_002dSpecific-Considerations">Irix-Specific Considerations</a>
<li><a href="#RTX_002dSpecific-Considerations">RTX-Specific Considerations</a>
<li><a href="#HP_002dUX_002dSpecific-Considerations">HP-UX-Specific Considerations</a>
</li></ul>
<p>Example of Binder Output File
<p>Elaboration Order Handling in GNAT
</p>
<ul class="menu">
<li><a href="#Elaboration-Code">Elaboration Code</a>
<li><a href="#Checking-the-Elaboration-Order">Checking the Elaboration Order</a>
<li><a href="#Controlling-the-Elaboration-Order">Controlling the Elaboration Order</a>
<li><a href="#Controlling-Elaboration-in-GNAT-_002d-Internal-Calls">Controlling Elaboration in GNAT - Internal Calls</a>
<li><a href="#Controlling-Elaboration-in-GNAT-_002d-External-Calls">Controlling Elaboration in GNAT - External Calls</a>
<li><a href="#Default-Behavior-in-GNAT-_002d-Ensuring-Safety">Default Behavior in GNAT - Ensuring Safety</a>
<li><a href="#Treatment-of-Pragma-Elaborate">Treatment of Pragma Elaborate</a>
<li><a href="#Elaboration-Issues-for-Library-Tasks">Elaboration Issues for Library Tasks</a>
<li><a href="#Mixing-Elaboration-Models">Mixing Elaboration Models</a>
<li><a href="#What-to-Do-If-the-Default-Elaboration-Behavior-Fails">What to Do If the Default Elaboration Behavior Fails</a>
<li><a href="#Elaboration-for-Access_002dto_002dSubprogram-Values">Elaboration for Access-to-Subprogram Values</a>
<li><a href="#Summary-of-Procedures-for-Elaboration-Control">Summary of Procedures for Elaboration Control</a>
<li><a href="#Other-Elaboration-Order-Considerations">Other Elaboration Order Considerations</a>
</li></ul>
<p>Conditional Compilation
</p>
<ul class="menu">
<li><a href="#Use-of-Boolean-Constants">Use of Boolean Constants</a>
<li><a href="#Debugging-_002d-A-Special-Case">Debugging - A Special Case</a>
<li><a href="#Conditionalizing-Declarations">Conditionalizing Declarations</a>
<li><a href="#Use-of-Alternative-Implementations">Use of Alternative Implementations</a>
<li><a href="#Preprocessing">Preprocessing</a>
</li></ul>
<p>Inline Assembler
</p>
<ul class="menu">
<li><a href="#Basic-Assembler-Syntax">Basic Assembler Syntax</a>
<li><a href="#A-Simple-Example-of-Inline-Assembler">A Simple Example of Inline Assembler</a>
<li><a href="#Output-Variables-in-Inline-Assembler">Output Variables in Inline Assembler</a>
<li><a href="#Input-Variables-in-Inline-Assembler">Input Variables in Inline Assembler</a>
<li><a href="#Inlining-Inline-Assembler-Code">Inlining Inline Assembler Code</a>
<li><a href="#Other-Asm-Functionality">Other Asm Functionality</a>
</li></ul>
<p>Compatibility and Porting Guide
</p>
<ul class="menu">
<li><a href="#Compatibility-with-Ada-83">Compatibility with Ada 83</a>
<li><a href="#Compatibility-between-Ada-95-and-Ada-2005">Compatibility between Ada 95 and Ada 2005</a>
<li><a href="#Implementation_002ddependent-characteristics">Implementation-dependent characteristics</a>
<!-- This brief section is only in the non-VMS version -->
<!-- The complete chapter on HP Ada issues is in the VMS version -->
<li><a href="#Compatibility-with-HP-Ada-83">Compatibility with HP Ada 83</a>
<li><a href="#Compatibility-with-Other-Ada-Systems">Compatibility with Other Ada Systems</a>
<li><a href="#Representation-Clauses">Representation Clauses</a>
</li></ul>
<p>Microsoft Windows Topics
</p>
<ul class="menu">
<li><a href="#Using-GNAT-on-Windows">Using GNAT on Windows</a>
<li><a href="#CONSOLE-and-WINDOWS-subsystems">CONSOLE and WINDOWS subsystems</a>
<li><a href="#Temporary-Files">Temporary Files</a>
<li><a href="#Mixed_002dLanguage-Programming-on-Windows">Mixed-Language Programming on Windows</a>
<li><a href="#Windows-Calling-Conventions">Windows Calling Conventions</a>
<li><a href="#Introduction-to-Dynamic-Link-Libraries-_0028DLLs_0029">Introduction to Dynamic Link Libraries (DLLs)</a>
<li><a href="#Using-DLLs-with-GNAT">Using DLLs with GNAT</a>
<li><a href="#Building-DLLs-with-GNAT">Building DLLs with GNAT</a>
<li><a href="#GNAT-and-Windows-Resources">GNAT and Windows Resources</a>
<li><a href="#Debugging-a-DLL">Debugging a DLL</a>
<li><a href="#Setting-Stack-Size-from-gnatlink">Setting Stack Size from gnatlink</a>
<li><a href="#Setting-Heap-Size-from-gnatlink">Setting Heap Size from gnatlink</a>
<li><a href="#Index">Index</a>
</ul>
<div class="node">
<a name="About-This-Guide"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Getting-Started-with-GNAT">Getting Started with GNAT</a>,
Previous: <a rel="previous" accesskey="p" href="#Top">Top</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="unnumbered">About This Guide</h2>
<p class="noindent">This guide describes the use of GNAT,
a compiler and software development
toolset for the full Ada programming language.
It documents the features of the compiler and tools, and explains
how to use them to build Ada applications.
<p>GNAT implements Ada 95 and Ada 2005, and it may also be invoked in
Ada 83 compatibility mode.
By default, GNAT assumes Ada 2005,
but you can override with a compiler switch
(see <a href="#Compiling-Different-Versions-of-Ada">Compiling Different Versions of Ada</a>)
to explicitly specify the language version.
Throughout this manual, references to “Ada” without a year suffix
apply to both the Ada 95 and Ada 2005 versions of the language.
<ul class="menu">
<li><a accesskey="1" href="#What-This-Guide-Contains">What This Guide Contains</a>
<li><a accesskey="2" href="#What-You-Should-Know-before-Reading-This-Guide">What You Should Know before Reading This Guide</a>
<li><a accesskey="3" href="#Related-Information">Related Information</a>
<li><a accesskey="4" href="#Conventions">Conventions</a>
</ul>
<div class="node">
<a name="What-This-Guide-Contains"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#What-You-Should-Know-before-Reading-This-Guide">What You Should Know before Reading This Guide</a>,
Up: <a rel="up" accesskey="u" href="#About-This-Guide">About This Guide</a>
</div>
<h3 class="unnumberedsec">What This Guide Contains</h3>
<p class="noindent">This guide contains the following chapters:
<ul>
<li><a href="#Getting-Started-with-GNAT">Getting Started with GNAT</a>, describes how to get started compiling
and running Ada programs with the GNAT Ada programming environment.
<li><a href="#The-GNAT-Compilation-Model">The GNAT Compilation Model</a>, describes the compilation model used
by GNAT.
<li><a href="#Compiling-Using-gcc">Compiling Using gcc</a>, describes how to compile
Ada programs with <samp><span class="command">gcc</span></samp>, the Ada compiler.
<li><a href="#Binding-Using-gnatbind">Binding Using gnatbind</a>, describes how to
perform binding of Ada programs with <code>gnatbind</code>, the GNAT binding
utility.
<li><a href="#Linking-Using-gnatlink">Linking Using gnatlink</a>,
describes <samp><span class="command">gnatlink</span></samp>, a
program that provides for linking using the GNAT run-time library to
construct a program. <samp><span class="command">gnatlink</span></samp> can also incorporate foreign language
object units into the executable.
<li><a href="#The-GNAT-Make-Program-gnatmake">The GNAT Make Program gnatmake</a>, describes <samp><span class="command">gnatmake</span></samp>, a
utility that automatically determines the set of sources
needed by an Ada compilation unit, and executes the necessary compilations
binding and link.
<li><a href="#Improving-Performance">Improving Performance</a>, shows various techniques for making your
Ada program run faster or take less space.
It discusses the effect of the compiler's optimization switch and
also describes the <samp><span class="command">gnatelim</span></samp> tool and unused subprogram/data
elimination.
<li><a href="#Renaming-Files-Using-gnatchop">Renaming Files Using gnatchop</a>, describes
<code>gnatchop</code>, a utility that allows you to preprocess a file that
contains Ada source code, and split it into one or more new files, one
for each compilation unit.
<li><a href="#Configuration-Pragmas">Configuration Pragmas</a>, describes the configuration pragmas
handled by GNAT.
<li><a href="#Handling-Arbitrary-File-Naming-Conventions-Using-gnatname">Handling Arbitrary File Naming Conventions Using gnatname</a>,
shows how to override the default GNAT file naming conventions,
either for an individual unit or globally.
<li><a href="#GNAT-Project-Manager">GNAT Project Manager</a>, describes how to use project files
to organize large projects.
<li><a href="#The-Cross_002dReferencing-Tools-gnatxref-and-gnatfind">The Cross-Referencing Tools gnatxref and gnatfind</a>, discusses
<code>gnatxref</code> and <code>gnatfind</code>, two tools that provide an easy
way to navigate through sources.
<li><a href="#The-GNAT-Pretty_002dPrinter-gnatpp">The GNAT Pretty-Printer gnatpp</a>, shows how to produce a reformatted
version of an Ada source file with control over casing, indentation,
comment placement, and other elements of program presentation style.
<li><a href="#The-GNAT-Metric-Tool-gnatmetric">The GNAT Metric Tool gnatmetric</a>, shows how to compute various
metrics for an Ada source file, such as the number of types and subprograms,
and assorted complexity measures.
<li><a href="#File-Name-Krunching-Using-gnatkr">File Name Krunching Using gnatkr</a>, describes the <code>gnatkr</code>
file name krunching utility, used to handle shortened
file names on operating systems with a limit on the length of names.
<li><a href="#Preprocessing-Using-gnatprep">Preprocessing Using gnatprep</a>, describes <code>gnatprep</code>, a
preprocessor utility that allows a single source file to be used to
generate multiple or parameterized source files by means of macro
substitution.
<li><a href="#The-GNAT-Library-Browser-gnatls">The GNAT Library Browser gnatls</a>, describes <code>gnatls</code>, a
utility that displays information about compiled units, including dependences
on the corresponding sources files, and consistency of compilations.
<li><a href="#Cleaning-Up-Using-gnatclean">Cleaning Up Using gnatclean</a>, describes <code>gnatclean</code>, a utility
to delete files that are produced by the compiler, binder and linker.
<li><a href="#GNAT-and-Libraries">GNAT and Libraries</a>, describes the process of creating and using
Libraries with GNAT. It also describes how to recompile the GNAT run-time
library.
<li><a href="#Using-the-GNU-make-Utility">Using the GNU make Utility</a>, describes some techniques for using
the GNAT toolset in Makefiles.
<li><a href="#Memory-Management-Issues">Memory Management Issues</a>, describes some useful predefined storage pools
and in particular the GNAT Debug Pool facility, which helps detect incorrect
memory references.
It also describes <samp><span class="command">gnatmem</span></samp>, a utility that monitors dynamic
allocation and deallocation and helps detect “memory leaks”.
<li><a href="#Stack-Related-Facilities">Stack Related Facilities</a>, describes some useful tools associated with
stack checking and analysis.
<li><a href="#Verifying-Properties-Using-gnatcheck">Verifying Properties Using gnatcheck</a>, discusses <code>gnatcheck</code>,
a utility that checks Ada code against a set of rules.
<li><a href="#Creating-Sample-Bodies-Using-gnatstub">Creating Sample Bodies Using gnatstub</a>, discusses <code>gnatstub</code>,
a utility that generates empty but compilable bodies for library units.
<li><a href="#Generating-Ada-Bindings-for-C-and-C_002b_002b-headers">Generating Ada Bindings for C and C++ headers</a>, describes how to
generate automatically Ada bindings from C and C++ headers.
<li><a href="#Other-Utility-Programs">Other Utility Programs</a>, discusses several other GNAT utilities,
including <code>gnathtml</code>.
<li><a href="#Code-Coverage-and-Profiling">Code Coverage and Profiling</a>, describes how to perform a structural
coverage and profile the execution of Ada programs.
<li><a href="#Running-and-Debugging-Ada-Programs">Running and Debugging Ada Programs</a>, describes how to run and debug
Ada programs.
<li><a href="#Platform_002dSpecific-Information-for-the-Run_002dTime-Libraries">Platform-Specific Information for the Run-Time Libraries</a>,
describes the various run-time
libraries supported by GNAT on various platforms and explains how to
choose a particular library.
<li><a href="#Example-of-Binder-Output-File">Example of Binder Output File</a>, shows the source code for the binder
output file for a sample program.
<li><a href="#Elaboration-Order-Handling-in-GNAT">Elaboration Order Handling in GNAT</a>, describes how GNAT helps
you deal with elaboration order issues.
<li><a href="#Conditional-Compilation">Conditional Compilation</a>, describes how to model conditional compilation,
both with Ada in general and with GNAT facilities in particular.
<li><a href="#Inline-Assembler">Inline Assembler</a>, shows how to use the inline assembly facility
in an Ada program.
<li><a href="#Compatibility-and-Porting-Guide">Compatibility and Porting Guide</a>, contains sections on compatibility
of GNAT with other Ada development environments (including Ada 83 systems),
to assist in porting code from those environments.
<li><a href="#Microsoft-Windows-Topics">Microsoft Windows Topics</a>, presents information relevant to the
Microsoft Windows platform.
</ul>
<!-- ************************************************* -->
<div class="node">
<a name="What-You-Should-Know-before-Reading-This-Guide"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Related-Information">Related Information</a>,
Previous: <a rel="previous" accesskey="p" href="#What-This-Guide-Contains">What This Guide Contains</a>,
Up: <a rel="up" accesskey="u" href="#About-This-Guide">About This Guide</a>
</div>
<!-- ************************************************* -->
<h3 class="unnumberedsec">What You Should Know before Reading This Guide</h3>
<p><a name="index-Ada-95-Language-Reference-Manual-1"></a><a name="index-Ada-2005-Language-Reference-Manual-2"></a>This guide assumes a basic familiarity with the Ada 95 language, as
described in the International Standard ANSI/ISO/IEC-8652:1995, January
1995.
It does not require knowledge of the new features introduced by Ada 2005,
(officially known as ISO/IEC 8652:1995 with Technical Corrigendum 1
and Amendment 1).
Both reference manuals are included in the GNAT documentation
package.
<div class="node">
<a name="Related-Information"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Conventions">Conventions</a>,
Previous: <a rel="previous" accesskey="p" href="#What-You-Should-Know-before-Reading-This-Guide">What You Should Know before Reading This Guide</a>,
Up: <a rel="up" accesskey="u" href="#About-This-Guide">About This Guide</a>
</div>
<h3 class="unnumberedsec">Related Information</h3>
<p class="noindent">For further information about related tools, refer to the following
documents:
<ul>
<li>See <a href="gnat_rm.html#Top">GNAT Reference Manual</a>, which contains all reference material for the GNAT
implementation of Ada.
<li><cite>Using the GNAT Programming Studio</cite>, which describes the GPS
Integrated Development Environment.
<li><cite>GNAT Programming Studio Tutorial</cite>, which introduces the
main GPS features through examples.
<li><cite>Ada 95 Reference Manual</cite>, which contains reference
material for the Ada 95 programming language.
<li><cite>Ada 2005 Reference Manual</cite>, which contains reference
material for the Ada 2005 programming language.
<li>See <a href="gdb.html#Top">Debugging with GDB</a>,
for all details on the use of the GNU source-level debugger.
<li>See <a href="emacs.html#Top">The extensible self-documenting text editor</a>,
for full information on the extensible editor and programming
environment Emacs.
</ul>
<!-- ************** -->
<div class="node">
<a name="Conventions"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Related-Information">Related Information</a>,
Up: <a rel="up" accesskey="u" href="#About-This-Guide">About This Guide</a>
</div>
<h3 class="unnumberedsec">Conventions</h3>
<p><a name="index-Conventions-3"></a><a name="index-Typographical-conventions-4"></a>
Following are examples of the typographical and graphic conventions used
in this guide:
<ul>
<li><code>Functions</code>, <samp><span class="command">utility program names</span></samp>, <code>standard names</code>,
and <code>classes</code>.
<li><samp><span class="option">Option flags</span></samp>
<li><samp><span class="file">File names</span></samp>, ‘<samp><span class="samp">button names</span></samp>’, and ‘<samp><span class="samp">field names</span></samp>’.
<li><code>Variables</code>, <samp><span class="env">environment variables</span></samp>, and <var>metasyntactic
variables</var>.
<li><em>Emphasis</em>.
<li><span class="roman">[</span>optional information or parameters<span class="roman">]</span>
<li>Examples are described by text
<pre class="smallexample"> and then shown this way.
</pre>
</ul>
<p class="noindent">Commands that are entered by the user are preceded in this manual by the
characters “<code>$ </code>”<!-- /@w --> (dollar sign followed by space). If your system
uses this sequence as a prompt, then the commands will appear exactly as
you see them in the manual. If your system uses some other prompt, then
the command will appear with the <code>$</code> replaced by whatever prompt
character you are using.
<p>Full file names are shown with the “<code>/</code>” character
as the directory separator; e.g., <samp><span class="file">parent-dir/subdir/myfile.adb</span></samp>.
If you are using GNAT on a Windows platform, please note that
the “<code>\</code>” character should be used instead.
<!-- **************************** -->
<div class="node">
<a name="Getting-Started-with-GNAT"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#The-GNAT-Compilation-Model">The GNAT Compilation Model</a>,
Previous: <a rel="previous" accesskey="p" href="#About-This-Guide">About This Guide</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">1 Getting Started with GNAT</h2>
<p class="noindent">This chapter describes some simple ways of using GNAT to build
executable Ada programs.
<a href="#Running-GNAT">Running GNAT</a>, through <a href="#Using-the-gnatmake-Utility">Using the gnatmake Utility</a>,
show how to use the command line environment.
<a href="#Introduction-to-GPS">Introduction to GPS</a>, provides a brief
introduction to the GNAT Programming Studio, a visually-oriented
Integrated Development Environment for GNAT.
GPS offers a graphical “look and feel”, support for development in
other programming languages, comprehensive browsing features, and
many other capabilities.
For information on GPS please refer to
<cite>Using the GNAT Programming Studio</cite>.
<ul class="menu">
<li><a accesskey="1" href="#Running-GNAT">Running GNAT</a>
<li><a accesskey="2" href="#Running-a-Simple-Ada-Program">Running a Simple Ada Program</a>
<li><a accesskey="3" href="#Running-a-Program-with-Multiple-Units">Running a Program with Multiple Units</a>
<li><a accesskey="4" href="#Using-the-gnatmake-Utility">Using the gnatmake Utility</a>
<li><a accesskey="5" href="#Introduction-to-GPS">Introduction to GPS</a>
</ul>
<div class="node">
<a name="Running-GNAT"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Running-a-Simple-Ada-Program">Running a Simple Ada Program</a>,
Up: <a rel="up" accesskey="u" href="#Getting-Started-with-GNAT">Getting Started with GNAT</a>
</div>
<h3 class="section">1.1 Running GNAT</h3>
<p class="noindent">Three steps are needed to create an executable file from an Ada source
file:
<ol type=1 start=1>
<li>The source file(s) must be compiled.
<li>The file(s) must be bound using the GNAT binder.
<li>All appropriate object files must be linked to produce an executable.
</ol>
<p class="noindent">All three steps are most commonly handled by using the <samp><span class="command">gnatmake</span></samp>
utility program that, given the name of the main program, automatically
performs the necessary compilation, binding and linking steps.
<div class="node">
<a name="Running-a-Simple-Ada-Program"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Running-a-Program-with-Multiple-Units">Running a Program with Multiple Units</a>,
Previous: <a rel="previous" accesskey="p" href="#Running-GNAT">Running GNAT</a>,
Up: <a rel="up" accesskey="u" href="#Getting-Started-with-GNAT">Getting Started with GNAT</a>
</div>
<h3 class="section">1.2 Running a Simple Ada Program</h3>
<p class="noindent">Any text editor may be used to prepare an Ada program.
(If <code>Emacs</code> is
used, the optional Ada mode may be helpful in laying out the program.)
The
program text is a normal text file. We will assume in our initial
example that you have used your editor to prepare the following
standard format text file:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
with Ada.Text_IO; use Ada.Text_IO;
procedure Hello is
begin
Put_Line ("Hello WORLD!");
end Hello;
</td></tr></table>
</pre>
<p class="noindent">This file should be named <samp><span class="file">hello.adb</span></samp>.
With the normal default file naming conventions, GNAT requires
that each file
contain a single compilation unit whose file name is the
unit name,
with periods replaced by hyphens; the
extension is <samp><span class="file">ads</span></samp> for a
spec and <samp><span class="file">adb</span></samp> for a body.
You can override this default file naming convention by use of the
special pragma <code>Source_File_Name</code> (see <a href="#Using-Other-File-Names">Using Other File Names</a>).
Alternatively, if you want to rename your files according to this default
convention, which is probably more convenient if you will be using GNAT
for all your compilations, then the <code>gnatchop</code> utility
can be used to generate correctly-named source files
(see <a href="#Renaming-Files-Using-gnatchop">Renaming Files Using gnatchop</a>).
<p>You can compile the program using the following command (<code>$</code> is used
as the command prompt in the examples in this document):
<pre class="smallexample"> $ gcc -c hello.adb
</pre>
<p class="noindent"><samp><span class="command">gcc</span></samp> is the command used to run the compiler. This compiler is
capable of compiling programs in several languages, including Ada and
C. It assumes that you have given it an Ada program if the file extension is
either <samp><span class="file">.ads</span></samp> or <samp><span class="file">.adb</span></samp>, and it will then call
the GNAT compiler to compile the specified file.
<p>The <samp><span class="option">-c</span></samp> switch is required. It tells <samp><span class="command">gcc</span></samp> to only do a
compilation. (For C programs, <samp><span class="command">gcc</span></samp> can also do linking, but this
capability is not used directly for Ada programs, so the <samp><span class="option">-c</span></samp>
switch must always be present.)
<p>This compile command generates a file
<samp><span class="file">hello.o</span></samp>, which is the object
file corresponding to your Ada program. It also generates
an “Ada Library Information” file <samp><span class="file">hello.ali</span></samp>,
which contains additional information used to check
that an Ada program is consistent.
To build an executable file,
use <code>gnatbind</code> to bind the program
and <samp><span class="command">gnatlink</span></samp> to link it. The
argument to both <code>gnatbind</code> and <samp><span class="command">gnatlink</span></samp> is the name of the
<samp><span class="file">ALI</span></samp> file, but the default extension of <samp><span class="file">.ali</span></samp> can
be omitted. This means that in the most common case, the argument
is simply the name of the main program:
<pre class="smallexample"> $ gnatbind hello
$ gnatlink hello
</pre>
<p class="noindent">A simpler method of carrying out these steps is to use
<samp><span class="command">gnatmake</span></samp>,
a master program that invokes all the required
compilation, binding and linking tools in the correct order. In particular,
<samp><span class="command">gnatmake</span></samp> automatically recompiles any sources that have been
modified since they were last compiled, or sources that depend
on such modified sources, so that “version skew” is avoided.
<a name="index-Version-skew-_0028avoided-by-_0040command_007bgnatmake_007d_0029-5"></a>
<pre class="smallexample"> $ gnatmake hello.adb
</pre>
<p class="noindent">The result is an executable program called <samp><span class="file">hello</span></samp>, which can be
run by entering:
<pre class="smallexample"> $ hello
</pre>
<p class="noindent">assuming that the current directory is on the search path
for executable programs.
<p class="noindent">and, if all has gone well, you will see
<pre class="smallexample"> Hello WORLD!
</pre>
<p class="noindent">appear in response to this command.
<!-- **************************************** -->
<div class="node">
<a name="Running-a-Program-with-Multiple-Units"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Using-the-gnatmake-Utility">Using the gnatmake Utility</a>,
Previous: <a rel="previous" accesskey="p" href="#Running-a-Simple-Ada-Program">Running a Simple Ada Program</a>,
Up: <a rel="up" accesskey="u" href="#Getting-Started-with-GNAT">Getting Started with GNAT</a>
</div>
<h3 class="section">1.3 Running a Program with Multiple Units</h3>
<p class="noindent">Consider a slightly more complicated example that has three files: a
main program, and the spec and body of a package:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
<p>package Greetings is
procedure Hello;
procedure Goodbye;
end Greetings;
with Ada.Text_IO; use Ada.Text_IO;
package body Greetings is
procedure Hello is
begin
Put_Line ("Hello WORLD!");
end Hello;
procedure Goodbye is
begin
Put_Line ("Goodbye WORLD!");
end Goodbye;
end Greetings;
<p>with Greetings;
procedure Gmain is
begin
Greetings.Hello;
Greetings.Goodbye;
end Gmain;
</td></tr></table>
</pre>
<p class="noindent">Following the one-unit-per-file rule, place this program in the
following three separate files:
<dl>
<dt><samp><span class="file">greetings.ads</span></samp><dd>spec of package <code>Greetings</code>
<br><dt><samp><span class="file">greetings.adb</span></samp><dd>body of package <code>Greetings</code>
<br><dt><samp><span class="file">gmain.adb</span></samp><dd>body of main program
</dl>
<p class="noindent">To build an executable version of
this program, we could use four separate steps to compile, bind, and link
the program, as follows:
<pre class="smallexample"> $ gcc -c gmain.adb
$ gcc -c greetings.adb
$ gnatbind gmain
$ gnatlink gmain
</pre>
<p class="noindent">Note that there is no required order of compilation when using GNAT.
In particular it is perfectly fine to compile the main program first.
Also, it is not necessary to compile package specs in the case where
there is an accompanying body; you only need to compile the body. If you want
to submit these files to the compiler for semantic checking and not code
generation, then use the
<samp><span class="option">-gnatc</span></samp> switch:
<pre class="smallexample"> $ gcc -c greetings.ads -gnatc
</pre>
<p class="noindent">Although the compilation can be done in separate steps as in the
above example, in practice it is almost always more convenient
to use the <samp><span class="command">gnatmake</span></samp> tool. All you need to know in this case
is the name of the main program's source file. The effect of the above four
commands can be achieved with a single one:
<pre class="smallexample"> $ gnatmake gmain.adb
</pre>
<p class="noindent">In the next section we discuss the advantages of using <samp><span class="command">gnatmake</span></samp> in
more detail.
<!-- ***************************** -->
<div class="node">
<a name="Using-the-gnatmake-Utility"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Introduction-to-GPS">Introduction to GPS</a>,
Previous: <a rel="previous" accesskey="p" href="#Running-a-Program-with-Multiple-Units">Running a Program with Multiple Units</a>,
Up: <a rel="up" accesskey="u" href="#Getting-Started-with-GNAT">Getting Started with GNAT</a>
</div>
<h3 class="section">1.4 Using the <samp><span class="command">gnatmake</span></samp> Utility</h3>
<p class="noindent">If you work on a program by compiling single components at a time using
<samp><span class="command">gcc</span></samp>, you typically keep track of the units you modify. In order to
build a consistent system, you compile not only these units, but also any
units that depend on the units you have modified.
For example, in the preceding case,
if you edit <samp><span class="file">gmain.adb</span></samp>, you only need to recompile that file. But if
you edit <samp><span class="file">greetings.ads</span></samp>, you must recompile both
<samp><span class="file">greetings.adb</span></samp> and <samp><span class="file">gmain.adb</span></samp>, because both files contain
units that depend on <samp><span class="file">greetings.ads</span></samp>.
<p><code>gnatbind</code> will warn you if you forget one of these compilation
steps, so that it is impossible to generate an inconsistent program as a
result of forgetting to do a compilation. Nevertheless it is tedious and
error-prone to keep track of dependencies among units.
One approach to handle the dependency-bookkeeping is to use a
makefile. However, makefiles present maintenance problems of their own:
if the dependencies change as you change the program, you must make
sure that the makefile is kept up-to-date manually, which is also an
error-prone process.
<p>The <samp><span class="command">gnatmake</span></samp> utility takes care of these details automatically.
Invoke it using either one of the following forms:
<pre class="smallexample"> $ gnatmake gmain.adb
$ gnatmake gmain
</pre>
<p class="noindent">The argument is the name of the file containing the main program;
you may omit the extension. <samp><span class="command">gnatmake</span></samp>
examines the environment, automatically recompiles any files that need
recompiling, and binds and links the resulting set of object files,
generating the executable file, <samp><span class="file">gmain</span></samp>.
In a large program, it
can be extremely helpful to use <samp><span class="command">gnatmake</span></samp>, because working out by hand
what needs to be recompiled can be difficult.
<p>Note that <samp><span class="command">gnatmake</span></samp>
takes into account all the Ada rules that
establish dependencies among units. These include dependencies that result
from inlining subprogram bodies, and from
generic instantiation. Unlike some other
Ada make tools, <samp><span class="command">gnatmake</span></samp> does not rely on the dependencies that were
found by the compiler on a previous compilation, which may possibly
be wrong when sources change. <samp><span class="command">gnatmake</span></samp> determines the exact set of
dependencies from scratch each time it is run.
<div class="node">
<a name="Introduction-to-GPS"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Using-the-gnatmake-Utility">Using the gnatmake Utility</a>,
Up: <a rel="up" accesskey="u" href="#Getting-Started-with-GNAT">Getting Started with GNAT</a>
</div>
<h3 class="section">1.5 Introduction to GPS</h3>
<p><a name="index-GPS-_0028GNAT-Programming-Studio_0029-6"></a><a name="index-GNAT-Programming-Studio-_0028GPS_0029-7"></a>Although the command line interface (<samp><span class="command">gnatmake</span></samp>, etc.) alone
is sufficient, a graphical Interactive Development
Environment can make it easier for you to compose, navigate, and debug
programs. This section describes the main features of GPS
(“GNAT Programming Studio”), the GNAT graphical IDE.
You will see how to use GPS to build and debug an executable, and
you will also learn some of the basics of the GNAT “project” facility.
<p>GPS enables you to do much more than is presented here;
e.g., you can produce a call graph, interface to a third-party
Version Control System, and inspect the generated assembly language
for a program.
Indeed, GPS also supports languages other than Ada.
Such additional information, and an explanation of all of the GPS menu
items. may be found in the on-line help, which includes
a user's guide and a tutorial (these are also accessible from the GNAT
startup menu).
<ul class="menu">
<li><a accesskey="1" href="#Building-a-New-Program-with-GPS">Building a New Program with GPS</a>
<li><a accesskey="2" href="#Simple-Debugging-with-GPS">Simple Debugging with GPS</a>
</ul>
<div class="node">
<a name="Building-a-New-Program-with-GPS"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Simple-Debugging-with-GPS">Simple Debugging with GPS</a>,
Up: <a rel="up" accesskey="u" href="#Introduction-to-GPS">Introduction to GPS</a>
</div>
<h4 class="subsection">1.5.1 Building a New Program with GPS</h4>
<p class="noindent">GPS invokes the GNAT compilation tools using information
contained in a <em>project</em> (also known as a <em>project file</em>):
a collection of properties such
as source directories, identities of main subprograms, tool switches, etc.,
and their associated values.
See <a href="#GNAT-Project-Manager">GNAT Project Manager</a> for details.
In order to run GPS, you will need to either create a new project
or else open an existing one.
<p>This section will explain how you can use GPS to create a project,
to associate Ada source files with a project, and to build and run
programs.
<ol type=1 start=1>
<li><em>Creating a project</em>
<p>Invoke GPS, either from the command line or the platform's IDE.
After it starts, GPS will display a “Welcome” screen with three
radio buttons:
<ul>
<li><code>Start with default project in directory</code>
<li><code>Create new project with wizard</code>
<li><code>Open existing project</code>
</ul>
<p class="noindent">Select <code>Create new project with wizard</code> and press <code>OK</code>.
A new window will appear. In the text box labeled with
<code>Enter the name of the project to create</code>, type <samp><span class="file">sample</span></samp>
as the project name.
In the next box, browse to choose the directory in which you
would like to create the project file.
After selecting an appropriate directory, press <code>Forward</code>.
<p>A window will appear with the title
<code>Version Control System Configuration</code>.
Simply press <code>Forward</code>.
<p>A window will appear with the title
<code>Please select the source directories for this project</code>.
The directory that you specified for the project file will be selected
by default as the one to use for sources; simply press <code>Forward</code>.
<p>A window will appear with the title
<code>Please select the build directory for this project</code>.
The directory that you specified for the project file will be selected
by default for object files and executables;
simply press <code>Forward</code>.
<p>A window will appear with the title
<code>Please select the main units for this project</code>.
You will supply this information later, after creating the source file.
Simply press <code>Forward</code> for now.
<p>A window will appear with the title
<code>Please select the switches to build the project</code>.
Press <code>Apply</code>. This will create a project file named
<samp><span class="file">sample.prj</span></samp> in the directory that you had specified.
<li><em>Creating and saving the source file</em>
<p>After you create the new project, a GPS window will appear, which is
partitioned into two main sections:
<ul>
<li>A <em>Workspace area</em>, initially greyed out, which you will use for
creating and editing source files
<li>Directly below, a <em>Messages area</em>, which initially displays a
“Welcome” message.
(If the Messages area is not visible, drag its border upward to expand it.)
</ul>
<p class="noindent">Select <code>File</code> on the menu bar, and then the <code>New</code> command.
The Workspace area will become white, and you can now
enter the source program explicitly.
Type the following text
<pre class="smallexample"> with Ada.Text_IO; use Ada.Text_IO;
procedure Hello is
begin
Put_Line("Hello from GPS!");
end Hello;
</pre>
<p class="noindent">Select <code>File</code>, then <code>Save As</code>, and enter the source file name
<samp><span class="file">hello.adb</span></samp>.
The file will be saved in the same directory you specified as the
location of the default project file.
<li><em>Updating the project file</em>
<p>You need to add the new source file to the project.
To do this, select
the <code>Project</code> menu and then <code>Edit project properties</code>.
Click the <code>Main files</code> tab on the left, and then the
<code>Add</code> button.
Choose <samp><span class="file">hello.adb</span></samp> from the list, and press <code>Open</code>.
The project settings window will reflect this action.
Click <code>OK</code>.
<li><em>Building and running the program</em>
<p>In the main GPS window, now choose the <code>Build</code> menu, then <code>Make</code>,
and select <samp><span class="file">hello.adb</span></samp>.
The Messages window will display the resulting invocations of <samp><span class="command">gcc</span></samp>,
<samp><span class="command">gnatbind</span></samp>, and <samp><span class="command">gnatlink</span></samp>
(reflecting the default switch settings from the
project file that you created) and then a “successful compilation/build”
message.
<p>To run the program, choose the <code>Build</code> menu, then <code>Run</code>, and
select <samp><span class="command">hello</span></samp>.
An <em>Arguments Selection</em> window will appear.
There are no command line arguments, so just click <code>OK</code>.
<p>The Messages window will now display the program's output (the string
<code>Hello from GPS</code>), and at the bottom of the GPS window a status
update is displayed (<code>Run: hello</code>).
Close the GPS window (or select <code>File</code>, then <code>Exit</code>) to
terminate this GPS session.
</ol>
<div class="node">
<a name="Simple-Debugging-with-GPS"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Building-a-New-Program-with-GPS">Building a New Program with GPS</a>,
Up: <a rel="up" accesskey="u" href="#Introduction-to-GPS">Introduction to GPS</a>
</div>
<h4 class="subsection">1.5.2 Simple Debugging with GPS</h4>
<p class="noindent">This section illustrates basic debugging techniques (setting breakpoints,
examining/modifying variables, single stepping).
<ol type=1 start=1>
<li><em>Opening a project</em>
<p>Start GPS and select <code>Open existing project</code>; browse to
specify the project file <samp><span class="file">sample.prj</span></samp> that you had created in the
earlier example.
<li><em>Creating a source file</em>
<p>Select <code>File</code>, then <code>New</code>, and type in the following program:
<pre class="smallexample"> with Ada.Text_IO; use Ada.Text_IO;
procedure Example is
Line : String (1..80);
N : Natural;
begin
Put_Line("Type a line of text at each prompt; an empty line to exit");
loop
Put(": ");
Get_Line (Line, N);
Put_Line (Line (1..N) );
exit when N=0;
end loop;
end Example;
</pre>
<p class="noindent">Select <code>File</code>, then <code>Save as</code>, and enter the file name
<samp><span class="file">example.adb</span></samp>.
<li><em>Updating the project file</em>
<p>Add <code>Example</code> as a new main unit for the project:
<ol type=a start=1>
<li>Select <code>Project</code>, then <code>Edit Project Properties</code>.
<li>Select the <code>Main files</code> tab, click <code>Add</code>, then
select the file <samp><span class="file">example.adb</span></samp> from the list, and
click <code>Open</code>.
You will see the file name appear in the list of main units
<li>Click <code>OK</code>
</ol>
<li><em>Building/running the executable</em>
<p>To build the executable
select <code>Build</code>, then <code>Make</code>, and then choose <samp><span class="file">example.adb</span></samp>.
<p>Run the program to see its effect (in the Messages area).
Each line that you enter is displayed; an empty line will
cause the loop to exit and the program to terminate.
<li><em>Debugging the program</em>
<p>Note that the <samp><span class="option">-g</span></samp> switches to <samp><span class="command">gcc</span></samp> and <samp><span class="command">gnatlink</span></samp>,
which are required for debugging, are on by default when you create
a new project.
Thus unless you intentionally remove these settings, you will be able
to debug any program that you develop using GPS.
<ol type=a start=1>
<li><em>Initializing</em>
<p>Select <code>Debug</code>, then <code>Initialize</code>, then <samp><span class="file">example</span></samp>
<li><em>Setting a breakpoint</em>
<p>After performing the initialization step, you will observe a small
icon to the right of each line number.
This serves as a toggle for breakpoints; clicking the icon will
set a breakpoint at the corresponding line (the icon will change to
a red circle with an “x”), and clicking it again
will remove the breakpoint / reset the icon.
<p>For purposes of this example, set a breakpoint at line 10 (the
statement <code>Put_Line (Line (1..N));</code>
<li><em>Starting program execution</em>
<p>Select <code>Debug</code>, then <code>Run</code>. When the
<code>Program Arguments</code> window appears, click <code>OK</code>.
A console window will appear; enter some line of text,
e.g. <code>abcde</code>, at the prompt.
The program will pause execution when it gets to the
breakpoint, and the corresponding line is highlighted.
<li><em>Examining a variable</em>
<p>Move the mouse over one of the occurrences of the variable <code>N</code>.
You will see the value (5) displayed, in “tool tip” fashion.
Right click on <code>N</code>, select <code>Debug</code>, then select <code>Display N</code>.
You will see information about <code>N</code> appear in the <code>Debugger Data</code>
pane, showing the value as 5.
<li><em>Assigning a new value to a variable</em>
<p>Right click on the <code>N</code> in the <code>Debugger Data</code> pane, and
select <code>Set value of N</code>.
When the input window appears, enter the value <code>4</code> and click
<code>OK</code>.
This value does not automatically appear in the <code>Debugger Data</code>
pane; to see it, right click again on the <code>N</code> in the
<code>Debugger Data</code> pane and select <code>Update value</code>.
The new value, 4, will appear in red.
<li><em>Single stepping</em>
<p>Select <code>Debug</code>, then <code>Next</code>.
This will cause the next statement to be executed, in this case the
call of <code>Put_Line</code> with the string slice.
Notice in the console window that the displayed string is simply
<code>abcd</code> and not <code>abcde</code> which you had entered.
This is because the upper bound of the slice is now 4 rather than 5.
<li><em>Removing a breakpoint</em>
<p>Toggle the breakpoint icon at line 10.
<li><em>Resuming execution from a breakpoint</em>
<p>Select <code>Debug</code>, then <code>Continue</code>.
The program will reach the next iteration of the loop, and
wait for input after displaying the prompt.
This time, just hit the <kbd>Enter</kbd> key.
The value of <code>N</code> will be 0, and the program will terminate.
The console window will disappear.
</ol>
</ol>
<div class="node">
<a name="The-GNAT-Compilation-Model"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Compiling-Using-gcc">Compiling Using gcc</a>,
Previous: <a rel="previous" accesskey="p" href="#Getting-Started-with-GNAT">Getting Started with GNAT</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">2 The GNAT Compilation Model</h2>
<p><a name="index-GNAT-compilation-model-8"></a><a name="index-Compilation-model-9"></a>
<ul class="menu">
<li><a accesskey="1" href="#Source-Representation">Source Representation</a>
<li><a accesskey="2" href="#Foreign-Language-Representation">Foreign Language Representation</a>
<li><a accesskey="3" href="#File-Naming-Rules">File Naming Rules</a>
<li><a accesskey="4" href="#Using-Other-File-Names">Using Other File Names</a>
<li><a accesskey="5" href="#Alternative-File-Naming-Schemes">Alternative File Naming Schemes</a>
<li><a accesskey="6" href="#Generating-Object-Files">Generating Object Files</a>
<li><a accesskey="7" href="#Source-Dependencies">Source Dependencies</a>
<li><a accesskey="8" href="#The-Ada-Library-Information-Files">The Ada Library Information Files</a>
<li><a accesskey="9" href="#Binding-an-Ada-Program">Binding an Ada Program</a>
<li><a href="#Mixed-Language-Programming">Mixed Language Programming</a>
<li><a href="#Building-Mixed-Ada-_0026-C_002b_002b-Programs">Building Mixed Ada & C++ Programs</a>
<li><a href="#Comparison-between-GNAT-and-C_002fC_002b_002b-Compilation-Models">Comparison between GNAT and C/C++ Compilation Models</a>
<li><a href="#Comparison-between-GNAT-and-Conventional-Ada-Library-Models">Comparison between GNAT and Conventional Ada Library Models</a>
</ul>
<p class="noindent">This chapter describes the compilation model used by GNAT. Although
similar to that used by other languages, such as C and C++, this model
is substantially different from the traditional Ada compilation models,
which are based on a library. The model is initially described without
reference to the library-based model. If you have not previously used an
Ada compiler, you need only read the first part of this chapter. The
last section describes and discusses the differences between the GNAT
model and the traditional Ada compiler models. If you have used other
Ada compilers, this section will help you to understand those
differences, and the advantages of the GNAT model.
<div class="node">
<a name="Source-Representation"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Foreign-Language-Representation">Foreign Language Representation</a>,
Up: <a rel="up" accesskey="u" href="#The-GNAT-Compilation-Model">The GNAT Compilation Model</a>
</div>
<h3 class="section">2.1 Source Representation</h3>
<p><a name="index-Latin_002d1-10"></a>
Ada source programs are represented in standard text files, using
Latin-1 coding. Latin-1 is an 8-bit code that includes the familiar
7-bit ASCII set, plus additional characters used for
representing foreign languages (see <a href="#Foreign-Language-Representation">Foreign Language Representation</a>
for support of non-USA character sets). The format effector characters
are represented using their standard ASCII encodings, as follows:
<dl>
<dt><code>VT</code><dd><a name="index-VT-11"></a>Vertical tab, <code>16#0B#</code>
<br><dt><code>HT</code><dd><a name="index-HT-12"></a>Horizontal tab, <code>16#09#</code>
<br><dt><code>CR</code><dd><a name="index-CR-13"></a>Carriage return, <code>16#0D#</code>
<br><dt><code>LF</code><dd><a name="index-LF-14"></a>Line feed, <code>16#0A#</code>
<br><dt><code>FF</code><dd><a name="index-FF-15"></a>Form feed, <code>16#0C#</code>
</dl>
<p class="noindent">Source files are in standard text file format. In addition, GNAT will
recognize a wide variety of stream formats, in which the end of
physical lines is marked by any of the following sequences:
<code>LF</code>, <code>CR</code>, <code>CR-LF</code>, or <code>LF-CR</code>. This is useful
in accommodating files that are imported from other operating systems.
<p><a name="index-End-of-source-file-16"></a><a name="index-Source-file_002c-end-17"></a><a name="index-SUB-18"></a>The end of a source file is normally represented by the physical end of
file. However, the control character <code>16#1A#</code> (<code>SUB</code>) is also
recognized as signalling the end of the source file. Again, this is
provided for compatibility with other operating systems where this
code is used to represent the end of file.
<p>Each file contains a single Ada compilation unit, including any pragmas
associated with the unit. For example, this means you must place a
package declaration (a package <dfn>spec</dfn>) and the corresponding body in
separate files. An Ada <dfn>compilation</dfn> (which is a sequence of
compilation units) is represented using a sequence of files. Similarly,
you will place each subunit or child unit in a separate file.
<div class="node">
<a name="Foreign-Language-Representation"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#File-Naming-Rules">File Naming Rules</a>,
Previous: <a rel="previous" accesskey="p" href="#Source-Representation">Source Representation</a>,
Up: <a rel="up" accesskey="u" href="#The-GNAT-Compilation-Model">The GNAT Compilation Model</a>
</div>
<h3 class="section">2.2 Foreign Language Representation</h3>
<p class="noindent">GNAT supports the standard character sets defined in Ada as well as
several other non-standard character sets for use in localized versions
of the compiler (see <a href="#Character-Set-Control">Character Set Control</a>).
<ul class="menu">
<li><a accesskey="1" href="#Latin_002d1">Latin-1</a>
<li><a accesskey="2" href="#Other-8_002dBit-Codes">Other 8-Bit Codes</a>
<li><a accesskey="3" href="#Wide-Character-Encodings">Wide Character Encodings</a>
</ul>
<div class="node">
<a name="Latin-1"></a>
<a name="Latin_002d1"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Other-8_002dBit-Codes">Other 8-Bit Codes</a>,
Up: <a rel="up" accesskey="u" href="#Foreign-Language-Representation">Foreign Language Representation</a>
</div>
<h4 class="subsection">2.2.1 Latin-1</h4>
<p><a name="index-Latin_002d1-19"></a>
The basic character set is Latin-1. This character set is defined by ISO
standard 8859, part 1. The lower half (character codes <code>16#00#</code>
<small class="dots">...</small> <code>16#7F#)</code> is identical to standard ASCII coding, but the upper
half is used to represent additional characters. These include extended letters
used by European languages, such as French accents, the vowels with umlauts
used in German, and the extra letter A-ring used in Swedish.
<p><a name="index-Ada_002eCharacters_002eLatin_005f1-20"></a>For a complete list of Latin-1 codes and their encodings, see the source
file of library unit <code>Ada.Characters.Latin_1</code> in file
<samp><span class="file">a-chlat1.ads</span></samp>.
You may use any of these extended characters freely in character or
string literals. In addition, the extended characters that represent
letters can be used in identifiers.
<div class="node">
<a name="Other-8-Bit-Codes"></a>
<a name="Other-8_002dBit-Codes"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Wide-Character-Encodings">Wide Character Encodings</a>,
Previous: <a rel="previous" accesskey="p" href="#Latin_002d1">Latin-1</a>,
Up: <a rel="up" accesskey="u" href="#Foreign-Language-Representation">Foreign Language Representation</a>
</div>
<h4 class="subsection">2.2.2 Other 8-Bit Codes</h4>
<p class="noindent">GNAT also supports several other 8-bit coding schemes:
<dl>
<dt>ISO 8859-2 (Latin-2)<dd><a name="index-Latin_002d2-21"></a><a name="index-ISO-8859_002d2-22"></a>Latin-2 letters allowed in identifiers, with uppercase and lowercase
equivalence.
<br><dt>ISO 8859-3 (Latin-3)<dd><a name="index-Latin_002d3-23"></a><a name="index-ISO-8859_002d3-24"></a>Latin-3 letters allowed in identifiers, with uppercase and lowercase
equivalence.
<br><dt>ISO 8859-4 (Latin-4)<dd><a name="index-Latin_002d4-25"></a><a name="index-ISO-8859_002d4-26"></a>Latin-4 letters allowed in identifiers, with uppercase and lowercase
equivalence.
<br><dt>ISO 8859-5 (Cyrillic)<dd><a name="index-ISO-8859_002d5-27"></a><a name="index-Cyrillic-28"></a>ISO 8859-5 letters (Cyrillic) allowed in identifiers, with uppercase and
lowercase equivalence.
<br><dt>ISO 8859-15 (Latin-9)<dd><a name="index-ISO-8859_002d15-29"></a><a name="index-Latin_002d9-30"></a>ISO 8859-15 (Latin-9) letters allowed in identifiers, with uppercase and
lowercase equivalence
<br><dt>IBM PC (code page 437)<dd><a name="index-code-page-437-31"></a>This code page is the normal default for PCs in the U.S. It corresponds
to the original IBM PC character set. This set has some, but not all, of
the extended Latin-1 letters, but these letters do not have the same
encoding as Latin-1. In this mode, these letters are allowed in
identifiers with uppercase and lowercase equivalence.
<br><dt>IBM PC (code page 850)<dd><a name="index-code-page-850-32"></a>This code page is a modification of 437 extended to include all the
Latin-1 letters, but still not with the usual Latin-1 encoding. In this
mode, all these letters are allowed in identifiers with uppercase and
lowercase equivalence.
<br><dt>Full Upper 8-bit<dd>Any character in the range 80-FF allowed in identifiers, and all are
considered distinct. In other words, there are no uppercase and lowercase
equivalences in this range. This is useful in conjunction with
certain encoding schemes used for some foreign character sets (e.g.,
the typical method of representing Chinese characters on the PC).
<br><dt>No Upper-Half<dd>No upper-half characters in the range 80-FF are allowed in identifiers.
This gives Ada 83 compatibility for identifier names.
</dl>
<p class="noindent">For precise data on the encodings permitted, and the uppercase and lowercase
equivalences that are recognized, see the file <samp><span class="file">csets.adb</span></samp> in
the GNAT compiler sources. You will need to obtain a full source release
of GNAT to obtain this file.
<div class="node">
<a name="Wide-Character-Encodings"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Other-8_002dBit-Codes">Other 8-Bit Codes</a>,
Up: <a rel="up" accesskey="u" href="#Foreign-Language-Representation">Foreign Language Representation</a>
</div>
<h4 class="subsection">2.2.3 Wide Character Encodings</h4>
<p class="noindent">GNAT allows wide character codes to appear in character and string
literals, and also optionally in identifiers, by means of the following
possible encoding schemes:
<dl>
<dt>Hex Coding<dd>In this encoding, a wide character is represented by the following five
character sequence:
<pre class="smallexample"> ESC a b c d
</pre>
<p class="noindent">Where <code>a</code>, <code>b</code>, <code>c</code>, <code>d</code> are the four hexadecimal
characters (using uppercase letters) of the wide character code. For
example, ESC A345 is used to represent the wide character with code
<code>16#A345#</code>.
This scheme is compatible with use of the full Wide_Character set.
<br><dt>Upper-Half Coding<dd><a name="index-Upper_002dHalf-Coding-33"></a>The wide character with encoding <code>16#abcd#</code> where the upper bit is on
(in other words, “a” is in the range 8-F) is represented as two bytes,
<code>16#ab#</code> and <code>16#cd#</code>. The second byte cannot be a format control
character, but is not required to be in the upper half. This method can
be also used for shift-JIS or EUC, where the internal coding matches the
external coding.
<br><dt>Shift JIS Coding<dd><a name="index-Shift-JIS-Coding-34"></a>A wide character is represented by a two-character sequence,
<code>16#ab#</code> and
<code>16#cd#</code>, with the restrictions described for upper-half encoding as
described above. The internal character code is the corresponding JIS
character according to the standard algorithm for Shift-JIS
conversion. Only characters defined in the JIS code set table can be
used with this encoding method.
<br><dt>EUC Coding<dd><a name="index-EUC-Coding-35"></a>A wide character is represented by a two-character sequence
<code>16#ab#</code> and
<code>16#cd#</code>, with both characters being in the upper half. The internal
character code is the corresponding JIS character according to the EUC
encoding algorithm. Only characters defined in the JIS code set table
can be used with this encoding method.
<br><dt>UTF-8 Coding<dd>A wide character is represented using
UCS Transformation Format 8 (UTF-8) as defined in Annex R of ISO
10646-1/Am.2. Depending on the character value, the representation
is a one, two, or three byte sequence:
<pre class="smallexample"> 16#0000#-16#007f#: 2#0<var>xxxxxxx</var>#
16#0080#-16#07ff#: 2#110<var>xxxxx</var># 2#10<var>xxxxxx</var>#
16#0800#-16#ffff#: 2#1110<var>xxxx</var># 2#10<var>xxxxxx</var># 2#10<var>xxxxxx</var>#
</pre>
<p class="noindent">where the <var>xxx</var> bits correspond to the left-padded bits of the
16-bit character value. Note that all lower half ASCII characters
are represented as ASCII bytes and all upper half characters and
other wide characters are represented as sequences of upper-half
(The full UTF-8 scheme allows for encoding 31-bit characters as
6-byte sequences, but in this implementation, all UTF-8 sequences
of four or more bytes length will be treated as illegal).
<br><dt>Brackets Coding<dd>In this encoding, a wide character is represented by the following eight
character sequence:
<pre class="smallexample"> [ " a b c d " ]
</pre>
<p class="noindent">Where <code>a</code>, <code>b</code>, <code>c</code>, <code>d</code> are the four hexadecimal
characters (using uppercase letters) of the wide character code. For
example, [“A345”] is used to represent the wide character with code
<code>16#A345#</code>. It is also possible (though not required) to use the
Brackets coding for upper half characters. For example, the code
<code>16#A3#</code> can be represented as <code>[``A3'']</code>.
<p>This scheme is compatible with use of the full Wide_Character set,
and is also the method used for wide character encoding in the standard
ACVC (Ada Compiler Validation Capability) test suite distributions.
</dl>
<p class="noindent">Note: Some of these coding schemes do not permit the full use of the
Ada character set. For example, neither Shift JIS, nor EUC allow the
use of the upper half of the Latin-1 set.
<div class="node">
<a name="File-Naming-Rules"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Using-Other-File-Names">Using Other File Names</a>,
Previous: <a rel="previous" accesskey="p" href="#Foreign-Language-Representation">Foreign Language Representation</a>,
Up: <a rel="up" accesskey="u" href="#The-GNAT-Compilation-Model">The GNAT Compilation Model</a>
</div>
<h3 class="section">2.3 File Naming Rules</h3>
<p class="noindent">The default file name is determined by the name of the unit that the
file contains. The name is formed by taking the full expanded name of
the unit and replacing the separating dots with hyphens and using
lowercase for all letters.
<p>An exception arises if the file name generated by the above rules starts
with one of the characters
‘<samp><span class="samp">a</span></samp>’, ‘<samp><span class="samp">g</span></samp>’, ‘<samp><span class="samp">i</span></samp>’, or ‘<samp><span class="samp">s</span></samp>’,
and the second character is a
minus. In this case, the character tilde is used in place
of the minus. The reason for this special rule is to avoid clashes with
the standard names for child units of the packages System, Ada,
Interfaces, and GNAT, which use the prefixes
‘<samp><span class="samp">s-</span></samp>’, ‘<samp><span class="samp">a-</span></samp>’, ‘<samp><span class="samp">i-</span></samp>’, and ‘<samp><span class="samp">g-</span></samp>’,
respectively.
<p>The file extension is <samp><span class="file">.ads</span></samp> for a spec and
<samp><span class="file">.adb</span></samp> for a body. The following list shows some
examples of these rules.
<dl>
<dt><samp><span class="file">main.ads</span></samp><dd>Main (spec)
<br><dt><samp><span class="file">main.adb</span></samp><dd>Main (body)
<br><dt><samp><span class="file">arith_functions.ads</span></samp><dd>Arith_Functions (package spec)
<br><dt><samp><span class="file">arith_functions.adb</span></samp><dd>Arith_Functions (package body)
<br><dt><samp><span class="file">func-spec.ads</span></samp><dd>Func.Spec (child package spec)
<br><dt><samp><span class="file">func-spec.adb</span></samp><dd>Func.Spec (child package body)
<br><dt><samp><span class="file">main-sub.adb</span></samp><dd>Sub (subunit of Main)
<br><dt><samp><span class="file">a~bad.adb</span></samp><dd>A.Bad (child package body)
</dl>
<p class="noindent">Following these rules can result in excessively long
file names if corresponding
unit names are long (for example, if child units or subunits are
heavily nested). An option is available to shorten such long file names
(called file name “krunching”). This may be particularly useful when
programs being developed with GNAT are to be used on operating systems
with limited file name lengths. See <a href="#Using-gnatkr">Using gnatkr</a>.
<p>Of course, no file shortening algorithm can guarantee uniqueness over
all possible unit names; if file name krunching is used, it is your
responsibility to ensure no name clashes occur. Alternatively you
can specify the exact file names that you want used, as described
in the next section. Finally, if your Ada programs are migrating from a
compiler with a different naming convention, you can use the gnatchop
utility to produce source files that follow the GNAT naming conventions.
(For details see <a href="#Renaming-Files-Using-gnatchop">Renaming Files Using gnatchop</a>.)
<p>Note: in the case of <code>Windows NT/XP</code> or <code>OpenVMS</code> operating
systems, case is not significant. So for example on <code>Windows XP</code>
if the canonical name is <code>main-sub.adb</code>, you can use the file name
<code>Main-Sub.adb</code> instead. However, case is significant for other
operating systems, so for example, if you want to use other than
canonically cased file names on a Unix system, you need to follow
the procedures described in the next section.
<div class="node">
<a name="Using-Other-File-Names"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Alternative-File-Naming-Schemes">Alternative File Naming Schemes</a>,
Previous: <a rel="previous" accesskey="p" href="#File-Naming-Rules">File Naming Rules</a>,
Up: <a rel="up" accesskey="u" href="#The-GNAT-Compilation-Model">The GNAT Compilation Model</a>
</div>
<h3 class="section">2.4 Using Other File Names</h3>
<p><a name="index-File-names-36"></a>
In the previous section, we have described the default rules used by
GNAT to determine the file name in which a given unit resides. It is
often convenient to follow these default rules, and if you follow them,
the compiler knows without being explicitly told where to find all
the files it needs.
<p>However, in some cases, particularly when a program is imported from
another Ada compiler environment, it may be more convenient for the
programmer to specify which file names contain which units. GNAT allows
arbitrary file names to be used by means of the Source_File_Name pragma.
The form of this pragma is as shown in the following examples:
<a name="index-Source_005fFile_005fName-pragma-37"></a>
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
pragma Source_File_Name (My_Utilities.Stacks,
Spec_File_Name => "myutilst_a.ada");
pragma Source_File_name (My_Utilities.Stacks,
Body_File_Name => "myutilst.ada");
</td></tr></table>
</pre>
<p class="noindent">As shown in this example, the first argument for the pragma is the unit
name (in this example a child unit). The second argument has the form
of a named association. The identifier
indicates whether the file name is for a spec or a body;
the file name itself is given by a string literal.
<p>The source file name pragma is a configuration pragma, which means that
normally it will be placed in the <samp><span class="file">gnat.adc</span></samp>
file used to hold configuration
pragmas that apply to a complete compilation environment.
For more details on how the <samp><span class="file">gnat.adc</span></samp> file is created and used
see <a href="#Handling-of-Configuration-Pragmas">Handling of Configuration Pragmas</a>.
<a name="index-g_t_0040file_007bgnat_002eadc_007d-38"></a>
GNAT allows completely arbitrary file names to be specified using the
source file name pragma. However, if the file name specified has an
extension other than <samp><span class="file">.ads</span></samp> or <samp><span class="file">.adb</span></samp> it is necessary to use
a special syntax when compiling the file. The name in this case must be
preceded by the special sequence <samp><span class="option">-x</span></samp> followed by a space and the name
of the language, here <code>ada</code>, as in:
<pre class="smallexample"> $ gcc -c -x ada peculiar_file_name.sim
</pre>
<p class="noindent"><samp><span class="command">gnatmake</span></samp> handles non-standard file names in the usual manner (the
non-standard file name for the main program is simply used as the
argument to gnatmake). Note that if the extension is also non-standard,
then it must be included in the <samp><span class="command">gnatmake</span></samp> command, it may not
be omitted.
<div class="node">
<a name="Alternative-File-Naming-Schemes"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Generating-Object-Files">Generating Object Files</a>,
Previous: <a rel="previous" accesskey="p" href="#Using-Other-File-Names">Using Other File Names</a>,
Up: <a rel="up" accesskey="u" href="#The-GNAT-Compilation-Model">The GNAT Compilation Model</a>
</div>
<h3 class="section">2.5 Alternative File Naming Schemes</h3>
<p><a name="index-File-naming-schemes_002c-alternative-39"></a><a name="index-File-names-40"></a>
In the previous section, we described the use of the <code>Source_File_Name</code>
pragma to allow arbitrary names to be assigned to individual source files.
However, this approach requires one pragma for each file, and especially in
large systems can result in very long <samp><span class="file">gnat.adc</span></samp> files, and also create
a maintenance problem.
<p>GNAT also provides a facility for specifying systematic file naming schemes
other than the standard default naming scheme previously described. An
alternative scheme for naming is specified by the use of
<code>Source_File_Name</code> pragmas having the following format:
<a name="index-Source_005fFile_005fName-pragma-41"></a>
<pre class="smallexample"> pragma Source_File_Name (
Spec_File_Name => FILE_NAME_PATTERN
<span class="roman">[</span>,Casing => CASING_SPEC<span class="roman">]</span>
<span class="roman">[</span>,Dot_Replacement => STRING_LITERAL<span class="roman">]</span>);
pragma Source_File_Name (
Body_File_Name => FILE_NAME_PATTERN
<span class="roman">[</span>,Casing => CASING_SPEC<span class="roman">]</span>
<span class="roman">[</span>,Dot_Replacement => STRING_LITERAL<span class="roman">]</span>);
pragma Source_File_Name (
Subunit_File_Name => FILE_NAME_PATTERN
<span class="roman">[</span>,Casing => CASING_SPEC<span class="roman">]</span>
<span class="roman">[</span>,Dot_Replacement => STRING_LITERAL<span class="roman">]</span>);
FILE_NAME_PATTERN ::= STRING_LITERAL
CASING_SPEC ::= Lowercase | Uppercase | Mixedcase
</pre>
<p class="noindent">The <code>FILE_NAME_PATTERN</code> string shows how the file name is constructed.
It contains a single asterisk character, and the unit name is substituted
systematically for this asterisk. The optional parameter
<code>Casing</code> indicates
whether the unit name is to be all upper-case letters, all lower-case letters,
or mixed-case. If no
<code>Casing</code> parameter is used, then the default is all
lower-case.
<p>The optional <code>Dot_Replacement</code> string is used to replace any periods
that occur in subunit or child unit names. If no <code>Dot_Replacement</code>
argument is used then separating dots appear unchanged in the resulting
file name.
Although the above syntax indicates that the
<code>Casing</code> argument must appear
before the <code>Dot_Replacement</code> argument, but it
is also permissible to write these arguments in the opposite order.
<p>As indicated, it is possible to specify different naming schemes for
bodies, specs, and subunits. Quite often the rule for subunits is the
same as the rule for bodies, in which case, there is no need to give
a separate <code>Subunit_File_Name</code> rule, and in this case the
<code>Body_File_name</code> rule is used for subunits as well.
<p>The separate rule for subunits can also be used to implement the rather
unusual case of a compilation environment (e.g. a single directory) which
contains a subunit and a child unit with the same unit name. Although
both units cannot appear in the same partition, the Ada Reference Manual
allows (but does not require) the possibility of the two units coexisting
in the same environment.
<p>The file name translation works in the following steps:
<ul>
<li>If there is a specific <code>Source_File_Name</code> pragma for the given unit,
then this is always used, and any general pattern rules are ignored.
<li>If there is a pattern type <code>Source_File_Name</code> pragma that applies to
the unit, then the resulting file name will be used if the file exists. If
more than one pattern matches, the latest one will be tried first, and the
first attempt resulting in a reference to a file that exists will be used.
<li>If no pattern type <code>Source_File_Name</code> pragma that applies to the unit
for which the corresponding file exists, then the standard GNAT default
naming rules are used.
</ul>
<p class="noindent">As an example of the use of this mechanism, consider a commonly used scheme
in which file names are all lower case, with separating periods copied
unchanged to the resulting file name, and specs end with <samp><span class="file">.1.ada</span></samp>, and
bodies end with <samp><span class="file">.2.ada</span></samp>. GNAT will follow this scheme if the following
two pragmas appear:
<pre class="smallexample"> pragma Source_File_Name
(Spec_File_Name => "*.1.ada");
pragma Source_File_Name
(Body_File_Name => "*.2.ada");
</pre>
<p class="noindent">The default GNAT scheme is actually implemented by providing the following
default pragmas internally:
<pre class="smallexample"> pragma Source_File_Name
(Spec_File_Name => "*.ads", Dot_Replacement => "-");
pragma Source_File_Name
(Body_File_Name => "*.adb", Dot_Replacement => "-");
</pre>
<p class="noindent">Our final example implements a scheme typically used with one of the
Ada 83 compilers, where the separator character for subunits was “__”
(two underscores), specs were identified by adding <samp><span class="file">_.ADA</span></samp>, bodies
by adding <samp><span class="file">.ADA</span></samp>, and subunits by
adding <samp><span class="file">.SEP</span></samp>. All file names were
upper case. Child units were not present of course since this was an
Ada 83 compiler, but it seems reasonable to extend this scheme to use
the same double underscore separator for child units.
<pre class="smallexample"> pragma Source_File_Name
(Spec_File_Name => "*_.ADA",
Dot_Replacement => "__",
Casing = Uppercase);
pragma Source_File_Name
(Body_File_Name => "*.ADA",
Dot_Replacement => "__",
Casing = Uppercase);
pragma Source_File_Name
(Subunit_File_Name => "*.SEP",
Dot_Replacement => "__",
Casing = Uppercase);
</pre>
<div class="node">
<a name="Generating-Object-Files"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Source-Dependencies">Source Dependencies</a>,
Previous: <a rel="previous" accesskey="p" href="#Alternative-File-Naming-Schemes">Alternative File Naming Schemes</a>,
Up: <a rel="up" accesskey="u" href="#The-GNAT-Compilation-Model">The GNAT Compilation Model</a>
</div>
<h3 class="section">2.6 Generating Object Files</h3>
<p class="noindent">An Ada program consists of a set of source files, and the first step in
compiling the program is to generate the corresponding object files.
These are generated by compiling a subset of these source files.
The files you need to compile are the following:
<ul>
<li>If a package spec has no body, compile the package spec to produce the
object file for the package.
<li>If a package has both a spec and a body, compile the body to produce the
object file for the package. The source file for the package spec need
not be compiled in this case because there is only one object file, which
contains the code for both the spec and body of the package.
<li>For a subprogram, compile the subprogram body to produce the object file
for the subprogram. The spec, if one is present, is as usual in a
separate file, and need not be compiled.
<li><a name="index-Subunits-42"></a>In the case of subunits, only compile the parent unit. A single object
file is generated for the entire subunit tree, which includes all the
subunits.
<li>Compile child units independently of their parent units
(though, of course, the spec of all the ancestor unit must be present in order
to compile a child unit).
<li><a name="index-Generics-43"></a>Compile generic units in the same manner as any other units. The object
files in this case are small dummy files that contain at most the
flag used for elaboration checking. This is because GNAT always handles generic
instantiation by means of macro expansion. However, it is still necessary to
compile generic units, for dependency checking and elaboration purposes.
</ul>
<p class="noindent">The preceding rules describe the set of files that must be compiled to
generate the object files for a program. Each object file has the same
name as the corresponding source file, except that the extension is
<samp><span class="file">.o</span></samp> as usual.
<p>You may wish to compile other files for the purpose of checking their
syntactic and semantic correctness. For example, in the case where a
package has a separate spec and body, you would not normally compile the
spec. However, it is convenient in practice to compile the spec to make
sure it is error-free before compiling clients of this spec, because such
compilations will fail if there is an error in the spec.
<p>GNAT provides an option for compiling such files purely for the
purposes of checking correctness; such compilations are not required as
part of the process of building a program. To compile a file in this
checking mode, use the <samp><span class="option">-gnatc</span></samp> switch.
<div class="node">
<a name="Source-Dependencies"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#The-Ada-Library-Information-Files">The Ada Library Information Files</a>,
Previous: <a rel="previous" accesskey="p" href="#Generating-Object-Files">Generating Object Files</a>,
Up: <a rel="up" accesskey="u" href="#The-GNAT-Compilation-Model">The GNAT Compilation Model</a>
</div>
<h3 class="section">2.7 Source Dependencies</h3>
<p class="noindent">A given object file clearly depends on the source file which is compiled
to produce it. Here we are using <dfn>depends</dfn> in the sense of a typical
<code>make</code> utility; in other words, an object file depends on a source
file if changes to the source file require the object file to be
recompiled.
In addition to this basic dependency, a given object may depend on
additional source files as follows:
<ul>
<li>If a file being compiled <code>with</code>'s a unit <var>X</var>, the object file
depends on the file containing the spec of unit <var>X</var>. This includes
files that are <code>with</code>'ed implicitly either because they are parents
of <code>with</code>'ed child units or they are run-time units required by the
language constructs used in a particular unit.
<li>If a file being compiled instantiates a library level generic unit, the
object file depends on both the spec and body files for this generic
unit.
<li>If a file being compiled instantiates a generic unit defined within a
package, the object file depends on the body file for the package as
well as the spec file.
<li><a name="index-Inline-44"></a><a name="index-g_t_0040option_007b_002dgnatn_007d-switch-45"></a>If a file being compiled contains a call to a subprogram for which
pragma <code>Inline</code> applies and inlining is activated with the
<samp><span class="option">-gnatn</span></samp> switch, the object file depends on the file containing the
body of this subprogram as well as on the file containing the spec. Note
that for inlining to actually occur as a result of the use of this switch,
it is necessary to compile in optimizing mode.
<p><a name="index-g_t_0040option_007b_002dgnatN_007d-switch-46"></a>The use of <samp><span class="option">-gnatN</span></samp> activates inlining optimization
that is performed by the front end of the compiler. This inlining does
not require that the code generation be optimized. Like <samp><span class="option">-gnatn</span></samp>,
the use of this switch generates additional dependencies.
<p>When using a gcc-based back end (in practice this means using any version
of GNAT other than the JGNAT, .NET or GNAAMP versions), then the use of
<samp><span class="option">-gnatN</span></samp> is deprecated, and the use of <samp><span class="option">-gnatn</span></samp> is preferred.
Historically front end inlining was more extensive than the gcc back end
inlining, but that is no longer the case.
<li>If an object file <samp><span class="file">O</span></samp> depends on the proper body of a subunit through
inlining or instantiation, it depends on the parent unit of the subunit.
This means that any modification of the parent unit or one of its subunits
affects the compilation of <samp><span class="file">O</span></samp>.
<li>The object file for a parent unit depends on all its subunit body files.
<li>The previous two rules meant that for purposes of computing dependencies and
recompilation, a body and all its subunits are treated as an indivisible whole.
<p class="noindent">These rules are applied transitively: if unit <code>A</code> <code>with</code>'s
unit <code>B</code>, whose elaboration calls an inlined procedure in package
<code>C</code>, the object file for unit <code>A</code> will depend on the body of
<code>C</code>, in file <samp><span class="file">c.adb</span></samp>.
<p>The set of dependent files described by these rules includes all the
files on which the unit is semantically dependent, as dictated by the
Ada language standard. However, it is a superset of what the
standard describes, because it includes generic, inline, and subunit
dependencies.
<p>An object file must be recreated by recompiling the corresponding source
file if any of the source files on which it depends are modified. For
example, if the <code>make</code> utility is used to control compilation,
the rule for an Ada object file must mention all the source files on
which the object file depends, according to the above definition.
The determination of the necessary
recompilations is done automatically when one uses <samp><span class="command">gnatmake</span></samp>.
</ul>
<div class="node">
<a name="The-Ada-Library-Information-Files"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Binding-an-Ada-Program">Binding an Ada Program</a>,
Previous: <a rel="previous" accesskey="p" href="#Source-Dependencies">Source Dependencies</a>,
Up: <a rel="up" accesskey="u" href="#The-GNAT-Compilation-Model">The GNAT Compilation Model</a>
</div>
<h3 class="section">2.8 The Ada Library Information Files</h3>
<p><a name="index-Ada-Library-Information-files-47"></a><a name="index-g_t_0040file_007bALI_007d-files-48"></a>
Each compilation actually generates two output files. The first of these
is the normal object file that has a <samp><span class="file">.o</span></samp> extension. The second is a
text file containing full dependency information. It has the same
name as the source file, but an <samp><span class="file">.ali</span></samp> extension.
This file is known as the Ada Library Information (<samp><span class="file">ALI</span></samp>) file.
The following information is contained in the <samp><span class="file">ALI</span></samp> file.
<ul>
<li>Version information (indicates which version of GNAT was used to compile
the unit(s) in question)
<li>Main program information (including priority and time slice settings,
as well as the wide character encoding used during compilation).
<li>List of arguments used in the <samp><span class="command">gcc</span></samp> command for the compilation
<li>Attributes of the unit, including configuration pragmas used, an indication
of whether the compilation was successful, exception model used etc.
<li>A list of relevant restrictions applying to the unit (used for consistency)
checking.
<li>Categorization information (e.g. use of pragma <code>Pure</code>).
<li>Information on all <code>with</code>'ed units, including presence of
<code>Elaborate</code> or <code>Elaborate_All</code> pragmas.
<li>Information from any <code>Linker_Options</code> pragmas used in the unit
<li>Information on the use of <code>Body_Version</code> or <code>Version</code>
attributes in the unit.
<li>Dependency information. This is a list of files, together with
time stamp and checksum information. These are files on which
the unit depends in the sense that recompilation is required
if any of these units are modified.
<li>Cross-reference data. Contains information on all entities referenced
in the unit. Used by tools like <code>gnatxref</code> and <code>gnatfind</code> to
provide cross-reference information.
</ul>
<p class="noindent">For a full detailed description of the format of the <samp><span class="file">ALI</span></samp> file,
see the source of the body of unit <code>Lib.Writ</code>, contained in file
<samp><span class="file">lib-writ.adb</span></samp> in the GNAT compiler sources.
<div class="node">
<a name="Binding-an-Ada-Program"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Mixed-Language-Programming">Mixed Language Programming</a>,
Previous: <a rel="previous" accesskey="p" href="#The-Ada-Library-Information-Files">The Ada Library Information Files</a>,
Up: <a rel="up" accesskey="u" href="#The-GNAT-Compilation-Model">The GNAT Compilation Model</a>
</div>
<h3 class="section">2.9 Binding an Ada Program</h3>
<p class="noindent">When using languages such as C and C++, once the source files have been
compiled the only remaining step in building an executable program
is linking the object modules together. This means that it is possible to
link an inconsistent version of a program, in which two units have
included different versions of the same header.
<p>The rules of Ada do not permit such an inconsistent program to be built.
For example, if two clients have different versions of the same package,
it is illegal to build a program containing these two clients.
These rules are enforced by the GNAT binder, which also determines an
elaboration order consistent with the Ada rules.
<p>The GNAT binder is run after all the object files for a program have
been created. It is given the name of the main program unit, and from
this it determines the set of units required by the program, by reading the
corresponding ALI files. It generates error messages if the program is
inconsistent or if no valid order of elaboration exists.
<p>If no errors are detected, the binder produces a main program, in Ada by
default, that contains calls to the elaboration procedures of those
compilation unit that require them, followed by
a call to the main program. This Ada program is compiled to generate the
object file for the main program. The name of
the Ada file is <samp><span class="file">b~</span><var>xxx</var><span class="file">.adb</span></samp> (with the corresponding spec
<samp><span class="file">b~</span><var>xxx</var><span class="file">.ads</span></samp>) where <var>xxx</var> is the name of the
main program unit.
<p>Finally, the linker is used to build the resulting executable program,
using the object from the main program from the bind step as well as the
object files for the Ada units of the program.
<div class="node">
<a name="Mixed-Language-Programming"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Building-Mixed-Ada-_0026-C_002b_002b-Programs">Building Mixed Ada & C++ Programs</a>,
Previous: <a rel="previous" accesskey="p" href="#Binding-an-Ada-Program">Binding an Ada Program</a>,
Up: <a rel="up" accesskey="u" href="#The-GNAT-Compilation-Model">The GNAT Compilation Model</a>
</div>
<h3 class="section">2.10 Mixed Language Programming</h3>
<p><a name="index-Mixed-Language-Programming-49"></a>
This section describes how to develop a mixed-language program,
specifically one that comprises units in both Ada and C.
<ul class="menu">
<li><a accesskey="1" href="#Interfacing-to-C">Interfacing to C</a>
<li><a accesskey="2" href="#Calling-Conventions">Calling Conventions</a>
</ul>
<div class="node">
<a name="Interfacing-to-C"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Calling-Conventions">Calling Conventions</a>,
Up: <a rel="up" accesskey="u" href="#Mixed-Language-Programming">Mixed Language Programming</a>
</div>
<h4 class="subsection">2.10.1 Interfacing to C</h4>
<p class="noindent">Interfacing Ada with a foreign language such as C involves using
compiler directives to import and/or export entity definitions in each
language—using <code>extern</code> statements in C, for instance, and the
<code>Import</code>, <code>Export</code>, and <code>Convention</code> pragmas in Ada.
A full treatment of these topics is provided in Appendix B, section 1
of the Ada Reference Manual.
<p>There are two ways to build a program using GNAT that contains some Ada
sources and some foreign language sources, depending on whether or not
the main subprogram is written in Ada. Here is a source example with
the main subprogram in Ada:
<pre class="smallexample"> /* file1.c */
#include <stdio.h>
void print_num (int num)
{
printf ("num is %d.\n", num);
return;
}
/* file2.c */
/* num_from_Ada is declared in my_main.adb */
extern int num_from_Ada;
int get_num (void)
{
return num_from_Ada;
}
</pre>
<pre class="smallexample"> -- my_main.adb
procedure My_Main is
-- Declare then export an Integer entity called num_from_Ada
My_Num : Integer := 10;
pragma Export (C, My_Num, "num_from_Ada");
-- Declare an Ada function spec for Get_Num, then use
-- C function get_num for the implementation.
function Get_Num return Integer;
pragma Import (C, Get_Num, "get_num");
-- Declare an Ada procedure spec for Print_Num, then use
-- C function print_num for the implementation.
procedure Print_Num (Num : Integer);
pragma Import (C, Print_Num, "print_num");
begin
Print_Num (Get_Num);
end My_Main;
</pre>
<ol type=1 start=1>
<li>To build this example, first compile the foreign language files to
generate object files:
<pre class="smallexample"> gcc -c file1.c
gcc -c file2.c
</pre>
<li>Then, compile the Ada units to produce a set of object files and ALI
files:
<pre class="smallexample"> gnatmake -c my_main.adb
</pre>
<li>Run the Ada binder on the Ada main program:
<pre class="smallexample"> gnatbind my_main.ali
</pre>
<li>Link the Ada main program, the Ada objects and the other language
objects:
<pre class="smallexample"> gnatlink my_main.ali file1.o file2.o
</pre>
</ol>
<p>The last three steps can be grouped in a single command:
<pre class="smallexample"> gnatmake my_main.adb -largs file1.o file2.o
</pre>
<p><a name="index-Binder-output-file-50"></a>If the main program is in a language other than Ada, then you may have
more than one entry point into the Ada subsystem. You must use a special
binder option to generate callable routines that initialize and
finalize the Ada units (see <a href="#Binding-with-Non_002dAda-Main-Programs">Binding with Non-Ada Main Programs</a>).
Calls to the initialization and finalization routines must be inserted
in the main program, or some other appropriate point in the code. The
call to initialize the Ada units must occur before the first Ada
subprogram is called, and the call to finalize the Ada units must occur
after the last Ada subprogram returns. The binder will place the
initialization and finalization subprograms into the
<samp><span class="file">b~</span><var>xxx</var><span class="file">.adb</span></samp> file where they can be accessed by your C
sources. To illustrate, we have the following example:
<pre class="smallexample"> /* main.c */
extern void adainit (void);
extern void adafinal (void);
extern int add (int, int);
extern int sub (int, int);
int main (int argc, char *argv[])
{
int a = 21, b = 7;
adainit();
/* Should print "21 + 7 = 28" */
printf ("%d + %d = %d\n", a, b, add (a, b));
/* Should print "21 - 7 = 14" */
printf ("%d - %d = %d\n", a, b, sub (a, b));
adafinal();
}
</pre>
<pre class="smallexample"> -- unit1.ads
package Unit1 is
function Add (A, B : Integer) return Integer;
pragma Export (C, Add, "add");
end Unit1;
-- unit1.adb
package body Unit1 is
function Add (A, B : Integer) return Integer is
begin
return A + B;
end Add;
end Unit1;
-- unit2.ads
package Unit2 is
function Sub (A, B : Integer) return Integer;
pragma Export (C, Sub, "sub");
end Unit2;
-- unit2.adb
package body Unit2 is
function Sub (A, B : Integer) return Integer is
begin
return A - B;
end Sub;
end Unit2;
</pre>
<ol type=1 start=1>
<li>The build procedure for this application is similar to the last
example's. First, compile the foreign language files to generate object
files:
<pre class="smallexample"> gcc -c main.c
</pre>
<li>Next, compile the Ada units to produce a set of object files and ALI
files:
<pre class="smallexample"> gnatmake -c unit1.adb
gnatmake -c unit2.adb
</pre>
<li>Run the Ada binder on every generated ALI file. Make sure to use the
<samp><span class="option">-n</span></samp> option to specify a foreign main program:
<pre class="smallexample"> gnatbind -n unit1.ali unit2.ali
</pre>
<li>Link the Ada main program, the Ada objects and the foreign language
objects. You need only list the last ALI file here:
<pre class="smallexample"> gnatlink unit2.ali main.o -o exec_file
</pre>
<p>This procedure yields a binary executable called <samp><span class="file">exec_file</span></samp>.
</ol>
<p class="noindent">Depending on the circumstances (for example when your non-Ada main object
does not provide symbol <code>main</code>), you may also need to instruct the
GNAT linker not to include the standard startup objects by passing the
<samp><span class="option">-nostartfiles</span></samp> switch to <samp><span class="command">gnatlink</span></samp>.
<div class="node">
<a name="Calling-Conventions"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Interfacing-to-C">Interfacing to C</a>,
Up: <a rel="up" accesskey="u" href="#Mixed-Language-Programming">Mixed Language Programming</a>
</div>
<h4 class="subsection">2.10.2 Calling Conventions</h4>
<p><a name="index-Foreign-Languages-51"></a><a name="index-Calling-Conventions-52"></a>GNAT follows standard calling sequence conventions and will thus interface
to any other language that also follows these conventions. The following
Convention identifiers are recognized by GNAT:
<a name="index-Interfacing-to-Ada-53"></a>
<a name="index-Other-Ada-compilers-54"></a>
<a name="index-Convention-Ada-55"></a>
<dl><dt><code>Ada</code><dd>This indicates that the standard Ada calling sequence will be
used and all Ada data items may be passed without any limitations in the
case where GNAT is used to generate both the caller and callee. It is also
possible to mix GNAT generated code and code generated by another Ada
compiler. In this case, the data types should be restricted to simple
cases, including primitive types. Whether complex data types can be passed
depends on the situation. Probably it is safe to pass simple arrays, such
as arrays of integers or floats. Records may or may not work, depending
on whether both compilers lay them out identically. Complex structures
involving variant records, access parameters, tasks, or protected types,
are unlikely to be able to be passed.
<p>Note that in the case of GNAT running
on a platform that supports HP Ada 83, a higher degree of compatibility
can be guaranteed, and in particular records are layed out in an identical
manner in the two compilers. Note also that if output from two different
compilers is mixed, the program is responsible for dealing with elaboration
issues. Probably the safest approach is to write the main program in the
version of Ada other than GNAT, so that it takes care of its own elaboration
requirements, and then call the GNAT-generated adainit procedure to ensure
elaboration of the GNAT components. Consult the documentation of the other
Ada compiler for further details on elaboration.
<p>However, it is not possible to mix the tasking run time of GNAT and
HP Ada 83, All the tasking operations must either be entirely within
GNAT compiled sections of the program, or entirely within HP Ada 83
compiled sections of the program.
<p><a name="index-Interfacing-to-Assembly-56"></a><a name="index-Convention-Assembler-57"></a><br><dt><code>Assembler</code><dd>Specifies assembler as the convention. In practice this has the
same effect as convention Ada (but is not equivalent in the sense of being
considered the same convention).
<p><a name="index-Convention-Asm-58"></a><a name="index-Asm-59"></a><br><dt><code>Asm</code><dd>Equivalent to Assembler.
<p><a name="index-Interfacing-to-COBOL-60"></a><a name="index-Convention-COBOL-61"></a><a name="index-COBOL-62"></a><br><dt><code>COBOL</code><dd>Data will be passed according to the conventions described
in section B.4 of the Ada Reference Manual.
<p><a name="index-C-63"></a><a name="index-Interfacing-to-C-64"></a><a name="index-Convention-C-65"></a><br><dt><code>C</code><dd>Data will be passed according to the conventions described
in section B.3 of the Ada Reference Manual.
<p>A note on interfacing to a C “varargs” function:
<a name="index-C-varargs-function-66"></a><a name="index-Interfacing-to-C-varargs-function-67"></a><a name="index-varargs-function-interfaces-68"></a>
<ul>
<li>In C, <code>varargs</code> allows a function to take a variable number of
arguments. There is no direct equivalent in this to Ada. One
approach that can be used is to create a C wrapper for each
different profile and then interface to this C wrapper. For
example, to print an <code>int</code> value using <code>printf</code>,
create a C function <code>printfi</code> that takes two arguments, a
pointer to a string and an int, and calls <code>printf</code>.
Then in the Ada program, use pragma <code>Import</code> to
interface to <code>printfi</code>.
<li>It may work on some platforms to directly interface to
a <code>varargs</code> function by providing a specific Ada profile
for a particular call. However, this does not work on
all platforms, since there is no guarantee that the
calling sequence for a two argument normal C function
is the same as for calling a <code>varargs</code> C function with
the same two arguments.
</ul>
<p><a name="index-Convention-Default-69"></a><a name="index-Default-70"></a><br><dt><code>Default</code><dd>Equivalent to C.
<p><a name="index-Convention-External-71"></a><a name="index-External-72"></a><br><dt><code>External</code><dd>Equivalent to C.
<p><a name="index-C_002b_002b-73"></a><a name="index-Interfacing-to-C_002b_002b-74"></a><a name="index-Convention-C_002b_002b-75"></a><br><dt><code>C_Plus_Plus (or CPP)</code><dd>This stands for C++. For most purposes this is identical to C.
See the separate description of the specialized GNAT pragmas relating to
C++ interfacing for further details.
<p><a name="index-Fortran-76"></a><a name="index-Interfacing-to-Fortran-77"></a><a name="index-Convention-Fortran-78"></a><br><dt><code>Fortran</code><dd>Data will be passed according to the conventions described
in section B.5 of the Ada Reference Manual.
<br><dt><code>Intrinsic</code><dd>This applies to an intrinsic operation, as defined in the Ada
Reference Manual. If a pragma Import (Intrinsic) applies to a subprogram,
this means that the body of the subprogram is provided by the compiler itself,
usually by means of an efficient code sequence, and that the user does not
supply an explicit body for it. In an application program, the pragma may
be applied to the following sets of names:
<ul>
<li>Rotate_Left, Rotate_Right, Shift_Left, Shift_Right,
Shift_Right_Arithmetic. The corresponding subprogram declaration must have
two formal parameters. The
first one must be a signed integer type or a modular type with a binary
modulus, and the second parameter must be of type Natural.
The return type must be the same as the type of the first argument. The size
of this type can only be 8, 16, 32, or 64.
<li>Binary arithmetic operators: “+”, “-”, “*”, “/”
The corresponding operator declaration must have parameters and result type
that have the same root numeric type (for example, all three are long_float
types). This simplifies the definition of operations that use type checking
to perform dimensional checks:
<pre class="smallexample"> type Distance is new Long_Float;
type Time is new Long_Float;
type Velocity is new Long_Float;
function "/" (D : Distance; T : Time)
return Velocity;
pragma Import (Intrinsic, "/");
</pre>
<p class="noindent">This common idiom is often programmed with a generic definition and an
explicit body. The pragma makes it simpler to introduce such declarations.
It incurs no overhead in compilation time or code size, because it is
implemented as a single machine instruction.
<li>General subprogram entities, to bind an Ada subprogram declaration to
a compiler builtin by name with back-ends where such interfaces are
available. A typical example is the set of “__builtin” functions
exposed by the GCC back-end, as in the following example:
<pre class="smallexample"> function builtin_sqrt (F : Float) return Float;
pragma Import (Intrinsic, builtin_sqrt, "__builtin_sqrtf");
</pre>
<p>Most of the GCC builtins are accessible this way, and as for other
import conventions (e.g. C), it is the user's responsibility to ensure
that the Ada subprogram profile matches the underlying builtin
expectations.
</ul>
<p class="noindent"><a name="index-Stdcall-79"></a><a name="index-Convention-Stdcall-80"></a><br><dt><code>Stdcall</code><dd>This is relevant only to Windows XP/2000/NT implementations of GNAT,
and specifies that the <code>Stdcall</code> calling sequence will be used,
as defined by the NT API. Nevertheless, to ease building
cross-platform bindings this convention will be handled as a <code>C</code> calling
convention on non-Windows platforms.
<p><a name="index-DLL-81"></a><a name="index-Convention-DLL-82"></a><br><dt><code>DLL</code><dd>This is equivalent to <code>Stdcall</code>.
<p><a name="index-Win32-83"></a><a name="index-Convention-Win32-84"></a><br><dt><code>Win32</code><dd>This is equivalent to <code>Stdcall</code>.
<p><a name="index-Stubbed-85"></a><a name="index-Convention-Stubbed-86"></a><br><dt><code>Stubbed</code><dd>This is a special convention that indicates that the compiler
should provide a stub body that raises <code>Program_Error</code>.
</dl>
<p class="noindent">GNAT additionally provides a useful pragma <code>Convention_Identifier</code>
that can be used to parameterize conventions and allow additional synonyms
to be specified. For example if you have legacy code in which the convention
identifier Fortran77 was used for Fortran, you can use the configuration
pragma:
<pre class="smallexample"> pragma Convention_Identifier (Fortran77, Fortran);
</pre>
<p class="noindent">And from now on the identifier Fortran77 may be used as a convention
identifier (for example in an <code>Import</code> pragma) with the same
meaning as Fortran.
<div class="node">
<a name="Building-Mixed-Ada-%26-C++-Programs"></a>
<a name="Building-Mixed-Ada-_0026-C_002b_002b-Programs"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Comparison-between-GNAT-and-C_002fC_002b_002b-Compilation-Models">Comparison between GNAT and C/C++ Compilation Models</a>,
Previous: <a rel="previous" accesskey="p" href="#Mixed-Language-Programming">Mixed Language Programming</a>,
Up: <a rel="up" accesskey="u" href="#The-GNAT-Compilation-Model">The GNAT Compilation Model</a>
</div>
<h3 class="section">2.11 Building Mixed Ada and C++ Programs</h3>
<p class="noindent">A programmer inexperienced with mixed-language development may find that
building an application containing both Ada and C++ code can be a
challenge. This section gives a few
hints that should make this task easier. The first section addresses
the differences between interfacing with C and interfacing with C++.
The second section
looks into the delicate problem of linking the complete application from
its Ada and C++ parts. The last section gives some hints on how the GNAT
run-time library can be adapted in order to allow inter-language dispatching
with a new C++ compiler.
<ul class="menu">
<li><a accesskey="1" href="#Interfacing-to-C_002b_002b">Interfacing to C++</a>
<li><a accesskey="2" href="#Linking-a-Mixed-C_002b_002b-_0026-Ada-Program">Linking a Mixed C++ & Ada Program</a>
<li><a accesskey="3" href="#A-Simple-Example">A Simple Example</a>
<li><a accesskey="4" href="#Interfacing-with-C_002b_002b-constructors">Interfacing with C++ constructors</a>
<li><a accesskey="5" href="#Interfacing-with-C_002b_002b-at-the-Class-Level">Interfacing with C++ at the Class Level</a>
</ul>
<div class="node">
<a name="Interfacing-to-C++"></a>
<a name="Interfacing-to-C_002b_002b"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Linking-a-Mixed-C_002b_002b-_0026-Ada-Program">Linking a Mixed C++ & Ada Program</a>,
Up: <a rel="up" accesskey="u" href="#Building-Mixed-Ada-_0026-C_002b_002b-Programs">Building Mixed Ada & C++ Programs</a>
</div>
<h4 class="subsection">2.11.1 Interfacing to C++</h4>
<p class="noindent">GNAT supports interfacing with the G++ compiler (or any C++ compiler
generating code that is compatible with the G++ Application Binary
Interface —see http://www.codesourcery.com/archives/cxx-abi).
<p class="noindent">Interfacing can be done at 3 levels: simple data, subprograms, and
classes. In the first two cases, GNAT offers a specific <code>Convention
C_Plus_Plus</code> (or <code>CPP</code>) that behaves exactly like <code>Convention C</code>.
Usually, C++ mangles the names of subprograms. To generate proper mangled
names automatically, see <a href="#Generating-Ada-Bindings-for-C-and-C_002b_002b-headers">Generating Ada Bindings for C and C++ headers</a>).
This problem can also be addressed manually in two ways:
<ul>
<li>by modifying the C++ code in order to force a C convention using
the <code>extern "C"</code> syntax.
<li>by figuring out the mangled name (using e.g. <samp><span class="command">nm</span></samp>) and using it as the
Link_Name argument of the pragma import.
</ul>
<p class="noindent">Interfacing at the class level can be achieved by using the GNAT specific
pragmas such as <code>CPP_Constructor</code>. See <a href="gnat_rm.html#Interfacing-to-C_002b_002b">Interfacing to C++</a>, for additional information.
<div class="node">
<a name="Linking-a-Mixed-C++-%26-Ada-Program"></a>
<a name="Linking-a-Mixed-C_002b_002b-_0026-Ada-Program"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#A-Simple-Example">A Simple Example</a>,
Previous: <a rel="previous" accesskey="p" href="#Interfacing-to-C_002b_002b">Interfacing to C++</a>,
Up: <a rel="up" accesskey="u" href="#Building-Mixed-Ada-_0026-C_002b_002b-Programs">Building Mixed Ada & C++ Programs</a>
</div>
<h4 class="subsection">2.11.2 Linking a Mixed C++ & Ada Program</h4>
<p class="noindent">Usually the linker of the C++ development system must be used to link
mixed applications because most C++ systems will resolve elaboration
issues (such as calling constructors on global class instances)
transparently during the link phase. GNAT has been adapted to ease the
use of a foreign linker for the last phase. Three cases can be
considered:
<ol type=1 start=1>
<li>Using GNAT and G++ (GNU C++ compiler) from the same GCC installation:
The C++ linker can simply be called by using the C++ specific driver
called <code>g++</code>.
<p>Note that if the C++ code uses inline functions, you will need to
compile your C++ code with the <code>-fkeep-inline-functions</code> switch in
order to provide an existing function implementation that the Ada code can
link with.
<pre class="smallexample"> $ g++ -c -fkeep-inline-functions file1.C
$ g++ -c -fkeep-inline-functions file2.C
$ gnatmake ada_unit -largs file1.o file2.o --LINK=g++
</pre>
<li>Using GNAT and G++ from two different GCC installations: If both
compilers are on the <samp><span class="env">PATH</span></samp>, the previous method may be used. It is
important to note that environment variables such as
<samp><span class="env">C_INCLUDE_PATH</span></samp>, <samp><span class="env">GCC_EXEC_PREFIX</span></samp>, <samp><span class="env">BINUTILS_ROOT</span></samp>, and
<samp><span class="env">GCC_ROOT</span></samp> will affect both compilers
at the same time and may make one of the two compilers operate
improperly if set during invocation of the wrong compiler. It is also
very important that the linker uses the proper <samp><span class="file">libgcc.a</span></samp> GCC
library – that is, the one from the C++ compiler installation. The
implicit link command as suggested in the <samp><span class="command">gnatmake</span></samp> command
from the former example can be replaced by an explicit link command with
the full-verbosity option in order to verify which library is used:
<pre class="smallexample"> $ gnatbind ada_unit
$ gnatlink -v -v ada_unit file1.o file2.o --LINK=c++
</pre>
<p>If there is a problem due to interfering environment variables, it can
be worked around by using an intermediate script. The following example
shows the proper script to use when GNAT has not been installed at its
default location and g++ has been installed at its default location:
<pre class="smallexample"> $ cat ./my_script
#!/bin/sh
unset BINUTILS_ROOT
unset GCC_ROOT
c++ $*
$ gnatlink -v -v ada_unit file1.o file2.o --LINK=./my_script
</pre>
<li>Using a non-GNU C++ compiler: The commands previously described can be
used to insure that the C++ linker is used. Nonetheless, you need to add
a few more parameters to the link command line, depending on the exception
mechanism used.
<p>If the <code>setjmp/longjmp</code> exception mechanism is used, only the paths
to the libgcc libraries are required:
<pre class="smallexample"> $ cat ./my_script
#!/bin/sh
CC $* `gcc -print-file-name=libgcc.a` `gcc -print-file-name=libgcc_eh.a`
$ gnatlink ada_unit file1.o file2.o --LINK=./my_script
</pre>
<p>Where CC is the name of the non-GNU C++ compiler.
<p>If the <code>zero cost</code> exception mechanism is used, and the platform
supports automatic registration of exception tables (e.g. Solaris or IRIX),
paths to more objects are required:
<pre class="smallexample"> $ cat ./my_script
#!/bin/sh
CC `gcc -print-file-name=crtbegin.o` $* \
`gcc -print-file-name=libgcc.a` `gcc -print-file-name=libgcc_eh.a` \
`gcc -print-file-name=crtend.o`
$ gnatlink ada_unit file1.o file2.o --LINK=./my_script
</pre>
<p>If the <code>zero cost</code> exception mechanism is used, and the platform
doesn't support automatic registration of exception tables (e.g. HP-UX,
Tru64 or AIX), the simple approach described above will not work and
a pre-linking phase using GNAT will be necessary.
</ol>
<p>Another alternative is to use the <samp><span class="command">gprbuild</span></samp> multi-language builder
which has a large knowledge base and knows how to link Ada and C++ code
together automatically in most cases.
<div class="node">
<a name="A-Simple-Example"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Interfacing-with-C_002b_002b-constructors">Interfacing with C++ constructors</a>,
Previous: <a rel="previous" accesskey="p" href="#Linking-a-Mixed-C_002b_002b-_0026-Ada-Program">Linking a Mixed C++ & Ada Program</a>,
Up: <a rel="up" accesskey="u" href="#Building-Mixed-Ada-_0026-C_002b_002b-Programs">Building Mixed Ada & C++ Programs</a>
</div>
<h4 class="subsection">2.11.3 A Simple Example</h4>
<p class="noindent">The following example, provided as part of the GNAT examples, shows how
to achieve procedural interfacing between Ada and C++ in both
directions. The C++ class A has two methods. The first method is exported
to Ada by the means of an extern C wrapper function. The second method
calls an Ada subprogram. On the Ada side, The C++ calls are modelled by
a limited record with a layout comparable to the C++ class. The Ada
subprogram, in turn, calls the C++ method. So, starting from the C++
main program, the process passes back and forth between the two
languages.
<p class="noindent">Here are the compilation commands:
<pre class="smallexample"> $ gnatmake -c simple_cpp_interface
$ g++ -c cpp_main.C
$ g++ -c ex7.C
$ gnatbind -n simple_cpp_interface
$ gnatlink simple_cpp_interface -o cpp_main --LINK=g++
-lstdc++ ex7.o cpp_main.o
</pre>
<p class="noindent">Here are the corresponding sources:
<pre class="smallexample">
//cpp_main.C
#include "ex7.h"
extern "C" {
void adainit (void);
void adafinal (void);
void method1 (A *t);
}
void method1 (A *t)
{
t->method1 ();
}
int main ()
{
A obj;
adainit ();
obj.method2 (3030);
adafinal ();
}
//ex7.h
class Origin {
public:
int o_value;
};
class A : public Origin {
public:
void method1 (void);
void method2 (int v);
A();
int a_value;
};
//ex7.C
#include "ex7.h"
#include <stdio.h>
extern "C" { void ada_method2 (A *t, int v);}
void A::method1 (void)
{
a_value = 2020;
printf ("in A::method1, a_value = %d \n",a_value);
}
void A::method2 (int v)
{
ada_method2 (this, v);
printf ("in A::method2, a_value = %d \n",a_value);
}
A::A(void)
{
a_value = 1010;
printf ("in A::A, a_value = %d \n",a_value);
}
</pre>
<pre class="smallexample"> -- Ada sources
package body Simple_Cpp_Interface is
procedure Ada_Method2 (This : in out A; V : Integer) is
begin
Method1 (This);
This.A_Value := V;
end Ada_Method2;
end Simple_Cpp_Interface;
with System;
package Simple_Cpp_Interface is
type A is limited
record
Vptr : System.Address;
O_Value : Integer;
A_Value : Integer;
end record;
pragma Convention (C, A);
procedure Method1 (This : in out A);
pragma Import (C, Method1);
procedure Ada_Method2 (This : in out A; V : Integer);
pragma Export (C, Ada_Method2);
end Simple_Cpp_Interface;
</pre>
<div class="node">
<a name="Interfacing-with-C++-constructors"></a>
<a name="Interfacing-with-C_002b_002b-constructors"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Interfacing-with-C_002b_002b-at-the-Class-Level">Interfacing with C++ at the Class Level</a>,
Previous: <a rel="previous" accesskey="p" href="#A-Simple-Example">A Simple Example</a>,
Up: <a rel="up" accesskey="u" href="#Building-Mixed-Ada-_0026-C_002b_002b-Programs">Building Mixed Ada & C++ Programs</a>
</div>
<h4 class="subsection">2.11.4 Interfacing with C++ constructors</h4>
<p class="noindent">In order to interface with C++ constructors GNAT provides the
<code>pragma CPP_Constructor</code> (See <a href="gnat_rm.html#Interfacing-to-C_002b_002b">Interfacing to C++</a>, for additional information).
In this section we present some common uses of C++ constructors
in mixed-languages programs in GNAT.
<p>Let us assume that we need to interface with the following
C++ class:
<pre class="smallexample"> <b>class</b> Root {
<b>public</b>:
int a_value;
int b_value;
<b>virtual</b> int Get_Value ();
Root(); // Default constructor
Root(int v); // 1st non-default constructor
Root(int v, int w); // 2nd non-default constructor
};
</pre>
<p>For this purpose we can write the following package spec (further
information on how to build this spec is available in
<a href="#Interfacing-with-C_002b_002b-at-the-Class-Level">Interfacing with C++ at the Class Level</a> and
<a href="#Generating-Ada-Bindings-for-C-and-C_002b_002b-headers">Generating Ada Bindings for C and C++ headers</a>).
<pre class="smallexample"> with Interfaces.C; use Interfaces.C;
package Pkg_Root is
type Root is tagged limited record
A_Value : int;
B_Value : int;
end record;
pragma Import (CPP, Root);
function Get_Value (Obj : Root) return int;
pragma Import (CPP, Get_Value);
function Constructor return Root;
pragma Cpp_Constructor (Constructor, "_ZN4RootC1Ev");
function Constructor (v : Integer) return Root;
pragma Cpp_Constructor (Constructor, "_ZN4RootC1Ei");
function Constructor (v, w : Integer) return Root;
pragma Cpp_Constructor (Constructor, "_ZN4RootC1Eii");
end Pkg_Root;
</pre>
<p>On the Ada side the constructor is represented by a function (whose
name is arbitrary) that returns the classwide type corresponding to
the imported C++ class. Although the constructor is described as a
function, it is typically a procedure with an extra implicit argument
(the object being initialized) at the implementation level. GNAT
issues the appropriate call, whatever it is, to get the object
properly initialized.
<p>Constructors can only appear in the following contexts:
<ul>
<li>On the right side of an initialization of an object of type <var>T</var>.
<li>On the right side of an initialization of a record component of type <var>T</var>.
<li>In an Ada 2005 limited aggregate.
<li>In an Ada 2005 nested limited aggregate.
<li>In an Ada 2005 limited aggregate that initializes an object built in
place by an extended return statement.
</ul>
<p class="noindent">In a declaration of an object whose type is a class imported from C++,
either the default C++ constructor is implicitly called by GNAT, or
else the required C++ constructor must be explicitly called in the
expression that initializes the object. For example:
<pre class="smallexample"> Obj1 : Root;
Obj2 : Root := Constructor;
Obj3 : Root := Constructor (v => 10);
Obj4 : Root := Constructor (30, 40);
</pre>
<p>The first two declarations are equivalent: in both cases the default C++
constructor is invoked (in the former case the call to the constructor is
implicit, and in the latter case the call is explicit in the object
declaration). <code>Obj3</code> is initialized by the C++ non-default constructor
that takes an integer argument, and <code>Obj4</code> is initialized by the
non-default C++ constructor that takes two integers.
<p>Let us derive the imported C++ class in the Ada side. For example:
<pre class="smallexample"> type DT is new Root with record
C_Value : Natural := 2009;
end record;
</pre>
<p>In this case the components DT inherited from the C++ side must be
initialized by a C++ constructor, and the additional Ada components
of type DT are initialized by GNAT. The initialization of such an
object is done either by default, or by means of a function returning
an aggregate of type DT, or by means of an extension aggregate.
<pre class="smallexample"> Obj5 : DT;
Obj6 : DT := Function_Returning_DT (50);
Obj7 : DT := (Constructor (30,40) with C_Value => 50);
</pre>
<p>The declaration of <code>Obj5</code> invokes the default constructors: the
C++ default constructor of the parent type takes care of the initialization
of the components inherited from Root, and GNAT takes care of the default
initialization of the additional Ada components of type DT (that is,
<code>C_Value</code> is initialized to value 2009). The order of invocation of
the constructors is consistent with the order of elaboration required by
Ada and C++. That is, the constructor of the parent type is always called
before the constructor of the derived type.
<p>Let us now consider a record that has components whose type is imported
from C++. For example:
<pre class="smallexample"> type Rec1 is limited record
Data1 : Root := Constructor (10);
Value : Natural := 1000;
end record;
type Rec2 (D : Integer := 20) is limited record
Rec : Rec1;
Data2 : Root := Constructor (D, 30);
end record;
</pre>
<p>The initialization of an object of type <code>Rec2</code> will call the
non-default C++ constructors specified for the imported components.
For example:
<pre class="smallexample"> Obj8 : Rec2 (40);
</pre>
<p>Using Ada 2005 we can use limited aggregates to initialize an object
invoking C++ constructors that differ from those specified in the type
declarations. For example:
<pre class="smallexample"> Obj9 : Rec2 := (Rec => (Data1 => Constructor (15, 16),
others => <>),
others => <>);
</pre>
<p>The above declaration uses an Ada 2005 limited aggregate to
initialize <code>Obj9</code>, and the C++ constructor that has two integer
arguments is invoked to initialize the <code>Data1</code> component instead
of the constructor specified in the declaration of type <code>Rec1</code>. In
Ada 2005 the box in the aggregate indicates that unspecified components
are initialized using the expression (if any) available in the component
declaration. That is, in this case discriminant <code>D</code> is initialized
to value <code>20</code>, <code>Value</code> is initialized to value 1000, and the
non-default C++ constructor that handles two integers takes care of
initializing component <code>Data2</code> with values <code>20,30</code>.
<p>In Ada 2005 we can use the extended return statement to build the Ada
equivalent to C++ non-default constructors. For example:
<pre class="smallexample"> function Constructor (V : Integer) return Rec2 is
begin
return Obj : Rec2 := (Rec => (Data1 => Constructor (V, 20),
others => <>),
others => <>) do
-- Further actions required for construction of
-- objects of type Rec2
...
end record;
end Constructor;
</pre>
<p>In this example the extended return statement construct is used to
build in place the returned object whose components are initialized
by means of a limited aggregate. Any further action associated with
the constructor can be placed inside the construct.
<div class="node">
<a name="Interfacing-with-C++-at-the-Class-Level"></a>
<a name="Interfacing-with-C_002b_002b-at-the-Class-Level"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Interfacing-with-C_002b_002b-constructors">Interfacing with C++ constructors</a>,
Up: <a rel="up" accesskey="u" href="#Building-Mixed-Ada-_0026-C_002b_002b-Programs">Building Mixed Ada & C++ Programs</a>
</div>
<h4 class="subsection">2.11.5 Interfacing with C++ at the Class Level</h4>
<p class="noindent">In this section we demonstrate the GNAT features for interfacing with
C++ by means of an example making use of Ada 2005 abstract interface
types. This example consists of a classification of animals; classes
have been used to model our main classification of animals, and
interfaces provide support for the management of secondary
classifications. We first demonstrate a case in which the types and
constructors are defined on the C++ side and imported from the Ada
side, and latter the reverse case.
<p>The root of our derivation will be the <code>Animal</code> class, with a
single private attribute (the <code>Age</code> of the animal) and two public
primitives to set and get the value of this attribute.
<pre class="smallexample"> <b>class</b> Animal {
<b>public</b>:
<b>virtual</b> void Set_Age (int New_Age);
<b>virtual</b> int Age ();
<b>private</b>:
int Age_Count;
};
</pre>
<p>Abstract interface types are defined in C++ by means of classes with pure
virtual functions and no data members. In our example we will use two
interfaces that provide support for the common management of <code>Carnivore</code>
and <code>Domestic</code> animals:
<pre class="smallexample"> <b>class</b> Carnivore {
<b>public</b>:
<b>virtual</b> int Number_Of_Teeth () = 0;
};
<b>class</b> Domestic {
<b>public</b>:
<b>virtual void</b> Set_Owner (char* Name) = 0;
};
</pre>
<p>Using these declarations, we can now say that a <code>Dog</code> is an animal that is
both Carnivore and Domestic, that is:
<pre class="smallexample"> <b>class</b> Dog : Animal, Carnivore, Domestic {
<b>public</b>:
<b>virtual</b> int Number_Of_Teeth ();
<b>virtual</b> void Set_Owner (char* Name);
Dog(); // Constructor
<b>private</b>:
int Tooth_Count;
char *Owner;
};
</pre>
<p>In the following examples we will assume that the previous declarations are
located in a file named <code>animals.h</code>. The following package demonstrates
how to import these C++ declarations from the Ada side:
<pre class="smallexample"> with Interfaces.C.Strings; use Interfaces.C.Strings;
package Animals is
type Carnivore is interface;
pragma Convention (C_Plus_Plus, Carnivore);
function Number_Of_Teeth (X : Carnivore)
return Natural is abstract;
type Domestic is interface;
pragma Convention (C_Plus_Plus, Set_Owner);
procedure Set_Owner
(X : in out Domestic;
Name : Chars_Ptr) is abstract;
type Animal is tagged record
Age : Natural := 0;
end record;
pragma Import (C_Plus_Plus, Animal);
procedure Set_Age (X : in out Animal; Age : Integer);
pragma Import (C_Plus_Plus, Set_Age);
function Age (X : Animal) return Integer;
pragma Import (C_Plus_Plus, Age);
type Dog is new Animal and Carnivore and Domestic with record
Tooth_Count : Natural;
Owner : String (1 .. 30);
end record;
pragma Import (C_Plus_Plus, Dog);
function Number_Of_Teeth (A : Dog) return Integer;
pragma Import (C_Plus_Plus, Number_Of_Teeth);
procedure Set_Owner (A : in out Dog; Name : Chars_Ptr);
pragma Import (C_Plus_Plus, Set_Owner);
function New_Dog return Dog;
pragma CPP_Constructor (New_Dog);
pragma Import (CPP, New_Dog, "_ZN3DogC2Ev");
end Animals;
</pre>
<p>Thanks to the compatibility between GNAT run-time structures and the C++ ABI,
interfacing with these C++ classes is easy. The only requirement is that all
the primitives and components must be declared exactly in the same order in
the two languages.
<p>Regarding the abstract interfaces, we must indicate to the GNAT compiler by
means of a <code>pragma Convention (C_Plus_Plus)</code>, the convention used to pass
the arguments to the called primitives will be the same as for C++. For the
imported classes we use <code>pragma Import</code> with convention <code>C_Plus_Plus</code>
to indicate that they have been defined on the C++ side; this is required
because the dispatch table associated with these tagged types will be built
in the C++ side and therefore will not contain the predefined Ada primitives
which Ada would otherwise expect.
<p>As the reader can see there is no need to indicate the C++ mangled names
associated with each subprogram because it is assumed that all the calls to
these primitives will be dispatching calls. The only exception is the
constructor, which must be registered with the compiler by means of
<code>pragma CPP_Constructor</code> and needs to provide its associated C++
mangled name because the Ada compiler generates direct calls to it.
<p>With the above packages we can now declare objects of type Dog on the Ada side
and dispatch calls to the corresponding subprograms on the C++ side. We can
also extend the tagged type Dog with further fields and primitives, and
override some of its C++ primitives on the Ada side. For example, here we have
a type derivation defined on the Ada side that inherits all the dispatching
primitives of the ancestor from the C++ side.
<pre class="smallexample"> <b>with</b> Animals; <b>use</b> Animals;
<b>package</b> Vaccinated_Animals <b>is</b>
<b>type</b> Vaccinated_Dog <b>is new</b> Dog <b>with null record</b>;
<b>function</b> Vaccination_Expired (A : Vaccinated_Dog) <b>return</b> Boolean;
<b>end</b> Vaccinated_Animals;
</pre>
<p>It is important to note that, because of the ABI compatibility, the programmer
does not need to add any further information to indicate either the object
layout or the dispatch table entry associated with each dispatching operation.
<p>Now let us define all the types and constructors on the Ada side and export
them to C++, using the same hierarchy of our previous example:
<pre class="smallexample"> with Interfaces.C.Strings;
use Interfaces.C.Strings;
package Animals is
type Carnivore is interface;
pragma Convention (C_Plus_Plus, Carnivore);
function Number_Of_Teeth (X : Carnivore)
return Natural is abstract;
type Domestic is interface;
pragma Convention (C_Plus_Plus, Set_Owner);
procedure Set_Owner
(X : in out Domestic;
Name : Chars_Ptr) is abstract;
type Animal is tagged record
Age : Natural := 0;
end record;
pragma Convention (C_Plus_Plus, Animal);
procedure Set_Age (X : in out Animal; Age : Integer);
pragma Export (C_Plus_Plus, Set_Age);
function Age (X : Animal) return Integer;
pragma Export (C_Plus_Plus, Age);
type Dog is new Animal and Carnivore and Domestic with record
Tooth_Count : Natural;
Owner : String (1 .. 30);
end record;
pragma Convention (C_Plus_Plus, Dog);
function Number_Of_Teeth (A : Dog) return Integer;
pragma Export (C_Plus_Plus, Number_Of_Teeth);
procedure Set_Owner (A : in out Dog; Name : Chars_Ptr);
pragma Export (C_Plus_Plus, Set_Owner);
function New_Dog return Dog'Class;
pragma Export (C_Plus_Plus, New_Dog);
end Animals;
</pre>
<p>Compared with our previous example the only difference is the use of
<code>pragma Export</code> to indicate to the GNAT compiler that the primitives will
be available to C++. Thanks to the ABI compatibility, on the C++ side there is
nothing else to be done; as explained above, the only requirement is that all
the primitives and components are declared in exactly the same order.
<p>For completeness, let us see a brief C++ main program that uses the
declarations available in <code>animals.h</code> (presented in our first example) to
import and use the declarations from the Ada side, properly initializing and
finalizing the Ada run-time system along the way:
<pre class="smallexample"> <b>#include</b> "animals.h"
<b>#include</b> <iostream>
<b>using namespace</b> std;
void Check_Carnivore (Carnivore *obj) {...}
void Check_Domestic (Domestic *obj) {...}
void Check_Animal (Animal *obj) {...}
void Check_Dog (Dog *obj) {...}
<b>extern</b> "C" {
void adainit (void);
void adafinal (void);
Dog* new_dog ();
}
void test ()
{
Dog *obj = new_dog(); // Ada constructor
Check_Carnivore (obj); // Check secondary DT
Check_Domestic (obj); // Check secondary DT
Check_Animal (obj); // Check primary DT
Check_Dog (obj); // Check primary DT
}
int main ()
{
adainit (); test(); adafinal ();
return 0;
}
</pre>
<div class="node">
<a name="Comparison-between-GNAT-and-C%2fC++-Compilation-Models"></a>
<a name="Comparison-between-GNAT-and-C_002fC_002b_002b-Compilation-Models"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Comparison-between-GNAT-and-Conventional-Ada-Library-Models">Comparison between GNAT and Conventional Ada Library Models</a>,
Previous: <a rel="previous" accesskey="p" href="#Building-Mixed-Ada-_0026-C_002b_002b-Programs">Building Mixed Ada & C++ Programs</a>,
Up: <a rel="up" accesskey="u" href="#The-GNAT-Compilation-Model">The GNAT Compilation Model</a>
</div>
<h3 class="section">2.12 Comparison between GNAT and C/C++ Compilation Models</h3>
<p class="noindent">The GNAT model of compilation is close to the C and C++ models. You can
think of Ada specs as corresponding to header files in C. As in C, you
don't need to compile specs; they are compiled when they are used. The
Ada <code>with</code> is similar in effect to the <code>#include</code> of a C
header.
<p>One notable difference is that, in Ada, you may compile specs separately
to check them for semantic and syntactic accuracy. This is not always
possible with C headers because they are fragments of programs that have
less specific syntactic or semantic rules.
<p>The other major difference is the requirement for running the binder,
which performs two important functions. First, it checks for
consistency. In C or C++, the only defense against assembling
inconsistent programs lies outside the compiler, in a makefile, for
example. The binder satisfies the Ada requirement that it be impossible
to construct an inconsistent program when the compiler is used in normal
mode.
<p><a name="index-Elaboration-order-control-87"></a>The other important function of the binder is to deal with elaboration
issues. There are also elaboration issues in C++ that are handled
automatically. This automatic handling has the advantage of being
simpler to use, but the C++ programmer has no control over elaboration.
Where <code>gnatbind</code> might complain there was no valid order of
elaboration, a C++ compiler would simply construct a program that
malfunctioned at run time.
<div class="node">
<a name="Comparison-between-GNAT-and-Conventional-Ada-Library-Models"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Comparison-between-GNAT-and-C_002fC_002b_002b-Compilation-Models">Comparison between GNAT and C/C++ Compilation Models</a>,
Up: <a rel="up" accesskey="u" href="#The-GNAT-Compilation-Model">The GNAT Compilation Model</a>
</div>
<h3 class="section">2.13 Comparison between GNAT and Conventional Ada Library Models</h3>
<p class="noindent">This section is intended for Ada programmers who have
used an Ada compiler implementing the traditional Ada library
model, as described in the Ada Reference Manual.
<p><a name="index-GNAT-library-88"></a>In GNAT, there is no “library” in the normal sense. Instead, the set of
source files themselves acts as the library. Compiling Ada programs does
not generate any centralized information, but rather an object file and
a ALI file, which are of interest only to the binder and linker.
In a traditional system, the compiler reads information not only from
the source file being compiled, but also from the centralized library.
This means that the effect of a compilation depends on what has been
previously compiled. In particular:
<ul>
<li>When a unit is <code>with</code>'ed, the unit seen by the compiler corresponds
to the version of the unit most recently compiled into the library.
<li>Inlining is effective only if the necessary body has already been
compiled into the library.
<li>Compiling a unit may obsolete other units in the library.
</ul>
<p class="noindent">In GNAT, compiling one unit never affects the compilation of any other
units because the compiler reads only source files. Only changes to source
files can affect the results of a compilation. In particular:
<ul>
<li>When a unit is <code>with</code>'ed, the unit seen by the compiler corresponds
to the source version of the unit that is currently accessible to the
compiler.
<li><a name="index-Inlining-89"></a>Inlining requires the appropriate source files for the package or
subprogram bodies to be available to the compiler. Inlining is always
effective, independent of the order in which units are complied.
<li>Compiling a unit never affects any other compilations. The editing of
sources may cause previous compilations to be out of date if they
depended on the source file being modified.
</ul>
<p class="noindent">The most important result of these differences is that order of compilation
is never significant in GNAT. There is no situation in which one is
required to do one compilation before another. What shows up as order of
compilation requirements in the traditional Ada library becomes, in
GNAT, simple source dependencies; in other words, there is only a set
of rules saying what source files must be present when a file is
compiled.
<!-- ************************* -->
<div class="node">
<a name="Compiling-Using-gcc"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Binding-Using-gnatbind">Binding Using gnatbind</a>,
Previous: <a rel="previous" accesskey="p" href="#The-GNAT-Compilation-Model">The GNAT Compilation Model</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">3 Compiling Using <samp><span class="command">gcc</span></samp></h2>
<p class="noindent">This chapter discusses how to compile Ada programs using the <samp><span class="command">gcc</span></samp>
command. It also describes the set of switches
that can be used to control the behavior of the compiler.
<ul class="menu">
<li><a accesskey="1" href="#Compiling-Programs">Compiling Programs</a>
<li><a accesskey="2" href="#Switches-for-gcc">Switches for gcc</a>
<li><a accesskey="3" href="#Search-Paths-and-the-Run_002dTime-Library-_0028RTL_0029">Search Paths and the Run-Time Library (RTL)</a>
<li><a accesskey="4" href="#Order-of-Compilation-Issues">Order of Compilation Issues</a>
<li><a accesskey="5" href="#Examples">Examples</a>
</ul>
<div class="node">
<a name="Compiling-Programs"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Switches-for-gcc">Switches for gcc</a>,
Up: <a rel="up" accesskey="u" href="#Compiling-Using-gcc">Compiling Using gcc</a>
</div>
<h3 class="section">3.1 Compiling Programs</h3>
<p class="noindent">The first step in creating an executable program is to compile the units
of the program using the <samp><span class="command">gcc</span></samp> command. You must compile the
following files:
<ul>
<li>the body file (<samp><span class="file">.adb</span></samp>) for a library level subprogram or generic
subprogram
<li>the spec file (<samp><span class="file">.ads</span></samp>) for a library level package or generic
package that has no body
<li>the body file (<samp><span class="file">.adb</span></samp>) for a library level package
or generic package that has a body
</ul>
<p class="noindent">You need <em>not</em> compile the following files
<ul>
<li>the spec of a library unit which has a body
<li>subunits
</ul>
<p class="noindent">because they are compiled as part of compiling related units. GNAT
package specs
when the corresponding body is compiled, and subunits when the parent is
compiled.
<p><a name="index-cannot-generate-code-90"></a>If you attempt to compile any of these files, you will get one of the
following error messages (where <var>fff</var> is the name of the file you
compiled):
<pre class="smallexample"> cannot generate code for file <var>fff</var> (package spec)
to check package spec, use -gnatc
cannot generate code for file <var>fff</var> (missing subunits)
to check parent unit, use -gnatc
cannot generate code for file <var>fff</var> (subprogram spec)
to check subprogram spec, use -gnatc
cannot generate code for file <var>fff</var> (subunit)
to check subunit, use -gnatc
</pre>
<p class="noindent">As indicated by the above error messages, if you want to submit
one of these files to the compiler to check for correct semantics
without generating code, then use the <samp><span class="option">-gnatc</span></samp> switch.
<p>The basic command for compiling a file containing an Ada unit is
<pre class="smallexample"> <!-- $ gcc -c @ovar{switches} @file{file name} -->
<!-- Expanding @ovar macro inline (explanation in macro def comments) -->
$ gcc -c <span class="roman">[</span><var>switches</var><span class="roman">]</span> <samp><span class="file">file name</span></samp>
</pre>
<p class="noindent">where <var>file name</var> is the name of the Ada file (usually
having an extension
<samp><span class="file">.ads</span></samp> for a spec or <samp><span class="file">.adb</span></samp> for a body).
You specify the
<samp><span class="option">-c</span></samp> switch to tell <samp><span class="command">gcc</span></samp> to compile, but not link, the file.
The result of a successful compilation is an object file, which has the
same name as the source file but an extension of <samp><span class="file">.o</span></samp> and an Ada
Library Information (ALI) file, which also has the same name as the
source file, but with <samp><span class="file">.ali</span></samp> as the extension. GNAT creates these
two output files in the current directory, but you may specify a source
file in any directory using an absolute or relative path specification
containing the directory information.
<p><a name="index-gnat1-91"></a><samp><span class="command">gcc</span></samp> is actually a driver program that looks at the extensions of
the file arguments and loads the appropriate compiler. For example, the
GNU C compiler is <samp><span class="file">cc1</span></samp>, and the Ada compiler is <samp><span class="file">gnat1</span></samp>.
These programs are in directories known to the driver program (in some
configurations via environment variables you set), but need not be in
your path. The <samp><span class="command">gcc</span></samp> driver also calls the assembler and any other
utilities needed to complete the generation of the required object
files.
<p>It is possible to supply several file names on the same <samp><span class="command">gcc</span></samp>
command. This causes <samp><span class="command">gcc</span></samp> to call the appropriate compiler for
each file. For example, the following command lists three separate
files to be compiled:
<pre class="smallexample"> $ gcc -c x.adb y.adb z.c
</pre>
<p class="noindent">calls <code>gnat1</code> (the Ada compiler) twice to compile <samp><span class="file">x.adb</span></samp> and
<samp><span class="file">y.adb</span></samp>, and <code>cc1</code> (the C compiler) once to compile <samp><span class="file">z.c</span></samp>.
The compiler generates three object files <samp><span class="file">x.o</span></samp>, <samp><span class="file">y.o</span></samp> and
<samp><span class="file">z.o</span></samp> and the two ALI files <samp><span class="file">x.ali</span></samp> and <samp><span class="file">y.ali</span></samp> from the
Ada compilations. Any switches apply to all the files listed,
except for
<samp><span class="option">-gnat</span><var>x</var></samp> switches, which apply only to Ada compilations.
<div class="node">
<a name="Switches-for-gcc"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Search-Paths-and-the-Run_002dTime-Library-_0028RTL_0029">Search Paths and the Run-Time Library (RTL)</a>,
Previous: <a rel="previous" accesskey="p" href="#Compiling-Programs">Compiling Programs</a>,
Up: <a rel="up" accesskey="u" href="#Compiling-Using-gcc">Compiling Using gcc</a>
</div>
<h3 class="section">3.2 Switches for <samp><span class="command">gcc</span></samp></h3>
<p class="noindent">The <samp><span class="command">gcc</span></samp> command accepts switches that control the
compilation process. These switches are fully described in this section.
First we briefly list all the switches, in alphabetical order, then we
describe the switches in more detail in functionally grouped sections.
<p>More switches exist for GCC than those documented here, especially
for specific targets. However, their use is not recommended as
they may change code generation in ways that are incompatible with
the Ada run-time library, or can cause inconsistencies between
compilation units.
<ul class="menu">
<li><a accesskey="1" href="#Output-and-Error-Message-Control">Output and Error Message Control</a>
<li><a accesskey="2" href="#Warning-Message-Control">Warning Message Control</a>
<li><a accesskey="3" href="#Debugging-and-Assertion-Control">Debugging and Assertion Control</a>
<li><a accesskey="4" href="#Validity-Checking">Validity Checking</a>
<li><a accesskey="5" href="#Style-Checking">Style Checking</a>
<li><a accesskey="6" href="#Run_002dTime-Checks">Run-Time Checks</a>
<li><a accesskey="7" href="#Using-gcc-for-Syntax-Checking">Using gcc for Syntax Checking</a>
<li><a accesskey="8" href="#Using-gcc-for-Semantic-Checking">Using gcc for Semantic Checking</a>
<li><a accesskey="9" href="#Compiling-Different-Versions-of-Ada">Compiling Different Versions of Ada</a>
<li><a href="#Character-Set-Control">Character Set Control</a>
<li><a href="#File-Naming-Control">File Naming Control</a>
<li><a href="#Subprogram-Inlining-Control">Subprogram Inlining Control</a>
<li><a href="#Auxiliary-Output-Control">Auxiliary Output Control</a>
<li><a href="#Debugging-Control">Debugging Control</a>
<li><a href="#Exception-Handling-Control">Exception Handling Control</a>
<li><a href="#Units-to-Sources-Mapping-Files">Units to Sources Mapping Files</a>
<li><a href="#Integrated-Preprocessing">Integrated Preprocessing</a>
<li><a href="#Code-Generation-Control">Code Generation Control</a>
</ul>
<dl>
<!-- !sort! -->
<a name="index-g_t_0040option_007b_002db_007d-_0028_0040command_007bgcc_007d_0029-92"></a><dt><samp><span class="option">-b </span><var>target</var></samp><dd>Compile your program to run on <var>target</var>, which is the name of a
system configuration. You must have a GNAT cross-compiler built if
<var>target</var> is not the same as your host system.
<br><dt><samp><span class="option">-B</span><var>dir</var></samp><dd><a name="index-g_t_0040option_007b_002dB_007d-_0028_0040command_007bgcc_007d_0029-93"></a>Load compiler executables (for example, <code>gnat1</code>, the Ada compiler)
from <var>dir</var> instead of the default location. Only use this switch
when multiple versions of the GNAT compiler are available.
See <a href="gcc.html#Directory-Options">Options for Directory Search</a>, for further details. You would normally
use the <samp><span class="option">-b</span></samp> or <samp><span class="option">-V</span></samp> switch instead.
<br><dt><samp><span class="option">-c</span></samp><dd><a name="index-g_t_0040option_007b_002dc_007d-_0028_0040command_007bgcc_007d_0029-94"></a>Compile. Always use this switch when compiling Ada programs.
<p>Note: for some other languages when using <samp><span class="command">gcc</span></samp>, notably in
the case of C and C++, it is possible to use
use <samp><span class="command">gcc</span></samp> without a <samp><span class="option">-c</span></samp> switch to
compile and link in one step. In the case of GNAT, you
cannot use this approach, because the binder must be run
and <samp><span class="command">gcc</span></samp> cannot be used to run the GNAT binder.
<br><dt><samp><span class="option">-fno-inline</span></samp><dd><a name="index-g_t_0040option_007b_002dfno_002dinline_007d-_0028_0040command_007bgcc_007d_0029-95"></a>Suppresses all back-end inlining, even if other optimization or inlining
switches are set.
This includes suppression of inlining that results
from the use of the pragma <code>Inline_Always</code>.
Any occurrences of pragma <code>Inline</code> or <code>Inline_Always</code>
are ignored, and <samp><span class="option">-gnatn</span></samp> and <samp><span class="option">-gnatN</span></samp> have no
effect if this switch is present.
<br><dt><samp><span class="option">-fno-inline-functions</span></samp><dd><a name="index-g_t_0040option_007b_002dfno_002dinline_002dfunctions_007d-_0028_0040command_007bgcc_007d_0029-96"></a>Suppresses automatic inlining of subprograms, which is enabled
if <samp><span class="option">-O3</span></samp> is used.
<br><dt><samp><span class="option">-fno-inline-small-functions</span></samp><dd><a name="index-g_t_0040option_007b_002dfno_002dinline_002dsmall_002dfunctions_007d-_0028_0040command_007bgcc_007d_0029-97"></a>Suppresses automatic inlining of small subprograms, which is enabled
if <samp><span class="option">-O2</span></samp> is used.
<br><dt><samp><span class="option">-fno-inline-functions-called-once</span></samp><dd><a name="index-g_t_0040option_007b_002dfno_002dinline_002dfunctions_002dcalled_002donce_007d-_0028_0040command_007bgcc_007d_0029-98"></a>Suppresses inlining of subprograms local to the unit and called once
from within it, which is enabled if <samp><span class="option">-O1</span></samp> is used.
<br><dt><samp><span class="option">-fno-ivopts</span></samp><dd><a name="index-g_t_0040option_007b_002dfno_002divopts_007d-_0028_0040command_007bgcc_007d_0029-99"></a>Suppresses high-level loop induction variable optimizations, which are
enabled if <samp><span class="option">-O1</span></samp> is used. These optimizations are generally
profitable but, for some specific cases of loops with numerous uses
of the iteration variable that follow a common pattern, they may end
up destroying the regularity that could be exploited at a lower level
and thus producing inferior code.
<br><dt><samp><span class="option">-fno-strict-aliasing</span></samp><dd><a name="index-g_t_0040option_007b_002dfno_002dstrict_002daliasing_007d-_0028_0040command_007bgcc_007d_0029-100"></a>Causes the compiler to avoid assumptions regarding non-aliasing
of objects of different types. See
<a href="#Optimization-and-Strict-Aliasing">Optimization and Strict Aliasing</a> for details.
<br><dt><samp><span class="option">-fstack-check</span></samp><dd><a name="index-g_t_0040option_007b_002dfstack_002dcheck_007d-_0028_0040command_007bgcc_007d_0029-101"></a>Activates stack checking.
See <a href="#Stack-Overflow-Checking">Stack Overflow Checking</a> for details.
<br><dt><samp><span class="option">-fstack-usage</span></samp><dd><a name="index-g_t_0040option_007b_002dfstack_002dusage_007d-_0028_0040command_007bgcc_007d_0029-102"></a>Makes the compiler output stack usage information for the program, on a
per-function basis. See <a href="#Static-Stack-Usage-Analysis">Static Stack Usage Analysis</a> for details.
<br><dt><samp><span class="option">-fcallgraph-info[=su]</span></samp><dd><a name="index-g_t_0040option_007b_002dfcallgraph_002dinfo_007d-_0028_0040command_007bgcc_007d_0029-103"></a>Makes the compiler output callgraph information for the program, on a
per-file basis. The information is generated in the VCG format. It can
be decorated with stack-usage per-node information.
<br><dt><samp><span class="option">-g</span></samp><dd><a name="index-g_t_0040option_007b_002dg_007d-_0028_0040command_007bgcc_007d_0029-104"></a>Generate debugging information. This information is stored in the object
file and copied from there to the final executable file by the linker,
where it can be read by the debugger. You must use the
<samp><span class="option">-g</span></samp> switch if you plan on using the debugger.
<br><dt><samp><span class="option">-gnat83</span></samp><dd><a name="index-g_t_0040option_007b_002dgnat83_007d-_0028_0040command_007bgcc_007d_0029-105"></a>Enforce Ada 83 restrictions.
<br><dt><samp><span class="option">-gnat95</span></samp><dd><a name="index-g_t_0040option_007b_002dgnat95_007d-_0028_0040command_007bgcc_007d_0029-106"></a>Enforce Ada 95 restrictions.
<br><dt><samp><span class="option">-gnat05</span></samp><dd><a name="index-g_t_0040option_007b_002dgnat05_007d-_0028_0040command_007bgcc_007d_0029-107"></a>Allow full Ada 2005 features.
<br><dt><samp><span class="option">-gnat2005</span></samp><dd><a name="index-g_t_0040option_007b_002dgnat2005_007d-_0028_0040command_007bgcc_007d_0029-108"></a>Allow full Ada 2005 features (same as <samp><span class="option">-gnat05</span></samp>)
<br><dt><samp><span class="option">-gnat12</span></samp><dd><a name="index-g_t_0040option_007b_002dgnat12_007d-_0028_0040command_007bgcc_007d_0029-109"></a>
<br><dt><samp><span class="option">-gnat2012</span></samp><dd><a name="index-g_t_0040option_007b_002dgnat2012_007d-_0028_0040command_007bgcc_007d_0029-110"></a>Allow full Ada 2012 features (same as <samp><span class="option">-gnat12</span></samp>)
<br><dt><samp><span class="option">-gnata</span></samp><dd><a name="index-g_t_0040option_007b_002dgnata_007d-_0028_0040command_007bgcc_007d_0029-111"></a>Assertions enabled. <code>Pragma Assert</code> and <code>pragma Debug</code> to be
activated. Note that these pragmas can also be controlled using the
configuration pragmas <code>Assertion_Policy</code> and <code>Debug_Policy</code>.
It also activates pragmas <code>Check</code>, <code>Precondition</code>, and
<code>Postcondition</code>. Note that these pragmas can also be controlled
using the configuration pragma <code>Check_Policy</code>.
<br><dt><samp><span class="option">-gnatA</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatA_007d-_0028_0040command_007bgcc_007d_0029-112"></a>Avoid processing <samp><span class="file">gnat.adc</span></samp>. If a <samp><span class="file">gnat.adc</span></samp> file is present,
it will be ignored.
<br><dt><samp><span class="option">-gnatb</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatb_007d-_0028_0040command_007bgcc_007d_0029-113"></a>Generate brief messages to <samp><span class="file">stderr</span></samp> even if verbose mode set.
<br><dt><samp><span class="option">-gnatB</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatB_007d-_0028_0040command_007bgcc_007d_0029-114"></a>Assume no invalid (bad) values except for 'Valid attribute use
(see <a href="#Validity-Checking">Validity Checking</a>).
<br><dt><samp><span class="option">-gnatc</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatc_007d-_0028_0040command_007bgcc_007d_0029-115"></a>Check syntax and semantics only (no code generation attempted).
<br><dt><samp><span class="option">-gnatC</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatC_007d-_0028_0040command_007bgcc_007d_0029-116"></a>Generate CodePeer information (no code generation attempted).
This switch will generate an intermediate representation suitable for
use by CodePeer (<samp><span class="file">.scil</span></samp> files). This switch is not compatible with
code generation (it will, among other things, disable some switches such
as -gnatn, and enable others such as -gnata).
<br><dt><samp><span class="option">-gnatd</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatd_007d-_0028_0040command_007bgcc_007d_0029-117"></a>Specify debug options for the compiler. The string of characters after
the <samp><span class="option">-gnatd</span></samp> specify the specific debug options. The possible
characters are 0-9, a-z, A-Z, optionally preceded by a dot. See
compiler source file <samp><span class="file">debug.adb</span></samp> for details of the implemented
debug options. Certain debug options are relevant to applications
programmers, and these are documented at appropriate points in this
users guide.
<br><dt><samp><span class="option">-gnatD</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatD_005bnn_005d_007d-_0028_0040command_007bgcc_007d_0029-118"></a>Create expanded source files for source level debugging. This switch
also suppress generation of cross-reference information
(see <samp><span class="option">-gnatx</span></samp>).
<br><dt><samp><span class="option">-gnatec=</span><var>path</var></samp><dd><a name="index-g_t_0040option_007b_002dgnatec_007d-_0028_0040command_007bgcc_007d_0029-119"></a>Specify a configuration pragma file
(the equal sign is optional)
(see <a href="#The-Configuration-Pragmas-Files">The Configuration Pragmas Files</a>).
<br><dt><samp><span class="option">-gnateDsymbol[=</span><var>value</var><span class="option">]</span></samp><dd><a name="index-g_t_0040option_007b_002dgnateD_007d-_0028_0040command_007bgcc_007d_0029-120"></a>Defines a symbol, associated with <var>value</var>, for preprocessing.
(see <a href="#Integrated-Preprocessing">Integrated Preprocessing</a>).
<br><dt><samp><span class="option">-gnateE</span></samp><dd><a name="index-g_t_0040option_007b_002dgnateE_007d-_0028_0040command_007bgcc_007d_0029-121"></a>Generate extra information in exception messages, in particular display
extra column information and the value and range associated with index and
range check failures, and extra column information for access checks.
<br><dt><samp><span class="option">-gnatef</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatef_007d-_0028_0040command_007bgcc_007d_0029-122"></a>Display full source path name in brief error messages.
<br><dt><samp><span class="option">-gnateG</span></samp><dd><a name="index-g_t_0040option_007b_002dgnateG_007d-_0028_0040command_007bgcc_007d_0029-123"></a>Save result of preprocessing in a text file.
<br><dt><samp><span class="option">-gnatem=</span><var>path</var></samp><dd><a name="index-g_t_0040option_007b_002dgnatem_007d-_0028_0040command_007bgcc_007d_0029-124"></a>Specify a mapping file
(the equal sign is optional)
(see <a href="#Units-to-Sources-Mapping-Files">Units to Sources Mapping Files</a>).
<br><dt><samp><span class="option">-gnatep=</span><var>file</var></samp><dd><a name="index-g_t_0040option_007b_002dgnatep_007d-_0028_0040command_007bgcc_007d_0029-125"></a>Specify a preprocessing data file
(the equal sign is optional)
(see <a href="#Integrated-Preprocessing">Integrated Preprocessing</a>).
<br><dt><samp><span class="option">-gnateP</span></samp><dd><a name="index-g_t_0040option_007b_002dgnateP_007d-_0028_0040command_007bgcc_007d_0029-126"></a>Turn categorization dependency errors into warnings.
Ada requires that units that WITH one another have compatible categories, for
example a Pure unit cannto WITH a Preelaborate unit. If this switch is used,
these errors become warnings (which can be ignored, or suppressed in the usual
manner). This can be useful in some specialized circumstances such as the
temporary use of special test software.
<br><dt><samp><span class="option">-gnateS</span></samp><dd><a name="index-g_t_0040option_007b_002dgnateS_007d-_0028_0040command_007bgcc_007d_0029-127"></a>Generate SCO (Source Coverage Obligation) information in the ALI
file. This information is used by advanced coverage tools. See
unit <samp><span class="file">SCOs</span></samp> in the compiler sources for details in files
<samp><span class="file">scos.ads</span></samp> and <samp><span class="file">scos.adb</span></samp>.
<br><dt><samp><span class="option">-gnatE</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatE_007d-_0028_0040command_007bgcc_007d_0029-128"></a>Full dynamic elaboration checks.
<br><dt><samp><span class="option">-gnatf</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatf_007d-_0028_0040command_007bgcc_007d_0029-129"></a>Full errors. Multiple errors per line, all undefined references, do not
attempt to suppress cascaded errors.
<br><dt><samp><span class="option">-gnatF</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatF_007d-_0028_0040command_007bgcc_007d_0029-130"></a>Externals names are folded to all uppercase.
<br><dt><samp><span class="option">-gnatg</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatg_007d-_0028_0040command_007bgcc_007d_0029-131"></a>Internal GNAT implementation mode. This should not be used for
applications programs, it is intended only for use by the compiler
and its run-time library. For documentation, see the GNAT sources.
Note that <samp><span class="option">-gnatg</span></samp> implies
<samp><span class="option">-gnatwae</span></samp> and
<samp><span class="option">-gnatyg</span></samp>
so that all standard warnings and all standard style options are turned on.
All warnings and style messages are treated as errors.
<br><dt><samp><span class="option">-gnatG=nn</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatG_005bnn_005d_007d-_0028_0040command_007bgcc_007d_0029-132"></a>List generated expanded code in source form.
<br><dt><samp><span class="option">-gnath</span></samp><dd><a name="index-g_t_0040option_007b_002dgnath_007d-_0028_0040command_007bgcc_007d_0029-133"></a>Output usage information. The output is written to <samp><span class="file">stdout</span></samp>.
<br><dt><samp><span class="option">-gnati</span><var>c</var></samp><dd><a name="index-g_t_0040option_007b_002dgnati_007d-_0028_0040command_007bgcc_007d_0029-134"></a>Identifier character set
(<var>c</var>=1/2/3/4/8/9/p/f/n/w).
For details of the possible selections for <var>c</var>,
see <a href="#Character-Set-Control">Character Set Control</a>.
<br><dt><samp><span class="option">-gnatI</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatI_007d-_0028_0040command_007bgcc_007d_0029-135"></a>Ignore representation clauses. When this switch is used,
representation clauses are treated as comments. This is useful
when initially porting code where you want to ignore rep clause
problems, and also for compiling foreign code (particularly
for use with ASIS). The representation clauses that are ignored
are: enumeration_representation_clause, record_representation_clause,
and attribute_definition_clause for the following attributes:
Address, Alignment, Bit_Order, Component_Size, Machine_Radix,
Object_Size, Size, Small, Stream_Size, and Value_Size.
Note that this option should be used only for compiling – the
code is likely to malfunction at run time.
<br><dt><samp><span class="option">-gnatjnn</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatjnn_007d-_0028_0040command_007bgcc_007d_0029-136"></a>Reformat error messages to fit on nn character lines
<br><dt><samp><span class="option">-gnatk=</span><var>n</var></samp><dd><a name="index-g_t_0040option_007b_002dgnatk_007d-_0028_0040command_007bgcc_007d_0029-137"></a>Limit file names to <var>n</var> (1-999) characters (<code>k</code> = krunch).
<br><dt><samp><span class="option">-gnatl</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatl_007d-_0028_0040command_007bgcc_007d_0029-138"></a>Output full source listing with embedded error messages.
<br><dt><samp><span class="option">-gnatL</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatL_007d-_0028_0040command_007bgcc_007d_0029-139"></a>Used in conjunction with -gnatG or -gnatD to intersperse original
source lines (as comment lines with line numbers) in the expanded
source output.
<br><dt><samp><span class="option">-gnatm=</span><var>n</var></samp><dd><a name="index-g_t_0040option_007b_002dgnatm_007d-_0028_0040command_007bgcc_007d_0029-140"></a>Limit number of detected error or warning messages to <var>n</var>
where <var>n</var> is in the range 1..999999. The default setting if
no switch is given is 9999. If the number of warnings reaches this
limit, then a message is output and further warnings are suppressed,
but the compilation is continued. If the number of error messages
reaches this limit, then a message is output and the compilation
is abandoned. The equal sign here is optional. A value of zero
means that no limit applies.
<br><dt><samp><span class="option">-gnatn</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatn_007d-_0028_0040command_007bgcc_007d_0029-141"></a>Activate inlining for subprograms for which
pragma <code>Inline</code> is specified. This inlining is performed
by the GCC back-end.
<br><dt><samp><span class="option">-gnatN</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatN_007d-_0028_0040command_007bgcc_007d_0029-142"></a>Activate front end inlining for subprograms for which
pragma <code>Inline</code> is specified. This inlining is performed
by the front end and will be visible in the
<samp><span class="option">-gnatG</span></samp> output.
<p>When using a gcc-based back end (in practice this means using any version
of GNAT other than the JGNAT, .NET or GNAAMP versions), then the use of
<samp><span class="option">-gnatN</span></samp> is deprecated, and the use of <samp><span class="option">-gnatn</span></samp> is preferred.
Historically front end inlining was more extensive than the gcc back end
inlining, but that is no longer the case.
<br><dt><samp><span class="option">-gnato</span></samp><dd><a name="index-g_t_0040option_007b_002dgnato_007d-_0028_0040command_007bgcc_007d_0029-143"></a>Enable numeric overflow checking (which is not normally enabled by
default). Note that division by zero is a separate check that is not
controlled by this switch (division by zero checking is on by default).
<br><dt><samp><span class="option">-gnatp</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatp_007d-_0028_0040command_007bgcc_007d_0029-144"></a>Suppress all checks. See <a href="#Run_002dTime-Checks">Run-Time Checks</a> for details. This switch
has no effect if cancelled by a subsequent <samp><span class="option">-gnat-p</span></samp> switch.
<br><dt><samp><span class="option">-gnat-p</span></samp><dd><a name="index-g_t_0040option_007b_002dgnat_002dp_007d-_0028_0040command_007bgcc_007d_0029-145"></a>Cancel effect of previous <samp><span class="option">-gnatp</span></samp> switch.
<br><dt><samp><span class="option">-gnatP</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatP_007d-_0028_0040command_007bgcc_007d_0029-146"></a>Enable polling. This is required on some systems (notably Windows NT) to
obtain asynchronous abort and asynchronous transfer of control capability.
See <a href="gnat_rm.html#Pragma-Polling">Pragma Polling</a>, for full
details.
<br><dt><samp><span class="option">-gnatq</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatq_007d-_0028_0040command_007bgcc_007d_0029-147"></a>Don't quit. Try semantics, even if parse errors.
<br><dt><samp><span class="option">-gnatQ</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatQ_007d-_0028_0040command_007bgcc_007d_0029-148"></a>Don't quit. Generate <samp><span class="file">ALI</span></samp> and tree files even if illegalities.
<br><dt><samp><span class="option">-gnatr</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatr_007d-_0028_0040command_007bgcc_007d_0029-149"></a>Treat pragma Restrictions as Restriction_Warnings.
<br><dt><samp><span class="option">-gnatR[0/1/2/3[s]]</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatR_007d-_0028_0040command_007bgcc_007d_0029-150"></a>Output representation information for declared types and objects.
<br><dt><samp><span class="option">-gnats</span></samp><dd><a name="index-g_t_0040option_007b_002dgnats_007d-_0028_0040command_007bgcc_007d_0029-151"></a>Syntax check only.
<br><dt><samp><span class="option">-gnatS</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatS_007d-_0028_0040command_007bgcc_007d_0029-152"></a>Print package Standard.
<br><dt><samp><span class="option">-gnatt</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatt_007d-_0028_0040command_007bgcc_007d_0029-153"></a>Generate tree output file.
<br><dt><samp><span class="option">-gnatT</span><var>nnn</var></samp><dd><a name="index-g_t_0040option_007b_002dgnatT_007d-_0028_0040command_007bgcc_007d_0029-154"></a>All compiler tables start at <var>nnn</var> times usual starting size.
<br><dt><samp><span class="option">-gnatu</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatu_007d-_0028_0040command_007bgcc_007d_0029-155"></a>List units for this compilation.
<br><dt><samp><span class="option">-gnatU</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatU_007d-_0028_0040command_007bgcc_007d_0029-156"></a>Tag all error messages with the unique string “error:”
<br><dt><samp><span class="option">-gnatv</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatv_007d-_0028_0040command_007bgcc_007d_0029-157"></a>Verbose mode. Full error output with source lines to <samp><span class="file">stdout</span></samp>.
<br><dt><samp><span class="option">-gnatV</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatV_007d-_0028_0040command_007bgcc_007d_0029-158"></a>Control level of validity checking (see <a href="#Validity-Checking">Validity Checking</a>).
<br><dt><samp><span class="option">-gnatw</span><var>xxx</var></samp><dd><a name="index-g_t_0040option_007b_002dgnatw_007d-_0028_0040command_007bgcc_007d_0029-159"></a>Warning mode where
<var>xxx</var> is a string of option letters that denotes
the exact warnings that
are enabled or disabled (see <a href="#Warning-Message-Control">Warning Message Control</a>).
<br><dt><samp><span class="option">-gnatW</span><var>e</var></samp><dd><a name="index-g_t_0040option_007b_002dgnatW_007d-_0028_0040command_007bgcc_007d_0029-160"></a>Wide character encoding method
(<var>e</var>=n/h/u/s/e/8).
<br><dt><samp><span class="option">-gnatx</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatx_007d-_0028_0040command_007bgcc_007d_0029-161"></a>Suppress generation of cross-reference information.
<br><dt><samp><span class="option">-gnatX</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatX_007d-_0028_0040command_007bgcc_007d_0029-162"></a>Enable GNAT implementation extensions and latest Ada version.
<br><dt><samp><span class="option">-gnaty</span></samp><dd><a name="index-g_t_0040option_007b_002dgnaty_007d-_0028_0040command_007bgcc_007d_0029-163"></a>Enable built-in style checks (see <a href="#Style-Checking">Style Checking</a>).
<br><dt><samp><span class="option">-gnatz</span><var>m</var></samp><dd><a name="index-g_t_0040option_007b_002dgnatz_007d-_0028_0040command_007bgcc_007d_0029-164"></a>Distribution stub generation and compilation
(<var>m</var>=r/c for receiver/caller stubs).
<br><dt><samp><span class="option">-I</span><var>dir</var></samp><dd><a name="index-g_t_0040option_007b_002dI_007d-_0028_0040command_007bgcc_007d_0029-165"></a><a name="index-RTL-166"></a>Direct GNAT to search the <var>dir</var> directory for source files needed by
the current compilation
(see <a href="#Search-Paths-and-the-Run_002dTime-Library-_0028RTL_0029">Search Paths and the Run-Time Library (RTL)</a>).
<br><dt><samp><span class="option">-I-</span></samp><dd><a name="index-g_t_0040option_007b_002dI_002d_007d-_0028_0040command_007bgcc_007d_0029-167"></a><a name="index-RTL-168"></a>Except for the source file named in the command line, do not look for source
files in the directory containing the source file named in the command line
(see <a href="#Search-Paths-and-the-Run_002dTime-Library-_0028RTL_0029">Search Paths and the Run-Time Library (RTL)</a>).
<br><dt><samp><span class="option">-mbig-switch</span></samp><dd><a name="index-g_t_0040option_007b_002dmbig_002dswitch_007d-_0028_0040command_007bgcc_007d_0029-169"></a><a name="index-g_t_0040code_007bcase_007d-statement-_0028effect-of-_0040option_007b_002dmbig_002dswitch_007d-option_0029-170"></a>This standard gcc switch causes the compiler to use larger offsets in its
jump table representation for <code>case</code> statements.
This may result in less efficient code, but is sometimes necessary
(for example on HP-UX targets)
<a name="index-HP_002dUX-and-_0040option_007b_002dmbig_002dswitch_007d-option-171"></a>in order to compile large and/or nested <code>case</code> statements.
<br><dt><samp><span class="option">-o </span><var>file</var></samp><dd><a name="index-g_t_0040option_007b_002do_007d-_0028_0040command_007bgcc_007d_0029-172"></a>This switch is used in <samp><span class="command">gcc</span></samp> to redirect the generated object file
and its associated ALI file. Beware of this switch with GNAT, because it may
cause the object file and ALI file to have different names which in turn
may confuse the binder and the linker.
<br><dt><samp><span class="option">-nostdinc</span></samp><dd><a name="index-g_t_0040option_007b_002dnostdinc_007d-_0028_0040command_007bgcc_007d_0029-173"></a>Inhibit the search of the default location for the GNAT Run Time
Library (RTL) source files.
<br><dt><samp><span class="option">-nostdlib</span></samp><dd><a name="index-g_t_0040option_007b_002dnostdlib_007d-_0028_0040command_007bgcc_007d_0029-174"></a>Inhibit the search of the default location for the GNAT Run Time
Library (RTL) ALI files.
<!-- @item -O@ovar{n} -->
<!-- Expanding @ovar macro inline (explanation in macro def comments) -->
<br><dt><samp><span class="option">-O[</span><var>n</var><span class="option">]</span></samp><dd><a name="index-g_t_0040option_007b_002dO_007d-_0028_0040command_007bgcc_007d_0029-175"></a><var>n</var> controls the optimization level.
<dl>
<dt>n = 0<dd>No optimization, the default setting if no <samp><span class="option">-O</span></samp> appears
<br><dt>n = 1<dd>Normal optimization, the default if you specify <samp><span class="option">-O</span></samp> without
an operand. A good compromise between code quality and compilation
time.
<br><dt>n = 2<dd>Extensive optimization, may improve execution time, possibly at the cost of
substantially increased compilation time.
<br><dt>n = 3<dd>Same as <samp><span class="option">-O2</span></samp>, and also includes inline expansion for small subprograms
in the same unit.
<br><dt>n = s<dd>Optimize space usage
</dl>
<p class="noindent">See also <a href="#Optimization-Levels">Optimization Levels</a>.
<br><dt><samp><span class="option">-pass-exit-codes</span></samp><dd><a name="index-g_t_0040option_007b_002dpass_002dexit_002dcodes_007d-_0028_0040command_007bgcc_007d_0029-176"></a>Catch exit codes from the compiler and use the most meaningful as
exit status.
<br><dt><samp><span class="option">--RTS=</span><var>rts-path</var></samp><dd><a name="index-g_t_0040option_007b_002d_002dRTS_007d-_0028_0040command_007bgcc_007d_0029-177"></a>Specifies the default location of the runtime library. Same meaning as the
equivalent <samp><span class="command">gnatmake</span></samp> flag (see <a href="#Switches-for-gnatmake">Switches for gnatmake</a>).
<br><dt><samp><span class="option">-S</span></samp><dd><a name="index-g_t_0040option_007b_002dS_007d-_0028_0040command_007bgcc_007d_0029-178"></a>Used in place of <samp><span class="option">-c</span></samp> to
cause the assembler source file to be
generated, using <samp><span class="file">.s</span></samp> as the extension,
instead of the object file.
This may be useful if you need to examine the generated assembly code.
<br><dt><samp><span class="option">-fverbose-asm</span></samp><dd><a name="index-g_t_0040option_007b_002dfverbose_002dasm_007d-_0028_0040command_007bgcc_007d_0029-179"></a>Used in conjunction with <samp><span class="option">-S</span></samp>
to cause the generated assembly code file to be annotated with variable
names, making it significantly easier to follow.
<br><dt><samp><span class="option">-v</span></samp><dd><a name="index-g_t_0040option_007b_002dv_007d-_0028_0040command_007bgcc_007d_0029-180"></a>Show commands generated by the <samp><span class="command">gcc</span></samp> driver. Normally used only for
debugging purposes or if you need to be sure what version of the
compiler you are executing.
<br><dt><samp><span class="option">-V </span><var>ver</var></samp><dd><a name="index-g_t_0040option_007b_002dV_007d-_0028_0040command_007bgcc_007d_0029-181"></a>Execute <var>ver</var> version of the compiler. This is the <samp><span class="command">gcc</span></samp>
version, not the GNAT version.
<br><dt><samp><span class="option">-w</span></samp><dd><a name="index-g_t_0040option_007b_002dw_007d-_0028_0040command_007bgcc_007d_0029-182"></a>Turn off warnings generated by the back end of the compiler. Use of
this switch also causes the default for front end warnings to be set
to suppress (as though <samp><span class="option">-gnatws</span></samp> had appeared at the start of
the options).
</dl>
<!-- Combining qualifiers does not work on VMS -->
<p>You may combine a sequence of GNAT switches into a single switch. For
example, the combined switch
<p><a name="index-Combining-GNAT-switches-183"></a>
<pre class="smallexample"> -gnatofi3
</pre>
<p class="noindent">is equivalent to specifying the following sequence of switches:
<pre class="smallexample"> -gnato -gnatf -gnati3
</pre>
<p class="noindent">The following restrictions apply to the combination of switches
in this manner:
<ul>
<li>The switch <samp><span class="option">-gnatc</span></samp> if combined with other switches must come
first in the string.
<li>The switch <samp><span class="option">-gnats</span></samp> if combined with other switches must come
first in the string.
<li>The switches
<p><samp><span class="option">-gnatzc</span></samp> and <samp><span class="option">-gnatzr</span></samp> may not be combined with any other
switches, and only one of them may appear in the command line.
<li>The switch <samp><span class="option">-gnat-p</span></samp> may not be combined with any other switch.
<li>Once a “y” appears in the string (that is a use of the <samp><span class="option">-gnaty</span></samp>
switch), then all further characters in the switch are interpreted
as style modifiers (see description of <samp><span class="option">-gnaty</span></samp>).
<li>Once a “d” appears in the string (that is a use of the <samp><span class="option">-gnatd</span></samp>
switch), then all further characters in the switch are interpreted
as debug flags (see description of <samp><span class="option">-gnatd</span></samp>).
<li>Once a “w” appears in the string (that is a use of the <samp><span class="option">-gnatw</span></samp>
switch), then all further characters in the switch are interpreted
as warning mode modifiers (see description of <samp><span class="option">-gnatw</span></samp>).
<li>Once a “V” appears in the string (that is a use of the <samp><span class="option">-gnatV</span></samp>
switch), then all further characters in the switch are interpreted
as validity checking options (see <a href="#Validity-Checking">Validity Checking</a>).
<li>Option “em”, “ec”, “ep”, “l=” and “R” must be the last options in
a combined list of options.
</ul>
<div class="node">
<a name="Output-and-Error-Message-Control"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Warning-Message-Control">Warning Message Control</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gcc">Switches for gcc</a>
</div>
<h4 class="subsection">3.2.1 Output and Error Message Control</h4>
<p><a name="index-stderr-184"></a>
The standard default format for error messages is called “brief format”.
Brief format messages are written to <samp><span class="file">stderr</span></samp> (the standard error
file) and have the following form:
<pre class="smallexample"> e.adb:3:04: Incorrect spelling of keyword "function"
e.adb:4:20: ";" should be "is"
</pre>
<p class="noindent">The first integer after the file name is the line number in the file,
and the second integer is the column number within the line.
<code>GPS</code> can parse the error messages
and point to the referenced character.
The following switches provide control over the error message
format:
<dl>
<!-- !sort! -->
<dt><samp><span class="option">-gnatv</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatv_007d-_0028_0040command_007bgcc_007d_0029-185"></a><a name="index-stdout-186"></a>The v stands for verbose.
The effect of this setting is to write long-format error
messages to <samp><span class="file">stdout</span></samp> (the standard output file.
The same program compiled with the
<samp><span class="option">-gnatv</span></samp> switch would generate:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
3. funcion X (Q : Integer)
|
>>> Incorrect spelling of keyword "function"
4. return Integer;
|
>>> ";" should be "is"
</td></tr></table>
</pre>
<p class="noindent">The vertical bar indicates the location of the error, and the ‘<samp><span class="samp">>>></span></samp>’
prefix can be used to search for error messages. When this switch is
used the only source lines output are those with errors.
<br><dt><samp><span class="option">-gnatl</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatl_007d-_0028_0040command_007bgcc_007d_0029-187"></a>The <code>l</code> stands for list.
This switch causes a full listing of
the file to be generated. In the case where a body is
compiled, the corresponding spec is also listed, along
with any subunits. Typical output from compiling a package
body <samp><span class="file">p.adb</span></samp> might look like:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
Compiling: p.adb
1. package body p is
2. procedure a;
3. procedure a is separate;
4. begin
5. null
|
>>> missing ";"
6. end;
Compiling: p.ads
1. package p is
2. pragma Elaborate_Body
|
>>> missing ";"
3. end p;
Compiling: p-a.adb
1. separate p
|
>>> missing "("
2. procedure a is
3. begin
4. null
|
>>> missing ";"
5. end;
</td></tr></table>
</pre>
<p class="noindent"><a name="index-stderr-188"></a>When you specify the <samp><span class="option">-gnatv</span></samp> or <samp><span class="option">-gnatl</span></samp> switches and
standard output is redirected, a brief summary is written to
<samp><span class="file">stderr</span></samp> (standard error) giving the number of error messages and
warning messages generated.
<br><dt><samp><span class="option">-gnatl=file</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatl_003dfname_007d-_0028_0040command_007bgcc_007d_0029-189"></a>This has the same effect as <samp><span class="option">-gnatl</span></samp> except that the output is
written to a file instead of to standard output. If the given name
<samp><span class="file">fname</span></samp> does not start with a period, then it is the full name
of the file to be written. If <samp><span class="file">fname</span></samp> is an extension, it is
appended to the name of the file being compiled. For example, if
file <samp><span class="file">xyz.adb</span></samp> is compiled with <samp><span class="option">-gnatl=.lst</span></samp>,
then the output is written to file xyz.adb.lst.
<br><dt><samp><span class="option">-gnatU</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatU_007d-_0028_0040command_007bgcc_007d_0029-190"></a>This switch forces all error messages to be preceded by the unique
string “error:”. This means that error messages take a few more
characters in space, but allows easy searching for and identification
of error messages.
<br><dt><samp><span class="option">-gnatb</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatb_007d-_0028_0040command_007bgcc_007d_0029-191"></a>The <code>b</code> stands for brief.
This switch causes GNAT to generate the
brief format error messages to <samp><span class="file">stderr</span></samp> (the standard error
file) as well as the verbose
format message or full listing (which as usual is written to
<samp><span class="file">stdout</span></samp> (the standard output file).
<br><dt><samp><span class="option">-gnatm=</span><var>n</var></samp><dd><a name="index-g_t_0040option_007b_002dgnatm_007d-_0028_0040command_007bgcc_007d_0029-192"></a>The <code>m</code> stands for maximum.
<var>n</var> is a decimal integer in the
range of 1 to 999999 and limits the number of error or warning
messages to be generated. For example, using
<samp><span class="option">-gnatm2</span></samp> might yield
<pre class="smallexample"> e.adb:3:04: Incorrect spelling of keyword "function"
e.adb:5:35: missing ".."
fatal error: maximum number of errors detected
compilation abandoned
</pre>
<p class="noindent">The default setting if
no switch is given is 9999. If the number of warnings reaches this
limit, then a message is output and further warnings are suppressed,
but the compilation is continued. If the number of error messages
reaches this limit, then a message is output and the compilation
is abandoned. A value of zero means that no limit applies.
<p class="noindent">Note that the equal sign is optional, so the switches
<samp><span class="option">-gnatm2</span></samp> and <samp><span class="option">-gnatm=2</span></samp> are equivalent.
<br><dt><samp><span class="option">-gnatf</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatf_007d-_0028_0040command_007bgcc_007d_0029-193"></a><a name="index-Error-messages_002c-suppressing-194"></a>The <code>f</code> stands for full.
Normally, the compiler suppresses error messages that are likely to be
redundant. This switch causes all error
messages to be generated. In particular, in the case of
references to undefined variables. If a given variable is referenced
several times, the normal format of messages is
<pre class="smallexample"> e.adb:7:07: "V" is undefined (more references follow)
</pre>
<p class="noindent">where the parenthetical comment warns that there are additional
references to the variable <code>V</code>. Compiling the same program with the
<samp><span class="option">-gnatf</span></samp> switch yields
<pre class="smallexample"> e.adb:7:07: "V" is undefined
e.adb:8:07: "V" is undefined
e.adb:8:12: "V" is undefined
e.adb:8:16: "V" is undefined
e.adb:9:07: "V" is undefined
e.adb:9:12: "V" is undefined
</pre>
<p class="noindent">The <samp><span class="option">-gnatf</span></samp> switch also generates additional information for
some error messages. Some examples are:
<ul>
<li>Details on possibly non-portable unchecked conversion
<li>List possible interpretations for ambiguous calls
<li>Additional details on incorrect parameters
</ul>
<br><dt><samp><span class="option">-gnatjnn</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatjnn_007d-_0028_0040command_007bgcc_007d_0029-195"></a>In normal operation mode (or if <samp><span class="option">-gnatj0</span></samp> is used, then error messages
with continuation lines are treated as though the continuation lines were
separate messages (and so a warning with two continuation lines counts as
three warnings, and is listed as three separate messages).
<p>If the <samp><span class="option">-gnatjnn</span></samp> switch is used with a positive value for nn, then
messages are output in a different manner. A message and all its continuation
lines are treated as a unit, and count as only one warning or message in the
statistics totals. Furthermore, the message is reformatted so that no line
is longer than nn characters.
<br><dt><samp><span class="option">-gnatq</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatq_007d-_0028_0040command_007bgcc_007d_0029-196"></a>The <code>q</code> stands for quit (really “don't quit”).
In normal operation mode, the compiler first parses the program and
determines if there are any syntax errors. If there are, appropriate
error messages are generated and compilation is immediately terminated.
This switch tells
GNAT to continue with semantic analysis even if syntax errors have been
found. This may enable the detection of more errors in a single run. On
the other hand, the semantic analyzer is more likely to encounter some
internal fatal error when given a syntactically invalid tree.
<br><dt><samp><span class="option">-gnatQ</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatQ_007d-_0028_0040command_007bgcc_007d_0029-197"></a>In normal operation mode, the <samp><span class="file">ALI</span></samp> file is not generated if any
illegalities are detected in the program. The use of <samp><span class="option">-gnatQ</span></samp> forces
generation of the <samp><span class="file">ALI</span></samp> file. This file is marked as being in
error, so it cannot be used for binding purposes, but it does contain
reasonably complete cross-reference information, and thus may be useful
for use by tools (e.g., semantic browsing tools or integrated development
environments) that are driven from the <samp><span class="file">ALI</span></samp> file. This switch
implies <samp><span class="option">-gnatq</span></samp>, since the semantic phase must be run to get a
meaningful ALI file.
<p>In addition, if <samp><span class="option">-gnatt</span></samp> is also specified, then the tree file is
generated even if there are illegalities. It may be useful in this case
to also specify <samp><span class="option">-gnatq</span></samp> to ensure that full semantic processing
occurs. The resulting tree file can be processed by ASIS, for the purpose
of providing partial information about illegal units, but if the error
causes the tree to be badly malformed, then ASIS may crash during the
analysis.
<p>When <samp><span class="option">-gnatQ</span></samp> is used and the generated <samp><span class="file">ALI</span></samp> file is marked as
being in error, <samp><span class="command">gnatmake</span></samp> will attempt to recompile the source when it
finds such an <samp><span class="file">ALI</span></samp> file, including with switch <samp><span class="option">-gnatc</span></samp>.
<p>Note that <samp><span class="option">-gnatQ</span></samp> has no effect if <samp><span class="option">-gnats</span></samp> is specified,
since ALI files are never generated if <samp><span class="option">-gnats</span></samp> is set.
</dl>
<div class="node">
<a name="Warning-Message-Control"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Debugging-and-Assertion-Control">Debugging and Assertion Control</a>,
Previous: <a rel="previous" accesskey="p" href="#Output-and-Error-Message-Control">Output and Error Message Control</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gcc">Switches for gcc</a>
</div>
<h4 class="subsection">3.2.2 Warning Message Control</h4>
<p><a name="index-Warning-messages-198"></a>In addition to error messages, which correspond to illegalities as defined
in the Ada Reference Manual, the compiler detects two kinds of warning
situations.
<p>First, the compiler considers some constructs suspicious and generates a
warning message to alert you to a possible error. Second, if the
compiler detects a situation that is sure to raise an exception at
run time, it generates a warning message. The following shows an example
of warning messages:
<pre class="smallexample"> e.adb:4:24: warning: creation of object may raise Storage_Error
e.adb:10:17: warning: static value out of range
e.adb:10:17: warning: "Constraint_Error" will be raised at run time
</pre>
<p class="noindent">GNAT considers a large number of situations as appropriate
for the generation of warning messages. As always, warnings are not
definite indications of errors. For example, if you do an out-of-range
assignment with the deliberate intention of raising a
<code>Constraint_Error</code> exception, then the warning that may be
issued does not indicate an error. Some of the situations for which GNAT
issues warnings (at least some of the time) are given in the following
list. This list is not complete, and new warnings are often added to
subsequent versions of GNAT. The list is intended to give a general idea
of the kinds of warnings that are generated.
<ul>
<li>Possible infinitely recursive calls
<li>Out-of-range values being assigned
<li>Possible order of elaboration problems
<li>Assertions (pragma Assert) that are sure to fail
<li>Unreachable code
<li>Address clauses with possibly unaligned values, or where an attempt is
made to overlay a smaller variable with a larger one.
<li>Fixed-point type declarations with a null range
<li>Direct_IO or Sequential_IO instantiated with a type that has access values
<li>Variables that are never assigned a value
<li>Variables that are referenced before being initialized
<li>Task entries with no corresponding <code>accept</code> statement
<li>Duplicate accepts for the same task entry in a <code>select</code>
<li>Objects that take too much storage
<li>Unchecked conversion between types of differing sizes
<li>Missing <code>return</code> statement along some execution path in a function
<li>Incorrect (unrecognized) pragmas
<li>Incorrect external names
<li>Allocation from empty storage pool
<li>Potentially blocking operation in protected type
<li>Suspicious parenthesization of expressions
<li>Mismatching bounds in an aggregate
<li>Attempt to return local value by reference
<li>Premature instantiation of a generic body
<li>Attempt to pack aliased components
<li>Out of bounds array subscripts
<li>Wrong length on string assignment
<li>Violations of style rules if style checking is enabled
<li>Unused <code>with</code> clauses
<li><code>Bit_Order</code> usage that does not have any effect
<li><code>Standard.Duration</code> used to resolve universal fixed expression
<li>Dereference of possibly null value
<li>Declaration that is likely to cause storage error
<li>Internal GNAT unit <code>with</code>'ed by application unit
<li>Values known to be out of range at compile time
<li>Unreferenced labels and variables
<li>Address overlays that could clobber memory
<li>Unexpected initialization when address clause present
<li>Bad alignment for address clause
<li>Useless type conversions
<li>Redundant assignment statements and other redundant constructs
<li>Useless exception handlers
<li>Accidental hiding of name by child unit
<li>Access before elaboration detected at compile time
<li>A range in a <code>for</code> loop that is known to be null or might be null
</ul>
<p class="noindent">The following section lists compiler switches that are available
to control the handling of warning messages. It is also possible
to exercise much finer control over what warnings are issued and
suppressed using the GNAT pragma Warnings, See <a href="gnat_rm.html#Pragma-Warnings">Pragma Warnings</a>.
<dl>
<!-- !sort! -->
<dt><samp><span class="option">-gnatwa</span></samp><dd><em>Activate most optional warnings.</em>
<a name="index-g_t_0040option_007b_002dgnatwa_007d-_0028_0040command_007bgcc_007d_0029-199"></a>This switch activates most optional warning messages. See the remaining list
in this section for details on optional warning messages that can be
individually controlled. The warnings that are not turned on by this
switch are
<samp><span class="option">-gnatwd</span></samp> (implicit dereferencing),
<samp><span class="option">-gnatwh</span></samp> (hiding),
<samp><span class="option">-gnatw.h</span></samp> (holes (gaps) in record layouts)
<samp><span class="option">-gnatwl</span></samp> (elaboration warnings),
<samp><span class="option">-gnatw.o</span></samp> (warn on values set by out parameters ignored)
and <samp><span class="option">-gnatwt</span></samp> (tracking of deleted conditional code).
All other optional warnings are turned on.
<br><dt><samp><span class="option">-gnatwA</span></samp><dd><em>Suppress all optional errors.</em>
<a name="index-g_t_0040option_007b_002dgnatwA_007d-_0028_0040command_007bgcc_007d_0029-200"></a>This switch suppresses all optional warning messages, see remaining list
in this section for details on optional warning messages that can be
individually controlled.
<br><dt><samp><span class="option">-gnatw.a</span></samp><dd><em>Activate warnings on failing assertions.</em>
<a name="index-g_t_0040option_007b_002dgnatw_002ea_007d-_0028_0040command_007bgcc_007d_0029-201"></a><a name="index-Assert-failures-202"></a>This switch activates warnings for assertions where the compiler can tell at
compile time that the assertion will fail. Note that this warning is given
even if assertions are disabled. The default is that such warnings are
generated.
<br><dt><samp><span class="option">-gnatw.A</span></samp><dd><em>Suppress warnings on failing assertions.</em>
<a name="index-g_t_0040option_007b_002dgnatw_002eA_007d-_0028_0040command_007bgcc_007d_0029-203"></a><a name="index-Assert-failures-204"></a>This switch suppresses warnings for assertions where the compiler can tell at
compile time that the assertion will fail.
<br><dt><samp><span class="option">-gnatwb</span></samp><dd><em>Activate warnings on bad fixed values.</em>
<a name="index-g_t_0040option_007b_002dgnatwb_007d-_0028_0040command_007bgcc_007d_0029-205"></a><a name="index-Bad-fixed-values-206"></a><a name="index-Fixed_002dpoint-Small-value-207"></a><a name="index-Small-value-208"></a>This switch activates warnings for static fixed-point expressions whose
value is not an exact multiple of Small. Such values are implementation
dependent, since an implementation is free to choose either of the multiples
that surround the value. GNAT always chooses the closer one, but this is not
required behavior, and it is better to specify a value that is an exact
multiple, ensuring predictable execution. The default is that such warnings
are not generated.
<br><dt><samp><span class="option">-gnatwB</span></samp><dd><em>Suppress warnings on bad fixed values.</em>
<a name="index-g_t_0040option_007b_002dgnatwB_007d-_0028_0040command_007bgcc_007d_0029-209"></a>This switch suppresses warnings for static fixed-point expressions whose
value is not an exact multiple of Small.
<br><dt><samp><span class="option">-gnatw.b</span></samp><dd><em>Activate warnings on biased representation.</em>
<a name="index-g_t_0040option_007b_002dgnatw_002eb_007d-_0028_0040command_007bgcc_007d_0029-210"></a><a name="index-Biased-representation-211"></a>This switch activates warnings when a size clause, value size clause, component
clause, or component size clause forces the use of biased representation for an
integer type (e.g. representing a range of 10..11 in a single bit by using 0/1
to represent 10/11). The default is that such warnings are generated.
<br><dt><samp><span class="option">-gnatw.B</span></samp><dd><em>Suppress warnings on biased representation.</em>
<a name="index-g_t_0040option_007b_002dgnatwB_007d-_0028_0040command_007bgcc_007d_0029-212"></a>This switch suppresses warnings for representation clauses that force the use
of biased representation.
<br><dt><samp><span class="option">-gnatwc</span></samp><dd><em>Activate warnings on conditionals.</em>
<a name="index-g_t_0040option_007b_002dgnatwc_007d-_0028_0040command_007bgcc_007d_0029-213"></a><a name="index-Conditionals_002c-constant-214"></a>This switch activates warnings for conditional expressions used in
tests that are known to be True or False at compile time. The default
is that such warnings are not generated.
Note that this warning does
not get issued for the use of boolean variables or constants whose
values are known at compile time, since this is a standard technique
for conditional compilation in Ada, and this would generate too many
false positive warnings.
<p>This warning option also activates a special test for comparisons using
the operators “>=” and“ <=”.
If the compiler can tell that only the equality condition is possible,
then it will warn that the “>” or “<” part of the test
is useless and that the operator could be replaced by “=”.
An example would be comparing a <code>Natural</code> variable <= 0.
<p>This warning option also generates warnings if
one or both tests is optimized away in a membership test for integer
values if the result can be determined at compile time. Range tests on
enumeration types are not included, since it is common for such tests
to include an end point.
<p>This warning can also be turned on using <samp><span class="option">-gnatwa</span></samp>.
<br><dt><samp><span class="option">-gnatwC</span></samp><dd><em>Suppress warnings on conditionals.</em>
<a name="index-g_t_0040option_007b_002dgnatwC_007d-_0028_0040command_007bgcc_007d_0029-215"></a>This switch suppresses warnings for conditional expressions used in
tests that are known to be True or False at compile time.
<br><dt><samp><span class="option">-gnatw.c</span></samp><dd><em>Activate warnings on missing component clauses.</em>
<a name="index-g_t_0040option_007b_002dgnatw_002ec_007d-_0028_0040command_007bgcc_007d_0029-216"></a><a name="index-Component-clause_002c-missing-217"></a>This switch activates warnings for record components where a record
representation clause is present and has component clauses for the
majority, but not all, of the components. A warning is given for each
component for which no component clause is present.
<p>This warning can also be turned on using <samp><span class="option">-gnatwa</span></samp>.
<br><dt><samp><span class="option">-gnatw.C</span></samp><dd><em>Suppress warnings on missing component clauses.</em>
<a name="index-g_t_0040option_007b_002dgnatwC_007d-_0028_0040command_007bgcc_007d_0029-218"></a>This switch suppresses warnings for record components that are
missing a component clause in the situation described above.
<br><dt><samp><span class="option">-gnatwd</span></samp><dd><em>Activate warnings on implicit dereferencing.</em>
<a name="index-g_t_0040option_007b_002dgnatwd_007d-_0028_0040command_007bgcc_007d_0029-219"></a>If this switch is set, then the use of a prefix of an access type
in an indexed component, slice, or selected component without an
explicit <code>.all</code> will generate a warning. With this warning
enabled, access checks occur only at points where an explicit
<code>.all</code> appears in the source code (assuming no warnings are
generated as a result of this switch). The default is that such
warnings are not generated.
Note that <samp><span class="option">-gnatwa</span></samp> does not affect the setting of
this warning option.
<br><dt><samp><span class="option">-gnatwD</span></samp><dd><em>Suppress warnings on implicit dereferencing.</em>
<a name="index-g_t_0040option_007b_002dgnatwD_007d-_0028_0040command_007bgcc_007d_0029-220"></a><a name="index-Implicit-dereferencing-221"></a><a name="index-Dereferencing_002c-implicit-222"></a>This switch suppresses warnings for implicit dereferences in
indexed components, slices, and selected components.
<br><dt><samp><span class="option">-gnatwe</span></samp><dd><em>Treat warnings and style checks as errors.</em>
<a name="index-g_t_0040option_007b_002dgnatwe_007d-_0028_0040command_007bgcc_007d_0029-223"></a><a name="index-Warnings_002c-treat-as-error-224"></a>This switch causes warning messages and style check messages to be
treated as errors.
The warning string still appears, but the warning messages are counted
as errors, and prevent the generation of an object file. Note that this
is the only -gnatw switch that affects the handling of style check messages.
<br><dt><samp><span class="option">-gnatw.e</span></samp><dd><em>Activate every optional warning</em>
<a name="index-g_t_0040option_007b_002dgnatw_002ee_007d-_0028_0040command_007bgcc_007d_0029-225"></a><a name="index-Warnings_002c-activate-every-optional-warning-226"></a>This switch activates all optional warnings, including those which
are not activated by <code>-gnatwa</code>.
<br><dt><samp><span class="option">-gnatwf</span></samp><dd><em>Activate warnings on unreferenced formals.</em>
<a name="index-g_t_0040option_007b_002dgnatwf_007d-_0028_0040command_007bgcc_007d_0029-227"></a><a name="index-Formals_002c-unreferenced-228"></a>This switch causes a warning to be generated if a formal parameter
is not referenced in the body of the subprogram. This warning can
also be turned on using <samp><span class="option">-gnatwa</span></samp> or <samp><span class="option">-gnatwu</span></samp>. The
default is that these warnings are not generated.
<br><dt><samp><span class="option">-gnatwF</span></samp><dd><em>Suppress warnings on unreferenced formals.</em>
<a name="index-g_t_0040option_007b_002dgnatwF_007d-_0028_0040command_007bgcc_007d_0029-229"></a>This switch suppresses warnings for unreferenced formal
parameters. Note that the
combination <samp><span class="option">-gnatwu</span></samp> followed by <samp><span class="option">-gnatwF</span></samp> has the
effect of warning on unreferenced entities other than subprogram
formals.
<br><dt><samp><span class="option">-gnatwg</span></samp><dd><em>Activate warnings on unrecognized pragmas.</em>
<a name="index-g_t_0040option_007b_002dgnatwg_007d-_0028_0040command_007bgcc_007d_0029-230"></a><a name="index-Pragmas_002c-unrecognized-231"></a>This switch causes a warning to be generated if an unrecognized
pragma is encountered. Apart from issuing this warning, the
pragma is ignored and has no effect. This warning can
also be turned on using <samp><span class="option">-gnatwa</span></samp>. The default
is that such warnings are issued (satisfying the Ada Reference
Manual requirement that such warnings appear).
<br><dt><samp><span class="option">-gnatwG</span></samp><dd><em>Suppress warnings on unrecognized pragmas.</em>
<a name="index-g_t_0040option_007b_002dgnatwG_007d-_0028_0040command_007bgcc_007d_0029-232"></a>This switch suppresses warnings for unrecognized pragmas.
<br><dt><samp><span class="option">-gnatwh</span></samp><dd><em>Activate warnings on hiding.</em>
<a name="index-g_t_0040option_007b_002dgnatwh_007d-_0028_0040command_007bgcc_007d_0029-233"></a><a name="index-Hiding-of-Declarations-234"></a>This switch activates warnings on hiding declarations.
A declaration is considered hiding
if it is for a non-overloadable entity, and it declares an entity with the
same name as some other entity that is directly or use-visible. The default
is that such warnings are not generated.
Note that <samp><span class="option">-gnatwa</span></samp> does not affect the setting of this warning option.
<br><dt><samp><span class="option">-gnatwH</span></samp><dd><em>Suppress warnings on hiding.</em>
<a name="index-g_t_0040option_007b_002dgnatwH_007d-_0028_0040command_007bgcc_007d_0029-235"></a>This switch suppresses warnings on hiding declarations.
<br><dt><samp><span class="option">-gnatw.h</span></samp><dd><em>Activate warnings on holes/gaps in records.</em>
<a name="index-g_t_0040option_007b_002dgnatw_002eh_007d-_0028_0040command_007bgcc_007d_0029-236"></a><a name="index-Record-Representation-_0028gaps_0029-237"></a>This switch activates warnings on component clauses in record
representation clauses that leave holes (gaps) in the record layout.
If this warning option is active, then record representation clauses
should specify a contiguous layout, adding unused fill fields if needed.
Note that <samp><span class="option">-gnatwa</span></samp> does not affect the setting of this warning option.
<br><dt><samp><span class="option">-gnatw.H</span></samp><dd><em>Suppress warnings on holes/gaps in records.</em>
<a name="index-g_t_0040option_007b_002dgnatw_002eH_007d-_0028_0040command_007bgcc_007d_0029-238"></a>This switch suppresses warnings on component clauses in record
representation clauses that leave holes (haps) in the record layout.
<br><dt><samp><span class="option">-gnatwi</span></samp><dd><em>Activate warnings on implementation units.</em>
<a name="index-g_t_0040option_007b_002dgnatwi_007d-_0028_0040command_007bgcc_007d_0029-239"></a>This switch activates warnings for a <code>with</code> of an internal GNAT
implementation unit, defined as any unit from the <code>Ada</code>,
<code>Interfaces</code>, <code>GNAT</code>,
or <code>System</code>
hierarchies that is not
documented in either the Ada Reference Manual or the GNAT
Programmer's Reference Manual. Such units are intended only
for internal implementation purposes and should not be <code>with</code>'ed
by user programs. The default is that such warnings are generated
This warning can also be turned on using <samp><span class="option">-gnatwa</span></samp>.
<br><dt><samp><span class="option">-gnatwI</span></samp><dd><em>Disable warnings on implementation units.</em>
<a name="index-g_t_0040option_007b_002dgnatwI_007d-_0028_0040command_007bgcc_007d_0029-240"></a>This switch disables warnings for a <code>with</code> of an internal GNAT
implementation unit.
<br><dt><samp><span class="option">-gnatw.i</span></samp><dd><em>Activate warnings on overlapping actuals.</em>
<a name="index-g_t_0040option_007b_002dgnatw_002ei_007d-_0028_0040command_007bgcc_007d_0029-241"></a>This switch enables a warning on statically detectable overlapping actuals in
a subprogram call, when one of the actuals is an in-out parameter, and the
types of the actuals are not by-copy types. The warning is off by default,
and is not included under -gnatwa.
<br><dt><samp><span class="option">-gnatw.I</span></samp><dd><em>Disable warnings on overlapping actuals.</em>
<a name="index-g_t_0040option_007b_002dgnatw_002eI_007d-_0028_0040command_007bgcc_007d_0029-242"></a>This switch disables warnings on overlapping actuals in a call..
<br><dt><samp><span class="option">-gnatwj</span></samp><dd><em>Activate warnings on obsolescent features (Annex J).</em>
<a name="index-g_t_0040option_007b_002dgnatwj_007d-_0028_0040command_007bgcc_007d_0029-243"></a><a name="index-Features_002c-obsolescent-244"></a><a name="index-Obsolescent-features-245"></a>If this warning option is activated, then warnings are generated for
calls to subprograms marked with <code>pragma Obsolescent</code> and
for use of features in Annex J of the Ada Reference Manual. In the
case of Annex J, not all features are flagged. In particular use
of the renamed packages (like <code>Text_IO</code>) and use of package
<code>ASCII</code> are not flagged, since these are very common and
would generate many annoying positive warnings. The default is that
such warnings are not generated. This warning is also turned on by
the use of <samp><span class="option">-gnatwa</span></samp>.
<p>In addition to the above cases, warnings are also generated for
GNAT features that have been provided in past versions but which
have been superseded (typically by features in the new Ada standard).
For example, <code>pragma Ravenscar</code> will be flagged since its
function is replaced by <code>pragma Profile(Ravenscar)</code>.
<p>Note that this warning option functions differently from the
restriction <code>No_Obsolescent_Features</code> in two respects.
First, the restriction applies only to annex J features.
Second, the restriction does flag uses of package <code>ASCII</code>.
<br><dt><samp><span class="option">-gnatwJ</span></samp><dd><em>Suppress warnings on obsolescent features (Annex J).</em>
<a name="index-g_t_0040option_007b_002dgnatwJ_007d-_0028_0040command_007bgcc_007d_0029-246"></a>This switch disables warnings on use of obsolescent features.
<br><dt><samp><span class="option">-gnatwk</span></samp><dd><em>Activate warnings on variables that could be constants.</em>
<a name="index-g_t_0040option_007b_002dgnatwk_007d-_0028_0040command_007bgcc_007d_0029-247"></a>This switch activates warnings for variables that are initialized but
never modified, and then could be declared constants. The default is that
such warnings are not given.
This warning can also be turned on using <samp><span class="option">-gnatwa</span></samp>.
<br><dt><samp><span class="option">-gnatwK</span></samp><dd><em>Suppress warnings on variables that could be constants.</em>
<a name="index-g_t_0040option_007b_002dgnatwK_007d-_0028_0040command_007bgcc_007d_0029-248"></a>This switch disables warnings on variables that could be declared constants.
<br><dt><samp><span class="option">-gnatwl</span></samp><dd><em>Activate warnings for elaboration pragmas.</em>
<a name="index-g_t_0040option_007b_002dgnatwl_007d-_0028_0040command_007bgcc_007d_0029-249"></a><a name="index-Elaboration_002c-warnings-250"></a>This switch activates warnings on missing
<code>Elaborate_All</code> and <code>Elaborate</code> pragmas.
See the section in this guide on elaboration checking for details on
when such pragmas should be used. In dynamic elaboration mode, this switch
generations warnings about the need to add elaboration pragmas. Note however,
that if you blindly follow these warnings, and add <code>Elaborate_All</code>
warnings wherever they are recommended, you basically end up with the
equivalent of the static elaboration model, which may not be what you want for
legacy code for which the static model does not work.
<p>For the static model, the messages generated are labeled "info:" (for
information messages). They are not warnings to add elaboration pragmas,
merely informational messages showing what implicit elaboration pragmas
have been added, for use in analyzing elaboration circularity problems.
<p>Warnings are also generated if you
are using the static mode of elaboration, and a <code>pragma Elaborate</code>
is encountered. The default is that such warnings
are not generated.
This warning is not automatically turned on by the use of <samp><span class="option">-gnatwa</span></samp>.
<br><dt><samp><span class="option">-gnatwL</span></samp><dd><em>Suppress warnings for elaboration pragmas.</em>
<a name="index-g_t_0040option_007b_002dgnatwL_007d-_0028_0040command_007bgcc_007d_0029-251"></a>This switch suppresses warnings on missing Elaborate and Elaborate_All pragmas.
See the section in this guide on elaboration checking for details on
when such pragmas should be used.
<br><dt><samp><span class="option">-gnatwm</span></samp><dd><em>Activate warnings on modified but unreferenced variables.</em>
<a name="index-g_t_0040option_007b_002dgnatwm_007d-_0028_0040command_007bgcc_007d_0029-252"></a>This switch activates warnings for variables that are assigned (using
an initialization value or with one or more assignment statements) but
whose value is never read. The warning is suppressed for volatile
variables and also for variables that are renamings of other variables
or for which an address clause is given.
This warning can also be turned on using <samp><span class="option">-gnatwa</span></samp>.
The default is that these warnings are not given.
<br><dt><samp><span class="option">-gnatwM</span></samp><dd><em>Disable warnings on modified but unreferenced variables.</em>
<a name="index-g_t_0040option_007b_002dgnatwM_007d-_0028_0040command_007bgcc_007d_0029-253"></a>This switch disables warnings for variables that are assigned or
initialized, but never read.
<br><dt><samp><span class="option">-gnatw.m</span></samp><dd><em>Activate warnings on suspicious modulus values.</em>
<a name="index-g_t_0040option_007b_002dgnatw_002em_007d-_0028_0040command_007bgcc_007d_0029-254"></a>This switch activates warnings for modulus values that seem suspicious.
The cases caught are where the size is the same as the modulus (e.g.
a modulus of 7 with a size of 7 bits), and modulus values of 32 or 64
with no size clause. The guess in both cases is that 2**x was intended
rather than x. The default is that these warnings are given.
<br><dt><samp><span class="option">-gnatw.M</span></samp><dd><em>Disable warnings on suspicious modulus values.</em>
<a name="index-g_t_0040option_007b_002dgnatw_002eM_007d-_0028_0040command_007bgcc_007d_0029-255"></a>This switch disables warnings for suspicious modulus values.
<br><dt><samp><span class="option">-gnatwn</span></samp><dd><em>Set normal warnings mode.</em>
<a name="index-g_t_0040option_007b_002dgnatwn_007d-_0028_0040command_007bgcc_007d_0029-256"></a>This switch sets normal warning mode, in which enabled warnings are
issued and treated as warnings rather than errors. This is the default
mode. the switch <samp><span class="option">-gnatwn</span></samp> can be used to cancel the effect of
an explicit <samp><span class="option">-gnatws</span></samp> or
<samp><span class="option">-gnatwe</span></samp>. It also cancels the effect of the
implicit <samp><span class="option">-gnatwe</span></samp> that is activated by the
use of <samp><span class="option">-gnatg</span></samp>.
<br><dt><samp><span class="option">-gnatwo</span></samp><dd><em>Activate warnings on address clause overlays.</em>
<a name="index-g_t_0040option_007b_002dgnatwo_007d-_0028_0040command_007bgcc_007d_0029-257"></a><a name="index-Address-Clauses_002c-warnings-258"></a>This switch activates warnings for possibly unintended initialization
effects of defining address clauses that cause one variable to overlap
another. The default is that such warnings are generated.
This warning can also be turned on using <samp><span class="option">-gnatwa</span></samp>.
<br><dt><samp><span class="option">-gnatwO</span></samp><dd><em>Suppress warnings on address clause overlays.</em>
<a name="index-g_t_0040option_007b_002dgnatwO_007d-_0028_0040command_007bgcc_007d_0029-259"></a>This switch suppresses warnings on possibly unintended initialization
effects of defining address clauses that cause one variable to overlap
another.
<br><dt><samp><span class="option">-gnatw.o</span></samp><dd><em>Activate warnings on modified but unreferenced out parameters.</em>
<a name="index-g_t_0040option_007b_002dgnatw_002eo_007d-_0028_0040command_007bgcc_007d_0029-260"></a>This switch activates warnings for variables that are modified by using
them as actuals for a call to a procedure with an out mode formal, where
the resulting assigned value is never read. It is applicable in the case
where there is more than one out mode formal. If there is only one out
mode formal, the warning is issued by default (controlled by -gnatwu).
The warning is suppressed for volatile
variables and also for variables that are renamings of other variables
or for which an address clause is given.
The default is that these warnings are not given. Note that this warning
is not included in -gnatwa, it must be activated explicitly.
<br><dt><samp><span class="option">-gnatw.O</span></samp><dd><em>Disable warnings on modified but unreferenced out parameters.</em>
<a name="index-g_t_0040option_007b_002dgnatw_002eO_007d-_0028_0040command_007bgcc_007d_0029-261"></a>This switch suppresses warnings for variables that are modified by using
them as actuals for a call to a procedure with an out mode formal, where
the resulting assigned value is never read.
<br><dt><samp><span class="option">-gnatwp</span></samp><dd><em>Activate warnings on ineffective pragma Inlines.</em>
<a name="index-g_t_0040option_007b_002dgnatwp_007d-_0028_0040command_007bgcc_007d_0029-262"></a><a name="index-Inlining_002c-warnings-263"></a>This switch activates warnings for failure of front end inlining
(activated by <samp><span class="option">-gnatN</span></samp>) to inline a particular call. There are
many reasons for not being able to inline a call, including most
commonly that the call is too complex to inline. The default is
that such warnings are not given.
This warning can also be turned on using <samp><span class="option">-gnatwa</span></samp>.
Warnings on ineffective inlining by the gcc back-end can be activated
separately, using the gcc switch -Winline.
<br><dt><samp><span class="option">-gnatwP</span></samp><dd><em>Suppress warnings on ineffective pragma Inlines.</em>
<a name="index-g_t_0040option_007b_002dgnatwP_007d-_0028_0040command_007bgcc_007d_0029-264"></a>This switch suppresses warnings on ineffective pragma Inlines. If the
inlining mechanism cannot inline a call, it will simply ignore the
request silently.
<br><dt><samp><span class="option">-gnatw.p</span></samp><dd><em>Activate warnings on parameter ordering.</em>
<a name="index-g_t_0040option_007b_002dgnatw_002ep_007d-_0028_0040command_007bgcc_007d_0029-265"></a><a name="index-Parameter-order_002c-warnings-266"></a>This switch activates warnings for cases of suspicious parameter
ordering when the list of arguments are all simple identifiers that
match the names of the formals, but are in a different order. The
warning is suppressed if any use of named parameter notation is used,
so this is the appropriate way to suppress a false positive (and
serves to emphasize that the "misordering" is deliberate). The
default is
that such warnings are not given.
This warning can also be turned on using <samp><span class="option">-gnatwa</span></samp>.
<br><dt><samp><span class="option">-gnatw.P</span></samp><dd><em>Suppress warnings on parameter ordering.</em>
<a name="index-g_t_0040option_007b_002dgnatw_002eP_007d-_0028_0040command_007bgcc_007d_0029-267"></a>This switch suppresses warnings on cases of suspicious parameter
ordering.
<br><dt><samp><span class="option">-gnatwq</span></samp><dd><em>Activate warnings on questionable missing parentheses.</em>
<a name="index-g_t_0040option_007b_002dgnatwq_007d-_0028_0040command_007bgcc_007d_0029-268"></a><a name="index-Parentheses_002c-warnings-269"></a>This switch activates warnings for cases where parentheses are not used and
the result is potential ambiguity from a readers point of view. For example
(not a > b) when a and b are modular means ((not a) > b) and very likely the
programmer intended (not (a > b)). Similarly (-x mod 5) means (-(x mod 5)) and
quite likely ((-x) mod 5) was intended. In such situations it seems best to
follow the rule of always parenthesizing to make the association clear, and
this warning switch warns if such parentheses are not present. The default
is that these warnings are given.
This warning can also be turned on using <samp><span class="option">-gnatwa</span></samp>.
<br><dt><samp><span class="option">-gnatwQ</span></samp><dd><em>Suppress warnings on questionable missing parentheses.</em>
<a name="index-g_t_0040option_007b_002dgnatwQ_007d-_0028_0040command_007bgcc_007d_0029-270"></a>This switch suppresses warnings for cases where the association is not
clear and the use of parentheses is preferred.
<br><dt><samp><span class="option">-gnatwr</span></samp><dd><em>Activate warnings on redundant constructs.</em>
<a name="index-g_t_0040option_007b_002dgnatwr_007d-_0028_0040command_007bgcc_007d_0029-271"></a>This switch activates warnings for redundant constructs. The following
is the current list of constructs regarded as redundant:
<ul>
<li>Assignment of an item to itself.
<li>Type conversion that converts an expression to its own type.
<li>Use of the attribute <code>Base</code> where <code>typ'Base</code> is the same
as <code>typ</code>.
<li>Use of pragma <code>Pack</code> when all components are placed by a record
representation clause.
<li>Exception handler containing only a reraise statement (raise with no
operand) which has no effect.
<li>Use of the operator abs on an operand that is known at compile time
to be non-negative
<li>Comparison of boolean expressions to an explicit True value.
</ul>
<p>This warning can also be turned on using <samp><span class="option">-gnatwa</span></samp>.
The default is that warnings for redundant constructs are not given.
<br><dt><samp><span class="option">-gnatwR</span></samp><dd><em>Suppress warnings on redundant constructs.</em>
<a name="index-g_t_0040option_007b_002dgnatwR_007d-_0028_0040command_007bgcc_007d_0029-272"></a>This switch suppresses warnings for redundant constructs.
<br><dt><samp><span class="option">-gnatw.r</span></samp><dd><em>Activate warnings for object renaming function.</em>
<a name="index-g_t_0040option_007b_002dgnatw_002er_007d-_0028_0040command_007bgcc_007d_0029-273"></a>This switch activates warnings for an object renaming that renames a
function call, which is equivalent to a constant declaration (as
opposed to renaming the function itself). The default is that these
warnings are given. This warning can also be turned on using
<samp><span class="option">-gnatwa</span></samp>.
<br><dt><samp><span class="option">-gnatw.R</span></samp><dd><em>Suppress warnings for object renaming function.</em>
<a name="index-g_t_0040option_007b_002dgnatwT_007d-_0028_0040command_007bgcc_007d_0029-274"></a>This switch suppresses warnings for object renaming function.
<br><dt><samp><span class="option">-gnatws</span></samp><dd><em>Suppress all warnings.</em>
<a name="index-g_t_0040option_007b_002dgnatws_007d-_0028_0040command_007bgcc_007d_0029-275"></a>This switch completely suppresses the
output of all warning messages from the GNAT front end.
Note that it does not suppress warnings from the <samp><span class="command">gcc</span></samp> back end.
To suppress these back end warnings as well, use the switch <samp><span class="option">-w</span></samp>
in addition to <samp><span class="option">-gnatws</span></samp>. Also this switch has no effect on the
handling of style check messages.
<br><dt><samp><span class="option">-gnatw.s</span></samp><dd><em>Activate warnings on overridden size clauses.</em>
<a name="index-g_t_0040option_007b_002dgnatw_002es_007d-_0028_0040command_007bgcc_007d_0029-276"></a><a name="index-Record-Representation-_0028component-sizes_0029-277"></a>This switch activates warnings on component clauses in record
representation clauses where the length given overrides that
specified by an explicit size clause for the component type. A
warning is similarly given in the array case if a specified
component size overrides an explicit size clause for the array
component type.
Note that <samp><span class="option">-gnatwa</span></samp> does not affect the setting of this warning option.
<br><dt><samp><span class="option">-gnatw.S</span></samp><dd><em>Suppress warnings on overridden size clauses.</em>
<a name="index-g_t_0040option_007b_002dgnatw_002eS_007d-_0028_0040command_007bgcc_007d_0029-278"></a>This switch suppresses warnings on component clauses in record
representation clauses that override size clauses, and similar
warnings when an array component size overrides a size clause.
<br><dt><samp><span class="option">-gnatwt</span></samp><dd><em>Activate warnings for tracking of deleted conditional code.</em>
<a name="index-g_t_0040option_007b_002dgnatwt_007d-_0028_0040command_007bgcc_007d_0029-279"></a><a name="index-Deactivated-code_002c-warnings-280"></a><a name="index-Deleted-code_002c-warnings-281"></a>This switch activates warnings for tracking of code in conditionals (IF and
CASE statements) that is detected to be dead code which cannot be executed, and
which is removed by the front end. This warning is off by default, and is not
turned on by <samp><span class="option">-gnatwa</span></samp>, it has to be turned on explicitly. This may be
useful for detecting deactivated code in certified applications.
<br><dt><samp><span class="option">-gnatwT</span></samp><dd><em>Suppress warnings for tracking of deleted conditional code.</em>
<a name="index-g_t_0040option_007b_002dgnatwT_007d-_0028_0040command_007bgcc_007d_0029-282"></a>This switch suppresses warnings for tracking of deleted conditional code.
<br><dt><samp><span class="option">-gnatwu</span></samp><dd><em>Activate warnings on unused entities.</em>
<a name="index-g_t_0040option_007b_002dgnatwu_007d-_0028_0040command_007bgcc_007d_0029-283"></a>This switch activates warnings to be generated for entities that
are declared but not referenced, and for units that are <code>with</code>'ed
and not
referenced. In the case of packages, a warning is also generated if
no entities in the package are referenced. This means that if the package
is referenced but the only references are in <code>use</code>
clauses or <code>renames</code>
declarations, a warning is still generated. A warning is also generated
for a generic package that is <code>with</code>'ed but never instantiated.
In the case where a package or subprogram body is compiled, and there
is a <code>with</code> on the corresponding spec
that is only referenced in the body,
a warning is also generated, noting that the
<code>with</code> can be moved to the body. The default is that
such warnings are not generated.
This switch also activates warnings on unreferenced formals
(it includes the effect of <samp><span class="option">-gnatwf</span></samp>).
This warning can also be turned on using <samp><span class="option">-gnatwa</span></samp>.
<br><dt><samp><span class="option">-gnatwU</span></samp><dd><em>Suppress warnings on unused entities.</em>
<a name="index-g_t_0040option_007b_002dgnatwU_007d-_0028_0040command_007bgcc_007d_0029-284"></a>This switch suppresses warnings for unused entities and packages.
It also turns off warnings on unreferenced formals (and thus includes
the effect of <samp><span class="option">-gnatwF</span></samp>).
<br><dt><samp><span class="option">-gnatw.u</span></samp><dd><em>Activate warnings on unordered enumeration types.</em>
<a name="index-g_t_0040option_007b_002dgnatw_002eu_007d-_0028_0040command_007bgcc_007d_0029-285"></a>This switch causes enumeration types to be considered as conceptually
unordered, unless an explicit pragma <code>Ordered</code> is given for the type.
The effect is to generate warnings in clients that use explicit comparisons
or subranges, since these constructs both treat objects of the type as
ordered. (A <em>client</em> is defined as a unit that is other than the unit in
which the type is declared, or its body or subunits.) Please refer to
the description of pragma <code>Ordered</code> in the
<cite>GNAT Reference Manual</cite> for further details.
<br><dt><samp><span class="option">-gnatw.U</span></samp><dd><em>Deactivate warnings on unordered enumeration types.</em>
<a name="index-g_t_0040option_007b_002dgnatw_002eU_007d-_0028_0040command_007bgcc_007d_0029-286"></a>This switch causes all enumeration types to be considered as ordered, so
that no warnings are given for comparisons or subranges for any type.
<br><dt><samp><span class="option">-gnatwv</span></samp><dd><em>Activate warnings on unassigned variables.</em>
<a name="index-g_t_0040option_007b_002dgnatwv_007d-_0028_0040command_007bgcc_007d_0029-287"></a><a name="index-Unassigned-variable-warnings-288"></a>This switch activates warnings for access to variables which
may not be properly initialized. The default is that
such warnings are generated.
This warning can also be turned on using <samp><span class="option">-gnatwa</span></samp>.
<br><dt><samp><span class="option">-gnatwV</span></samp><dd><em>Suppress warnings on unassigned variables.</em>
<a name="index-g_t_0040option_007b_002dgnatwV_007d-_0028_0040command_007bgcc_007d_0029-289"></a>This switch suppresses warnings for access to variables which
may not be properly initialized.
For variables of a composite type, the warning can also be suppressed in
Ada 2005 by using a default initialization with a box. For example, if
Table is an array of records whose components are only partially uninitialized,
then the following code:
<pre class="smallexample"> Tab : Table := (others => <>);
</pre>
<p>will suppress warnings on subsequent statements that access components
of variable Tab.
<br><dt><samp><span class="option">-gnatww</span></samp><dd><em>Activate warnings on wrong low bound assumption.</em>
<a name="index-g_t_0040option_007b_002dgnatww_007d-_0028_0040command_007bgcc_007d_0029-290"></a><a name="index-String-indexing-warnings-291"></a>This switch activates warnings for indexing an unconstrained string parameter
with a literal or S'Length. This is a case where the code is assuming that the
low bound is one, which is in general not true (for example when a slice is
passed). The default is that such warnings are generated.
This warning can also be turned on using <samp><span class="option">-gnatwa</span></samp>.
<br><dt><samp><span class="option">-gnatwW</span></samp><dd><em>Suppress warnings on wrong low bound assumption.</em>
<a name="index-g_t_0040option_007b_002dgnatwW_007d-_0028_0040command_007bgcc_007d_0029-292"></a>This switch suppresses warnings for indexing an unconstrained string parameter
with a literal or S'Length. Note that this warning can also be suppressed
in a particular case by adding an
assertion that the lower bound is 1,
as shown in the following example.
<pre class="smallexample"> procedure K (S : String) is
pragma Assert (S'First = 1);
...
</pre>
<br><dt><samp><span class="option">-gnatw.w</span></samp><dd><em>Activate warnings on unnecessary Warnings Off pragmas</em>
<a name="index-g_t_0040option_007b_002dgnatw_002ew_007d-_0028_0040command_007bgcc_007d_0029-293"></a><a name="index-Warnings-Off-control-294"></a>This switch activates warnings for use of <code>pragma Warnings (Off, entity</code>
where either the pragma is entirely useless (because it suppresses no
warnings), or it could be replaced by <code>pragma Unreferenced</code> or
<code>pragma Unmodified</code>.The default is that these warnings are not given.
Note that this warning is not included in -gnatwa, it must be
activated explicitly.
<br><dt><samp><span class="option">-gnatw.W</span></samp><dd><em>Suppress warnings on unnecessary Warnings Off pragmas</em>
<a name="index-g_t_0040option_007b_002dgnatw_002eW_007d-_0028_0040command_007bgcc_007d_0029-295"></a>This switch suppresses warnings for use of <code>pragma Warnings (Off, entity</code>.
<br><dt><samp><span class="option">-gnatwx</span></samp><dd><em>Activate warnings on Export/Import pragmas.</em>
<a name="index-g_t_0040option_007b_002dgnatwx_007d-_0028_0040command_007bgcc_007d_0029-296"></a><a name="index-Export_002fImport-pragma-warnings-297"></a>This switch activates warnings on Export/Import pragmas when
the compiler detects a possible conflict between the Ada and
foreign language calling sequences. For example, the use of
default parameters in a convention C procedure is dubious
because the C compiler cannot supply the proper default, so
a warning is issued. The default is that such warnings are
generated.
This warning can also be turned on using <samp><span class="option">-gnatwa</span></samp>.
<br><dt><samp><span class="option">-gnatwX</span></samp><dd><em>Suppress warnings on Export/Import pragmas.</em>
<a name="index-g_t_0040option_007b_002dgnatwX_007d-_0028_0040command_007bgcc_007d_0029-298"></a>This switch suppresses warnings on Export/Import pragmas.
The sense of this is that you are telling the compiler that
you know what you are doing in writing the pragma, and it
should not complain at you.
<br><dt><samp><span class="option">-gnatw.x</span></samp><dd><em>Activate warnings for No_Exception_Propagation mode.</em>
<a name="index-g_t_0040option_007b_002dgnatwm_007d-_0028_0040command_007bgcc_007d_0029-299"></a>This switch activates warnings for exception usage when pragma Restrictions
(No_Exception_Propagation) is in effect. Warnings are given for implicit or
explicit exception raises which are not covered by a local handler, and for
exception handlers which do not cover a local raise. The default is that these
warnings are not given.
<br><dt><samp><span class="option">-gnatw.X</span></samp><dd><em>Disable warnings for No_Exception_Propagation mode.</em>
This switch disables warnings for exception usage when pragma Restrictions
(No_Exception_Propagation) is in effect.
<br><dt><samp><span class="option">-gnatwy</span></samp><dd><em>Activate warnings for Ada 2005 compatibility issues.</em>
<a name="index-g_t_0040option_007b_002dgnatwy_007d-_0028_0040command_007bgcc_007d_0029-300"></a><a name="index-Ada-2005-compatibility-issues-warnings-301"></a>For the most part Ada 2005 is upwards compatible with Ada 95,
but there are some exceptions (for example the fact that
<code>interface</code> is now a reserved word in Ada 2005). This
switch activates several warnings to help in identifying
and correcting such incompatibilities. The default is that
these warnings are generated. Note that at one point Ada 2005
was called Ada 0Y, hence the choice of character.
This warning can also be turned on using <samp><span class="option">-gnatwa</span></samp>.
<br><dt><samp><span class="option">-gnatwY</span></samp><dd><em>Disable warnings for Ada 2005 compatibility issues.</em>
<a name="index-g_t_0040option_007b_002dgnatwY_007d-_0028_0040command_007bgcc_007d_0029-302"></a><a name="index-Ada-2005-compatibility-issues-warnings-303"></a>This switch suppresses several warnings intended to help in identifying
incompatibilities between Ada 95 and Ada 2005.
<br><dt><samp><span class="option">-gnatwz</span></samp><dd><em>Activate warnings on unchecked conversions.</em>
<a name="index-g_t_0040option_007b_002dgnatwz_007d-_0028_0040command_007bgcc_007d_0029-304"></a><a name="index-Unchecked_005fConversion-warnings-305"></a>This switch activates warnings for unchecked conversions
where the types are known at compile time to have different
sizes. The default
is that such warnings are generated. Warnings are also
generated for subprogram pointers with different conventions,
and, on VMS only, for data pointers with different conventions.
This warning can also be turned on using <samp><span class="option">-gnatwa</span></samp>.
<br><dt><samp><span class="option">-gnatwZ</span></samp><dd><em>Suppress warnings on unchecked conversions.</em>
<a name="index-g_t_0040option_007b_002dgnatwZ_007d-_0028_0040command_007bgcc_007d_0029-306"></a>This switch suppresses warnings for unchecked conversions
where the types are known at compile time to have different
sizes or conventions.
<br><dt><samp><span class="option">-Wunused</span></samp><dd><a name="index-g_t_0040option_007b_002dWunused_007d-307"></a>The warnings controlled by the <samp><span class="option">-gnatw</span></samp> switch are generated by
the front end of the compiler. The <samp><span class="option">GCC</span></samp> back end can provide
additional warnings and they are controlled by the <samp><span class="option">-W</span></samp> switch.
For example, <samp><span class="option">-Wunused</span></samp> activates back end
warnings for entities that are declared but not referenced.
<br><dt><samp><span class="option">-Wuninitialized</span></samp><dd><a name="index-g_t_0040option_007b_002dWuninitialized_007d-308"></a>Similarly, <samp><span class="option">-Wuninitialized</span></samp> activates
the back end warning for uninitialized variables. This switch must be
used in conjunction with an optimization level greater than zero.
<br><dt><samp><span class="option">-Wall</span></samp><dd><a name="index-g_t_0040option_007b_002dWall_007d-309"></a>This switch enables all the above warnings from the <samp><span class="option">GCC</span></samp> back end.
The code generator detects a number of warning situations that are missed
by the <samp><span class="option">GNAT</span></samp> front end, and this switch can be used to activate them.
The use of this switch also sets the default front end warning mode to
<samp><span class="option">-gnatwa</span></samp>, that is, most front end warnings activated as well.
<br><dt><samp><span class="option">-w</span></samp><dd><a name="index-g_t_0040option_007b_002dw_007d-310"></a>Conversely, this switch suppresses warnings from the <samp><span class="option">GCC</span></samp> back end.
The use of this switch also sets the default front end warning mode to
<samp><span class="option">-gnatws</span></samp>, that is, front end warnings suppressed as well.
</dl>
<p class="noindent">A string of warning parameters can be used in the same parameter. For example:
<pre class="smallexample"> -gnatwaLe
</pre>
<p class="noindent">will turn on all optional warnings except for elaboration pragma warnings,
and also specify that warnings should be treated as errors.
When no switch <samp><span class="option">-gnatw</span></samp> is used, this is equivalent to:
<dl>
<!-- !sort! -->
<dt><samp><span class="option">-gnatwC</span></samp><br><dt><samp><span class="option">-gnatwD</span></samp><br><dt><samp><span class="option">-gnatwF</span></samp><br><dt><samp><span class="option">-gnatwg</span></samp><br><dt><samp><span class="option">-gnatwH</span></samp><br><dt><samp><span class="option">-gnatwi</span></samp><br><dt><samp><span class="option">-gnatwJ</span></samp><br><dt><samp><span class="option">-gnatwK</span></samp><br><dt><samp><span class="option">-gnatwL</span></samp><br><dt><samp><span class="option">-gnatwM</span></samp><br><dt><samp><span class="option">-gnatwn</span></samp><br><dt><samp><span class="option">-gnatwo</span></samp><br><dt><samp><span class="option">-gnatwP</span></samp><br><dt><samp><span class="option">-gnatwR</span></samp><br><dt><samp><span class="option">-gnatwU</span></samp><br><dt><samp><span class="option">-gnatwv</span></samp><br><dt><samp><span class="option">-gnatwz</span></samp><br><dt><samp><span class="option">-gnatwx</span></samp><dd>
</dl>
<div class="node">
<a name="Debugging-and-Assertion-Control"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Validity-Checking">Validity Checking</a>,
Previous: <a rel="previous" accesskey="p" href="#Warning-Message-Control">Warning Message Control</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gcc">Switches for gcc</a>
</div>
<h4 class="subsection">3.2.3 Debugging and Assertion Control</h4>
<dl>
<dt><samp><span class="option">-gnata</span></samp><dd><a name="index-g_t_0040option_007b_002dgnata_007d-_0028_0040command_007bgcc_007d_0029-311"></a><a name="index-Assert-312"></a><a name="index-Debug-313"></a><a name="index-Assertions-314"></a>
The pragmas <code>Assert</code> and <code>Debug</code> normally have no effect and
are ignored. This switch, where ‘<samp><span class="samp">a</span></samp>’ stands for assert, causes
<code>Assert</code> and <code>Debug</code> pragmas to be activated.
<p>The pragmas have the form:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
<b>pragma</b> Assert (<var>Boolean-expression</var> <span class="roman">[</span>,
<var>static-string-expression</var><span class="roman">]</span>)
<b>pragma</b> Debug (<var>procedure call</var>)
</td></tr></table>
</pre>
<p class="noindent">The <code>Assert</code> pragma causes <var>Boolean-expression</var> to be tested.
If the result is <code>True</code>, the pragma has no effect (other than
possible side effects from evaluating the expression). If the result is
<code>False</code>, the exception <code>Assert_Failure</code> declared in the package
<code>System.Assertions</code> is
raised (passing <var>static-string-expression</var>, if present, as the
message associated with the exception). If no string expression is
given the default is a string giving the file name and line number
of the pragma.
<p>The <code>Debug</code> pragma causes <var>procedure</var> to be called. Note that
<code>pragma Debug</code> may appear within a declaration sequence, allowing
debugging procedures to be called between declarations.
</dl>
<div class="node">
<a name="Validity-Checking"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Style-Checking">Style Checking</a>,
Previous: <a rel="previous" accesskey="p" href="#Debugging-and-Assertion-Control">Debugging and Assertion Control</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gcc">Switches for gcc</a>
</div>
<h4 class="subsection">3.2.4 Validity Checking</h4>
<p><a name="index-Validity-Checking-315"></a>
The Ada Reference Manual defines the concept of invalid values (see
RM 13.9.1). The primary source of invalid values is uninitialized
variables. A scalar variable that is left uninitialized may contain
an invalid value; the concept of invalid does not apply to access or
composite types.
<p>It is an error to read an invalid value, but the RM does not require
run-time checks to detect such errors, except for some minimal
checking to prevent erroneous execution (i.e. unpredictable
behavior). This corresponds to the <samp><span class="option">-gnatVd</span></samp> switch below,
which is the default. For example, by default, if the expression of a
case statement is invalid, it will raise Constraint_Error rather than
causing a wild jump, and if an array index on the left-hand side of an
assignment is invalid, it will raise Constraint_Error rather than
overwriting an arbitrary memory location.
<p>The <samp><span class="option">-gnatVa</span></samp> may be used to enable additional validity checks,
which are not required by the RM. These checks are often very
expensive (which is why the RM does not require them). These checks
are useful in tracking down uninitialized variables, but they are
not usually recommended for production builds.
<p>The other <samp><span class="option">-gnatV</span><var>x</var></samp> switches below allow finer-grained
control; you can enable whichever validity checks you desire. However,
for most debugging purposes, <samp><span class="option">-gnatVa</span></samp> is sufficient, and the
default <samp><span class="option">-gnatVd</span></samp> (i.e. standard Ada behavior) is usually
sufficient for non-debugging use.
<p>The <samp><span class="option">-gnatB</span></samp> switch tells the compiler to assume that all
values are valid (that is, within their declared subtype range)
except in the context of a use of the Valid attribute. This means
the compiler can generate more efficient code, since the range
of values is better known at compile time. However, an uninitialized
variable can cause wild jumps and memory corruption in this mode.
<p>The <samp><span class="option">-gnatV</span><var>x</var></samp> switch allows control over the validity
checking mode as described below.
The <code>x</code> argument is a string of letters that
indicate validity checks that are performed or not performed in addition
to the default checks required by Ada as described above.
<dl>
<!-- !sort! -->
<dt><samp><span class="option">-gnatVa</span></samp><dd><em>All validity checks.</em>
<a name="index-g_t_0040option_007b_002dgnatVa_007d-_0028_0040command_007bgcc_007d_0029-316"></a>All validity checks are turned on.
That is, <samp><span class="option">-gnatVa</span></samp> is
equivalent to <samp><span class="option">gnatVcdfimorst</span></samp>.
<br><dt><samp><span class="option">-gnatVc</span></samp><dd><em>Validity checks for copies.</em>
<a name="index-g_t_0040option_007b_002dgnatVc_007d-_0028_0040command_007bgcc_007d_0029-317"></a>The right hand side of assignments, and the initializing values of
object declarations are validity checked.
<br><dt><samp><span class="option">-gnatVd</span></samp><dd><em>Default (RM) validity checks.</em>
<a name="index-g_t_0040option_007b_002dgnatVd_007d-_0028_0040command_007bgcc_007d_0029-318"></a>Some validity checks are done by default following normal Ada semantics
(RM 13.9.1 (9-11)).
A check is done in case statements that the expression is within the range
of the subtype. If it is not, Constraint_Error is raised.
For assignments to array components, a check is done that the expression used
as index is within the range. If it is not, Constraint_Error is raised.
Both these validity checks may be turned off using switch <samp><span class="option">-gnatVD</span></samp>.
They are turned on by default. If <samp><span class="option">-gnatVD</span></samp> is specified, a subsequent
switch <samp><span class="option">-gnatVd</span></samp> will leave the checks turned on.
Switch <samp><span class="option">-gnatVD</span></samp> should be used only if you are sure that all such
expressions have valid values. If you use this switch and invalid values
are present, then the program is erroneous, and wild jumps or memory
overwriting may occur.
<br><dt><samp><span class="option">-gnatVe</span></samp><dd><em>Validity checks for elementary components.</em>
<a name="index-g_t_0040option_007b_002dgnatVe_007d-_0028_0040command_007bgcc_007d_0029-319"></a>In the absence of this switch, assignments to record or array components are
not validity checked, even if validity checks for assignments generally
(<samp><span class="option">-gnatVc</span></samp>) are turned on. In Ada, assignment of composite values do not
require valid data, but assignment of individual components does. So for
example, there is a difference between copying the elements of an array with a
slice assignment, compared to assigning element by element in a loop. This
switch allows you to turn off validity checking for components, even when they
are assigned component by component.
<br><dt><samp><span class="option">-gnatVf</span></samp><dd><em>Validity checks for floating-point values.</em>
<a name="index-g_t_0040option_007b_002dgnatVf_007d-_0028_0040command_007bgcc_007d_0029-320"></a>In the absence of this switch, validity checking occurs only for discrete
values. If <samp><span class="option">-gnatVf</span></samp> is specified, then validity checking also applies
for floating-point values, and NaNs and infinities are considered invalid,
as well as out of range values for constrained types. Note that this means
that standard IEEE infinity mode is not allowed. The exact contexts
in which floating-point values are checked depends on the setting of other
options. For example,
<samp><span class="option">-gnatVif</span></samp> or
<samp><span class="option">-gnatVfi</span></samp>
(the order does not matter) specifies that floating-point parameters of mode
<code>in</code> should be validity checked.
<br><dt><samp><span class="option">-gnatVi</span></samp><dd><em>Validity checks for </em><code>in</code><em> mode parameters</em>
<a name="index-g_t_0040option_007b_002dgnatVi_007d-_0028_0040command_007bgcc_007d_0029-321"></a>Arguments for parameters of mode <code>in</code> are validity checked in function
and procedure calls at the point of call.
<br><dt><samp><span class="option">-gnatVm</span></samp><dd><em>Validity checks for </em><code>in out</code><em> mode parameters.</em>
<a name="index-g_t_0040option_007b_002dgnatVm_007d-_0028_0040command_007bgcc_007d_0029-322"></a>Arguments for parameters of mode <code>in out</code> are validity checked in
procedure calls at the point of call. The <code>'m'</code> here stands for
modify, since this concerns parameters that can be modified by the call.
Note that there is no specific option to test <code>out</code> parameters,
but any reference within the subprogram will be tested in the usual
manner, and if an invalid value is copied back, any reference to it
will be subject to validity checking.
<br><dt><samp><span class="option">-gnatVn</span></samp><dd><em>No validity checks.</em>
<a name="index-g_t_0040option_007b_002dgnatVn_007d-_0028_0040command_007bgcc_007d_0029-323"></a>This switch turns off all validity checking, including the default checking
for case statements and left hand side subscripts. Note that the use of
the switch <samp><span class="option">-gnatp</span></samp> suppresses all run-time checks, including
validity checks, and thus implies <samp><span class="option">-gnatVn</span></samp>. When this switch
is used, it cancels any other <samp><span class="option">-gnatV</span></samp> previously issued.
<br><dt><samp><span class="option">-gnatVo</span></samp><dd><em>Validity checks for operator and attribute operands.</em>
<a name="index-g_t_0040option_007b_002dgnatVo_007d-_0028_0040command_007bgcc_007d_0029-324"></a>Arguments for predefined operators and attributes are validity checked.
This includes all operators in package <code>Standard</code>,
the shift operators defined as intrinsic in package <code>Interfaces</code>
and operands for attributes such as <code>Pos</code>. Checks are also made
on individual component values for composite comparisons, and on the
expressions in type conversions and qualified expressions. Checks are
also made on explicit ranges using ‘<samp><span class="samp">..</span></samp>’ (e.g. slices, loops etc).
<br><dt><samp><span class="option">-gnatVp</span></samp><dd><em>Validity checks for parameters.</em>
<a name="index-g_t_0040option_007b_002dgnatVp_007d-_0028_0040command_007bgcc_007d_0029-325"></a>This controls the treatment of parameters within a subprogram (as opposed
to <samp><span class="option">-gnatVi</span></samp> and <samp><span class="option">-gnatVm</span></samp> which control validity testing
of parameters on a call. If either of these call options is used, then
normally an assumption is made within a subprogram that the input arguments
have been validity checking at the point of call, and do not need checking
again within a subprogram). If <samp><span class="option">-gnatVp</span></samp> is set, then this assumption
is not made, and parameters are not assumed to be valid, so their validity
will be checked (or rechecked) within the subprogram.
<br><dt><samp><span class="option">-gnatVr</span></samp><dd><em>Validity checks for function returns.</em>
<a name="index-g_t_0040option_007b_002dgnatVr_007d-_0028_0040command_007bgcc_007d_0029-326"></a>The expression in <code>return</code> statements in functions is validity
checked.
<br><dt><samp><span class="option">-gnatVs</span></samp><dd><em>Validity checks for subscripts.</em>
<a name="index-g_t_0040option_007b_002dgnatVs_007d-_0028_0040command_007bgcc_007d_0029-327"></a>All subscripts expressions are checked for validity, whether they appear
on the right side or left side (in default mode only left side subscripts
are validity checked).
<br><dt><samp><span class="option">-gnatVt</span></samp><dd><em>Validity checks for tests.</em>
<a name="index-g_t_0040option_007b_002dgnatVt_007d-_0028_0040command_007bgcc_007d_0029-328"></a>Expressions used as conditions in <code>if</code>, <code>while</code> or <code>exit</code>
statements are checked, as well as guard expressions in entry calls.
</dl>
<p class="noindent">The <samp><span class="option">-gnatV</span></samp> switch may be followed by
a string of letters
to turn on a series of validity checking options.
For example,
<samp><span class="option">-gnatVcr</span></samp>
specifies that in addition to the default validity checking, copies and
function return expressions are to be validity checked.
In order to make it easier
to specify the desired combination of effects,
the upper case letters <code>CDFIMORST</code> may
be used to turn off the corresponding lower case option.
Thus
<samp><span class="option">-gnatVaM</span></samp>
turns on all validity checking options except for
checking of <b>in out</b> procedure arguments.
<p>The specification of additional validity checking generates extra code (and
in the case of <samp><span class="option">-gnatVa</span></samp> the code expansion can be substantial).
However, these additional checks can be very useful in detecting
uninitialized variables, incorrect use of unchecked conversion, and other
errors leading to invalid values. The use of pragma <code>Initialize_Scalars</code>
is useful in conjunction with the extra validity checking, since this
ensures that wherever possible uninitialized variables have invalid values.
<p>See also the pragma <code>Validity_Checks</code> which allows modification of
the validity checking mode at the program source level, and also allows for
temporary disabling of validity checks.
<div class="node">
<a name="Style-Checking"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Run_002dTime-Checks">Run-Time Checks</a>,
Previous: <a rel="previous" accesskey="p" href="#Validity-Checking">Validity Checking</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gcc">Switches for gcc</a>
</div>
<h4 class="subsection">3.2.5 Style Checking</h4>
<p><a name="index-Style-checking-329"></a>
The <samp><span class="option">-gnatyx</span></samp> switch
<a name="index-g_t_0040option_007b_002dgnaty_007d-_0028_0040command_007bgcc_007d_0029-330"></a>causes the compiler to
enforce specified style rules. A limited set of style rules has been used
in writing the GNAT sources themselves. This switch allows user programs
to activate all or some of these checks. If the source program fails a
specified style check, an appropriate message is given, preceded by
the character sequence “(style)”. This message does not prevent
successful compilation (unless the <samp><span class="option">-gnatwe</span></samp> switch is used).
<p>Note that this is by no means intended to be a general facility for
checking arbitrary coding standards. It is simply an embedding of the
style rules we have chosen for the GNAT sources. If you are starting
a project which does not have established style standards, you may
find it useful to adopt the entire set of GNAT coding standards, or
some subset of them. If you already have an established set of coding
standards, then it may be that selected style checking options do
indeed correspond to choices you have made, but for general checking
of an existing set of coding rules, you should look to the gnatcheck
tool, which is designed for that purpose.
<p>The string <var>x</var> is a sequence of letters or digits
indicating the particular style
checks to be performed. The following checks are defined:
<dl>
<!-- !sort! -->
<dt><samp><span class="option">0-9</span></samp><dd><em>Specify indentation level.</em>
If a digit from 1-9 appears
in the string after <samp><span class="option">-gnaty</span></samp>
then proper indentation is checked, with the digit indicating the
indentation level required. A value of zero turns off this style check.
The general style of required indentation is as specified by
the examples in the Ada Reference Manual. Full line comments must be
aligned with the <code>--</code> starting on a column that is a multiple of
the alignment level, or they may be aligned the same way as the following
non-blank line (this is useful when full line comments appear in the middle
of a statement.
<br><dt><samp><span class="option">a</span></samp><dd><em>Check attribute casing.</em>
Attribute names, including the case of keywords such as <code>digits</code>
used as attributes names, must be written in mixed case, that is, the
initial letter and any letter following an underscore must be uppercase.
All other letters must be lowercase.
<br><dt><samp><span class="option">A</span></samp><dd><em>Use of array index numbers in array attributes.</em>
When using the array attributes First, Last, Range,
or Length, the index number must be omitted for one-dimensional arrays
and is required for multi-dimensional arrays.
<br><dt><samp><span class="option">b</span></samp><dd><em>Blanks not allowed at statement end.</em>
Trailing blanks are not allowed at the end of statements. The purpose of this
rule, together with h (no horizontal tabs), is to enforce a canonical format
for the use of blanks to separate source tokens.
<br><dt><samp><span class="option">B</span></samp><dd><em>Check Boolean operators.</em>
The use of AND/OR operators is not permitted except in the cases of modular
operands, array operands, and simple stand-alone boolean variables or
boolean constants. In all other cases AND THEN/OR ELSE are required.
<br><dt><samp><span class="option">c</span></samp><dd><em>Check comments.</em>
Comments must meet the following set of rules:
<ul>
<li>The “<code>--</code>” that starts the column must either start in column one,
or else at least one blank must precede this sequence.
<li>Comments that follow other tokens on a line must have at least one blank
following the “<code>--</code>” at the start of the comment.
<li>Full line comments must have at least two blanks following the
“<code>--</code>” that starts the comment, with the following exceptions.
<li>A line consisting only of the “<code>--</code>” characters, possibly preceded
by blanks is permitted.
<li>A comment starting with “<code>--x</code>” where <code>x</code> is a special character
is permitted.
This allows proper processing of the output generated by specialized tools
including <samp><span class="command">gnatprep</span></samp> (where “<code>--!</code>” is used) and the SPARK
annotation
language (where “<code>--#</code>” is used). For the purposes of this rule, a
special character is defined as being in one of the ASCII ranges
<code>16#21#...16#2F#</code> or <code>16#3A#...16#3F#</code>.
Note that this usage is not permitted
in GNAT implementation units (i.e., when <samp><span class="option">-gnatg</span></samp> is used).
<li>A line consisting entirely of minus signs, possibly preceded by blanks, is
permitted. This allows the construction of box comments where lines of minus
signs are used to form the top and bottom of the box.
<li>A comment that starts and ends with “<code>--</code>” is permitted as long as at
least one blank follows the initial “<code>--</code>”. Together with the preceding
rule, this allows the construction of box comments, as shown in the following
example:
<pre class="smallexample"> ---------------------------
-- This is a box comment --
-- with two text lines. --
---------------------------
</pre>
</ul>
<br><dt><samp><span class="option">d</span></samp><dd><em>Check no DOS line terminators present.</em>
All lines must be terminated by a single ASCII.LF
character (in particular the DOS line terminator sequence CR/LF is not
allowed).
<br><dt><samp><span class="option">e</span></samp><dd><em>Check end/exit labels.</em>
Optional labels on <code>end</code> statements ending subprograms and on
<code>exit</code> statements exiting named loops, are required to be present.
<br><dt><samp><span class="option">f</span></samp><dd><em>No form feeds or vertical tabs.</em>
Neither form feeds nor vertical tab characters are permitted
in the source text.
<br><dt><samp><span class="option">g</span></samp><dd><em>GNAT style mode</em>
The set of style check switches is set to match that used by the GNAT sources.
This may be useful when developing code that is eventually intended to be
incorporated into GNAT. For further details, see GNAT sources.
<br><dt><samp><span class="option">h</span></samp><dd><em>No horizontal tabs.</em>
Horizontal tab characters are not permitted in the source text.
Together with the b (no blanks at end of line) check, this
enforces a canonical form for the use of blanks to separate
source tokens.
<br><dt><samp><span class="option">i</span></samp><dd><em>Check if-then layout.</em>
The keyword <code>then</code> must appear either on the same
line as corresponding <code>if</code>, or on a line on its own, lined
up under the <code>if</code> with at least one non-blank line in between
containing all or part of the condition to be tested.
<br><dt><samp><span class="option">I</span></samp><dd><em>check mode IN keywords</em>
Mode <code>in</code> (the default mode) is not
allowed to be given explicitly. <code>in out</code> is fine,
but not <code>in</code> on its own.
<br><dt><samp><span class="option">k</span></samp><dd><em>Check keyword casing.</em>
All keywords must be in lower case (with the exception of keywords
such as <code>digits</code> used as attribute names to which this check
does not apply).
<br><dt><samp><span class="option">l</span></samp><dd><em>Check layout.</em>
Layout of statement and declaration constructs must follow the
recommendations in the Ada Reference Manual, as indicated by the
form of the syntax rules. For example an <code>else</code> keyword must
be lined up with the corresponding <code>if</code> keyword.
<p>There are two respects in which the style rule enforced by this check
option are more liberal than those in the Ada Reference Manual. First
in the case of record declarations, it is permissible to put the
<code>record</code> keyword on the same line as the <code>type</code> keyword, and
then the <code>end</code> in <code>end record</code> must line up under <code>type</code>.
This is also permitted when the type declaration is split on two lines.
For example, any of the following three layouts is acceptable:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
type q is record
a : integer;
b : integer;
end record;
type q is
record
a : integer;
b : integer;
end record;
type q is
record
a : integer;
b : integer;
end record;
</td></tr></table>
</pre>
<p class="noindent">Second, in the case of a block statement, a permitted alternative
is to put the block label on the same line as the <code>declare</code> or
<code>begin</code> keyword, and then line the <code>end</code> keyword up under
the block label. For example both the following are permitted:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
Block : declare
A : Integer := 3;
begin
Proc (A, A);
end Block;
Block :
declare
A : Integer := 3;
begin
Proc (A, A);
end Block;
</td></tr></table>
</pre>
<p class="noindent">The same alternative format is allowed for loops. For example, both of
the following are permitted:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
Clear : while J < 10 loop
A (J) := 0;
end loop Clear;
Clear :
while J < 10 loop
A (J) := 0;
end loop Clear;
</td></tr></table>
</pre>
<br><dt><samp><span class="option">Lnnn</span></samp><dd><em>Set maximum nesting level</em>
The maximum level of nesting of constructs (including subprograms, loops,
blocks, packages, and conditionals) may not exceed the given value
<samp><span class="option">nnn</span></samp>. A value of zero disconnects this style check.
<br><dt><samp><span class="option">m</span></samp><dd><em>Check maximum line length.</em>
The length of source lines must not exceed 79 characters, including
any trailing blanks. The value of 79 allows convenient display on an
80 character wide device or window, allowing for possible special
treatment of 80 character lines. Note that this count is of
characters in the source text. This means that a tab character counts
as one character in this count but a wide character sequence counts as
a single character (however many bytes are needed in the encoding).
<br><dt><samp><span class="option">Mnnn</span></samp><dd><em>Set maximum line length.</em>
The length of lines must not exceed the
given value <samp><span class="option">nnn</span></samp>. The maximum value that can be specified is 32767.
<br><dt><samp><span class="option">n</span></samp><dd><em>Check casing of entities in Standard.</em>
Any identifier from Standard must be cased
to match the presentation in the Ada Reference Manual (for example,
<code>Integer</code> and <code>ASCII.NUL</code>).
<br><dt><samp><span class="option">N</span></samp><dd><em>Turn off all style checks</em>
All style check options are turned off.
<br><dt><samp><span class="option">o</span></samp><dd><em>Check order of subprogram bodies.</em>
All subprogram bodies in a given scope
(e.g. a package body) must be in alphabetical order. The ordering
rule uses normal Ada rules for comparing strings, ignoring casing
of letters, except that if there is a trailing numeric suffix, then
the value of this suffix is used in the ordering (e.g. Junk2 comes
before Junk10).
<br><dt><samp><span class="option">O</span></samp><dd><em>Check that overriding subprograms are explicitly marked as such.</em>
The declaration of a primitive operation of a type extension that overrides
an inherited operation must carry an overriding indicator.
<br><dt><samp><span class="option">p</span></samp><dd><em>Check pragma casing.</em>
Pragma names must be written in mixed case, that is, the
initial letter and any letter following an underscore must be uppercase.
All other letters must be lowercase.
<br><dt><samp><span class="option">r</span></samp><dd><em>Check references.</em>
All identifier references must be cased in the same way as the
corresponding declaration. No specific casing style is imposed on
identifiers. The only requirement is for consistency of references
with declarations.
<br><dt><samp><span class="option">S</span></samp><dd><em>Check no statements after THEN/ELSE.</em>
No statements are allowed
on the same line as a THEN or ELSE keyword following the
keyword in an IF statement. OR ELSE and AND THEN are not affected,
and a special exception allows a pragma to appear after ELSE.
<br><dt><samp><span class="option">s</span></samp><dd><em>Check separate specs.</em>
Separate declarations (“specs”) are required for subprograms (a
body is not allowed to serve as its own declaration). The only
exception is that parameterless library level procedures are
not required to have a separate declaration. This exception covers
the most frequent form of main program procedures.
<br><dt><samp><span class="option">t</span></samp><dd><em>Check token spacing.</em>
The following token spacing rules are enforced:
<ul>
<li>The keywords <b>abs</b> and <b>not</b> must be followed by a space.
<li>The token <code>=></code> must be surrounded by spaces.
<li>The token <code><></code> must be preceded by a space or a left parenthesis.
<li>Binary operators other than <code>**</code> must be surrounded by spaces.
There is no restriction on the layout of the <code>**</code> binary operator.
<li>Colon must be surrounded by spaces.
<li>Colon-equal (assignment, initialization) must be surrounded by spaces.
<li>Comma must be the first non-blank character on the line, or be
immediately preceded by a non-blank character, and must be followed
by a space.
<li>If the token preceding a left parenthesis ends with a letter or digit, then
a space must separate the two tokens.
<li>if the token following a right parenthesis starts with a letter or digit, then
a space must separate the two tokens.
<li>A right parenthesis must either be the first non-blank character on
a line, or it must be preceded by a non-blank character.
<li>A semicolon must not be preceded by a space, and must not be followed by
a non-blank character.
<li>A unary plus or minus may not be followed by a space.
<li>A vertical bar must be surrounded by spaces.
</ul>
<br><dt><samp><span class="option">u</span></samp><dd><em>Check unnecessary blank lines.</em>
Unnecessary blank lines are not allowed. A blank line is considered
unnecessary if it appears at the end of the file, or if more than
one blank line occurs in sequence.
<br><dt><samp><span class="option">x</span></samp><dd><em>Check extra parentheses.</em>
Unnecessary extra level of parentheses (C-style) are not allowed
around conditions in <code>if</code> statements, <code>while</code> statements and
<code>exit</code> statements.
<br><dt><samp><span class="option">y</span></samp><dd><em>Set all standard style check options</em>
This is equivalent to <code>gnaty3aAbcefhiklmnprst</code>, that is all checking
options enabled with the exception of <samp><span class="option">-gnatyo</span></samp>, <samp><span class="option">-gnatyI</span></samp>,
<samp><span class="option">-gnatyS</span></samp>, <samp><span class="option">-gnatyLnnn</span></samp>,
<samp><span class="option">-gnatyd</span></samp>, <samp><span class="option">-gnatyu</span></samp>, and <samp><span class="option">-gnatyx</span></samp>.
<br><dt><samp><span class="option">-</span></samp><dd><em>Remove style check options</em>
This causes any subsequent options in the string to act as canceling the
corresponding style check option. To cancel maximum nesting level control,
use <samp><span class="option">L</span></samp> parameter witout any integer value after that, because any
digit following <samp><span class="option">-</span></samp> in the parameter string of the <samp><span class="option">-gnaty</span></samp>
option will be threated as canceling indentation check. The same is true
for <samp><span class="option">M</span></samp> parameter. <samp><span class="option">y</span></samp> and <samp><span class="option">N</span></samp> parameters are not
allowed after <samp><span class="option">-</span></samp>.
<br><dt><samp><span class="option">+</span></samp><dd>This causes any subsequent options in the string to enable the corresponding
style check option. That is, it cancels the effect of a previous -,
if any.
</dl>
<p class="noindent">In the above rules, appearing in column one is always permitted, that is,
counts as meeting either a requirement for a required preceding space,
or as meeting a requirement for no preceding space.
<p>Appearing at the end of a line is also always permitted, that is, counts
as meeting either a requirement for a following space, or as meeting
a requirement for no following space.
<p class="noindent">If any of these style rules is violated, a message is generated giving
details on the violation. The initial characters of such messages are
always “<code>(style)</code>”. Note that these messages are treated as warning
messages, so they normally do not prevent the generation of an object
file. The <samp><span class="option">-gnatwe</span></samp> switch can be used to treat warning messages,
including style messages, as fatal errors.
<p>The switch
<samp><span class="option">-gnaty</span></samp> on its own (that is not
followed by any letters or digits), then the effect is equivalent
to the use of <samp><span class="option">-gnatyy</span></samp>, as described above, that is all
built-in standard style check options are enabled.
<p>The switch
<samp><span class="option">-gnatyN</span></samp>
clears any previously set style checks.
<div class="node">
<a name="Run-Time-Checks"></a>
<a name="Run_002dTime-Checks"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Using-gcc-for-Syntax-Checking">Using gcc for Syntax Checking</a>,
Previous: <a rel="previous" accesskey="p" href="#Style-Checking">Style Checking</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gcc">Switches for gcc</a>
</div>
<h4 class="subsection">3.2.6 Run-Time Checks</h4>
<p><a name="index-Division-by-zero-331"></a><a name="index-Access-before-elaboration-332"></a><a name="index-Checks_002c-division-by-zero-333"></a><a name="index-Checks_002c-access-before-elaboration-334"></a><a name="index-Checks_002c-stack-overflow-checking-335"></a>
By default, the following checks are suppressed: integer overflow
checks, stack overflow checks, and checks for access before
elaboration on subprogram calls. All other checks, including range
checks and array bounds checks, are turned on by default. The
following <samp><span class="command">gcc</span></samp> switches refine this default behavior.
<dl>
<!-- !sort! -->
<dt><samp><span class="option">-gnatp</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatp_007d-_0028_0040command_007bgcc_007d_0029-336"></a><a name="index-Suppressing-checks-337"></a><a name="index-Checks_002c-suppressing-338"></a><a name="index-Suppress-339"></a>This switch causes the unit to be compiled
as though <code>pragma Suppress (All_checks)</code>
had been present in the source. Validity checks are also eliminated (in
other words <samp><span class="option">-gnatp</span></samp> also implies <samp><span class="option">-gnatVn</span></samp>.
Use this switch to improve the performance
of the code at the expense of safety in the presence of invalid data or
program bugs.
<p>Note that when checks are suppressed, the compiler is allowed, but not
required, to omit the checking code. If the run-time cost of the
checking code is zero or near-zero, the compiler will generate it even
if checks are suppressed. In particular, if the compiler can prove
that a certain check will necessarily fail, it will generate code to
do an unconditional “raise”, even if checks are suppressed. The
compiler warns in this case. Another case in which checks may not be
eliminated is when they are embedded in certain run time routines such
as math library routines.
<p>Of course, run-time checks are omitted whenever the compiler can prove
that they will not fail, whether or not checks are suppressed.
<p>Note that if you suppress a check that would have failed, program
execution is erroneous, which means the behavior is totally
unpredictable. The program might crash, or print wrong answers, or
do anything else. It might even do exactly what you wanted it to do
(and then it might start failing mysteriously next week or next
year). The compiler will generate code based on the assumption that
the condition being checked is true, which can result in disaster if
that assumption is wrong.
<p>The <samp><span class="option">-gnatp</span></samp> switch has no effect if a subsequent
<samp><span class="option">-gnat-p</span></samp> switch appears.
<br><dt><samp><span class="option">-gnat-p</span></samp><dd><a name="index-g_t_0040option_007b_002dgnat_002dp_007d-_0028_0040command_007bgcc_007d_0029-340"></a><a name="index-Suppressing-checks-341"></a><a name="index-Checks_002c-suppressing-342"></a><a name="index-Suppress-343"></a>This switch cancels the effect of a previous <samp><span class="option">gnatp</span></samp> switch.
<br><dt><samp><span class="option">-gnato</span></samp><dd><a name="index-g_t_0040option_007b_002dgnato_007d-_0028_0040command_007bgcc_007d_0029-344"></a><a name="index-Overflow-checks-345"></a><a name="index-Check_002c-overflow-346"></a>Enables overflow checking for integer operations.
This causes GNAT to generate slower and larger executable
programs by adding code to check for overflow (resulting in raising
<code>Constraint_Error</code> as required by standard Ada
semantics). These overflow checks correspond to situations in which
the true value of the result of an operation may be outside the base
range of the result type. The following example shows the distinction:
<pre class="smallexample"> X1 : Integer := "Integer'Last";
X2 : Integer range 1 .. 5 := "5";
X3 : Integer := "Integer'Last";
X4 : Integer range 1 .. 5 := "5";
F : Float := "2.0E+20";
...
X1 := X1 + 1;
X2 := X2 + 1;
X3 := Integer (F);
X4 := Integer (F);
</pre>
<p class="noindent">Note that if explicit values are assigned at compile time, the
compiler may be able to detect overflow at compile time, in which case
no actual run-time checking code is required, and Constraint_Error
will be raised unconditionally, with or without
<samp><span class="option">-gnato</span></samp>. That's why the assigned values in the above fragment
are in quotes, the meaning is "assign a value not known to the
compiler that happens to be equal to ...". The remaining discussion
assumes that the compiler cannot detect the values at compile time.
<p>Here the first addition results in a value that is outside the base range
of Integer, and hence requires an overflow check for detection of the
constraint error. Thus the first assignment to <code>X1</code> raises a
<code>Constraint_Error</code> exception only if <samp><span class="option">-gnato</span></samp> is set.
<p>The second increment operation results in a violation of the explicit
range constraint; such range checks are performed by default, and are
unaffected by <samp><span class="option">-gnato</span></samp>.
<p>The two conversions of <code>F</code> both result in values that are outside
the base range of type <code>Integer</code> and thus will raise
<code>Constraint_Error</code> exceptions only if <samp><span class="option">-gnato</span></samp> is used.
The fact that the result of the second conversion is assigned to
variable <code>X4</code> with a restricted range is irrelevant, since the problem
is in the conversion, not the assignment.
<p>Basically the rule is that in the default mode (<samp><span class="option">-gnato</span></samp> not
used), the generated code assures that all integer variables stay
within their declared ranges, or within the base range if there is
no declared range. This prevents any serious problems like indexes
out of range for array operations.
<p>What is not checked in default mode is an overflow that results in
an in-range, but incorrect value. In the above example, the assignments
to <code>X1</code>, <code>X2</code>, <code>X3</code> all give results that are within the
range of the target variable, but the result is wrong in the sense that
it is too large to be represented correctly. Typically the assignment
to <code>X1</code> will result in wrap around to the largest negative number.
The conversions of <code>F</code> will result in some <code>Integer</code> value
and if that integer value is out of the <code>X4</code> range then the
subsequent assignment would generate an exception.
<p><a name="index-Machine_005fOverflows-347"></a>Note that the <samp><span class="option">-gnato</span></samp> switch does not affect the code generated
for any floating-point operations; it applies only to integer
semantics).
For floating-point, GNAT has the <code>Machine_Overflows</code>
attribute set to <code>False</code> and the normal mode of operation is to
generate IEEE NaN and infinite values on overflow or invalid operations
(such as dividing 0.0 by 0.0).
<p>The reason that we distinguish overflow checking from other kinds of
range constraint checking is that a failure of an overflow check, unlike
for example the failure of a range check, can result in an incorrect
value, but cannot cause random memory destruction (like an out of range
subscript), or a wild jump (from an out of range case value). Overflow
checking is also quite expensive in time and space, since in general it
requires the use of double length arithmetic.
<p>Note again that <samp><span class="option">-gnato</span></samp> is off by default, so overflow checking is
not performed in default mode. This means that out of the box, with the
default settings, GNAT does not do all the checks expected from the
language description in the Ada Reference Manual. If you want all constraint
checks to be performed, as described in this Manual, then you must
explicitly use the -gnato switch either on the <samp><span class="command">gnatmake</span></samp> or
<samp><span class="command">gcc</span></samp> command.
<br><dt><samp><span class="option">-gnatE</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatE_007d-_0028_0040command_007bgcc_007d_0029-348"></a><a name="index-Elaboration-checks-349"></a><a name="index-Check_002c-elaboration-350"></a>Enables dynamic checks for access-before-elaboration
on subprogram calls and generic instantiations.
Note that <samp><span class="option">-gnatE</span></samp> is not necessary for safety, because in the
default mode, GNAT ensures statically that the checks would not fail.
For full details of the effect and use of this switch,
See <a href="#Compiling-Using-gcc">Compiling Using gcc</a>.
<br><dt><samp><span class="option">-fstack-check</span></samp><dd><a name="index-g_t_0040option_007b_002dfstack_002dcheck_007d-_0028_0040command_007bgcc_007d_0029-351"></a><a name="index-Stack-Overflow-Checking-352"></a><a name="index-Checks_002c-stack-overflow-checking-353"></a>Activates stack overflow checking. For full details of the effect and use of
this switch see <a href="#Stack-Overflow-Checking">Stack Overflow Checking</a>.
</dl>
<p><a name="index-Unsuppress-354"></a>The setting of these switches only controls the default setting of the
checks. You may modify them using either <code>Suppress</code> (to remove
checks) or <code>Unsuppress</code> (to add back suppressed checks) pragmas in
the program source.
<div class="node">
<a name="Using-gcc-for-Syntax-Checking"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Using-gcc-for-Semantic-Checking">Using gcc for Semantic Checking</a>,
Previous: <a rel="previous" accesskey="p" href="#Run_002dTime-Checks">Run-Time Checks</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gcc">Switches for gcc</a>
</div>
<h4 class="subsection">3.2.7 Using <samp><span class="command">gcc</span></samp> for Syntax Checking</h4>
<dl>
<dt><samp><span class="option">-gnats</span></samp><dd><a name="index-g_t_0040option_007b_002dgnats_007d-_0028_0040command_007bgcc_007d_0029-355"></a>
The <code>s</code> stands for “syntax”.
<p>Run GNAT in syntax checking only mode. For
example, the command
<pre class="smallexample"> $ gcc -c -gnats x.adb
</pre>
<p class="noindent">compiles file <samp><span class="file">x.adb</span></samp> in syntax-check-only mode. You can check a
series of files in a single command
, and can use wild cards to specify such a group of files.
Note that you must specify the <samp><span class="option">-c</span></samp> (compile
only) flag in addition to the <samp><span class="option">-gnats</span></samp> flag.
.
You may use other switches in conjunction with <samp><span class="option">-gnats</span></samp>. In
particular, <samp><span class="option">-gnatl</span></samp> and <samp><span class="option">-gnatv</span></samp> are useful to control the
format of any generated error messages.
<p>When the source file is empty or contains only empty lines and/or comments,
the output is a warning:
<pre class="smallexample"> $ gcc -c -gnats -x ada toto.txt
toto.txt:1:01: warning: empty file, contains no compilation units
$
</pre>
<p>Otherwise, the output is simply the error messages, if any. No object file or
ALI file is generated by a syntax-only compilation. Also, no units other
than the one specified are accessed. For example, if a unit <code>X</code>
<code>with</code>'s a unit <code>Y</code>, compiling unit <code>X</code> in syntax
check only mode does not access the source file containing unit
<code>Y</code>.
<p><a name="index-Multiple-units_002c-syntax-checking-356"></a>Normally, GNAT allows only a single unit in a source file. However, this
restriction does not apply in syntax-check-only mode, and it is possible
to check a file containing multiple compilation units concatenated
together. This is primarily used by the <code>gnatchop</code> utility
(see <a href="#Renaming-Files-Using-gnatchop">Renaming Files Using gnatchop</a>).
</dl>
<div class="node">
<a name="Using-gcc-for-Semantic-Checking"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Compiling-Different-Versions-of-Ada">Compiling Different Versions of Ada</a>,
Previous: <a rel="previous" accesskey="p" href="#Using-gcc-for-Syntax-Checking">Using gcc for Syntax Checking</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gcc">Switches for gcc</a>
</div>
<h4 class="subsection">3.2.8 Using <samp><span class="command">gcc</span></samp> for Semantic Checking</h4>
<dl>
<dt><samp><span class="option">-gnatc</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatc_007d-_0028_0040command_007bgcc_007d_0029-357"></a>
The <code>c</code> stands for “check”.
Causes the compiler to operate in semantic check mode,
with full checking for all illegalities specified in the
Ada Reference Manual, but without generation of any object code
(no object file is generated).
<p>Because dependent files must be accessed, you must follow the GNAT
semantic restrictions on file structuring to operate in this mode:
<ul>
<li>The needed source files must be accessible
(see <a href="#Search-Paths-and-the-Run_002dTime-Library-_0028RTL_0029">Search Paths and the Run-Time Library (RTL)</a>).
<li>Each file must contain only one compilation unit.
<li>The file name and unit name must match (see <a href="#File-Naming-Rules">File Naming Rules</a>).
</ul>
<p>The output consists of error messages as appropriate. No object file is
generated. An <samp><span class="file">ALI</span></samp> file is generated for use in the context of
cross-reference tools, but this file is marked as not being suitable
for binding (since no object file is generated).
The checking corresponds exactly to the notion of
legality in the Ada Reference Manual.
<p>Any unit can be compiled in semantics-checking-only mode, including
units that would not normally be compiled (subunits,
and specifications where a separate body is present).
</dl>
<div class="node">
<a name="Compiling-Different-Versions-of-Ada"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Character-Set-Control">Character Set Control</a>,
Previous: <a rel="previous" accesskey="p" href="#Using-gcc-for-Semantic-Checking">Using gcc for Semantic Checking</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gcc">Switches for gcc</a>
</div>
<h4 class="subsection">3.2.9 Compiling Different Versions of Ada</h4>
<p class="noindent">The switches described in this section allow you to explicitly specify
the version of the Ada language that your programs are written in.
By default GNAT assumes Ada 2005,
but you can also specify Ada 95 or
indicate Ada 83 compatibility mode.
<a name="index-Compatibility-with-Ada-83-358"></a>
<dl>
<dt><samp><span class="option">-gnat83 (Ada 83 Compatibility Mode)</span></samp><dd><a name="index-g_t_0040option_007b_002dgnat83_007d-_0028_0040command_007bgcc_007d_0029-359"></a><a name="index-ACVC_002c-Ada-83-tests-360"></a><a name="index-Ada-83-mode-361"></a>
Although GNAT is primarily an Ada 95 / Ada 2005 compiler, this switch
specifies that the program is to be compiled in Ada 83 mode. With
<samp><span class="option">-gnat83</span></samp>, GNAT rejects most post-Ada 83 extensions and applies Ada 83
semantics where this can be done easily.
It is not possible to guarantee this switch does a perfect
job; some subtle tests, such as are
found in earlier ACVC tests (and that have been removed from the ACATS suite
for Ada 95), might not compile correctly.
Nevertheless, this switch may be useful in some circumstances, for example
where, due to contractual reasons, existing code needs to be maintained
using only Ada 83 features.
<p>With few exceptions (most notably the need to use <code><></code> on
<a name="index-Generic-formal-parameters-362"></a>unconstrained generic formal parameters, the use of the new Ada 95 / Ada 2005
reserved words, and the use of packages
with optional bodies), it is not necessary to specify the
<samp><span class="option">-gnat83</span></samp> switch when compiling Ada 83 programs, because, with rare
exceptions, Ada 95 and Ada 2005 are upwardly compatible with Ada 83. Thus
a correct Ada 83 program is usually also a correct program
in these later versions of the language standard.
For further information, please refer to <a href="#Compatibility-and-Porting-Guide">Compatibility and Porting Guide</a>.
<br><dt><samp><span class="option">-gnat95 (Ada 95 mode)</span></samp><dd><a name="index-g_t_0040option_007b_002dgnat95_007d-_0028_0040command_007bgcc_007d_0029-363"></a><a name="index-Ada-95-mode-364"></a>
This switch directs the compiler to implement the Ada 95 version of the
language.
Since Ada 95 is almost completely upwards
compatible with Ada 83, Ada 83 programs may generally be compiled using
this switch (see the description of the <samp><span class="option">-gnat83</span></samp> switch for further
information about Ada 83 mode).
If an Ada 2005 program is compiled in Ada 95 mode,
uses of the new Ada 2005 features will cause error
messages or warnings.
<p>This switch also can be used to cancel the effect of a previous
<samp><span class="option">-gnat83</span></samp>, <samp><span class="option">-gnat05/2005</span></samp>, or <samp><span class="option">-gnat12/2012</span></samp>
switch earlier in the command line.
<br><dt><samp><span class="option">-gnat05 or -gnat2005 (Ada 2005 mode)</span></samp><dd><a name="index-g_t_0040option_007b_002dgnat05_007d-_0028_0040command_007bgcc_007d_0029-365"></a><a name="index-g_t_0040option_007b_002dgnat2005_007d-_0028_0040command_007bgcc_007d_0029-366"></a><a name="index-Ada-2005-mode-367"></a>
This switch directs the compiler to implement the Ada 2005 version of the
language, as documented in the official Ada standards document.
Since Ada 2005 is almost completely upwards
compatible with Ada 95 (and thus also with Ada 83), Ada 83 and Ada 95 programs
may generally be compiled using this switch (see the description of the
<samp><span class="option">-gnat83</span></samp> and <samp><span class="option">-gnat95</span></samp> switches for further
information).
<br><dt><samp><span class="option">-gnat12 or -gnat2012 (Ada 2012 mode)</span></samp><dd><a name="index-g_t_0040option_007b_002dgnat12_007d-_0028_0040command_007bgcc_007d_0029-368"></a><a name="index-g_t_0040option_007b_002dgnat2012_007d-_0028_0040command_007bgcc_007d_0029-369"></a><a name="index-Ada-2012-mode-370"></a>
This switch directs the compiler to implement the Ada 2012 version of the
language.
Since Ada 2012 is almost completely upwards
compatible with Ada 2005 (and thus also with Ada 83, and Ada 95),
Ada 83 and Ada 95 programs
may generally be compiled using this switch (see the description of the
<samp><span class="option">-gnat83</span></samp>, <samp><span class="option">-gnat95</span></samp>, and <samp><span class="option">-gnat05/2005</span></samp> switches
for further information).
<p>For information about the approved “Ada Issues” that have been incorporated
into Ada 2012, see <a href="http://www.ada-auth.org/ais.html">http://www.ada-auth.org/ais.html</a>.
Included with GNAT releases is a file <samp><span class="file">features-ada12</span></samp> that describes
the set of implemented Ada 2012 features.
<br><dt><samp><span class="option">-gnatX (Enable GNAT Extensions)</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatX_007d-_0028_0040command_007bgcc_007d_0029-371"></a><a name="index-Ada-language-extensions-372"></a><a name="index-GNAT-extensions-373"></a>
This switch directs the compiler to implement the latest version of the
language (currently Ada 2012) and also to enable certain GNAT implementation
extensions that are not part of any Ada standard. For a full list of these
extensions, see the GNAT reference manual.
</dl>
<div class="node">
<a name="Character-Set-Control"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#File-Naming-Control">File Naming Control</a>,
Previous: <a rel="previous" accesskey="p" href="#Compiling-Different-Versions-of-Ada">Compiling Different Versions of Ada</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gcc">Switches for gcc</a>
</div>
<h4 class="subsection">3.2.10 Character Set Control</h4>
<dl>
<dt><samp><span class="option">-gnati</span><var>c</var></samp><dd><a name="index-g_t_0040option_007b_002dgnati_007d-_0028_0040command_007bgcc_007d_0029-374"></a>
Normally GNAT recognizes the Latin-1 character set in source program
identifiers, as described in the Ada Reference Manual.
This switch causes
GNAT to recognize alternate character sets in identifiers. <var>c</var> is a
single character indicating the character set, as follows:
<dl>
<dt><code>1</code><dd>ISO 8859-1 (Latin-1) identifiers
<br><dt><code>2</code><dd>ISO 8859-2 (Latin-2) letters allowed in identifiers
<br><dt><code>3</code><dd>ISO 8859-3 (Latin-3) letters allowed in identifiers
<br><dt><code>4</code><dd>ISO 8859-4 (Latin-4) letters allowed in identifiers
<br><dt><code>5</code><dd>ISO 8859-5 (Cyrillic) letters allowed in identifiers
<br><dt><code>9</code><dd>ISO 8859-15 (Latin-9) letters allowed in identifiers
<br><dt><code>p</code><dd>IBM PC letters (code page 437) allowed in identifiers
<br><dt><code>8</code><dd>IBM PC letters (code page 850) allowed in identifiers
<br><dt><code>f</code><dd>Full upper-half codes allowed in identifiers
<br><dt><code>n</code><dd>No upper-half codes allowed in identifiers
<br><dt><code>w</code><dd>Wide-character codes (that is, codes greater than 255)
allowed in identifiers
</dl>
<p>See <a href="#Foreign-Language-Representation">Foreign Language Representation</a>, for full details on the
implementation of these character sets.
<br><dt><samp><span class="option">-gnatW</span><var>e</var></samp><dd><a name="index-g_t_0040option_007b_002dgnatW_007d-_0028_0040command_007bgcc_007d_0029-375"></a>Specify the method of encoding for wide characters.
<var>e</var> is one of the following:
<dl>
<dt><code>h</code><dd>Hex encoding (brackets coding also recognized)
<br><dt><code>u</code><dd>Upper half encoding (brackets encoding also recognized)
<br><dt><code>s</code><dd>Shift/JIS encoding (brackets encoding also recognized)
<br><dt><code>e</code><dd>EUC encoding (brackets encoding also recognized)
<br><dt><code>8</code><dd>UTF-8 encoding (brackets encoding also recognized)
<br><dt><code>b</code><dd>Brackets encoding only (default value)
</dl>
For full details on these encoding
methods see <a href="#Wide-Character-Encodings">Wide Character Encodings</a>.
Note that brackets coding is always accepted, even if one of the other
options is specified, so for example <samp><span class="option">-gnatW8</span></samp> specifies that both
brackets and UTF-8 encodings will be recognized. The units that are
with'ed directly or indirectly will be scanned using the specified
representation scheme, and so if one of the non-brackets scheme is
used, it must be used consistently throughout the program. However,
since brackets encoding is always recognized, it may be conveniently
used in standard libraries, allowing these libraries to be used with
any of the available coding schemes.
scheme.
<p>If no <samp><span class="option">-gnatW?</span></samp> parameter is present, then the default
representation is normally Brackets encoding only. However, if the
first three characters of the file are 16#EF# 16#BB# 16#BF# (the standard
byte order mark or BOM for UTF-8), then these three characters are
skipped and the default representation for the file is set to UTF-8.
<p>Note that the wide character representation that is specified (explicitly
or by default) for the main program also acts as the default encoding used
for Wide_Text_IO files if not specifically overridden by a WCEM form
parameter.
</dl>
<div class="node">
<a name="File-Naming-Control"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Subprogram-Inlining-Control">Subprogram Inlining Control</a>,
Previous: <a rel="previous" accesskey="p" href="#Character-Set-Control">Character Set Control</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gcc">Switches for gcc</a>
</div>
<h4 class="subsection">3.2.11 File Naming Control</h4>
<dl>
<dt><samp><span class="option">-gnatk</span><var>n</var></samp><dd><a name="index-g_t_0040option_007b_002dgnatk_007d-_0028_0040command_007bgcc_007d_0029-376"></a>Activates file name “krunching”. <var>n</var>, a decimal integer in the range
1-999, indicates the maximum allowable length of a file name (not
including the <samp><span class="file">.ads</span></samp> or <samp><span class="file">.adb</span></samp> extension). The default is not
to enable file name krunching.
<p>For the source file naming rules, See <a href="#File-Naming-Rules">File Naming Rules</a>.
</dl>
<div class="node">
<a name="Subprogram-Inlining-Control"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Auxiliary-Output-Control">Auxiliary Output Control</a>,
Previous: <a rel="previous" accesskey="p" href="#File-Naming-Control">File Naming Control</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gcc">Switches for gcc</a>
</div>
<h4 class="subsection">3.2.12 Subprogram Inlining Control</h4>
<dl>
<!-- !sort! -->
<dt><samp><span class="option">-gnatn</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatn_007d-_0028_0040command_007bgcc_007d_0029-377"></a>The <code>n</code> here is intended to suggest the first syllable of the
word “inline”.
GNAT recognizes and processes <code>Inline</code> pragmas. However, for the
inlining to actually occur, optimization must be enabled. To enable
inlining of subprograms specified by pragma <code>Inline</code>,
you must also specify this switch.
In the absence of this switch, GNAT does not attempt
inlining and does not need to access the bodies of
subprograms for which <code>pragma Inline</code> is specified if they are not
in the current unit.
<p>If you specify this switch the compiler will access these bodies,
creating an extra source dependency for the resulting object file, and
where possible, the call will be inlined.
For further details on when inlining is possible
see <a href="#Inlining-of-Subprograms">Inlining of Subprograms</a>.
<br><dt><samp><span class="option">-gnatN</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatN_007d-_0028_0040command_007bgcc_007d_0029-378"></a>This switch activates front-end inlining which also
generates additional dependencies.
<p>When using a gcc-based back end (in practice this means using any version
of GNAT other than the JGNAT, .NET or GNAAMP versions), then the use of
<samp><span class="option">-gnatN</span></samp> is deprecated, and the use of <samp><span class="option">-gnatn</span></samp> is preferred.
Historically front end inlining was more extensive than the gcc back end
inlining, but that is no longer the case.
</dl>
<div class="node">
<a name="Auxiliary-Output-Control"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Debugging-Control">Debugging Control</a>,
Previous: <a rel="previous" accesskey="p" href="#Subprogram-Inlining-Control">Subprogram Inlining Control</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gcc">Switches for gcc</a>
</div>
<h4 class="subsection">3.2.13 Auxiliary Output Control</h4>
<dl>
<dt><samp><span class="option">-gnatt</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatt_007d-_0028_0040command_007bgcc_007d_0029-379"></a><a name="index-Writing-internal-trees-380"></a><a name="index-Internal-trees_002c-writing-to-file-381"></a>Causes GNAT to write the internal tree for a unit to a file (with the
extension <samp><span class="file">.adt</span></samp>.
This not normally required, but is used by separate analysis tools.
Typically
these tools do the necessary compilations automatically, so you should
not have to specify this switch in normal operation.
Note that the combination of switches <samp><span class="option">-gnatct</span></samp>
generates a tree in the form required by ASIS applications.
<br><dt><samp><span class="option">-gnatu</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatu_007d-_0028_0040command_007bgcc_007d_0029-382"></a>Print a list of units required by this compilation on <samp><span class="file">stdout</span></samp>.
The listing includes all units on which the unit being compiled depends
either directly or indirectly.
<br><dt><samp><span class="option">-pass-exit-codes</span></samp><dd><a name="index-g_t_0040option_007b_002dpass_002dexit_002dcodes_007d-_0028_0040command_007bgcc_007d_0029-383"></a>If this switch is not used, the exit code returned by <samp><span class="command">gcc</span></samp> when
compiling multiple files indicates whether all source files have
been successfully used to generate object files or not.
<p>When <samp><span class="option">-pass-exit-codes</span></samp> is used, <samp><span class="command">gcc</span></samp> exits with an extended
exit status and allows an integrated development environment to better
react to a compilation failure. Those exit status are:
<dl>
<dt>5<dd>There was an error in at least one source file.
<br><dt>3<dd>At least one source file did not generate an object file.
<br><dt>2<dd>The compiler died unexpectedly (internal error for example).
<br><dt>0<dd>An object file has been generated for every source file.
</dl>
</dl>
<div class="node">
<a name="Debugging-Control"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Exception-Handling-Control">Exception Handling Control</a>,
Previous: <a rel="previous" accesskey="p" href="#Auxiliary-Output-Control">Auxiliary Output Control</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gcc">Switches for gcc</a>
</div>
<h4 class="subsection">3.2.14 Debugging Control</h4>
<dl>
<!-- !sort! -->
<a name="index-Debugging-options-384"></a><dt><samp><span class="option">-gnatd</span><var>x</var></samp><dd><a name="index-g_t_0040option_007b_002dgnatd_007d-_0028_0040command_007bgcc_007d_0029-385"></a>Activate internal debugging switches. <var>x</var> is a letter or digit, or
string of letters or digits, which specifies the type of debugging
outputs desired. Normally these are used only for internal development
or system debugging purposes. You can find full documentation for these
switches in the body of the <code>Debug</code> unit in the compiler source
file <samp><span class="file">debug.adb</span></samp>.
<br><dt><samp><span class="option">-gnatG[=nn]</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatG_007d-_0028_0040command_007bgcc_007d_0029-386"></a>This switch causes the compiler to generate auxiliary output containing
a pseudo-source listing of the generated expanded code. Like most Ada
compilers, GNAT works by first transforming the high level Ada code into
lower level constructs. For example, tasking operations are transformed
into calls to the tasking run-time routines. A unique capability of GNAT
is to list this expanded code in a form very close to normal Ada source.
This is very useful in understanding the implications of various Ada
usage on the efficiency of the generated code. There are many cases in
Ada (e.g. the use of controlled types), where simple Ada statements can
generate a lot of run-time code. By using <samp><span class="option">-gnatG</span></samp> you can identify
these cases, and consider whether it may be desirable to modify the coding
approach to improve efficiency.
<p>The optional parameter <code>nn</code> if present after -gnatG specifies an
alternative maximum line length that overrides the normal default of 72.
This value is in the range 40-999999, values less than 40 being silently
reset to 40. The equal sign is optional.
<p>The format of the output is very similar to standard Ada source, and is
easily understood by an Ada programmer. The following special syntactic
additions correspond to low level features used in the generated code that
do not have any exact analogies in pure Ada source form. The following
is a partial list of these special constructions. See the spec
of package <code>Sprint</code> in file <samp><span class="file">sprint.ads</span></samp> for a full list.
<p>If the switch <samp><span class="option">-gnatL</span></samp> is used in conjunction with
<a name="index-g_t_0040option_007b_002dgnatL_007d-_0028_0040command_007bgcc_007d_0029-387"></a><samp><span class="option">-gnatG</span></samp>, then the original source lines are interspersed
in the expanded source (as comment lines with the original line number).
<dl>
<dt><code>new </code><var>xxx</var> <span class="roman">[</span><code>storage_pool = </code><var>yyy</var><span class="roman">]</span><dd>Shows the storage pool being used for an allocator.
<br><dt><code>at end </code><var>procedure-name</var><code>;</code><dd>Shows the finalization (cleanup) procedure for a scope.
<br><dt><code>(if </code><var>expr</var><code> then </code><var>expr</var><code> else </code><var>expr</var><code>)</code><dd>Conditional expression equivalent to the <code>x?y:z</code> construction in C.
<br><dt><var>target</var><code>^(</code><var>source</var><code>)</code><dd>A conversion with floating-point truncation instead of rounding.
<br><dt><var>target</var><code>?(</code><var>source</var><code>)</code><dd>A conversion that bypasses normal Ada semantic checking. In particular
enumeration types and fixed-point types are treated simply as integers.
<br><dt><var>target</var><code>?^(</code><var>source</var><code>)</code><dd>Combines the above two cases.
<br><dt><var>x</var><code> #/ </code><var>y</var><dt><var>x</var><code> #mod </code><var>y</var><dt><var>x</var><code> #* </code><var>y</var><dt><var>x</var><code> #rem </code><var>y</var><dd>A division or multiplication of fixed-point values which are treated as
integers without any kind of scaling.
<br><dt><code>free </code><var>expr</var> <span class="roman">[</span><code>storage_pool = </code><var>xxx</var><span class="roman">]</span><dd>Shows the storage pool associated with a <code>free</code> statement.
<br><dt><code>[subtype or type declaration]</code><dd>Used to list an equivalent declaration for an internally generated
type that is referenced elsewhere in the listing.
<!-- @item freeze @var{type-name} @ovar{actions} -->
<!-- Expanding @ovar macro inline (explanation in macro def comments) -->
<br><dt><code>freeze </code><var>type-name</var> <span class="roman">[</span><var>actions</var><span class="roman">]</span><dd>Shows the point at which <var>type-name</var> is frozen, with possible
associated actions to be performed at the freeze point.
<br><dt><code>reference </code><var>itype</var><dd>Reference (and hence definition) to internal type <var>itype</var>.
<br><dt><var>function-name</var><code>! (</code><var>arg</var><code>, </code><var>arg</var><code>, </code><var>arg</var><code>)</code><dd>Intrinsic function call.
<br><dt><var>label-name</var><code> : label</code><dd>Declaration of label <var>labelname</var>.
<br><dt><code>#$ </code><var>subprogram-name</var><dd>An implicit call to a run-time support routine
(to meet the requirement of H.3.1(9) in a
convenient manner).
<br><dt><var>expr</var><code> && </code><var>expr</var><code> && </code><var>expr</var><code> ... && </code><var>expr</var><dd>A multiple concatenation (same effect as <var>expr</var> & <var>expr</var> &
<var>expr</var>, but handled more efficiently).
<br><dt><code>[constraint_error]</code><dd>Raise the <code>Constraint_Error</code> exception.
<br><dt><var>expression</var><code>'reference</code><dd>A pointer to the result of evaluating <var>expression</var>.
<br><dt><var>target-type</var><code>!(</code><var>source-expression</var><code>)</code><dd>An unchecked conversion of <var>source-expression</var> to <var>target-type</var>.
<br><dt><code>[</code><var>numerator</var><code>/</code><var>denominator</var><code>]</code><dd>Used to represent internal real literals (that) have no exact
representation in base 2-16 (for example, the result of compile time
evaluation of the expression 1.0/27.0).
</dl>
<br><dt><samp><span class="option">-gnatD[=nn]</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatD_007d-_0028_0040command_007bgcc_007d_0029-388"></a>When used in conjunction with <samp><span class="option">-gnatG</span></samp>, this switch causes
the expanded source, as described above for
<samp><span class="option">-gnatG</span></samp> to be written to files with names
<samp><span class="file">xxx.dg</span></samp>, where <samp><span class="file">xxx</span></samp> is the normal file name,
instead of to the standard output file. For
example, if the source file name is <samp><span class="file">hello.adb</span></samp>, then a file
<samp><span class="file">hello.adb.dg</span></samp> will be written. The debugging
information generated by the <samp><span class="command">gcc</span></samp> <samp><span class="option">-g</span></samp> switch
will refer to the generated <samp><span class="file">xxx.dg</span></samp> file. This allows
you to do source level debugging using the generated code which is
sometimes useful for complex code, for example to find out exactly
which part of a complex construction raised an exception. This switch
also suppress generation of cross-reference information (see
<samp><span class="option">-gnatx</span></samp>) since otherwise the cross-reference information
would refer to the <samp><span class="file">.dg</span></samp> file, which would cause
confusion since this is not the original source file.
<p>Note that <samp><span class="option">-gnatD</span></samp> actually implies <samp><span class="option">-gnatG</span></samp>
automatically, so it is not necessary to give both options.
In other words <samp><span class="option">-gnatD</span></samp> is equivalent to <samp><span class="option">-gnatDG</span></samp>).
<p>If the switch <samp><span class="option">-gnatL</span></samp> is used in conjunction with
<a name="index-g_t_0040option_007b_002dgnatL_007d-_0028_0040command_007bgcc_007d_0029-389"></a><samp><span class="option">-gnatDG</span></samp>, then the original source lines are interspersed
in the expanded source (as comment lines with the original line number).
<p>The optional parameter <code>nn</code> if present after -gnatD specifies an
alternative maximum line length that overrides the normal default of 72.
This value is in the range 40-999999, values less than 40 being silently
reset to 40. The equal sign is optional.
<br><dt><samp><span class="option">-gnatr</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatr_007d-_0028_0040command_007bgcc_007d_0029-390"></a><a name="index-pragma-Restrictions-391"></a>This switch causes pragma Restrictions to be treated as Restriction_Warnings
so that violation of restrictions causes warnings rather than illegalities.
This is useful during the development process when new restrictions are added
or investigated. The switch also causes pragma Profile to be treated as
Profile_Warnings, and pragma Restricted_Run_Time and pragma Ravenscar set
restriction warnings rather than restrictions.
<br><dt><samp><span class="option">-gnatR[0|1|2|3[s]]</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatR_007d-_0028_0040command_007bgcc_007d_0029-392"></a>This switch controls output from the compiler of a listing showing
representation information for declared types and objects. For
<samp><span class="option">-gnatR0</span></samp>, no information is output (equivalent to omitting
the <samp><span class="option">-gnatR</span></samp> switch). For <samp><span class="option">-gnatR1</span></samp> (which is the default,
so <samp><span class="option">-gnatR</span></samp> with no parameter has the same effect), size and alignment
information is listed for declared array and record types. For
<samp><span class="option">-gnatR2</span></samp>, size and alignment information is listed for all
declared types and objects. Finally <samp><span class="option">-gnatR3</span></samp> includes symbolic
expressions for values that are computed at run time for
variant records. These symbolic expressions have a mostly obvious
format with #n being used to represent the value of the n'th
discriminant. See source files <samp><span class="file">repinfo.ads/adb</span></samp> in the
<code>GNAT</code> sources for full details on the format of <samp><span class="option">-gnatR3</span></samp>
output. If the switch is followed by an s (e.g. <samp><span class="option">-gnatR2s</span></samp>), then
the output is to a file with the name <samp><span class="file">file.rep</span></samp> where
file is the name of the corresponding source file.
Note that it is possible for record components to have zero size. In
this case, the component clause uses an obvious extension of permitted
Ada syntax, for example <code>at 0 range 0 .. -1</code>.
<p>Representation information requires that code be generated (since it is the
code generator that lays out complex data structures). If an attempt is made
to output representation information when no code is generated, for example
when a subunit is compiled on its own, then no information can be generated
and the compiler outputs a message to this effect.
<br><dt><samp><span class="option">-gnatS</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatS_007d-_0028_0040command_007bgcc_007d_0029-393"></a>The use of the switch <samp><span class="option">-gnatS</span></samp> for an
Ada compilation will cause the compiler to output a
representation of package Standard in a form very
close to standard Ada. It is not quite possible to
do this entirely in standard Ada (since new
numeric base types cannot be created in standard
Ada), but the output is easily
readable to any Ada programmer, and is useful to
determine the characteristics of target dependent
types in package Standard.
<br><dt><samp><span class="option">-gnatx</span></samp><dd><a name="index-g_t_0040option_007b_002dgnatx_007d-_0028_0040command_007bgcc_007d_0029-394"></a>Normally the compiler generates full cross-referencing information in
the <samp><span class="file">ALI</span></samp> file. This information is used by a number of tools,
including <code>gnatfind</code> and <code>gnatxref</code>. The <samp><span class="option">-gnatx</span></samp> switch
suppresses this information. This saves some space and may slightly
speed up compilation, but means that these tools cannot be used.
</dl>
<div class="node">
<a name="Exception-Handling-Control"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Units-to-Sources-Mapping-Files">Units to Sources Mapping Files</a>,
Previous: <a rel="previous" accesskey="p" href="#Debugging-Control">Debugging Control</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gcc">Switches for gcc</a>
</div>
<h4 class="subsection">3.2.15 Exception Handling Control</h4>
<p class="noindent">GNAT uses two methods for handling exceptions at run-time. The
<code>setjmp/longjmp</code> method saves the context when entering
a frame with an exception handler. Then when an exception is
raised, the context can be restored immediately, without the
need for tracing stack frames. This method provides very fast
exception propagation, but introduces significant overhead for
the use of exception handlers, even if no exception is raised.
<p>The other approach is called “zero cost” exception handling.
With this method, the compiler builds static tables to describe
the exception ranges. No dynamic code is required when entering
a frame containing an exception handler. When an exception is
raised, the tables are used to control a back trace of the
subprogram invocation stack to locate the required exception
handler. This method has considerably poorer performance for
the propagation of exceptions, but there is no overhead for
exception handlers if no exception is raised. Note that in this
mode and in the context of mixed Ada and C/C++ programming,
to propagate an exception through a C/C++ code, the C/C++ code
must be compiled with the <samp><span class="option">-funwind-tables</span></samp> GCC's
option.
<p>The following switches may be used to control which of the
two exception handling methods is used.
<dl>
<!-- !sort! -->
<dt><samp><span class="option">--RTS=sjlj</span></samp><dd><a name="index-g_t_0040option_007b_002d_002dRTS_003dsjlj_007d-_0028_0040command_007bgnatmake_007d_0029-395"></a>This switch causes the setjmp/longjmp run-time (when available) to be used
for exception handling. If the default
mechanism for the target is zero cost exceptions, then
this switch can be used to modify this default, and must be
used for all units in the partition.
This option is rarely used. One case in which it may be
advantageous is if you have an application where exception
raising is common and the overall performance of the
application is improved by favoring exception propagation.
<br><dt><samp><span class="option">--RTS=zcx</span></samp><dd><a name="index-g_t_0040option_007b_002d_002dRTS_003dzcx_007d-_0028_0040command_007bgnatmake_007d_0029-396"></a><a name="index-Zero-Cost-Exceptions-397"></a>This switch causes the zero cost approach to be used
for exception handling. If this is the default mechanism for the
target (see below), then this switch is unneeded. If the default
mechanism for the target is setjmp/longjmp exceptions, then
this switch can be used to modify this default, and must be
used for all units in the partition.
This option can only be used if the zero cost approach
is available for the target in use, otherwise it will generate an error.
</dl>
<p class="noindent">The same option <samp><span class="option">--RTS</span></samp> must be used both for <samp><span class="command">gcc</span></samp>
and <samp><span class="command">gnatbind</span></samp>. Passing this option to <samp><span class="command">gnatmake</span></samp>
(see <a href="#Switches-for-gnatmake">Switches for gnatmake</a>) will ensure the required consistency
through the compilation and binding steps.
<div class="node">
<a name="Units-to-Sources-Mapping-Files"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Integrated-Preprocessing">Integrated Preprocessing</a>,
Previous: <a rel="previous" accesskey="p" href="#Exception-Handling-Control">Exception Handling Control</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gcc">Switches for gcc</a>
</div>
<h4 class="subsection">3.2.16 Units to Sources Mapping Files</h4>
<dl>
<dt><samp><span class="option">-gnatem=</span><var>path</var></samp><dd><a name="index-g_t_0040option_007b_002dgnatem_007d-_0028_0040command_007bgcc_007d_0029-398"></a>A mapping file is a way to communicate to the compiler two mappings:
from unit names to file names (without any directory information) and from
file names to path names (with full directory information). These mappings
are used by the compiler to short-circuit the path search.
<p>The use of mapping files is not required for correct operation of the
compiler, but mapping files can improve efficiency, particularly when
sources are read over a slow network connection. In normal operation,
you need not be concerned with the format or use of mapping files,
and the <samp><span class="option">-gnatem</span></samp> switch is not a switch that you would use
explicitly. It is intended primarily for use by automatic tools such as
<samp><span class="command">gnatmake</span></samp> running under the project file facility. The
description here of the format of mapping files is provided
for completeness and for possible use by other tools.
<p>A mapping file is a sequence of sets of three lines. In each set, the
first line is the unit name, in lower case, with <code>%s</code> appended
for specs and <code>%b</code> appended for bodies; the second line is the
file name; and the third line is the path name.
<p>Example:
<pre class="smallexample"> main%b
main.2.ada
/gnat/project1/sources/main.2.ada
</pre>
<p>When the switch <samp><span class="option">-gnatem</span></samp> is specified, the compiler will
create in memory the two mappings from the specified file. If there is
any problem (nonexistent file, truncated file or duplicate entries),
no mapping will be created.
<p>Several <samp><span class="option">-gnatem</span></samp> switches may be specified; however, only the
last one on the command line will be taken into account.
<p>When using a project file, <samp><span class="command">gnatmake</span></samp> creates a temporary
mapping file and communicates it to the compiler using this switch.
</dl>
<div class="node">
<a name="Integrated-Preprocessing"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Code-Generation-Control">Code Generation Control</a>,
Previous: <a rel="previous" accesskey="p" href="#Units-to-Sources-Mapping-Files">Units to Sources Mapping Files</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gcc">Switches for gcc</a>
</div>
<h4 class="subsection">3.2.17 Integrated Preprocessing</h4>
<p class="noindent">GNAT sources may be preprocessed immediately before compilation.
In this case, the actual
text of the source is not the text of the source file, but is derived from it
through a process called preprocessing. Integrated preprocessing is specified
through switches <samp><span class="option">-gnatep</span></samp> and/or <samp><span class="option">-gnateD</span></samp>. <samp><span class="option">-gnatep</span></samp>
indicates, through a text file, the preprocessing data to be used.
<samp><span class="option">-gnateD</span></samp> specifies or modifies the values of preprocessing symbol.
<p class="noindent">Note that when integrated preprocessing is used, the output from the
preprocessor is not written to any external file. Instead it is passed
internally to the compiler. If you need to preserve the result of
preprocessing in a file, then you should use <samp><span class="command">gnatprep</span></samp>
to perform the desired preprocessing in stand-alone mode.
<p class="noindent">It is recommended that <samp><span class="command">gnatmake</span></samp> switch -s should be
used when Integrated Preprocessing is used. The reason is that preprocessing
with another Preprocessing Data file without changing the sources will
not trigger recompilation without this switch.
<p class="noindent">Note that <samp><span class="command">gnatmake</span></samp> switch -m will almost
always trigger recompilation for sources that are preprocessed,
because <samp><span class="command">gnatmake</span></samp> cannot compute the checksum of the source after
preprocessing.
<p class="noindent">The actual preprocessing function is described in details in section
<a href="#Preprocessing-Using-gnatprep">Preprocessing Using gnatprep</a>. This section only describes how integrated
preprocessing is triggered and parameterized.
<dl>
<dt><code>-gnatep=</code><var>file</var><dd><a name="index-g_t_0040option_007b_002dgnatep_007d-_0028_0040command_007bgcc_007d_0029-399"></a>This switch indicates to the compiler the file name (without directory
information) of the preprocessor data file to use. The preprocessor data file
should be found in the source directories.
<p class="noindent">A preprocessing data file is a text file with significant lines indicating
how should be preprocessed either a specific source or all sources not
mentioned in other lines. A significant line is a nonempty, non-comment line.
Comments are similar to Ada comments.
<p class="noindent">Each significant line starts with either a literal string or the character '*'.
A literal string is the file name (without directory information) of the source
to preprocess. A character '*' indicates the preprocessing for all the sources
that are not specified explicitly on other lines (order of the lines is not
significant). It is an error to have two lines with the same file name or two
lines starting with the character '*'.
<p class="noindent">After the file name or the character '*', another optional literal string
indicating the file name of the definition file to be used for preprocessing
(see <a href="#Form-of-Definitions-File">Form of Definitions File</a>). The definition files are found by the
compiler in one of the source directories. In some cases, when compiling
a source in a directory other than the current directory, if the definition
file is in the current directory, it may be necessary to add the current
directory as a source directory through switch -I., otherwise
the compiler would not find the definition file.
<p class="noindent">Then, optionally, switches similar to those of <code>gnatprep</code> may
be found. Those switches are:
<dl>
<dt><code>-b</code><dd>Causes both preprocessor lines and the lines deleted by
preprocessing to be replaced by blank lines, preserving the line number.
This switch is always implied; however, if specified after <samp><span class="option">-c</span></samp>
it cancels the effect of <samp><span class="option">-c</span></samp>.
<br><dt><code>-c</code><dd>Causes both preprocessor lines and the lines deleted
by preprocessing to be retained as comments marked
with the special string “<code>--! </code>”.
<br><dt><code>-Dsymbol=value</code><dd>Define or redefine a symbol, associated with value. A symbol is an Ada
identifier, or an Ada reserved word, with the exception of <code>if</code>,
<code>else</code>, <code>elsif</code>, <code>end</code>, <code>and</code>, <code>or</code> and <code>then</code>.
<code>value</code> is either a literal string, an Ada identifier or any Ada reserved
word. A symbol declared with this switch replaces a symbol with the
same name defined in a definition file.
<br><dt><code>-s</code><dd>Causes a sorted list of symbol names and values to be
listed on the standard output file.
<br><dt><code>-u</code><dd>Causes undefined symbols to be treated as having the value <code>FALSE</code>
in the context
of a preprocessor test. In the absence of this option, an undefined symbol in
a <code>#if</code> or <code>#elsif</code> test will be treated as an error.
</dl>
<p class="noindent">Examples of valid lines in a preprocessor data file:
<pre class="smallexample"> "toto.adb" "prep.def" -u
-- preprocess "toto.adb", using definition file "prep.def",
-- undefined symbol are False.
* -c -DVERSION=V101
-- preprocess all other sources without a definition file;
-- suppressed lined are commented; symbol VERSION has the value V101.
"titi.adb" "prep2.def" -s
-- preprocess "titi.adb", using definition file "prep2.def";
-- list all symbols with their values.
</pre>
<br><dt><code>-gnateDsymbol</code><span class="roman">[</span><code>=value</code><span class="roman">]</span><dd><a name="index-g_t_0040option_007b_002dgnateD_007d-_0028_0040command_007bgcc_007d_0029-400"></a>Define or redefine a preprocessing symbol, associated with value. If no value
is given on the command line, then the value of the symbol is <code>True</code>.
A symbol is an identifier, following normal Ada (case-insensitive)
rules for its syntax, and value is any sequence (including an empty sequence)
of characters from the set (letters, digits, period, underline).
Ada reserved words may be used as symbols, with the exceptions of <code>if</code>,
<code>else</code>, <code>elsif</code>, <code>end</code>, <code>and</code>, <code>or</code> and <code>then</code>.
<p class="noindent">A symbol declared with this switch on the command line replaces a
symbol with the same name either in a definition file or specified with a
switch -D in the preprocessor data file.
<p class="noindent">This switch is similar to switch <samp><span class="option">-D</span></samp> of <code>gnatprep</code>.
<br><dt><code>-gnateG</code><dd>When integrated preprocessing is performed and the preprocessor modifies
the source text, write the result of this preprocessing into a file
<source>.prep.
</dl>
<div class="node">
<a name="Code-Generation-Control"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Integrated-Preprocessing">Integrated Preprocessing</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gcc">Switches for gcc</a>
</div>
<h4 class="subsection">3.2.18 Code Generation Control</h4>
<p class="noindent">The GCC technology provides a wide range of target dependent
<samp><span class="option">-m</span></samp> switches for controlling
details of code generation with respect to different versions of
architectures. This includes variations in instruction sets (e.g.
different members of the power pc family), and different requirements
for optimal arrangement of instructions (e.g. different members of
the x86 family). The list of available <samp><span class="option">-m</span></samp> switches may be
found in the GCC documentation.
<p>Use of these <samp><span class="option">-m</span></samp> switches may in some cases result in improved
code performance.
<p>The GNAT Pro technology is tested and qualified without any
<samp><span class="option">-m</span></samp> switches,
so generally the most reliable approach is to avoid the use of these
switches. However, we generally expect most of these switches to work
successfully with GNAT Pro, and many customers have reported successful
use of these options.
<p>Our general advice is to avoid the use of <samp><span class="option">-m</span></samp> switches unless
special needs lead to requirements in this area. In particular,
there is no point in using <samp><span class="option">-m</span></samp> switches to improve performance
unless you actually see a performance improvement.
<div class="node">
<a name="Search-Paths-and-the-Run-Time-Library-(RTL)"></a>
<a name="Search-Paths-and-the-Run_002dTime-Library-_0028RTL_0029"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Order-of-Compilation-Issues">Order of Compilation Issues</a>,
Previous: <a rel="previous" accesskey="p" href="#Switches-for-gcc">Switches for gcc</a>,
Up: <a rel="up" accesskey="u" href="#Compiling-Using-gcc">Compiling Using gcc</a>
</div>
<h3 class="section">3.3 Search Paths and the Run-Time Library (RTL)</h3>
<p class="noindent">With the GNAT source-based library system, the compiler must be able to
find source files for units that are needed by the unit being compiled.
Search paths are used to guide this process.
<p>The compiler compiles one source file whose name must be given
explicitly on the command line. In other words, no searching is done
for this file. To find all other source files that are needed (the most
common being the specs of units), the compiler examines the following
directories, in the following order:
<ol type=1 start=1>
<li>The directory containing the source file of the main unit being compiled
(the file name on the command line).
<li>Each directory named by an <samp><span class="option">-I</span></samp> switch given on the
<samp><span class="command">gcc</span></samp> command line, in the order given.
<li><a name="index-ADA_005fPRJ_005fINCLUDE_005fFILE-401"></a>Each of the directories listed in the text file whose name is given
by the <samp><span class="env">ADA_PRJ_INCLUDE_FILE</span></samp> environment variable.
<p class="noindent"><samp><span class="env">ADA_PRJ_INCLUDE_FILE</span></samp> is normally set by gnatmake or by the gnat
driver when project files are used. It should not normally be set
by other means.
<li><a name="index-ADA_005fINCLUDE_005fPATH-402"></a>Each of the directories listed in the value of the
<samp><span class="env">ADA_INCLUDE_PATH</span></samp> environment variable.
Construct this value
exactly as the <samp><span class="env">PATH</span></samp> environment variable: a list of directory
names separated by colons (semicolons when working with the NT version).
<li>The content of the <samp><span class="file">ada_source_path</span></samp> file which is part of the GNAT
installation tree and is used to store standard libraries such as the
GNAT Run Time Library (RTL) source files.
<a href="#Installing-a-library">Installing a library</a>
</ol>
<p class="noindent">Specifying the switch <samp><span class="option">-I-</span></samp>
inhibits the use of the directory
containing the source file named in the command line. You can still
have this directory on your search path, but in this case it must be
explicitly requested with a <samp><span class="option">-I</span></samp> switch.
<p>Specifying the switch <samp><span class="option">-nostdinc</span></samp>
inhibits the search of the default location for the GNAT Run Time
Library (RTL) source files.
<p>The compiler outputs its object files and ALI files in the current
working directory.
Caution: The object file can be redirected with the <samp><span class="option">-o</span></samp> switch;
however, <samp><span class="command">gcc</span></samp> and <code>gnat1</code> have not been coordinated on this
so the <samp><span class="file">ALI</span></samp> file will not go to the right place. Therefore, you should
avoid using the <samp><span class="option">-o</span></samp> switch.
<p><a name="index-System_002eIO-403"></a>The packages <code>Ada</code>, <code>System</code>, and <code>Interfaces</code> and their
children make up the GNAT RTL, together with the simple <code>System.IO</code>
package used in the <code>"Hello World"</code> example. The sources for these units
are needed by the compiler and are kept together in one directory. Not
all of the bodies are needed, but all of the sources are kept together
anyway. In a normal installation, you need not specify these directory
names when compiling or binding. Either the environment variables or
the built-in defaults cause these files to be found.
<p>In addition to the language-defined hierarchies (<code>System</code>, <code>Ada</code> and
<code>Interfaces</code>), the GNAT distribution provides a fourth hierarchy,
consisting of child units of <code>GNAT</code>. This is a collection of generally
useful types, subprograms, etc. See <a href="gnat_rm.html#Top">GNAT Reference Manual</a>, for further details.
<p>Besides simplifying access to the RTL, a major use of search paths is
in compiling sources from multiple directories. This can make
development environments much more flexible.
<div class="node">
<a name="Order-of-Compilation-Issues"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Examples">Examples</a>,
Previous: <a rel="previous" accesskey="p" href="#Search-Paths-and-the-Run_002dTime-Library-_0028RTL_0029">Search Paths and the Run-Time Library (RTL)</a>,
Up: <a rel="up" accesskey="u" href="#Compiling-Using-gcc">Compiling Using gcc</a>
</div>
<h3 class="section">3.4 Order of Compilation Issues</h3>
<p class="noindent">If, in our earlier example, there was a spec for the <code>hello</code>
procedure, it would be contained in the file <samp><span class="file">hello.ads</span></samp>; yet this
file would not have to be explicitly compiled. This is the result of the
model we chose to implement library management. Some of the consequences
of this model are as follows:
<ul>
<li>There is no point in compiling specs (except for package
specs with no bodies) because these are compiled as needed by clients. If
you attempt a useless compilation, you will receive an error message.
It is also useless to compile subunits because they are compiled as needed
by the parent.
<li>There are no order of compilation requirements: performing a
compilation never obsoletes anything. The only way you can obsolete
something and require recompilations is to modify one of the
source files on which it depends.
<li>There is no library as such, apart from the ALI files
(see <a href="#The-Ada-Library-Information-Files">The Ada Library Information Files</a>, for information on the format
of these files). For now we find it convenient to create separate ALI files,
but eventually the information therein may be incorporated into the object
file directly.
<li>When you compile a unit, the source files for the specs of all units
that it <code>with</code>'s, all its subunits, and the bodies of any generics it
instantiates must be available (reachable by the search-paths mechanism
described above), or you will receive a fatal error message.
</ul>
<div class="node">
<a name="Examples"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Order-of-Compilation-Issues">Order of Compilation Issues</a>,
Up: <a rel="up" accesskey="u" href="#Compiling-Using-gcc">Compiling Using gcc</a>
</div>
<h3 class="section">3.5 Examples</h3>
<p class="noindent">The following are some typical Ada compilation command line examples:
<dl>
<dt><code>$ gcc -c xyz.adb</code><dd>Compile body in file <samp><span class="file">xyz.adb</span></samp> with all default options.
<br><dt><code>$ gcc -c -O2 -gnata xyz-def.adb</code><dd>
Compile the child unit package in file <samp><span class="file">xyz-def.adb</span></samp> with extensive
optimizations, and pragma <code>Assert</code>/<code>Debug</code> statements
enabled.
<br><dt><code>$ gcc -c -gnatc abc-def.adb</code><dd>Compile the subunit in file <samp><span class="file">abc-def.adb</span></samp> in semantic-checking-only
mode.
</dl>
<div class="node">
<a name="Binding-Using-gnatbind"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Linking-Using-gnatlink">Linking Using gnatlink</a>,
Previous: <a rel="previous" accesskey="p" href="#Compiling-Using-gcc">Compiling Using gcc</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">4 Binding Using <code>gnatbind</code></h2>
<p><a name="index-gnatbind-404"></a>
<ul class="menu">
<li><a accesskey="1" href="#Running-gnatbind">Running gnatbind</a>
<li><a accesskey="2" href="#Switches-for-gnatbind">Switches for gnatbind</a>
<li><a accesskey="3" href="#Command_002dLine-Access">Command-Line Access</a>
<li><a accesskey="4" href="#Search-Paths-for-gnatbind">Search Paths for gnatbind</a>
<li><a accesskey="5" href="#Examples-of-gnatbind-Usage">Examples of gnatbind Usage</a>
</ul>
<p class="noindent">This chapter describes the GNAT binder, <code>gnatbind</code>, which is used
to bind compiled GNAT objects.
<p>Note: to invoke <code>gnatbind</code> with a project file, use the <code>gnat</code>
driver (see <a href="#The-GNAT-Driver-and-Project-Files">The GNAT Driver and Project Files</a>).
<p>The <code>gnatbind</code> program performs four separate functions:
<ol type=1 start=1>
<li>Checks that a program is consistent, in accordance with the rules in
Chapter 10 of the Ada Reference Manual. In particular, error
messages are generated if a program uses inconsistent versions of a
given unit.
<li>Checks that an acceptable order of elaboration exists for the program
and issues an error message if it cannot find an order of elaboration
that satisfies the rules in Chapter 10 of the Ada Language Manual.
<li>Generates a main program incorporating the given elaboration order.
This program is a small Ada package (body and spec) that
must be subsequently compiled
using the GNAT compiler. The necessary compilation step is usually
performed automatically by <samp><span class="command">gnatlink</span></samp>. The two most important
functions of this program
are to call the elaboration routines of units in an appropriate order
and to call the main program.
<li>Determines the set of object files required by the given main program.
This information is output in the forms of comments in the generated program,
to be read by the <samp><span class="command">gnatlink</span></samp> utility used to link the Ada application.
</ol>
<div class="node">
<a name="Running-gnatbind"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Switches-for-gnatbind">Switches for gnatbind</a>,
Up: <a rel="up" accesskey="u" href="#Binding-Using-gnatbind">Binding Using gnatbind</a>
</div>
<h3 class="section">4.1 Running <code>gnatbind</code></h3>
<p class="noindent">The form of the <code>gnatbind</code> command is
<pre class="smallexample"> <!-- $ gnatbind @ovar{switches} @var{mainprog}@r{[}.ali@r{]} @ovar{switches} -->
<!-- Expanding @ovar macro inline (explanation in macro def comments) -->
$ gnatbind <span class="roman">[</span><var>switches</var><span class="roman">]</span> <var>mainprog</var><span class="roman">[</span>.ali<span class="roman">]</span> <span class="roman">[</span><var>switches</var><span class="roman">]</span>
</pre>
<p class="noindent">where <samp><var>mainprog</var><span class="file">.adb</span></samp> is the Ada file containing the main program
unit body. <code>gnatbind</code> constructs an Ada
package in two files whose names are
<samp><span class="file">b~</span><var>mainprog</var><span class="file">.ads</span></samp>, and <samp><span class="file">b~</span><var>mainprog</var><span class="file">.adb</span></samp>.
For example, if given the
parameter <samp><span class="file">hello.ali</span></samp>, for a main program contained in file
<samp><span class="file">hello.adb</span></samp>, the binder output files would be <samp><span class="file">b~hello.ads</span></samp>
and <samp><span class="file">b~hello.adb</span></samp>.
<p>When doing consistency checking, the binder takes into consideration
any source files it can locate. For example, if the binder determines
that the given main program requires the package <code>Pack</code>, whose
<samp><span class="file">.ALI</span></samp>
file is <samp><span class="file">pack.ali</span></samp> and whose corresponding source spec file is
<samp><span class="file">pack.ads</span></samp>, it attempts to locate the source file <samp><span class="file">pack.ads</span></samp>
(using the same search path conventions as previously described for the
<samp><span class="command">gcc</span></samp> command). If it can locate this source file, it checks that
the time stamps
or source checksums of the source and its references to in <samp><span class="file">ALI</span></samp> files
match. In other words, any <samp><span class="file">ALI</span></samp> files that mentions this spec must have
resulted from compiling this version of the source file (or in the case
where the source checksums match, a version close enough that the
difference does not matter).
<p><a name="index-Source-files_002c-use-by-binder-405"></a>The effect of this consistency checking, which includes source files, is
that the binder ensures that the program is consistent with the latest
version of the source files that can be located at bind time. Editing a
source file without compiling files that depend on the source file cause
error messages to be generated by the binder.
<p>For example, suppose you have a main program <samp><span class="file">hello.adb</span></samp> and a
package <code>P</code>, from file <samp><span class="file">p.ads</span></samp> and you perform the following
steps:
<ol type=1 start=1>
<li>Enter <code>gcc -c hello.adb</code> to compile the main program.
<li>Enter <code>gcc -c p.ads</code> to compile package <code>P</code>.
<li>Edit file <samp><span class="file">p.ads</span></samp>.
<li>Enter <code>gnatbind hello</code>.
</ol>
<p class="noindent">At this point, the file <samp><span class="file">p.ali</span></samp> contains an out-of-date time stamp
because the file <samp><span class="file">p.ads</span></samp> has been edited. The attempt at binding
fails, and the binder generates the following error messages:
<pre class="smallexample"> error: "hello.adb" must be recompiled ("p.ads" has been modified)
error: "p.ads" has been modified and must be recompiled
</pre>
<p class="noindent">Now both files must be recompiled as indicated, and then the bind can
succeed, generating a main program. You need not normally be concerned
with the contents of this file, but for reference purposes a sample
binder output file is given in <a href="#Example-of-Binder-Output-File">Example of Binder Output File</a>.
<p>In most normal usage, the default mode of <samp><span class="command">gnatbind</span></samp> which is to
generate the main package in Ada, as described in the previous section.
In particular, this means that any Ada programmer can read and understand
the generated main program. It can also be debugged just like any other
Ada code provided the <samp><span class="option">-g</span></samp> switch is used for
<samp><span class="command">gnatbind</span></samp> and <samp><span class="command">gnatlink</span></samp>.
<div class="node">
<a name="Switches-for-gnatbind"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Command_002dLine-Access">Command-Line Access</a>,
Previous: <a rel="previous" accesskey="p" href="#Running-gnatbind">Running gnatbind</a>,
Up: <a rel="up" accesskey="u" href="#Binding-Using-gnatbind">Binding Using gnatbind</a>
</div>
<h3 class="section">4.2 Switches for <samp><span class="command">gnatbind</span></samp></h3>
<p class="noindent">The following switches are available with <code>gnatbind</code>; details will
be presented in subsequent sections.
<ul class="menu">
<li><a accesskey="1" href="#Consistency_002dChecking-Modes">Consistency-Checking Modes</a>
<li><a accesskey="2" href="#Binder-Error-Message-Control">Binder Error Message Control</a>
<li><a accesskey="3" href="#Elaboration-Control">Elaboration Control</a>
<li><a accesskey="4" href="#Output-Control">Output Control</a>
<li><a accesskey="5" href="#Dynamic-Allocation-Control">Dynamic Allocation Control</a>
<li><a accesskey="6" href="#Binding-with-Non_002dAda-Main-Programs">Binding with Non-Ada Main Programs</a>
<li><a accesskey="7" href="#Binding-Programs-with-No-Main-Subprogram">Binding Programs with No Main Subprogram</a>
</ul>
<dl>
<!-- !sort! -->
<dt><samp><span class="option">--version</span></samp><dd><a name="index-g_t_0040option_007b_002d_002dversion_007d-_0040command_007bgnatbind_007d-406"></a>Display Copyright and version, then exit disregarding all other options.
<br><dt><samp><span class="option">--help</span></samp><dd><a name="index-g_t_0040option_007b_002d_002dhelp_007d-_0040command_007bgnatbind_007d-407"></a>If <samp><span class="option">--version</span></samp> was not used, display usage, then exit disregarding
all other options.
<br><dt><samp><span class="option">-a</span></samp><dd><a name="index-g_t_0040option_007b_002da_007d-_0040command_007bgnatbind_007d-408"></a>Indicates that, if supported by the platform, the adainit procedure should
be treated as an initialisation routine by the linker (a constructor). This
is intended to be used by the Project Manager to automatically initialize
shared Stand-Alone Libraries.
<br><dt><samp><span class="option">-aO</span></samp><dd><a name="index-g_t_0040option_007b_002daO_007d-_0028_0040command_007bgnatbind_007d_0029-409"></a>Specify directory to be searched for ALI files.
<br><dt><samp><span class="option">-aI</span></samp><dd><a name="index-g_t_0040option_007b_002daI_007d-_0028_0040command_007bgnatbind_007d_0029-410"></a>Specify directory to be searched for source file.
<br><dt><samp><span class="option">-A[=</span><var>filename</var><span class="option">]</span></samp><dd><a name="index-g_t_0040option_007b_002dA_007d-_0028_0040command_007bgnatbind_007d_0029-411"></a>Output ALI list (to standard output or to the named file).
<br><dt><samp><span class="option">-b</span></samp><dd><a name="index-g_t_0040option_007b_002db_007d-_0028_0040command_007bgnatbind_007d_0029-412"></a>Generate brief messages to <samp><span class="file">stderr</span></samp> even if verbose mode set.
<br><dt><samp><span class="option">-c</span></samp><dd><a name="index-g_t_0040option_007b_002dc_007d-_0028_0040command_007bgnatbind_007d_0029-413"></a>Check only, no generation of binder output file.
<br><dt><samp><span class="option">-d</span><var>nn</var><span class="option">[k|m]</span></samp><dd><a name="index-g_t_0040option_007b_002dd_0040var_007bnn_007d_0040r_007b_005b_007dk_0040r_007b_007c_007dm_0040r_007b_005d_007d_007d-_0028_0040command_007bgnatbind_007d_0029-414"></a>This switch can be used to change the default task stack size value
to a specified size <var>nn</var>, which is expressed in bytes by default, or
in kilobytes when suffixed with <var>k</var> or in megabytes when suffixed
with <var>m</var>.
In the absence of a ‘<samp><span class="samp">[k|m]</span></samp>’ suffix, this switch is equivalent,
in effect, to completing all task specs with
<pre class="smallexample"> pragma Storage_Size (nn);
</pre>
<p>When they do not already have such a pragma.
<br><dt><samp><span class="option">-D</span><var>nn</var><span class="option">[k|m]</span></samp><dd><a name="index-g_t_0040option_007b_002dD_007d-_0028_0040command_007bgnatbind_007d_0029-415"></a>This switch can be used to change the default secondary stack size value
to a specified size <var>nn</var>, which is expressed in bytes by default, or
in kilobytes when suffixed with <var>k</var> or in megabytes when suffixed
with <var>m</var>.
<p>The secondary stack is used to deal with functions that return a variable
sized result, for example a function returning an unconstrained
String. There are two ways in which this secondary stack is allocated.
<p>For most targets, the secondary stack is growing on demand and is allocated
as a chain of blocks in the heap. The -D option is not very
relevant. It only give some control over the size of the allocated
blocks (whose size is the minimum of the default secondary stack size value,
and the actual size needed for the current allocation request).
<p>For certain targets, notably VxWorks 653,
the secondary stack is allocated by carving off a fixed ratio chunk of the
primary task stack. The -D option is used to define the
size of the environment task's secondary stack.
<br><dt><samp><span class="option">-e</span></samp><dd><a name="index-g_t_0040option_007b_002de_007d-_0028_0040command_007bgnatbind_007d_0029-416"></a>Output complete list of elaboration-order dependencies.
<br><dt><samp><span class="option">-E</span></samp><dd><a name="index-g_t_0040option_007b_002dE_007d-_0028_0040command_007bgnatbind_007d_0029-417"></a>Store tracebacks in exception occurrences when the target supports it.
See also the packages <code>GNAT.Traceback</code> and
<code>GNAT.Traceback.Symbolic</code> for more information.
Note that on x86 ports, you must not use <samp><span class="option">-fomit-frame-pointer</span></samp>
<samp><span class="command">gcc</span></samp> option.
<br><dt><samp><span class="option">-F</span></samp><dd><a name="index-g_t_0040option_007b_002dF_007d-_0028_0040command_007bgnatbind_007d_0029-418"></a>Force the checks of elaboration flags. <samp><span class="command">gnatbind</span></samp> does not normally
generate checks of elaboration flags for the main executable, except when
a Stand-Alone Library is used. However, there are cases when this cannot be
detected by gnatbind. An example is importing an interface of a Stand-Alone
Library through a pragma Import and only specifying through a linker switch
this Stand-Alone Library. This switch is used to guarantee that elaboration
flag checks are generated.
<br><dt><samp><span class="option">-h</span></samp><dd><a name="index-g_t_0040option_007b_002dh_007d-_0028_0040command_007bgnatbind_007d_0029-419"></a>Output usage (help) information
<br><dt><samp><span class="option">-H32</span></samp><dd><a name="index-g_t_0040option_007b_002dH32_007d-_0028_0040command_007bgnatbind_007d_0029-420"></a>Use 32-bit allocations for <code>__gnat_malloc</code> (and thus for access types).
For further details see <a href="#Dynamic-Allocation-Control">Dynamic Allocation Control</a>.
<br><dt><samp><span class="option">-H64</span></samp><dd><a name="index-g_t_0040option_007b_002dH64_007d-_0028_0040command_007bgnatbind_007d_0029-421"></a>Use 64-bit allocations for <code>__gnat_malloc</code> (and thus for access types).
<a name="index-g_t_0040code_007b_005f_005fgnat_005fmalloc_007d-422"></a>For further details see <a href="#Dynamic-Allocation-Control">Dynamic Allocation Control</a>.
<br><dt><samp><span class="option">-I</span></samp><dd><a name="index-g_t_0040option_007b_002dI_007d-_0028_0040command_007bgnatbind_007d_0029-423"></a>Specify directory to be searched for source and ALI files.
<br><dt><samp><span class="option">-I-</span></samp><dd><a name="index-g_t_0040option_007b_002dI_002d_007d-_0028_0040command_007bgnatbind_007d_0029-424"></a>Do not look for sources in the current directory where <code>gnatbind</code> was
invoked, and do not look for ALI files in the directory containing the
ALI file named in the <code>gnatbind</code> command line.
<br><dt><samp><span class="option">-l</span></samp><dd><a name="index-g_t_0040option_007b_002dl_007d-_0028_0040command_007bgnatbind_007d_0029-425"></a>Output chosen elaboration order.
<br><dt><samp><span class="option">-L</span><var>xxx</var></samp><dd><a name="index-g_t_0040option_007b_002dL_007d-_0028_0040command_007bgnatbind_007d_0029-426"></a>Bind the units for library building. In this case the adainit and
adafinal procedures (see <a href="#Binding-with-Non_002dAda-Main-Programs">Binding with Non-Ada Main Programs</a>)
are renamed to <var>xxx</var>init and
<var>xxx</var>final.
Implies -n.
(See <a href="#GNAT-and-Libraries">GNAT and Libraries</a>, for more details.)
<br><dt><samp><span class="option">-Mxyz</span></samp><dd><a name="index-g_t_0040option_007b_002dM_007d-_0028_0040command_007bgnatbind_007d_0029-427"></a>Rename generated main program from main to xyz. This option is
supported on cross environments only.
<br><dt><samp><span class="option">-m</span><var>n</var></samp><dd><a name="index-g_t_0040option_007b_002dm_007d-_0028_0040command_007bgnatbind_007d_0029-428"></a>Limit number of detected errors or warnings to <var>n</var>, where <var>n</var> is
in the range 1..999999. The default value if no switch is
given is 9999. If the number of warnings reaches this limit, then a
message is output and further warnings are suppressed, the bind
continues in this case. If the number of errors reaches this
limit, then a message is output and the bind is abandoned.
A value of zero means that no limit is enforced. The equal
sign is optional.
<p>Furthermore, under Windows, the sources pointed to by the libraries path
set in the registry are not searched for.
<br><dt><samp><span class="option">-n</span></samp><dd><a name="index-g_t_0040option_007b_002dn_007d-_0028_0040command_007bgnatbind_007d_0029-429"></a>No main program.
<br><dt><samp><span class="option">-nostdinc</span></samp><dd><a name="index-g_t_0040option_007b_002dnostdinc_007d-_0028_0040command_007bgnatbind_007d_0029-430"></a>Do not look for sources in the system default directory.
<br><dt><samp><span class="option">-nostdlib</span></samp><dd><a name="index-g_t_0040option_007b_002dnostdlib_007d-_0028_0040command_007bgnatbind_007d_0029-431"></a>Do not look for library files in the system default directory.
<br><dt><samp><span class="option">--RTS=</span><var>rts-path</var></samp><dd><a name="index-g_t_0040option_007b_002d_002dRTS_007d-_0028_0040code_007bgnatbind_007d_0029-432"></a>Specifies the default location of the runtime library. Same meaning as the
equivalent <samp><span class="command">gnatmake</span></samp> flag (see <a href="#Switches-for-gnatmake">Switches for gnatmake</a>).
<br><dt><samp><span class="option">-o </span><var>file</var></samp><dd><a name="index-g_t_0040option_007b_002do-_007d-_0028_0040command_007bgnatbind_007d_0029-433"></a>Name the output file <var>file</var> (default is <samp><span class="file">b~</span><var>xxx</var><span class="file">.adb</span></samp>).
Note that if this option is used, then linking must be done manually,
gnatlink cannot be used.
<br><dt><samp><span class="option">-O[=</span><var>filename</var><span class="option">]</span></samp><dd><a name="index-g_t_0040option_007b_002dO_007d-_0028_0040command_007bgnatbind_007d_0029-434"></a>Output object list (to standard output or to the named file).
<br><dt><samp><span class="option">-p</span></samp><dd><a name="index-g_t_0040option_007b_002dp_007d-_0028_0040command_007bgnatbind_007d_0029-435"></a>Pessimistic (worst-case) elaboration order
<br><dt><samp><span class="option">-R</span></samp><dd><a name="index-g_t_0040option_007b_002dR_007d-_0028_0040command_007bgnatbind_007d_0029-436"></a>Output closure source list.
<br><dt><samp><span class="option">-s</span></samp><dd><a name="index-g_t_0040option_007b_002ds_007d-_0028_0040command_007bgnatbind_007d_0029-437"></a>Require all source files to be present.
<br><dt><samp><span class="option">-S</span><var>xxx</var></samp><dd><a name="index-g_t_0040option_007b_002dS_007d-_0028_0040command_007bgnatbind_007d_0029-438"></a>Specifies the value to be used when detecting uninitialized scalar
objects with pragma Initialize_Scalars.
The <var>xxx</var> string specified with the switch may be either
<ul>
<li>“<samp><span class="option">in</span></samp>” requesting an invalid value where possible
<li>“<samp><span class="option">lo</span></samp>” for the lowest possible value
<li>“<samp><span class="option">hi</span></samp>” for the highest possible value
<li>“<samp><var>xx</var></samp>” for a value consisting of repeated bytes with the
value <code>16#</code><var>xx</var><code>#</code> (i.e., <var>xx</var> is a string of two hexadecimal digits).
</ul>
<p>In addition, you can specify <samp><span class="option">-Sev</span></samp> to indicate that the value is
to be set at run time. In this case, the program will look for an environment
<a name="index-GNAT_005fINIT_005fSCALARS-439"></a>variable of the form <samp><span class="env">GNAT_INIT_SCALARS=</span><var>xx</var></samp>, where <var>xx</var> is one
of <samp><span class="option">in/lo/hi/</span><var>xx</var></samp> with the same meanings as above.
If no environment variable is found, or if it does not have a valid value,
then the default is <samp><span class="option">in</span></samp> (invalid values).
<br><dt><samp><span class="option">-static</span></samp><dd><a name="index-g_t_0040option_007b_002dstatic_007d-_0028_0040code_007bgnatbind_007d_0029-440"></a>Link against a static GNAT run time.
<br><dt><samp><span class="option">-shared</span></samp><dd><a name="index-g_t_0040option_007b_002dshared_007d-_0028_0040code_007bgnatbind_007d_0029-441"></a>Link against a shared GNAT run time when available.
<br><dt><samp><span class="option">-t</span></samp><dd><a name="index-g_t_0040option_007b_002dt_007d-_0028_0040code_007bgnatbind_007d_0029-442"></a>Tolerate time stamp and other consistency errors
<br><dt><samp><span class="option">-T</span><var>n</var></samp><dd><a name="index-g_t_0040option_007b_002dT_007d-_0028_0040code_007bgnatbind_007d_0029-443"></a>Set the time slice value to <var>n</var> milliseconds. If the system supports
the specification of a specific time slice value, then the indicated value
is used. If the system does not support specific time slice values, but
does support some general notion of round-robin scheduling, then any
nonzero value will activate round-robin scheduling.
<p>A value of zero is treated specially. It turns off time
slicing, and in addition, indicates to the tasking run time that the
semantics should match as closely as possible the Annex D
requirements of the Ada RM, and in particular sets the default
scheduling policy to <code>FIFO_Within_Priorities</code>.
<br><dt><samp><span class="option">-u</span><var>n</var></samp><dd><a name="index-g_t_0040option_007b_002du_007d-_0028_0040code_007bgnatbind_007d_0029-444"></a>Enable dynamic stack usage, with <var>n</var> results stored and displayed
at program termination. A result is generated when a task
terminates. Results that can't be stored are displayed on the fly, at
task termination. This option is currently not supported on Itanium
platforms. (See <a href="#Dynamic-Stack-Usage-Analysis">Dynamic Stack Usage Analysis</a> for details.)
<br><dt><samp><span class="option">-v</span></samp><dd><a name="index-g_t_0040option_007b_002dv_007d-_0028_0040code_007bgnatbind_007d_0029-445"></a>Verbose mode. Write error messages, header, summary output to
<samp><span class="file">stdout</span></samp>.
<br><dt><samp><span class="option">-w</span><var>x</var></samp><dd><a name="index-g_t_0040option_007b_002dw_007d-_0028_0040code_007bgnatbind_007d_0029-446"></a>Warning mode (<var>x</var>=s/e for suppress/treat as error)
<br><dt><samp><span class="option">-Wx</span><var>e</var></samp><dd><a name="index-g_t_0040option_007b_002dWx_007d-_0028_0040code_007bgnatbind_007d_0029-447"></a>Override default wide character encoding for standard Text_IO files.
<br><dt><samp><span class="option">-x</span></samp><dd><a name="index-g_t_0040option_007b_002dx_007d-_0028_0040code_007bgnatbind_007d_0029-448"></a>Exclude source files (check object consistency only).
<br><dt><samp><span class="option">-y</span></samp><dd><a name="index-g_t_0040option_007b_002dy_007d-_0028_0040code_007bgnatbind_007d_0029-449"></a>Enable leap seconds support in <code>Ada.Calendar</code> and its children.
<br><dt><samp><span class="option">-z</span></samp><dd><a name="index-g_t_0040option_007b_002dz_007d-_0028_0040code_007bgnatbind_007d_0029-450"></a>No main subprogram.
</dl>
<p class="noindent">You may obtain this listing of switches by running <code>gnatbind</code> with
no arguments.
<div class="node">
<a name="Consistency-Checking-Modes"></a>
<a name="Consistency_002dChecking-Modes"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Binder-Error-Message-Control">Binder Error Message Control</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gnatbind">Switches for gnatbind</a>
</div>
<h4 class="subsection">4.2.1 Consistency-Checking Modes</h4>
<p class="noindent">As described earlier, by default <code>gnatbind</code> checks
that object files are consistent with one another and are consistent
with any source files it can locate. The following switches control binder
access to sources.
<dl>
<!-- !sort! -->
<dt><samp><span class="option">-s</span></samp><dd><a name="index-g_t_0040option_007b_002ds_007d-_0028_0040code_007bgnatbind_007d_0029-451"></a>Require source files to be present. In this mode, the binder must be
able to locate all source files that are referenced, in order to check
their consistency. In normal mode, if a source file cannot be located it
is simply ignored. If you specify this switch, a missing source
file is an error.
<br><dt><samp><span class="option">-Wx</span><var>e</var></samp><dd><a name="index-g_t_0040option_007b_002dWx_007d-_0028_0040code_007bgnatbind_007d_0029-452"></a>Override default wide character encoding for standard Text_IO files.
Normally the default wide character encoding method used for standard
[Wide_[Wide_]]Text_IO files is taken from the encoding specified for
the main source input (see description of switch
<samp><span class="option">-gnatWx</span></samp> for the compiler). The
use of this switch for the binder (which has the same set of
possible arguments) overrides this default as specified.
<br><dt><samp><span class="option">-x</span></samp><dd><a name="index-g_t_0040option_007b_002dx_007d-_0028_0040code_007bgnatbind_007d_0029-453"></a>Exclude source files. In this mode, the binder only checks that ALI
files are consistent with one another. Source files are not accessed.
The binder runs faster in this mode, and there is still a guarantee that
the resulting program is self-consistent.
If a source file has been edited since it was last compiled, and you
specify this switch, the binder will not detect that the object
file is out of date with respect to the source file. Note that this is the
mode that is automatically used by <samp><span class="command">gnatmake</span></samp> because in this
case the checking against sources has already been performed by
<samp><span class="command">gnatmake</span></samp> in the course of compilation (i.e. before binding).
</dl>
<div class="node">
<a name="Binder-Error-Message-Control"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Elaboration-Control">Elaboration Control</a>,
Previous: <a rel="previous" accesskey="p" href="#Consistency_002dChecking-Modes">Consistency-Checking Modes</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gnatbind">Switches for gnatbind</a>
</div>
<h4 class="subsection">4.2.2 Binder Error Message Control</h4>
<p class="noindent">The following switches provide control over the generation of error
messages from the binder:
<dl>
<!-- !sort! -->
<dt><samp><span class="option">-v</span></samp><dd><a name="index-g_t_0040option_007b_002dv_007d-_0028_0040code_007bgnatbind_007d_0029-454"></a>Verbose mode. In the normal mode, brief error messages are generated to
<samp><span class="file">stderr</span></samp>. If this switch is present, a header is written
to <samp><span class="file">stdout</span></samp> and any error messages are directed to <samp><span class="file">stdout</span></samp>.
All that is written to <samp><span class="file">stderr</span></samp> is a brief summary message.
<br><dt><samp><span class="option">-b</span></samp><dd><a name="index-g_t_0040option_007b_002db_007d-_0028_0040code_007bgnatbind_007d_0029-455"></a>Generate brief error messages to <samp><span class="file">stderr</span></samp> even if verbose mode is
specified. This is relevant only when used with the
<samp><span class="option">-v</span></samp> switch.
<br><dt><samp><span class="option">-m</span><var>n</var></samp><dd><a name="index-g_t_0040option_007b_002dm_007d-_0028_0040code_007bgnatbind_007d_0029-456"></a>Limits the number of error messages to <var>n</var>, a decimal integer in the
range 1-999. The binder terminates immediately if this limit is reached.
<br><dt><samp><span class="option">-M</span><var>xxx</var></samp><dd><a name="index-g_t_0040option_007b_002dM_007d-_0028_0040code_007bgnatbind_007d_0029-457"></a>Renames the generated main program from <code>main</code> to <code>xxx</code>.
This is useful in the case of some cross-building environments, where
the actual main program is separate from the one generated
by <code>gnatbind</code>.
<br><dt><samp><span class="option">-ws</span></samp><dd><a name="index-g_t_0040option_007b_002dws_007d-_0028_0040code_007bgnatbind_007d_0029-458"></a><a name="index-Warnings-459"></a>Suppress all warning messages.
<br><dt><samp><span class="option">-we</span></samp><dd><a name="index-g_t_0040option_007b_002dwe_007d-_0028_0040code_007bgnatbind_007d_0029-460"></a>Treat any warning messages as fatal errors.
<br><dt><samp><span class="option">-t</span></samp><dd><a name="index-g_t_0040option_007b_002dt_007d-_0028_0040code_007bgnatbind_007d_0029-461"></a><a name="index-Time-stamp-checks_002c-in-binder-462"></a><a name="index-Binder-consistency-checks-463"></a><a name="index-Consistency-checks_002c-in-binder-464"></a>The binder performs a number of consistency checks including:
<ul>
<li>Check that time stamps of a given source unit are consistent
<li>Check that checksums of a given source unit are consistent
<li>Check that consistent versions of <code>GNAT</code> were used for compilation
<li>Check consistency of configuration pragmas as required
</ul>
<p class="noindent">Normally failure of such checks, in accordance with the consistency
requirements of the Ada Reference Manual, causes error messages to be
generated which abort the binder and prevent the output of a binder
file and subsequent link to obtain an executable.
<p>The <samp><span class="option">-t</span></samp> switch converts these error messages
into warnings, so that
binding and linking can continue to completion even in the presence of such
errors. The result may be a failed link (due to missing symbols), or a
non-functional executable which has undefined semantics.
<em>This means that
</em><samp><span class="option">-t</span></samp><em> should be used only in unusual situations,
with extreme care.</em>
</dl>
<div class="node">
<a name="Elaboration-Control"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Output-Control">Output Control</a>,
Previous: <a rel="previous" accesskey="p" href="#Binder-Error-Message-Control">Binder Error Message Control</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gnatbind">Switches for gnatbind</a>
</div>
<h4 class="subsection">4.2.3 Elaboration Control</h4>
<p class="noindent">The following switches provide additional control over the elaboration
order. For full details see <a href="#Elaboration-Order-Handling-in-GNAT">Elaboration Order Handling in GNAT</a>.
<dl>
<dt><samp><span class="option">-p</span></samp><dd><a name="index-g_t_0040option_007b_002dp_007d-_0028_0040code_007bgnatbind_007d_0029-465"></a>Normally the binder attempts to choose an elaboration order that is
likely to minimize the likelihood of an elaboration order error resulting
in raising a <code>Program_Error</code> exception. This switch reverses the
action of the binder, and requests that it deliberately choose an order
that is likely to maximize the likelihood of an elaboration error.
This is useful in ensuring portability and avoiding dependence on
accidental fortuitous elaboration ordering.
<p>Normally it only makes sense to use the <samp><span class="option">-p</span></samp>
switch if dynamic
elaboration checking is used (<samp><span class="option">-gnatE</span></samp> switch used for compilation).
This is because in the default static elaboration mode, all necessary
<code>Elaborate</code> and <code>Elaborate_All</code> pragmas are implicitly inserted.
These implicit pragmas are still respected by the binder in
<samp><span class="option">-p</span></samp> mode, so a
safe elaboration order is assured.
</dl>
<div class="node">
<a name="Output-Control"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Dynamic-Allocation-Control">Dynamic Allocation Control</a>,
Previous: <a rel="previous" accesskey="p" href="#Elaboration-Control">Elaboration Control</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gnatbind">Switches for gnatbind</a>
</div>
<h4 class="subsection">4.2.4 Output Control</h4>
<p class="noindent">The following switches allow additional control over the output
generated by the binder.
<dl>
<!-- !sort! -->
<dt><samp><span class="option">-c</span></samp><dd><a name="index-g_t_0040option_007b_002dc_007d-_0028_0040code_007bgnatbind_007d_0029-466"></a>Check only. Do not generate the binder output file. In this mode the
binder performs all error checks but does not generate an output file.
<br><dt><samp><span class="option">-e</span></samp><dd><a name="index-g_t_0040option_007b_002de_007d-_0028_0040code_007bgnatbind_007d_0029-467"></a>Output complete list of elaboration-order dependencies, showing the
reason for each dependency. This output can be rather extensive but may
be useful in diagnosing problems with elaboration order. The output is
written to <samp><span class="file">stdout</span></samp>.
<br><dt><samp><span class="option">-h</span></samp><dd><a name="index-g_t_0040option_007b_002dh_007d-_0028_0040code_007bgnatbind_007d_0029-468"></a>Output usage information. The output is written to <samp><span class="file">stdout</span></samp>.
<br><dt><samp><span class="option">-K</span></samp><dd><a name="index-g_t_0040option_007b_002dK_007d-_0028_0040code_007bgnatbind_007d_0029-469"></a>Output linker options to <samp><span class="file">stdout</span></samp>. Includes library search paths,
contents of pragmas Ident and Linker_Options, and libraries added
by <code>gnatbind</code>.
<br><dt><samp><span class="option">-l</span></samp><dd><a name="index-g_t_0040option_007b_002dl_007d-_0028_0040code_007bgnatbind_007d_0029-470"></a>Output chosen elaboration order. The output is written to <samp><span class="file">stdout</span></samp>.
<br><dt><samp><span class="option">-O</span></samp><dd><a name="index-g_t_0040option_007b_002dO_007d-_0028_0040code_007bgnatbind_007d_0029-471"></a>Output full names of all the object files that must be linked to provide
the Ada component of the program. The output is written to <samp><span class="file">stdout</span></samp>.
This list includes the files explicitly supplied and referenced by the user
as well as implicitly referenced run-time unit files. The latter are
omitted if the corresponding units reside in shared libraries. The
directory names for the run-time units depend on the system configuration.
<br><dt><samp><span class="option">-o </span><var>file</var></samp><dd><a name="index-g_t_0040option_007b_002do_007d-_0028_0040code_007bgnatbind_007d_0029-472"></a>Set name of output file to <var>file</var> instead of the normal
<samp><span class="file">b~</span><var>mainprog</var><span class="file">.adb</span></samp> default. Note that <var>file</var> denote the Ada
binder generated body filename.
Note that if this option is used, then linking must be done manually.
It is not possible to use gnatlink in this case, since it cannot locate
the binder file.
<br><dt><samp><span class="option">-r</span></samp><dd><a name="index-g_t_0040option_007b_002dr_007d-_0028_0040code_007bgnatbind_007d_0029-473"></a>Generate list of <code>pragma Restrictions</code> that could be applied to
the current unit. This is useful for code audit purposes, and also may
be used to improve code generation in some cases.
</dl>
<div class="node">
<a name="Dynamic-Allocation-Control"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Binding-with-Non_002dAda-Main-Programs">Binding with Non-Ada Main Programs</a>,
Previous: <a rel="previous" accesskey="p" href="#Output-Control">Output Control</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gnatbind">Switches for gnatbind</a>
</div>
<h4 class="subsection">4.2.5 Dynamic Allocation Control</h4>
<p class="noindent">The heap control switches – <samp><span class="option">-H32</span></samp> and <samp><span class="option">-H64</span></samp> –
determine whether dynamic allocation uses 32-bit or 64-bit memory.
They only affect compiler-generated allocations via <code>__gnat_malloc</code>;
explicit calls to <code>malloc</code> and related functions from the C
run-time library are unaffected.
<dl>
<dt><samp><span class="option">-H32</span></samp><dd>Allocate memory on 32-bit heap
<br><dt><samp><span class="option">-H64</span></samp><dd>Allocate memory on 64-bit heap. This is the default
unless explicitly overridden by a <code>'Size</code> clause on the access type.
</dl>
<p class="noindent">These switches are only effective on VMS platforms.
<div class="node">
<a name="Binding-with-Non-Ada-Main-Programs"></a>
<a name="Binding-with-Non_002dAda-Main-Programs"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Binding-Programs-with-No-Main-Subprogram">Binding Programs with No Main Subprogram</a>,
Previous: <a rel="previous" accesskey="p" href="#Dynamic-Allocation-Control">Dynamic Allocation Control</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gnatbind">Switches for gnatbind</a>
</div>
<h4 class="subsection">4.2.6 Binding with Non-Ada Main Programs</h4>
<p class="noindent">In our description so far we have assumed that the main
program is in Ada, and that the task of the binder is to generate a
corresponding function <code>main</code> that invokes this Ada main
program. GNAT also supports the building of executable programs where
the main program is not in Ada, but some of the called routines are
written in Ada and compiled using GNAT (see <a href="#Mixed-Language-Programming">Mixed Language Programming</a>).
The following switch is used in this situation:
<dl>
<dt><samp><span class="option">-n</span></samp><dd><a name="index-g_t_0040option_007b_002dn_007d-_0028_0040code_007bgnatbind_007d_0029-474"></a>No main program. The main program is not in Ada.
</dl>
<p class="noindent">In this case, most of the functions of the binder are still required,
but instead of generating a main program, the binder generates a file
containing the following callable routines:
<dl>
<dt><code>adainit</code><dd><a name="index-adainit-475"></a>You must call this routine to initialize the Ada part of the program by
calling the necessary elaboration routines. A call to <code>adainit</code> is
required before the first call to an Ada subprogram.
<p>Note that it is assumed that the basic execution environment must be setup
to be appropriate for Ada execution at the point where the first Ada
subprogram is called. In particular, if the Ada code will do any
floating-point operations, then the FPU must be setup in an appropriate
manner. For the case of the x86, for example, full precision mode is
required. The procedure GNAT.Float_Control.Reset may be used to ensure
that the FPU is in the right state.
<br><dt><code>adafinal</code><dd><a name="index-adafinal-476"></a>You must call this routine to perform any library-level finalization
required by the Ada subprograms. A call to <code>adafinal</code> is required
after the last call to an Ada subprogram, and before the program
terminates.
</dl>
<p class="noindent">If the <samp><span class="option">-n</span></samp> switch
<a name="index-g_t_0040option_007b_002dn_007d-_0028_0040command_007bgnatbind_007d_0029-477"></a><a name="index-Binder_002c-multiple-input-files-478"></a>is given, more than one ALI file may appear on
the command line for <code>gnatbind</code>. The normal <dfn>closure</dfn>
calculation is performed for each of the specified units. Calculating
the closure means finding out the set of units involved by tracing
<code>with</code> references. The reason it is necessary to be able to
specify more than one ALI file is that a given program may invoke two or
more quite separate groups of Ada units.
<p>The binder takes the name of its output file from the last specified ALI
file, unless overridden by the use of the <samp><span class="option">-o file</span></samp>.
<a name="index-g_t_0040option_007b_002do_007d-_0028_0040command_007bgnatbind_007d_0029-479"></a>The output is an Ada unit in source form that can be compiled with GNAT.
This compilation occurs automatically as part of the <samp><span class="command">gnatlink</span></samp>
processing.
<p>Currently the GNAT run time requires a FPU using 80 bits mode
precision. Under targets where this is not the default it is required to
call GNAT.Float_Control.Reset before using floating point numbers (this
include float computation, float input and output) in the Ada code. A
side effect is that this could be the wrong mode for the foreign code
where floating point computation could be broken after this call.
<div class="node">
<a name="Binding-Programs-with-No-Main-Subprogram"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Binding-with-Non_002dAda-Main-Programs">Binding with Non-Ada Main Programs</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gnatbind">Switches for gnatbind</a>
</div>
<h4 class="subsection">4.2.7 Binding Programs with No Main Subprogram</h4>
<p class="noindent">It is possible to have an Ada program which does not have a main
subprogram. This program will call the elaboration routines of all the
packages, then the finalization routines.
<p>The following switch is used to bind programs organized in this manner:
<dl>
<dt><samp><span class="option">-z</span></samp><dd><a name="index-g_t_0040option_007b_002dz_007d-_0028_0040code_007bgnatbind_007d_0029-480"></a>Normally the binder checks that the unit name given on the command line
corresponds to a suitable main subprogram. When this switch is used,
a list of ALI files can be given, and the execution of the program
consists of elaboration of these units in an appropriate order. Note
that the default wide character encoding method for standard Text_IO
files is always set to Brackets if this switch is set (you can use
the binder switch
<samp><span class="option">-Wx</span></samp> to override this default).
</dl>
<div class="node">
<a name="Command-Line-Access"></a>
<a name="Command_002dLine-Access"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Search-Paths-for-gnatbind">Search Paths for gnatbind</a>,
Previous: <a rel="previous" accesskey="p" href="#Switches-for-gnatbind">Switches for gnatbind</a>,
Up: <a rel="up" accesskey="u" href="#Binding-Using-gnatbind">Binding Using gnatbind</a>
</div>
<h3 class="section">4.3 Command-Line Access</h3>
<p class="noindent">The package <code>Ada.Command_Line</code> provides access to the command-line
arguments and program name. In order for this interface to operate
correctly, the two variables
<pre class="smallexample"> int gnat_argc;
char **gnat_argv;
</pre>
<p class="noindent"><a name="index-gnat_005fargv-481"></a><a name="index-gnat_005fargc-482"></a>are declared in one of the GNAT library routines. These variables must
be set from the actual <code>argc</code> and <code>argv</code> values passed to the
main program. With no <samp><span class="option">n</span></samp> present, <code>gnatbind</code>
generates the C main program to automatically set these variables.
If the <samp><span class="option">n</span></samp> switch is used, there is no automatic way to
set these variables. If they are not set, the procedures in
<code>Ada.Command_Line</code> will not be available, and any attempt to use
them will raise <code>Constraint_Error</code>. If command line access is
required, your main program must set <code>gnat_argc</code> and
<code>gnat_argv</code> from the <code>argc</code> and <code>argv</code> values passed to
it.
<div class="node">
<a name="Search-Paths-for-gnatbind"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Examples-of-gnatbind-Usage">Examples of gnatbind Usage</a>,
Previous: <a rel="previous" accesskey="p" href="#Command_002dLine-Access">Command-Line Access</a>,
Up: <a rel="up" accesskey="u" href="#Binding-Using-gnatbind">Binding Using gnatbind</a>
</div>
<h3 class="section">4.4 Search Paths for <code>gnatbind</code></h3>
<p class="noindent">The binder takes the name of an ALI file as its argument and needs to
locate source files as well as other ALI files to verify object consistency.
<p>For source files, it follows exactly the same search rules as <samp><span class="command">gcc</span></samp>
(see <a href="#Search-Paths-and-the-Run_002dTime-Library-_0028RTL_0029">Search Paths and the Run-Time Library (RTL)</a>). For ALI files the
directories searched are:
<ol type=1 start=1>
<li>The directory containing the ALI file named in the command line, unless
the switch <samp><span class="option">-I-</span></samp> is specified.
<li>All directories specified by <samp><span class="option">-I</span></samp>
switches on the <code>gnatbind</code>
command line, in the order given.
<li><a name="index-ADA_005fPRJ_005fOBJECTS_005fFILE-483"></a>Each of the directories listed in the text file whose name is given
by the <samp><span class="env">ADA_PRJ_OBJECTS_FILE</span></samp> environment variable.
<p class="noindent"><samp><span class="env">ADA_PRJ_OBJECTS_FILE</span></samp> is normally set by gnatmake or by the gnat
driver when project files are used. It should not normally be set
by other means.
<li><a name="index-ADA_005fOBJECTS_005fPATH-484"></a>Each of the directories listed in the value of the
<samp><span class="env">ADA_OBJECTS_PATH</span></samp> environment variable.
Construct this value
exactly as the <samp><span class="env">PATH</span></samp> environment variable: a list of directory
names separated by colons (semicolons when working with the NT version
of GNAT).
<li>The content of the <samp><span class="file">ada_object_path</span></samp> file which is part of the GNAT
installation tree and is used to store standard libraries such as the
GNAT Run Time Library (RTL) unless the switch <samp><span class="option">-nostdlib</span></samp> is
specified.
<a href="#Installing-a-library">Installing a library</a>
</ol>
<p class="noindent">In the binder the switch <samp><span class="option">-I</span></samp>
<a name="index-g_t_0040option_007b_002dI_007d-_0028_0040command_007bgnatbind_007d_0029-485"></a>is used to specify both source and
library file paths. Use <samp><span class="option">-aI</span></samp>
<a name="index-g_t_0040option_007b_002daI_007d-_0028_0040command_007bgnatbind_007d_0029-486"></a>instead if you want to specify
source paths only, and <samp><span class="option">-aO</span></samp>
<a name="index-g_t_0040option_007b_002daO_007d-_0028_0040command_007bgnatbind_007d_0029-487"></a>if you want to specify library paths
only. This means that for the binder
<samp><span class="option">-I</span></samp><var>dir</var> is equivalent to
<samp><span class="option">-aI</span></samp><var>dir</var>
<samp><span class="option">-aO</span></samp><var>dir</var>.
The binder generates the bind file (a C language source file) in the
current working directory.
<p><a name="index-Ada-488"></a><a name="index-System-489"></a><a name="index-Interfaces-490"></a><a name="index-GNAT-491"></a>The packages <code>Ada</code>, <code>System</code>, and <code>Interfaces</code> and their
children make up the GNAT Run-Time Library, together with the package
GNAT and its children, which contain a set of useful additional
library functions provided by GNAT. The sources for these units are
needed by the compiler and are kept together in one directory. The ALI
files and object files generated by compiling the RTL are needed by the
binder and the linker and are kept together in one directory, typically
different from the directory containing the sources. In a normal
installation, you need not specify these directory names when compiling
or binding. Either the environment variables or the built-in defaults
cause these files to be found.
<p>Besides simplifying access to the RTL, a major use of search paths is
in compiling sources from multiple directories. This can make
development environments much more flexible.
<div class="node">
<a name="Examples-of-gnatbind-Usage"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Search-Paths-for-gnatbind">Search Paths for gnatbind</a>,
Up: <a rel="up" accesskey="u" href="#Binding-Using-gnatbind">Binding Using gnatbind</a>
</div>
<h3 class="section">4.5 Examples of <code>gnatbind</code> Usage</h3>
<p class="noindent">This section contains a number of examples of using the GNAT binding
utility <code>gnatbind</code>.
<dl>
<dt><code>gnatbind hello</code><dd>The main program <code>Hello</code> (source program in <samp><span class="file">hello.adb</span></samp>) is
bound using the standard switch settings. The generated main program is
<samp><span class="file">b~hello.adb</span></samp>. This is the normal, default use of the binder.
<br><dt><code>gnatbind hello -o mainprog.adb</code><dd>The main program <code>Hello</code> (source program in <samp><span class="file">hello.adb</span></samp>) is
bound using the standard switch settings. The generated main program is
<samp><span class="file">mainprog.adb</span></samp> with the associated spec in
<samp><span class="file">mainprog.ads</span></samp>. Note that you must specify the body here not the
spec. Note that if this option is used, then linking must be done manually,
since gnatlink will not be able to find the generated file.
</dl>
<!-- -->
<div class="node">
<a name="Linking-Using-gnatlink"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#The-GNAT-Make-Program-gnatmake">The GNAT Make Program gnatmake</a>,
Previous: <a rel="previous" accesskey="p" href="#Binding-Using-gnatbind">Binding Using gnatbind</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">5 Linking Using <samp><span class="command">gnatlink</span></samp></h2>
<!-- -->
<p><a name="index-gnatlink-492"></a>
This chapter discusses <samp><span class="command">gnatlink</span></samp>, a tool that links
an Ada program and builds an executable file. This utility
invokes the system linker (via the <samp><span class="command">gcc</span></samp> command)
with a correct list of object files and library references.
<samp><span class="command">gnatlink</span></samp> automatically determines the list of files and
references for the Ada part of a program. It uses the binder file
generated by the <samp><span class="command">gnatbind</span></samp> to determine this list.
<p>Note: to invoke <code>gnatlink</code> with a project file, use the <code>gnat</code>
driver (see <a href="#The-GNAT-Driver-and-Project-Files">The GNAT Driver and Project Files</a>).
<ul class="menu">
<li><a accesskey="1" href="#Running-gnatlink">Running gnatlink</a>
<li><a accesskey="2" href="#Switches-for-gnatlink">Switches for gnatlink</a>
</ul>
<div class="node">
<a name="Running-gnatlink"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Switches-for-gnatlink">Switches for gnatlink</a>,
Up: <a rel="up" accesskey="u" href="#Linking-Using-gnatlink">Linking Using gnatlink</a>
</div>
<h3 class="section">5.1 Running <samp><span class="command">gnatlink</span></samp></h3>
<p class="noindent">The form of the <samp><span class="command">gnatlink</span></samp> command is
<pre class="smallexample"> <!-- $ gnatlink @ovar{switches} @var{mainprog}@r{[}.ali@r{]} -->
<!-- @ovar{non-Ada objects} @ovar{linker options} -->
<!-- Expanding @ovar macro inline (explanation in macro def comments) -->
$ gnatlink <span class="roman">[</span><var>switches</var><span class="roman">]</span> <var>mainprog</var><span class="roman">[</span>.ali<span class="roman">]</span>
<span class="roman">[</span><var>non-Ada objects</var><span class="roman">]</span> <span class="roman">[</span><var>linker options</var><span class="roman">]</span>
</pre>
<p class="noindent">The arguments of <samp><span class="command">gnatlink</span></samp> (switches, main <samp><span class="file">ALI</span></samp> file,
non-Ada objects
or linker options) may be in any order, provided that no non-Ada object may
be mistaken for a main <samp><span class="file">ALI</span></samp> file.
Any file name <samp><span class="file">F</span></samp> without the <samp><span class="file">.ali</span></samp>
extension will be taken as the main <samp><span class="file">ALI</span></samp> file if a file exists
whose name is the concatenation of <samp><span class="file">F</span></samp> and <samp><span class="file">.ali</span></samp>.
<p class="noindent"><samp><var>mainprog</var><span class="file">.ali</span></samp> references the ALI file of the main program.
The <samp><span class="file">.ali</span></samp> extension of this file can be omitted. From this
reference, <samp><span class="command">gnatlink</span></samp> locates the corresponding binder file
<samp><span class="file">b~</span><var>mainprog</var><span class="file">.adb</span></samp> and, using the information in this file along
with the list of non-Ada objects and linker options, constructs a
linker command file to create the executable.
<p>The arguments other than the <samp><span class="command">gnatlink</span></samp> switches and the main
<samp><span class="file">ALI</span></samp> file are passed to the linker uninterpreted.
They typically include the names of
object files for units written in other languages than Ada and any library
references required to resolve references in any of these foreign language
units, or in <code>Import</code> pragmas in any Ada units.
<p><var>linker options</var> is an optional list of linker specific
switches.
The default linker called by gnatlink is <samp><span class="command">gcc</span></samp> which in
turn calls the appropriate system linker.
<p>One useful option for the linker is <samp><span class="option">-s</span></samp>: it reduces the size of the
executable by removing all symbol table and relocation information from the
executable.
<p>Standard options for the linker such as <samp><span class="option">-lmy_lib</span></samp> or
<samp><span class="option">-Ldir</span></samp> can be added as is.
For options that are not recognized by
<samp><span class="command">gcc</span></samp> as linker options, use the <samp><span class="command">gcc</span></samp> switches
<samp><span class="option">-Xlinker</span></samp> or <samp><span class="option">-Wl,</span></samp>.
<p>Refer to the GCC documentation for
details.
<p>Here is an example showing how to generate a linker map:
<pre class="smallexample"> $ gnatlink my_prog -Wl,-Map,MAPFILE
</pre>
<p>Using <var>linker options</var> it is possible to set the program stack and
heap size.
See <a href="#Setting-Stack-Size-from-gnatlink">Setting Stack Size from gnatlink</a> and
<a href="#Setting-Heap-Size-from-gnatlink">Setting Heap Size from gnatlink</a>.
<p><samp><span class="command">gnatlink</span></samp> determines the list of objects required by the Ada
program and prepends them to the list of objects passed to the linker.
<samp><span class="command">gnatlink</span></samp> also gathers any arguments set by the use of
<code>pragma Linker_Options</code> and adds them to the list of arguments
presented to the linker.
<div class="node">
<a name="Switches-for-gnatlink"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Running-gnatlink">Running gnatlink</a>,
Up: <a rel="up" accesskey="u" href="#Linking-Using-gnatlink">Linking Using gnatlink</a>
</div>
<h3 class="section">5.2 Switches for <samp><span class="command">gnatlink</span></samp></h3>
<p class="noindent">The following switches are available with the <samp><span class="command">gnatlink</span></samp> utility:
<dl>
<!-- !sort! -->
<dt><samp><span class="option">--version</span></samp><dd><a name="index-g_t_0040option_007b_002d_002dversion_007d-_0040command_007bgnatlink_007d-493"></a>Display Copyright and version, then exit disregarding all other options.
<br><dt><samp><span class="option">--help</span></samp><dd><a name="index-g_t_0040option_007b_002d_002dhelp_007d-_0040command_007bgnatlink_007d-494"></a>If <samp><span class="option">--version</span></samp> was not used, display usage, then exit disregarding
all other options.
<br><dt><samp><span class="option">-f</span></samp><dd><a name="index-Command-line-length-495"></a><a name="index-g_t_0040option_007b_002df_007d-_0028_0040command_007bgnatlink_007d_0029-496"></a>On some targets, the command line length is limited, and <samp><span class="command">gnatlink</span></samp>
will generate a separate file for the linker if the list of object files
is too long.
The <samp><span class="option">-f</span></samp> switch forces this file
to be generated even if
the limit is not exceeded. This is useful in some cases to deal with
special situations where the command line length is exceeded.
<br><dt><samp><span class="option">-g</span></samp><dd><a name="index-Debugging-information_002c-including-497"></a><a name="index-g_t_0040option_007b_002dg_007d-_0028_0040command_007bgnatlink_007d_0029-498"></a>The option to include debugging information causes the Ada bind file (in
other words, <samp><span class="file">b~</span><var>mainprog</var><span class="file">.adb</span></samp>) to be compiled with
<samp><span class="option">-g</span></samp>.
In addition, the binder does not delete the <samp><span class="file">b~</span><var>mainprog</var><span class="file">.adb</span></samp>,
<samp><span class="file">b~</span><var>mainprog</var><span class="file">.o</span></samp> and <samp><span class="file">b~</span><var>mainprog</var><span class="file">.ali</span></samp> files.
Without <samp><span class="option">-g</span></samp>, the binder removes these files by
default. The same procedure apply if a C bind file was generated using
<samp><span class="option">-C</span></samp> <code>gnatbind</code> option, in this case the filenames
are <samp><span class="file">b_</span><var>mainprog</var><span class="file">.c</span></samp> and <samp><span class="file">b_</span><var>mainprog</var><span class="file">.o</span></samp>.
<br><dt><samp><span class="option">-n</span></samp><dd><a name="index-g_t_0040option_007b_002dn_007d-_0028_0040command_007bgnatlink_007d_0029-499"></a>Do not compile the file generated by the binder. This may be used when
a link is rerun with different options, but there is no need to recompile
the binder file.
<br><dt><samp><span class="option">-v</span></samp><dd><a name="index-g_t_0040option_007b_002dv_007d-_0028_0040command_007bgnatlink_007d_0029-500"></a>Causes additional information to be output, including a full list of the
included object files. This switch option is most useful when you want
to see what set of object files are being used in the link step.
<br><dt><samp><span class="option">-v -v</span></samp><dd><a name="index-g_t_0040option_007b_002dv-_002dv_007d-_0028_0040command_007bgnatlink_007d_0029-501"></a>Very verbose mode. Requests that the compiler operate in verbose mode when
it compiles the binder file, and that the system linker run in verbose mode.
<br><dt><samp><span class="option">-o </span><var>exec-name</var></samp><dd><a name="index-g_t_0040option_007b_002do_007d-_0028_0040command_007bgnatlink_007d_0029-502"></a><var>exec-name</var> specifies an alternate name for the generated
executable program. If this switch is omitted, the executable has the same
name as the main unit. For example, <code>gnatlink try.ali</code> creates
an executable called <samp><span class="file">try</span></samp>.
<br><dt><samp><span class="option">-b </span><var>target</var></samp><dd><a name="index-g_t_0040option_007b_002db_007d-_0028_0040command_007bgnatlink_007d_0029-503"></a>Compile your program to run on <var>target</var>, which is the name of a
system configuration. You must have a GNAT cross-compiler built if
<var>target</var> is not the same as your host system.
<br><dt><samp><span class="option">-B</span><var>dir</var></samp><dd><a name="index-g_t_0040option_007b_002dB_007d-_0028_0040command_007bgnatlink_007d_0029-504"></a>Load compiler executables (for example, <code>gnat1</code>, the Ada compiler)
from <var>dir</var> instead of the default location. Only use this switch
when multiple versions of the GNAT compiler are available.
See <a href="gcc.html#Directory-Options">Directory Options</a>,
for further details. You would normally use the <samp><span class="option">-b</span></samp> or
<samp><span class="option">-V</span></samp> switch instead.
<br><dt><samp><span class="option">--GCC=</span><var>compiler_name</var></samp><dd><a name="index-g_t_0040option_007b_002d_002dGCC_003dcompiler_005fname_007d-_0028_0040command_007bgnatlink_007d_0029-505"></a>Program used for compiling the binder file. The default is
<samp><span class="command">gcc</span></samp>. You need to use quotes around <var>compiler_name</var> if
<code>compiler_name</code> contains spaces or other separator characters.
As an example <samp><span class="option">--GCC="foo -x -y"</span></samp> will instruct <samp><span class="command">gnatlink</span></samp> to
use <code>foo -x -y</code> as your compiler. Note that switch <samp><span class="option">-c</span></samp> is always
inserted after your command name. Thus in the above example the compiler
command that will be used by <samp><span class="command">gnatlink</span></samp> will be <code>foo -c -x -y</code>.
A limitation of this syntax is that the name and path name of the executable
itself must not include any embedded spaces. If the compiler executable is
different from the default one (gcc or <prefix>-gcc), then the back-end
switches in the ALI file are not used to compile the binder generated source.
For example, this is the case with <samp><span class="option">--GCC="foo -x -y"</span></samp>. But the back end
switches will be used for <samp><span class="option">--GCC="gcc -gnatv"</span></samp>. If several
<samp><span class="option">--GCC=compiler_name</span></samp> are used, only the last <var>compiler_name</var>
is taken into account. However, all the additional switches are also taken
into account. Thus,
<samp><span class="option">--GCC="foo -x -y" --GCC="bar -z -t"</span></samp> is equivalent to
<samp><span class="option">--GCC="bar -x -y -z -t"</span></samp>.
<br><dt><samp><span class="option">--LINK=</span><var>name</var></samp><dd><a name="index-g_t_0040option_007b_002d_002dLINK_003d_007d-_0028_0040command_007bgnatlink_007d_0029-506"></a><var>name</var> is the name of the linker to be invoked. This is especially
useful in mixed language programs since languages such as C++ require
their own linker to be used. When this switch is omitted, the default
name for the linker is <samp><span class="command">gcc</span></samp>. When this switch is used, the
specified linker is called instead of <samp><span class="command">gcc</span></samp> with exactly the same
parameters that would have been passed to <samp><span class="command">gcc</span></samp> so if the desired
linker requires different parameters it is necessary to use a wrapper
script that massages the parameters before invoking the real linker. It
may be useful to control the exact invocation by using the verbose
switch.
</dl>
<div class="node">
<a name="The-GNAT-Make-Program-gnatmake"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Improving-Performance">Improving Performance</a>,
Previous: <a rel="previous" accesskey="p" href="#Linking-Using-gnatlink">Linking Using gnatlink</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">6 The GNAT Make Program <samp><span class="command">gnatmake</span></samp></h2>
<p><a name="index-gnatmake-507"></a>
<ul class="menu">
<li><a accesskey="1" href="#Running-gnatmake">Running gnatmake</a>
<li><a accesskey="2" href="#Switches-for-gnatmake">Switches for gnatmake</a>
<li><a accesskey="3" href="#Mode-Switches-for-gnatmake">Mode Switches for gnatmake</a>
<li><a accesskey="4" href="#Notes-on-the-Command-Line">Notes on the Command Line</a>
<li><a accesskey="5" href="#How-gnatmake-Works">How gnatmake Works</a>
<li><a accesskey="6" href="#Examples-of-gnatmake-Usage">Examples of gnatmake Usage</a>
</ul>
A typical development cycle when working on an Ada program consists of
the following steps:
<ol type=1 start=1>
<li>Edit some sources to fix bugs.
<li>Add enhancements.
<li>Compile all sources affected.
<li>Rebind and relink.
<li>Test.
</ol>
<p class="noindent">The third step can be tricky, because not only do the modified files
<a name="index-Dependency-rules-508"></a>have to be compiled, but any files depending on these files must also be
recompiled. The dependency rules in Ada can be quite complex, especially
in the presence of overloading, <code>use</code> clauses, generics and inlined
subprograms.
<p><samp><span class="command">gnatmake</span></samp> automatically takes care of the third and fourth steps
of this process. It determines which sources need to be compiled,
compiles them, and binds and links the resulting object files.
<p>Unlike some other Ada make programs, the dependencies are always
accurately recomputed from the new sources. The source based approach of
the GNAT compilation model makes this possible. This means that if
changes to the source program cause corresponding changes in
dependencies, they will always be tracked exactly correctly by
<samp><span class="command">gnatmake</span></samp>.
<div class="node">
<a name="Running-gnatmake"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Switches-for-gnatmake">Switches for gnatmake</a>,
Up: <a rel="up" accesskey="u" href="#The-GNAT-Make-Program-gnatmake">The GNAT Make Program gnatmake</a>
</div>
<h3 class="section">6.1 Running <samp><span class="command">gnatmake</span></samp></h3>
<p class="noindent">The usual form of the <samp><span class="command">gnatmake</span></samp> command is
<pre class="smallexample"> <!-- $ gnatmake @ovar{switches} @var{file_name} -->
<!-- @ovar{file_names} @ovar{mode_switches} -->
<!-- Expanding @ovar macro inline (explanation in macro def comments) -->
$ gnatmake <span class="roman">[</span><var>switches</var><span class="roman">]</span> <var>file_name</var>
<span class="roman">[</span><var>file_names</var><span class="roman">]</span> <span class="roman">[</span><var>mode_switches</var><span class="roman">]</span>
</pre>
<p class="noindent">The only required argument is one <var>file_name</var>, which specifies
a compilation unit that is a main program. Several <var>file_names</var> can be
specified: this will result in several executables being built.
If <code>switches</code> are present, they can be placed before the first
<var>file_name</var>, between <var>file_names</var> or after the last <var>file_name</var>.
If <var>mode_switches</var> are present, they must always be placed after
the last <var>file_name</var> and all <code>switches</code>.
<p>If you are using standard file extensions (<samp><span class="file">.adb</span></samp> and <samp><span class="file">.ads</span></samp>), then the
extension may be omitted from the <var>file_name</var> arguments. However, if
you are using non-standard extensions, then it is required that the
extension be given. A relative or absolute directory path can be
specified in a <var>file_name</var>, in which case, the input source file will
be searched for in the specified directory only. Otherwise, the input
source file will first be searched in the directory where
<samp><span class="command">gnatmake</span></samp> was invoked and if it is not found, it will be search on
the source path of the compiler as described in
<a href="#Search-Paths-and-the-Run_002dTime-Library-_0028RTL_0029">Search Paths and the Run-Time Library (RTL)</a>.
<p>All <samp><span class="command">gnatmake</span></samp> output (except when you specify
<samp><span class="option">-M</span></samp>) is to
<samp><span class="file">stderr</span></samp>. The output produced by the
<samp><span class="option">-M</span></samp> switch is send to
<samp><span class="file">stdout</span></samp>.
<div class="node">
<a name="Switches-for-gnatmake"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Mode-Switches-for-gnatmake">Mode Switches for gnatmake</a>,
Previous: <a rel="previous" accesskey="p" href="#Running-gnatmake">Running gnatmake</a>,
Up: <a rel="up" accesskey="u" href="#The-GNAT-Make-Program-gnatmake">The GNAT Make Program gnatmake</a>
</div>
<h3 class="section">6.2 Switches for <samp><span class="command">gnatmake</span></samp></h3>
<p class="noindent">You may specify any of the following switches to <samp><span class="command">gnatmake</span></samp>:
<dl>
<!-- !sort! -->
<dt><samp><span class="option">--version</span></samp><dd><a name="index-g_t_0040option_007b_002d_002dversion_007d-_0040command_007bgnatmake_007d-509"></a>Display Copyright and version, then exit disregarding all other options.
<br><dt><samp><span class="option">--help</span></samp><dd><a name="index-g_t_0040option_007b_002d_002dhelp_007d-_0040command_007bgnatmake_007d-510"></a>If <samp><span class="option">--version</span></samp> was not used, display usage, then exit disregarding
all other options.
<br><dt><samp><span class="option">--GCC=</span><var>compiler_name</var></samp><dd><a name="index-g_t_0040option_007b_002d_002dGCC_003dcompiler_005fname_007d-_0028_0040command_007bgnatmake_007d_0029-511"></a>Program used for compiling. The default is `<samp><span class="command">gcc</span></samp>'. You need to use
quotes around <var>compiler_name</var> if <code>compiler_name</code> contains
spaces or other separator characters. As an example <samp><span class="option">--GCC="foo -x
-y"</span></samp> will instruct <samp><span class="command">gnatmake</span></samp> to use <code>foo -x -y</code> as your
compiler. A limitation of this syntax is that the name and path name of
the executable itself must not include any embedded spaces. Note that
switch <samp><span class="option">-c</span></samp> is always inserted after your command name. Thus in the
above example the compiler command that will be used by <samp><span class="command">gnatmake</span></samp>
will be <code>foo -c -x -y</code>. If several <samp><span class="option">--GCC=compiler_name</span></samp> are
used, only the last <var>compiler_name</var> is taken into account. However,
all the additional switches are also taken into account. Thus,
<samp><span class="option">--GCC="foo -x -y" --GCC="bar -z -t"</span></samp> is equivalent to
<samp><span class="option">--GCC="bar -x -y -z -t"</span></samp>.
<br><dt><samp><span class="option">--GNATBIND=</span><var>binder_name</var></samp><dd><a name="index-g_t_0040option_007b_002d_002dGNATBIND_003dbinder_005fname_007d-_0028_0040command_007bgnatmake_007d_0029-512"></a>Program used for binding. The default is `<code>gnatbind</code>'. You need to
use quotes around <var>binder_name</var> if <var>binder_name</var> contains spaces
or other separator characters. As an example <samp><span class="option">--GNATBIND="bar -x
-y"</span></samp> will instruct <samp><span class="command">gnatmake</span></samp> to use <code>bar -x -y</code> as your
binder. Binder switches that are normally appended by <samp><span class="command">gnatmake</span></samp>
to `<code>gnatbind</code>' are now appended to the end of <code>bar -x -y</code>.
A limitation of this syntax is that the name and path name of the executable
itself must not include any embedded spaces.
<br><dt><samp><span class="option">--GNATLINK=</span><var>linker_name</var></samp><dd><a name="index-g_t_0040option_007b_002d_002dGNATLINK_003dlinker_005fname_007d-_0028_0040command_007bgnatmake_007d_0029-513"></a>Program used for linking. The default is `<samp><span class="command">gnatlink</span></samp>'. You need to
use quotes around <var>linker_name</var> if <var>linker_name</var> contains spaces
or other separator characters. As an example <samp><span class="option">--GNATLINK="lan -x
-y"</span></samp> will instruct <samp><span class="command">gnatmake</span></samp> to use <code>lan -x -y</code> as your
linker. Linker switches that are normally appended by <samp><span class="command">gnatmake</span></samp> to
`<samp><span class="command">gnatlink</span></samp>' are now appended to the end of <code>lan -x -y</code>.
A limitation of this syntax is that the name and path name of the executable
itself must not include any embedded spaces.
<br><dt><samp><span class="option">--subdirs=subdir</span></samp><dd>Actual object directory of each project file is the subdirectory subdir of the
object directory specified or defaulted in the project file.
<br><dt><samp><span class="option">--single-compile-per-obj-dir</span></samp><dd>Disallow simultaneous compilations in the same object directory when
project files are used.
<br><dt><samp><span class="option">--unchecked-shared-lib-imports</span></samp><dd>By default, shared library projects are not allowed to import static library
projects. When this switch is used on the command line, this restriction is
relaxed.
<br><dt><samp><span class="option">--source-info=<source info file></span></samp><dd>Specify a source info file. This switch is active only when project files
are used. If the source info file is specified as a relative path, then it is
relative to the object directory of the main project. If the source info file
does not exist, then after the Project Manager has successfully parsed and
processed the project files and found the sources, it creates the source info
file. If the source info file already exists and can be read successfully,
then the Project Manager will get all the needed information about the sources
from the source info file and will not look for them. This reduces the time
to process the project files, especially when looking for sources that take a
long time. If the source info file exists but cannot be parsed successfully,
the Project Manager will attempt to recreate it. If the Project Manager fails
to create the source info file, a message is issued, but gnatmake does not
fail.
<br><dt><samp><span class="option">--create-map-file</span></samp><dd>When linking an executable, create a map file. The name of the map file
has the same name as the executable with extension ".map".
<br><dt><samp><span class="option">--create-map-file=mapfile</span></samp><dd>When linking an executable, create a map file. The name of the map file is
"mapfile".
<br><dt><samp><span class="option">-a</span></samp><dd><a name="index-g_t_0040option_007b_002da_007d-_0028_0040command_007bgnatmake_007d_0029-514"></a>Consider all files in the make process, even the GNAT internal system
files (for example, the predefined Ada library files), as well as any
locked files. Locked files are files whose ALI file is write-protected.
By default,
<samp><span class="command">gnatmake</span></samp> does not check these files,
because the assumption is that the GNAT internal files are properly up
to date, and also that any write protected ALI files have been properly
installed. Note that if there is an installation problem, such that one
of these files is not up to date, it will be properly caught by the
binder.
You may have to specify this switch if you are working on GNAT
itself. The switch <samp><span class="option">-a</span></samp> is also useful
in conjunction with <samp><span class="option">-f</span></samp>
if you need to recompile an entire application,
including run-time files, using special configuration pragmas,
such as a <code>Normalize_Scalars</code> pragma.
<p>By default
<code>gnatmake -a</code> compiles all GNAT
internal files with
<code>gcc -c -gnatpg</code> rather than <code>gcc -c</code>.
<br><dt><samp><span class="option">-b</span></samp><dd><a name="index-g_t_0040option_007b_002db_007d-_0028_0040command_007bgnatmake_007d_0029-515"></a>Bind only. Can be combined with <samp><span class="option">-c</span></samp> to do
compilation and binding, but no link.
Can be combined with <samp><span class="option">-l</span></samp>
to do binding and linking. When not combined with
<samp><span class="option">-c</span></samp>
all the units in the closure of the main program must have been previously
compiled and must be up to date. The root unit specified by <var>file_name</var>
may be given without extension, with the source extension or, if no GNAT
Project File is specified, with the ALI file extension.
<br><dt><samp><span class="option">-c</span></samp><dd><a name="index-g_t_0040option_007b_002dc_007d-_0028_0040command_007bgnatmake_007d_0029-516"></a>Compile only. Do not perform binding, except when <samp><span class="option">-b</span></samp>
is also specified. Do not perform linking, except if both
<samp><span class="option">-b</span></samp> and
<samp><span class="option">-l</span></samp> are also specified.
If the root unit specified by <var>file_name</var> is not a main unit, this is the
default. Otherwise <samp><span class="command">gnatmake</span></samp> will attempt binding and linking
unless all objects are up to date and the executable is more recent than
the objects.
<br><dt><samp><span class="option">-C</span></samp><dd><a name="index-g_t_0040option_007b_002dC_007d-_0028_0040command_007bgnatmake_007d_0029-517"></a>Use a temporary mapping file. A mapping file is a way to communicate
to the compiler two mappings: from unit names to file names (without
any directory information) and from file names to path names (with
full directory information). A mapping file can make the compiler's
file searches faster, especially if there are many source directories,
or the sources are read over a slow network connection. If
<samp><span class="option">-P</span></samp> is used, a mapping file is always used, so
<samp><span class="option">-C</span></samp> is unnecessary; in this case the mapping file
is initially populated based on the project file. If
<samp><span class="option">-C</span></samp> is used without
<samp><span class="option">-P</span></samp>,
the mapping file is initially empty. Each invocation of the compiler
will add any newly accessed sources to the mapping file.
<br><dt><samp><span class="option">-C=</span><var>file</var></samp><dd><a name="index-g_t_0040option_007b_002dC_003d_007d-_0028_0040command_007bgnatmake_007d_0029-518"></a>Use a specific mapping file. The file, specified as a path name (absolute or
relative) by this switch, should already exist, otherwise the switch is
ineffective. The specified mapping file will be communicated to the compiler.
This switch is not compatible with a project file
(-P<var>file</var>) or with multiple compiling processes
(-jnnn, when nnn is greater than 1).
<br><dt><samp><span class="option">-d</span></samp><dd><a name="index-g_t_0040option_007b_002dd_007d-_0028_0040command_007bgnatmake_007d_0029-519"></a>Display progress for each source, up to date or not, as a single line
<pre class="smallexample"> completed x out of y (zz%)
</pre>
<p>If the file needs to be compiled this is displayed after the invocation of
the compiler. These lines are displayed even in quiet output mode.
<br><dt><samp><span class="option">-D </span><var>dir</var></samp><dd><a name="index-g_t_0040option_007b_002dD_007d-_0028_0040command_007bgnatmake_007d_0029-520"></a>Put all object files and ALI file in directory <var>dir</var>.
If the <samp><span class="option">-D</span></samp> switch is not used, all object files
and ALI files go in the current working directory.
<p>This switch cannot be used when using a project file.
<br><dt><samp><span class="option">-eL</span></samp><dd><a name="index-g_t_0040option_007b_002deL_007d-_0028_0040command_007bgnatmake_007d_0029-521"></a><a name="index-symbolic-links-522"></a>Follow all symbolic links when processing project files.
This should be used if your project uses symbolic links for files or
directories, but is not needed in other cases.
<p><a name="index-naming-scheme-523"></a>This also assumes that no directory matches the naming scheme for files (for
instance that you do not have a directory called "sources.ads" when using the
default GNAT naming scheme).
<p>When you do not have to use this switch (i.e. by default), gnatmake is able to
save a lot of system calls (several per source file and object file), which
can result in a significant speed up to load and manipulate a project file,
especially when using source files from a remote system.
<br><dt><samp><span class="option">-eS</span></samp><dd><a name="index-g_t_0040option_007b_002deS_007d-_0028_0040command_007bgnatmake_007d_0029-524"></a>Output the commands for the compiler, the binder and the linker
on standard output,
instead of standard error.
<br><dt><samp><span class="option">-f</span></samp><dd><a name="index-g_t_0040option_007b_002df_007d-_0028_0040command_007bgnatmake_007d_0029-525"></a>Force recompilations. Recompile all sources, even though some object
files may be up to date, but don't recompile predefined or GNAT internal
files or locked files (files with a write-protected ALI file),
unless the <samp><span class="option">-a</span></samp> switch is also specified.
<br><dt><samp><span class="option">-F</span></samp><dd><a name="index-g_t_0040option_007b_002dF_007d-_0028_0040command_007bgnatmake_007d_0029-526"></a>When using project files, if some errors or warnings are detected during
parsing and verbose mode is not in effect (no use of switch
-v), then error lines start with the full path name of the project
file, rather than its simple file name.
<br><dt><samp><span class="option">-g</span></samp><dd><a name="index-g_t_0040option_007b_002dg_007d-_0028_0040command_007bgnatmake_007d_0029-527"></a>Enable debugging. This switch is simply passed to the compiler and to the
linker.
<br><dt><samp><span class="option">-i</span></samp><dd><a name="index-g_t_0040option_007b_002di_007d-_0028_0040command_007bgnatmake_007d_0029-528"></a>In normal mode, <samp><span class="command">gnatmake</span></samp> compiles all object files and ALI files
into the current directory. If the <samp><span class="option">-i</span></samp> switch is used,
then instead object files and ALI files that already exist are overwritten
in place. This means that once a large project is organized into separate
directories in the desired manner, then <samp><span class="command">gnatmake</span></samp> will automatically
maintain and update this organization. If no ALI files are found on the
Ada object path (<a href="#Search-Paths-and-the-Run_002dTime-Library-_0028RTL_0029">Search Paths and the Run-Time Library (RTL)</a>),
the new object and ALI files are created in the
directory containing the source being compiled. If another organization
is desired, where objects and sources are kept in different directories,
a useful technique is to create dummy ALI files in the desired directories.
When detecting such a dummy file, <samp><span class="command">gnatmake</span></samp> will be forced to
recompile the corresponding source file, and it will be put the resulting
object and ALI files in the directory where it found the dummy file.
<br><dt><samp><span class="option">-j</span><var>n</var></samp><dd><a name="index-g_t_0040option_007b_002dj_007d-_0028_0040command_007bgnatmake_007d_0029-529"></a><a name="index-Parallel-make-530"></a>Use <var>n</var> processes to carry out the (re)compilations. On a
multiprocessor machine compilations will occur in parallel. In the
event of compilation errors, messages from various compilations might
get interspersed (but <samp><span class="command">gnatmake</span></samp> will give you the full ordered
list of failing compiles at the end). If this is problematic, rerun
the make process with n set to 1 to get a clean list of messages.
<br><dt><samp><span class="option">-k</span></samp><dd><a name="index-g_t_0040option_007b_002dk_007d-_0028_0040command_007bgnatmake_007d_0029-531"></a>Keep going. Continue as much as possible after a compilation error. To
ease the programmer's task in case of compilation errors, the list of
sources for which the compile fails is given when <samp><span class="command">gnatmake</span></samp>
terminates.
<p>If <samp><span class="command">gnatmake</span></samp> is invoked with several <samp><span class="file">file_names</span></samp> and with this
switch, if there are compilation errors when building an executable,
<samp><span class="command">gnatmake</span></samp> will not attempt to build the following executables.
<br><dt><samp><span class="option">-l</span></samp><dd><a name="index-g_t_0040option_007b_002dl_007d-_0028_0040command_007bgnatmake_007d_0029-532"></a>Link only. Can be combined with <samp><span class="option">-b</span></samp> to binding
and linking. Linking will not be performed if combined with
<samp><span class="option">-c</span></samp>
but not with <samp><span class="option">-b</span></samp>.
When not combined with <samp><span class="option">-b</span></samp>
all the units in the closure of the main program must have been previously
compiled and must be up to date, and the main program needs to have been bound.
The root unit specified by <var>file_name</var>
may be given without extension, with the source extension or, if no GNAT
Project File is specified, with the ALI file extension.
<br><dt><samp><span class="option">-m</span></samp><dd><a name="index-g_t_0040option_007b_002dm_007d-_0028_0040command_007bgnatmake_007d_0029-533"></a>Specify that the minimum necessary amount of recompilations
be performed. In this mode <samp><span class="command">gnatmake</span></samp> ignores time
stamp differences when the only
modifications to a source file consist in adding/removing comments,
empty lines, spaces or tabs. This means that if you have changed the
comments in a source file or have simply reformatted it, using this
switch will tell <samp><span class="command">gnatmake</span></samp> not to recompile files that depend on it
(provided other sources on which these files depend have undergone no
semantic modifications). Note that the debugging information may be
out of date with respect to the sources if the <samp><span class="option">-m</span></samp> switch causes
a compilation to be switched, so the use of this switch represents a
trade-off between compilation time and accurate debugging information.
<br><dt><samp><span class="option">-M</span></samp><dd><a name="index-Dependencies_002c-producing-list-534"></a><a name="index-g_t_0040option_007b_002dM_007d-_0028_0040command_007bgnatmake_007d_0029-535"></a>Check if all objects are up to date. If they are, output the object
dependences to <samp><span class="file">stdout</span></samp> in a form that can be directly exploited in
a <samp><span class="file">Makefile</span></samp>. By default, each source file is prefixed with its
(relative or absolute) directory name. This name is whatever you
specified in the various <samp><span class="option">-aI</span></samp>
and <samp><span class="option">-I</span></samp> switches. If you use
<code>gnatmake -M</code>
<samp><span class="option">-q</span></samp>
(see below), only the source file names,
without relative paths, are output. If you just specify the
<samp><span class="option">-M</span></samp>
switch, dependencies of the GNAT internal system files are omitted. This
is typically what you want. If you also specify
the <samp><span class="option">-a</span></samp> switch,
dependencies of the GNAT internal files are also listed. Note that
dependencies of the objects in external Ada libraries (see switch
<samp><span class="option">-aL</span></samp><var>dir</var> in the following list)
are never reported.
<br><dt><samp><span class="option">-n</span></samp><dd><a name="index-g_t_0040option_007b_002dn_007d-_0028_0040command_007bgnatmake_007d_0029-536"></a>Don't compile, bind, or link. Checks if all objects are up to date.
If they are not, the full name of the first file that needs to be
recompiled is printed.
Repeated use of this option, followed by compiling the indicated source
file, will eventually result in recompiling all required units.
<br><dt><samp><span class="option">-o </span><var>exec_name</var></samp><dd><a name="index-g_t_0040option_007b_002do_007d-_0028_0040command_007bgnatmake_007d_0029-537"></a>Output executable name. The name of the final executable program will be
<var>exec_name</var>. If the <samp><span class="option">-o</span></samp> switch is omitted the default
name for the executable will be the name of the input file in appropriate form
for an executable file on the host system.
<p>This switch cannot be used when invoking <samp><span class="command">gnatmake</span></samp> with several
<samp><span class="file">file_names</span></samp>.
<br><dt><samp><span class="option">-p or --create-missing-dirs</span></samp><dd><a name="index-g_t_0040option_007b_002dp_007d-_0028_0040command_007bgnatmake_007d_0029-538"></a>When using project files (-P<var>project</var>), create
automatically missing object directories, library directories and exec
directories.
<br><dt><samp><span class="option">-P</span><var>project</var></samp><dd><a name="index-g_t_0040option_007b_002dP_007d-_0028_0040command_007bgnatmake_007d_0029-539"></a>Use project file <var>project</var>. Only one such switch can be used.
See <a href="#gnatmake-and-Project-Files">gnatmake and Project Files</a>.
<br><dt><samp><span class="option">-q</span></samp><dd><a name="index-g_t_0040option_007b_002dq_007d-_0028_0040command_007bgnatmake_007d_0029-540"></a>Quiet. When this flag is not set, the commands carried out by
<samp><span class="command">gnatmake</span></samp> are displayed.
<br><dt><samp><span class="option">-s</span></samp><dd><a name="index-g_t_0040option_007b_002ds_007d-_0028_0040command_007bgnatmake_007d_0029-541"></a>Recompile if compiler switches have changed since last compilation.
All compiler switches but -I and -o are taken into account in the
following way:
orders between different “first letter” switches are ignored, but
orders between same switches are taken into account. For example,
<samp><span class="option">-O -O2</span></samp> is different than <samp><span class="option">-O2 -O</span></samp>, but <samp><span class="option">-g -O</span></samp>
is equivalent to <samp><span class="option">-O -g</span></samp>.
<p>This switch is recommended when Integrated Preprocessing is used.
<br><dt><samp><span class="option">-u</span></samp><dd><a name="index-g_t_0040option_007b_002du_007d-_0028_0040command_007bgnatmake_007d_0029-542"></a>Unique. Recompile at most the main files. It implies -c. Combined with
-f, it is equivalent to calling the compiler directly. Note that using
-u with a project file and no main has a special meaning
(see <a href="#Project-Files-and-Main-Subprograms">Project Files and Main Subprograms</a>).
<br><dt><samp><span class="option">-U</span></samp><dd><a name="index-g_t_0040option_007b_002dU_007d-_0028_0040command_007bgnatmake_007d_0029-543"></a>When used without a project file or with one or several mains on the command
line, is equivalent to -u. When used with a project file and no main
on the command line, all sources of all project files are checked and compiled
if not up to date, and libraries are rebuilt, if necessary.
<br><dt><samp><span class="option">-v</span></samp><dd><a name="index-g_t_0040option_007b_002dv_007d-_0028_0040command_007bgnatmake_007d_0029-544"></a>Verbose. Display the reason for all recompilations <samp><span class="command">gnatmake</span></samp>
decides are necessary, with the highest verbosity level.
<br><dt><samp><span class="option">-vl</span></samp><dd><a name="index-g_t_0040option_007b_002dvl_007d-_0028_0040command_007bgnatmake_007d_0029-545"></a>Verbosity level Low. Display fewer lines than in verbosity Medium.
<br><dt><samp><span class="option">-vm</span></samp><dd><a name="index-g_t_0040option_007b_002dvm_007d-_0028_0040command_007bgnatmake_007d_0029-546"></a>Verbosity level Medium. Potentially display fewer lines than in verbosity High.
<br><dt><samp><span class="option">-vh</span></samp><dd><a name="index-g_t_0040option_007b_002dvm_007d-_0028_0040command_007bgnatmake_007d_0029-547"></a>Verbosity level High. Equivalent to -v.
<br><dt><samp><span class="option">-vP</span><em>x</em></samp><dd>Indicate the verbosity of the parsing of GNAT project files.
See <a href="#Switches-Related-to-Project-Files">Switches Related to Project Files</a>.
<br><dt><samp><span class="option">-x</span></samp><dd><a name="index-g_t_0040option_007b_002dx_007d-_0028_0040command_007bgnatmake_007d_0029-548"></a>Indicate that sources that are not part of any Project File may be compiled.
Normally, when using Project Files, only sources that are part of a Project
File may be compile. When this switch is used, a source outside of all Project
Files may be compiled. The ALI file and the object file will be put in the
object directory of the main Project. The compilation switches used will only
be those specified on the command line. Even when
<samp><span class="option">-x</span></samp> is used, mains specified on the
command line need to be sources of a project file.
<br><dt><samp><span class="option">-X</span><var>name=value</var></samp><dd>Indicate that external variable <var>name</var> has the value <var>value</var>.
The Project Manager will use this value for occurrences of
<code>external(name)</code> when parsing the project file.
See <a href="#Switches-Related-to-Project-Files">Switches Related to Project Files</a>.
<br><dt><samp><span class="option">-z</span></samp><dd><a name="index-g_t_0040option_007b_002dz_007d-_0028_0040command_007bgnatmake_007d_0029-549"></a>No main subprogram. Bind and link the program even if the unit name
given on the command line is a package name. The resulting executable
will execute the elaboration routines of the package and its closure,
then the finalization routines.
</dl>
<dl>
<dt><samp><span class="command">gcc</span></samp> switches<dd>Any uppercase or multi-character switch that is not a <samp><span class="command">gnatmake</span></samp> switch
is passed to <samp><span class="command">gcc</span></samp> (e.g. <samp><span class="option">-O</span></samp>, <samp><span class="option">-gnato,</span></samp> etc.)
</dl>
<p class="noindent">Source and library search path switches:
<dl>
<!-- !sort! -->
<dt><samp><span class="option">-aI</span><var>dir</var></samp><dd><a name="index-g_t_0040option_007b_002daI_007d-_0028_0040command_007bgnatmake_007d_0029-550"></a>When looking for source files also look in directory <var>dir</var>.
The order in which source files search is undertaken is
described in <a href="#Search-Paths-and-the-Run_002dTime-Library-_0028RTL_0029">Search Paths and the Run-Time Library (RTL)</a>.
<br><dt><samp><span class="option">-aL</span><var>dir</var></samp><dd><a name="index-g_t_0040option_007b_002daL_007d-_0028_0040command_007bgnatmake_007d_0029-551"></a>Consider <var>dir</var> as being an externally provided Ada library.
Instructs <samp><span class="command">gnatmake</span></samp> to skip compilation units whose <samp><span class="file">.ALI</span></samp>
files have been located in directory <var>dir</var>. This allows you to have
missing bodies for the units in <var>dir</var> and to ignore out of date bodies
for the same units. You still need to specify
the location of the specs for these units by using the switches
<samp><span class="option">-aI</span><var>dir</var></samp>
or <samp><span class="option">-I</span><var>dir</var></samp>.
Note: this switch is provided for compatibility with previous versions
of <samp><span class="command">gnatmake</span></samp>. The easier method of causing standard libraries
to be excluded from consideration is to write-protect the corresponding
ALI files.
<br><dt><samp><span class="option">-aO</span><var>dir</var></samp><dd><a name="index-g_t_0040option_007b_002daO_007d-_0028_0040command_007bgnatmake_007d_0029-552"></a>When searching for library and object files, look in directory
<var>dir</var>. The order in which library files are searched is described in
<a href="#Search-Paths-for-gnatbind">Search Paths for gnatbind</a>.
<br><dt><samp><span class="option">-A</span><var>dir</var></samp><dd><a name="index-Search-paths_002c-for-_0040command_007bgnatmake_007d-553"></a><a name="index-g_t_0040option_007b_002dA_007d-_0028_0040command_007bgnatmake_007d_0029-554"></a>Equivalent to <samp><span class="option">-aL</span><var>dir</var><span class="option">
-aI</span><var>dir</var></samp>.
<br><dt><samp><span class="option">-I</span><var>dir</var></samp><dd><a name="index-g_t_0040option_007b_002dI_007d-_0028_0040command_007bgnatmake_007d_0029-555"></a>Equivalent to <samp><span class="option">-aO</span><var>dir</var><span class="option">
-aI</span><var>dir</var></samp>.
<br><dt><samp><span class="option">-I-</span></samp><dd><a name="index-g_t_0040option_007b_002dI_002d_007d-_0028_0040command_007bgnatmake_007d_0029-556"></a><a name="index-Source-files_002c-suppressing-search-557"></a>Do not look for source files in the directory containing the source
file named in the command line.
Do not look for ALI or object files in the directory
where <samp><span class="command">gnatmake</span></samp> was invoked.
<br><dt><samp><span class="option">-L</span><var>dir</var></samp><dd><a name="index-g_t_0040option_007b_002dL_007d-_0028_0040command_007bgnatmake_007d_0029-558"></a><a name="index-Linker-libraries-559"></a>Add directory <var>dir</var> to the list of directories in which the linker
will search for libraries. This is equivalent to
<samp><span class="option">-largs -L</span></samp><var>dir</var>.
Furthermore, under Windows, the sources pointed to by the libraries path
set in the registry are not searched for.
<br><dt><samp><span class="option">-nostdinc</span></samp><dd><a name="index-g_t_0040option_007b_002dnostdinc_007d-_0028_0040command_007bgnatmake_007d_0029-560"></a>Do not look for source files in the system default directory.
<br><dt><samp><span class="option">-nostdlib</span></samp><dd><a name="index-g_t_0040option_007b_002dnostdlib_007d-_0028_0040command_007bgnatmake_007d_0029-561"></a>Do not look for library files in the system default directory.
<br><dt><samp><span class="option">--RTS=</span><var>rts-path</var></samp><dd><a name="index-g_t_0040option_007b_002d_002dRTS_007d-_0028_0040command_007bgnatmake_007d_0029-562"></a>Specifies the default location of the runtime library. GNAT looks for the
runtime
in the following directories, and stops as soon as a valid runtime is found
(<samp><span class="file">adainclude</span></samp> or <samp><span class="file">ada_source_path</span></samp>, and <samp><span class="file">adalib</span></samp> or
<samp><span class="file">ada_object_path</span></samp> present):
<ul>
<li><current directory>/$rts_path
<li><default-search-dir>/$rts_path
<li><default-search-dir>/rts-$rts_path
</ul>
<p class="noindent">The selected path is handled like a normal RTS path.
</dl>
<div class="node">
<a name="Mode-Switches-for-gnatmake"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Notes-on-the-Command-Line">Notes on the Command Line</a>,
Previous: <a rel="previous" accesskey="p" href="#Switches-for-gnatmake">Switches for gnatmake</a>,
Up: <a rel="up" accesskey="u" href="#The-GNAT-Make-Program-gnatmake">The GNAT Make Program gnatmake</a>
</div>
<h3 class="section">6.3 Mode Switches for <samp><span class="command">gnatmake</span></samp></h3>
<p class="noindent">The mode switches (referred to as <code>mode_switches</code>) allow the
inclusion of switches that are to be passed to the compiler itself, the
binder or the linker. The effect of a mode switch is to cause all
subsequent switches up to the end of the switch list, or up to the next
mode switch, to be interpreted as switches to be passed on to the
designated component of GNAT.
<dl>
<!-- !sort! -->
<dt><samp><span class="option">-cargs </span><var>switches</var></samp><dd><a name="index-g_t_0040option_007b_002dcargs_007d-_0028_0040command_007bgnatmake_007d_0029-563"></a>Compiler switches. Here <var>switches</var> is a list of switches
that are valid switches for <samp><span class="command">gcc</span></samp>. They will be passed on to
all compile steps performed by <samp><span class="command">gnatmake</span></samp>.
<br><dt><samp><span class="option">-bargs </span><var>switches</var></samp><dd><a name="index-g_t_0040option_007b_002dbargs_007d-_0028_0040command_007bgnatmake_007d_0029-564"></a>Binder switches. Here <var>switches</var> is a list of switches
that are valid switches for <code>gnatbind</code>. They will be passed on to
all bind steps performed by <samp><span class="command">gnatmake</span></samp>.
<br><dt><samp><span class="option">-largs </span><var>switches</var></samp><dd><a name="index-g_t_0040option_007b_002dlargs_007d-_0028_0040command_007bgnatmake_007d_0029-565"></a>Linker switches. Here <var>switches</var> is a list of switches
that are valid switches for <samp><span class="command">gnatlink</span></samp>. They will be passed on to
all link steps performed by <samp><span class="command">gnatmake</span></samp>.
<br><dt><samp><span class="option">-margs </span><var>switches</var></samp><dd><a name="index-g_t_0040option_007b_002dmargs_007d-_0028_0040command_007bgnatmake_007d_0029-566"></a>Make switches. The switches are directly interpreted by <samp><span class="command">gnatmake</span></samp>,
regardless of any previous occurrence of <samp><span class="option">-cargs</span></samp>, <samp><span class="option">-bargs</span></samp>
or <samp><span class="option">-largs</span></samp>.
</dl>
<div class="node">
<a name="Notes-on-the-Command-Line"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#How-gnatmake-Works">How gnatmake Works</a>,
Previous: <a rel="previous" accesskey="p" href="#Mode-Switches-for-gnatmake">Mode Switches for gnatmake</a>,
Up: <a rel="up" accesskey="u" href="#The-GNAT-Make-Program-gnatmake">The GNAT Make Program gnatmake</a>
</div>
<h3 class="section">6.4 Notes on the Command Line</h3>
<p class="noindent">This section contains some additional useful notes on the operation
of the <samp><span class="command">gnatmake</span></samp> command.
<ul>
<li><a name="index-Recompilation_002c-by-_0040command_007bgnatmake_007d-567"></a>If <samp><span class="command">gnatmake</span></samp> finds no ALI files, it recompiles the main program
and all other units required by the main program.
This means that <samp><span class="command">gnatmake</span></samp>
can be used for the initial compile, as well as during subsequent steps of
the development cycle.
<li>If you enter <code>gnatmake </code><var>file</var><code>.adb</code>, where <samp><var>file</var><span class="file">.adb</span></samp>
is a subunit or body of a generic unit, <samp><span class="command">gnatmake</span></samp> recompiles
<samp><var>file</var><span class="file">.adb</span></samp> (because it finds no ALI) and stops, issuing a
warning.
<li>In <samp><span class="command">gnatmake</span></samp> the switch <samp><span class="option">-I</span></samp>
is used to specify both source and
library file paths. Use <samp><span class="option">-aI</span></samp>
instead if you just want to specify
source paths only and <samp><span class="option">-aO</span></samp>
if you want to specify library paths
only.
<li><samp><span class="command">gnatmake</span></samp> will ignore any files whose ALI file is write-protected.
This may conveniently be used to exclude standard libraries from
consideration and in particular it means that the use of the
<samp><span class="option">-f</span></samp> switch will not recompile these files
unless <samp><span class="option">-a</span></samp> is also specified.
<li><samp><span class="command">gnatmake</span></samp> has been designed to make the use of Ada libraries
particularly convenient. Assume you have an Ada library organized
as follows: <i>obj-dir</i> contains the objects and ALI files for
of your Ada compilation units,
whereas <i>include-dir</i> contains the
specs of these units, but no bodies. Then to compile a unit
stored in <code>main.adb</code>, which uses this Ada library you would just type
<pre class="smallexample"> $ gnatmake -aI<var>include-dir</var> -aL<var>obj-dir</var> main
</pre>
<li>Using <samp><span class="command">gnatmake</span></samp> along with the
<samp><span class="option">-m (minimal recompilation)</span></samp>
switch provides a mechanism for avoiding unnecessary recompilations. Using
this switch,
you can update the comments/format of your
source files without having to recompile everything. Note, however, that
adding or deleting lines in a source files may render its debugging
info obsolete. If the file in question is a spec, the impact is rather
limited, as that debugging info will only be useful during the
elaboration phase of your program. For bodies the impact can be more
significant. In all events, your debugger will warn you if a source file
is more recent than the corresponding object, and alert you to the fact
that the debugging information may be out of date.
</ul>
<div class="node">
<a name="How-gnatmake-Works"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Examples-of-gnatmake-Usage">Examples of gnatmake Usage</a>,
Previous: <a rel="previous" accesskey="p" href="#Notes-on-the-Command-Line">Notes on the Command Line</a>,
Up: <a rel="up" accesskey="u" href="#The-GNAT-Make-Program-gnatmake">The GNAT Make Program gnatmake</a>
</div>
<h3 class="section">6.5 How <samp><span class="command">gnatmake</span></samp> Works</h3>
<p class="noindent">Generally <samp><span class="command">gnatmake</span></samp> automatically performs all necessary
recompilations and you don't need to worry about how it works. However,
it may be useful to have some basic understanding of the <samp><span class="command">gnatmake</span></samp>
approach and in particular to understand how it uses the results of
previous compilations without incorrectly depending on them.
<p>First a definition: an object file is considered <dfn>up to date</dfn> if the
corresponding ALI file exists and if all the source files listed in the
dependency section of this ALI file have time stamps matching those in
the ALI file. This means that neither the source file itself nor any
files that it depends on have been modified, and hence there is no need
to recompile this file.
<p><samp><span class="command">gnatmake</span></samp> works by first checking if the specified main unit is up
to date. If so, no compilations are required for the main unit. If not,
<samp><span class="command">gnatmake</span></samp> compiles the main program to build a new ALI file that
reflects the latest sources. Then the ALI file of the main unit is
examined to find all the source files on which the main program depends,
and <samp><span class="command">gnatmake</span></samp> recursively applies the above procedure on all these
files.
<p>This process ensures that <samp><span class="command">gnatmake</span></samp> only trusts the dependencies
in an existing ALI file if they are known to be correct. Otherwise it
always recompiles to determine a new, guaranteed accurate set of
dependencies. As a result the program is compiled “upside down” from what may
be more familiar as the required order of compilation in some other Ada
systems. In particular, clients are compiled before the units on which
they depend. The ability of GNAT to compile in any order is critical in
allowing an order of compilation to be chosen that guarantees that
<samp><span class="command">gnatmake</span></samp> will recompute a correct set of new dependencies if
necessary.
<p>When invoking <samp><span class="command">gnatmake</span></samp> with several <var>file_names</var>, if a unit is
imported by several of the executables, it will be recompiled at most once.
<p>Note: when using non-standard naming conventions
(see <a href="#Using-Other-File-Names">Using Other File Names</a>), changing through a configuration pragmas
file the version of a source and invoking <samp><span class="command">gnatmake</span></samp> to recompile may
have no effect, if the previous version of the source is still accessible
by <samp><span class="command">gnatmake</span></samp>. It may be necessary to use the switch
-f.
<div class="node">
<a name="Examples-of-gnatmake-Usage"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#How-gnatmake-Works">How gnatmake Works</a>,
Up: <a rel="up" accesskey="u" href="#The-GNAT-Make-Program-gnatmake">The GNAT Make Program gnatmake</a>
</div>
<h3 class="section">6.6 Examples of <samp><span class="command">gnatmake</span></samp> Usage</h3>
<dl>
<dt><code>gnatmake hello.adb</code><dd>Compile all files necessary to bind and link the main program
<samp><span class="file">hello.adb</span></samp> (containing unit <code>Hello</code>) and bind and link the
resulting object files to generate an executable file <samp><span class="file">hello</span></samp>.
<br><dt><code>gnatmake main1 main2 main3</code><dd>Compile all files necessary to bind and link the main programs
<samp><span class="file">main1.adb</span></samp> (containing unit <code>Main1</code>), <samp><span class="file">main2.adb</span></samp>
(containing unit <code>Main2</code>) and <samp><span class="file">main3.adb</span></samp>
(containing unit <code>Main3</code>) and bind and link the resulting object files
to generate three executable files <samp><span class="file">main1</span></samp>,
<samp><span class="file">main2</span></samp>
and <samp><span class="file">main3</span></samp>.
<br><dt><code>gnatmake -q Main_Unit -cargs -O2 -bargs -l</code><dd>
Compile all files necessary to bind and link the main program unit
<code>Main_Unit</code> (from file <samp><span class="file">main_unit.adb</span></samp>). All compilations will
be done with optimization level 2 and the order of elaboration will be
listed by the binder. <samp><span class="command">gnatmake</span></samp> will operate in quiet mode, not
displaying commands it is executing.
</dl>
<!-- ************************* -->
<div class="node">
<a name="Improving-Performance"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Renaming-Files-Using-gnatchop">Renaming Files Using gnatchop</a>,
Previous: <a rel="previous" accesskey="p" href="#The-GNAT-Make-Program-gnatmake">The GNAT Make Program gnatmake</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">7 Improving Performance</h2>
<p><a name="index-Improving-performance-568"></a>
This chapter presents several topics related to program performance.
It first describes some of the tradeoffs that need to be considered
and some of the techniques for making your program run faster.
It then documents the <samp><span class="command">gnatelim</span></samp> tool and unused subprogram/data
elimination feature, which can reduce the size of program executables.
<p>Note: to invoke <samp><span class="command">gnatelim</span></samp> with a project file, use the <code>gnat</code>
driver (see <a href="#The-GNAT-Driver-and-Project-Files">The GNAT Driver and Project Files</a>).
<ul class="menu">
<li><a accesskey="1" href="#Performance-Considerations">Performance Considerations</a>
<li><a accesskey="2" href="#Text_005fIO-Suggestions">Text_IO Suggestions</a>
<li><a accesskey="3" href="#Reducing-Size-of-Ada-Executables-with-gnatelim">Reducing Size of Ada Executables with gnatelim</a>
<li><a accesskey="4" href="#Reducing-Size-of-Executables-with-unused-subprogram_002fdata-elimination">Reducing Size of Executables with unused subprogram/data elimination</a>
</ul>
<!-- ***************************** -->
<div class="node">
<a name="Performance-Considerations"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Text_005fIO-Suggestions">Text_IO Suggestions</a>,
Up: <a rel="up" accesskey="u" href="#Improving-Performance">Improving Performance</a>
</div>
<h3 class="section">7.1 Performance Considerations</h3>
<p class="noindent">The GNAT system provides a number of options that allow a trade-off
between
<ul>
<li>performance of the generated code
<li>speed of compilation
<li>minimization of dependences and recompilation
<li>the degree of run-time checking.
</ul>
<p class="noindent">The defaults (if no options are selected) aim at improving the speed
of compilation and minimizing dependences, at the expense of performance
of the generated code:
<ul>
<li>no optimization
<li>no inlining of subprogram calls
<li>all run-time checks enabled except overflow and elaboration checks
</ul>
<p class="noindent">These options are suitable for most program development purposes. This
chapter describes how you can modify these choices, and also provides
some guidelines on debugging optimized code.
<ul class="menu">
<li><a accesskey="1" href="#Controlling-Run_002dTime-Checks">Controlling Run-Time Checks</a>
<li><a accesskey="2" href="#Use-of-Restrictions">Use of Restrictions</a>
<li><a accesskey="3" href="#Optimization-Levels">Optimization Levels</a>
<li><a accesskey="4" href="#Debugging-Optimized-Code">Debugging Optimized Code</a>
<li><a accesskey="5" href="#Inlining-of-Subprograms">Inlining of Subprograms</a>
<li><a accesskey="6" href="#Other-Optimization-Switches">Other Optimization Switches</a>
<li><a accesskey="7" href="#Optimization-and-Strict-Aliasing">Optimization and Strict Aliasing</a>
</ul>
<div class="node">
<a name="Controlling-Run-Time-Checks"></a>
<a name="Controlling-Run_002dTime-Checks"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Use-of-Restrictions">Use of Restrictions</a>,
Up: <a rel="up" accesskey="u" href="#Performance-Considerations">Performance Considerations</a>
</div>
<h4 class="subsection">7.1.1 Controlling Run-Time Checks</h4>
<p class="noindent">By default, GNAT generates all run-time checks, except integer overflow
checks, stack overflow checks, and checks for access before elaboration on
subprogram calls. The latter are not required in default mode, because all
necessary checking is done at compile time.
<a name="index-g_t_0040option_007b_002dgnatp_007d-_0028_0040command_007bgcc_007d_0029-569"></a><a name="index-g_t_0040option_007b_002dgnato_007d-_0028_0040command_007bgcc_007d_0029-570"></a>Two gnat switches, <samp><span class="option">-gnatp</span></samp> and <samp><span class="option">-gnato</span></samp> allow this default to
be modified. See <a href="#Run_002dTime-Checks">Run-Time Checks</a>.
<p>Our experience is that the default is suitable for most development
purposes.
<p>We treat integer overflow specially because these
are quite expensive and in our experience are not as important as other
run-time checks in the development process. Note that division by zero
is not considered an overflow check, and divide by zero checks are
generated where required by default.
<p>Elaboration checks are off by default, and also not needed by default, since
GNAT uses a static elaboration analysis approach that avoids the need for
run-time checking. This manual contains a full chapter discussing the issue
of elaboration checks, and if the default is not satisfactory for your use,
you should read this chapter.
<p>For validity checks, the minimal checks required by the Ada Reference
Manual (for case statements and assignments to array elements) are on
by default. These can be suppressed by use of the <samp><span class="option">-gnatVn</span></samp> switch.
Note that in Ada 83, there were no validity checks, so if the Ada 83 mode
is acceptable (or when comparing GNAT performance with an Ada 83 compiler),
it may be reasonable to routinely use <samp><span class="option">-gnatVn</span></samp>. Validity checks
are also suppressed entirely if <samp><span class="option">-gnatp</span></samp> is used.
<p><a name="index-Overflow-checks-571"></a><a name="index-Checks_002c-overflow-572"></a><a name="index-Suppress-573"></a><a name="index-Unsuppress-574"></a><a name="index-pragma-Suppress-575"></a><a name="index-pragma-Unsuppress-576"></a>Note that the setting of the switches controls the default setting of
the checks. They may be modified using either <code>pragma Suppress</code> (to
remove checks) or <code>pragma Unsuppress</code> (to add back suppressed
checks) in the program source.
<div class="node">
<a name="Use-of-Restrictions"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Optimization-Levels">Optimization Levels</a>,
Previous: <a rel="previous" accesskey="p" href="#Controlling-Run_002dTime-Checks">Controlling Run-Time Checks</a>,
Up: <a rel="up" accesskey="u" href="#Performance-Considerations">Performance Considerations</a>
</div>
<h4 class="subsection">7.1.2 Use of Restrictions</h4>
<p class="noindent">The use of pragma Restrictions allows you to control which features are
permitted in your program. Apart from the obvious point that if you avoid
relatively expensive features like finalization (enforceable by the use
of pragma Restrictions (No_Finalization), the use of this pragma does not
affect the generated code in most cases.
<p>One notable exception to this rule is that the possibility of task abort
results in some distributed overhead, particularly if finalization or
exception handlers are used. The reason is that certain sections of code
have to be marked as non-abortable.
<p>If you use neither the <code>abort</code> statement, nor asynchronous transfer
of control (<code>select ... then abort</code>), then this distributed overhead
is removed, which may have a general positive effect in improving
overall performance. Especially code involving frequent use of tasking
constructs and controlled types will show much improved performance.
The relevant restrictions pragmas are
<pre class="smallexample"> pragma Restrictions (No_Abort_Statements);
pragma Restrictions (Max_Asynchronous_Select_Nesting => 0);
</pre>
<p class="noindent">It is recommended that these restriction pragmas be used if possible. Note
that this also means that you can write code without worrying about the
possibility of an immediate abort at any point.
<div class="node">
<a name="Optimization-Levels"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Debugging-Optimized-Code">Debugging Optimized Code</a>,
Previous: <a rel="previous" accesskey="p" href="#Use-of-Restrictions">Use of Restrictions</a>,
Up: <a rel="up" accesskey="u" href="#Performance-Considerations">Performance Considerations</a>
</div>
<h4 class="subsection">7.1.3 Optimization Levels</h4>
<p><a name="index-g_t_0040option_007b_002dO_007d-_0028_0040command_007bgcc_007d_0029-577"></a>
Without any optimization option,
the compiler's goal is to reduce the cost of
compilation and to make debugging produce the expected results.
Statements are independent: if you stop the program with a breakpoint between
statements, you can then assign a new value to any variable or change
the program counter to any other statement in the subprogram and get exactly
the results you would expect from the source code.
<p>Turning on optimization makes the compiler attempt to improve the
performance and/or code size at the expense of compilation time and
possibly the ability to debug the program.
<p>If you use multiple
-O options, with or without level numbers,
the last such option is the one that is effective.
<p class="noindent">The default is optimization off. This results in the fastest compile
times, but GNAT makes absolutely no attempt to optimize, and the
generated programs are considerably larger and slower than when
optimization is enabled. You can use the
<samp><span class="option">-O</span></samp> switch (the permitted forms are <samp><span class="option">-O0</span></samp>, <samp><span class="option">-O1</span></samp>
<samp><span class="option">-O2</span></samp>, <samp><span class="option">-O3</span></samp>, and <samp><span class="option">-Os</span></samp>)
to <samp><span class="command">gcc</span></samp> to control the optimization level:
<dl>
<dt><samp><span class="option">-O0</span></samp><dd>No optimization (the default);
generates unoptimized code but has
the fastest compilation time.
<p>Note that many other compilers do fairly extensive optimization
even if “no optimization” is specified. With gcc, it is
very unusual to use -O0 for production if
execution time is of any concern, since -O0
really does mean no optimization at all. This difference between
gcc and other compilers should be kept in mind when doing
performance comparisons.
<br><dt><samp><span class="option">-O1</span></samp><dd>Moderate optimization;
optimizes reasonably well but does not
degrade compilation time significantly.
<br><dt><samp><span class="option">-O2</span></samp><dd>Full optimization;
generates highly optimized code and has
the slowest compilation time.
<br><dt><samp><span class="option">-O3</span></samp><dd>Full optimization as in <samp><span class="option">-O2</span></samp>;
also uses more aggressive automatic inlining of subprograms within a unit
(see <a href="#Inlining-of-Subprograms">Inlining of Subprograms</a>) and attempts to vectorize loops.
<br><dt><samp><span class="option">-Os</span></samp><dd>Optimize space usage (code and data) of resulting program.
</dl>
<p class="noindent">Higher optimization levels perform more global transformations on the
program and apply more expensive analysis algorithms in order to generate
faster and more compact code. The price in compilation time, and the
resulting improvement in execution time,
both depend on the particular application and the hardware environment.
You should experiment to find the best level for your application.
<p>Since the precise set of optimizations done at each level will vary from
release to release (and sometime from target to target), it is best to think
of the optimization settings in general terms.
See <a href="gcc.html#Optimize-Options">Options That Control Optimization</a>, for details about
the <samp><span class="option">-O</span></samp> settings and a number of <samp><span class="option">-f</span></samp> options that
individually enable or disable specific optimizations.
<p>Unlike some other compilation systems, <samp><span class="command">gcc</span></samp> has
been tested extensively at all optimization levels. There are some bugs
which appear only with optimization turned on, but there have also been
bugs which show up only in <em>unoptimized</em> code. Selecting a lower
level of optimization does not improve the reliability of the code
generator, which in practice is highly reliable at all optimization
levels.
<p>Note regarding the use of <samp><span class="option">-O3</span></samp>: The use of this optimization level
is generally discouraged with GNAT, since it often results in larger
executables which may run more slowly. See further discussion of this point
in <a href="#Inlining-of-Subprograms">Inlining of Subprograms</a>.
<div class="node">
<a name="Debugging-Optimized-Code"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Inlining-of-Subprograms">Inlining of Subprograms</a>,
Previous: <a rel="previous" accesskey="p" href="#Optimization-Levels">Optimization Levels</a>,
Up: <a rel="up" accesskey="u" href="#Performance-Considerations">Performance Considerations</a>
</div>
<h4 class="subsection">7.1.4 Debugging Optimized Code</h4>
<p><a name="index-Debugging-optimized-code-578"></a><a name="index-Optimization-and-debugging-579"></a>
Although it is possible to do a reasonable amount of debugging at
nonzero optimization levels,
the higher the level the more likely that
source-level constructs will have been eliminated by optimization.
For example, if a loop is strength-reduced, the loop
control variable may be completely eliminated and thus cannot be
displayed in the debugger.
This can only happen at <samp><span class="option">-O2</span></samp> or <samp><span class="option">-O3</span></samp>.
Explicit temporary variables that you code might be eliminated at
level <samp><span class="option">-O1</span></samp> or higher.
<p>The use of the <samp><span class="option">-g</span></samp> switch,
<a name="index-g_t_0040option_007b_002dg_007d-_0028_0040command_007bgcc_007d_0029-580"></a>which is needed for source-level debugging,
affects the size of the program executable on disk,
and indeed the debugging information can be quite large.
However, it has no effect on the generated code (and thus does not
degrade performance)
<p>Since the compiler generates debugging tables for a compilation unit before
it performs optimizations, the optimizing transformations may invalidate some
of the debugging data. You therefore need to anticipate certain
anomalous situations that may arise while debugging optimized code.
These are the most common cases:
<ol type=1 start=1>
<li><i>The “hopping Program Counter”:</i> Repeated <code>step</code> or <code>next</code>
commands show
the PC bouncing back and forth in the code. This may result from any of
the following optimizations:
<ul>
<li><i>Common subexpression elimination:</i> using a single instance of code for a
quantity that the source computes several times. As a result you
may not be able to stop on what looks like a statement.
<li><i>Invariant code motion:</i> moving an expression that does not change within a
loop, to the beginning of the loop.
<li><i>Instruction scheduling:</i> moving instructions so as to
overlap loads and stores (typically) with other code, or in
general to move computations of values closer to their uses. Often
this causes you to pass an assignment statement without the assignment
happening and then later bounce back to the statement when the
value is actually needed. Placing a breakpoint on a line of code
and then stepping over it may, therefore, not always cause all the
expected side-effects.
</ul>
<li><i>The “big leap”:</i> More commonly known as <em>cross-jumping</em>, in which
two identical pieces of code are merged and the program counter suddenly
jumps to a statement that is not supposed to be executed, simply because
it (and the code following) translates to the same thing as the code
that <em>was</em> supposed to be executed. This effect is typically seen in
sequences that end in a jump, such as a <code>goto</code>, a <code>return</code>, or
a <code>break</code> in a C <code>switch</code> statement.
<li><i>The “roving variable”:</i> The symptom is an unexpected value in a variable.
There are various reasons for this effect:
<ul>
<li>In a subprogram prologue, a parameter may not yet have been moved to its
“home”.
<li>A variable may be dead, and its register re-used. This is
probably the most common cause.
<li>As mentioned above, the assignment of a value to a variable may
have been moved.
<li>A variable may be eliminated entirely by value propagation or
other means. In this case, GCC may incorrectly generate debugging
information for the variable
</ul>
<p class="noindent">In general, when an unexpected value appears for a local variable or parameter
you should first ascertain if that value was actually computed by
your program, as opposed to being incorrectly reported by the debugger.
Record fields or
array elements in an object designated by an access value
are generally less of a problem, once you have ascertained that the access
value is sensible.
Typically, this means checking variables in the preceding code and in the
calling subprogram to verify that the value observed is explainable from other
values (one must apply the procedure recursively to those
other values); or re-running the code and stopping a little earlier
(perhaps before the call) and stepping to better see how the variable obtained
the value in question; or continuing to step <em>from</em> the point of the
strange value to see if code motion had simply moved the variable's
assignments later.
</ol>
<p class="noindent">In light of such anomalies, a recommended technique is to use <samp><span class="option">-O0</span></samp>
early in the software development cycle, when extensive debugging capabilities
are most needed, and then move to <samp><span class="option">-O1</span></samp> and later <samp><span class="option">-O2</span></samp> as
the debugger becomes less critical.
Whether to use the <samp><span class="option">-g</span></samp> switch in the release version is
a release management issue.
Note that if you use <samp><span class="option">-g</span></samp> you can then use the <samp><span class="command">strip</span></samp> program
on the resulting executable,
which removes both debugging information and global symbols.
<div class="node">
<a name="Inlining-of-Subprograms"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Other-Optimization-Switches">Other Optimization Switches</a>,
Previous: <a rel="previous" accesskey="p" href="#Debugging-Optimized-Code">Debugging Optimized Code</a>,
Up: <a rel="up" accesskey="u" href="#Performance-Considerations">Performance Considerations</a>
</div>
<h4 class="subsection">7.1.5 Inlining of Subprograms</h4>
<p class="noindent">A call to a subprogram in the current unit is inlined if all the
following conditions are met:
<ul>
<li>The optimization level is at least <samp><span class="option">-O1</span></samp>.
<li>The called subprogram is suitable for inlining: It must be small enough
and not contain something that <samp><span class="command">gcc</span></samp> cannot support in inlined
subprograms.
<li><a name="index-pragma-Inline-581"></a><a name="index-Inline-582"></a>Any one of the following applies: <code>pragma Inline</code> is applied to the
subprogram and the <samp><span class="option">-gnatn</span></samp> switch is specified; the
subprogram is local to the unit and called once from within it; the
subprogram is small and optimization level <samp><span class="option">-O2</span></samp> is specified;
optimization level <samp><span class="option">-O3</span></samp>) is specified.
</ul>
<p class="noindent">Calls to subprograms in <code>with</code>'ed units are normally not inlined.
To achieve actual inlining (that is, replacement of the call by the code
in the body of the subprogram), the following conditions must all be true.
<ul>
<li>The optimization level is at least <samp><span class="option">-O1</span></samp>.
<li>The called subprogram is suitable for inlining: It must be small enough
and not contain something that <samp><span class="command">gcc</span></samp> cannot support in inlined
subprograms.
<li>The call appears in a body (not in a package spec).
<li>There is a <code>pragma Inline</code> for the subprogram.
<li>The <samp><span class="option">-gnatn</span></samp> switch is used on the command line.
</ul>
<p>Even if all these conditions are met, it may not be possible for
the compiler to inline the call, due to the length of the body,
or features in the body that make it impossible for the compiler
to do the inlining.
<p>Note that specifying the <samp><span class="option">-gnatn</span></samp> switch causes additional
compilation dependencies. Consider the following:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
package R is
procedure Q;
pragma Inline (Q);
end R;
package body R is
...
end R;
with R;
procedure Main is
begin
...
R.Q;
end Main;
</td></tr></table>
</pre>
<p class="noindent">With the default behavior (no <samp><span class="option">-gnatn</span></samp> switch specified), the
compilation of the <code>Main</code> procedure depends only on its own source,
<samp><span class="file">main.adb</span></samp>, and the spec of the package in file <samp><span class="file">r.ads</span></samp>. This
means that editing the body of <code>R</code> does not require recompiling
<code>Main</code>.
<p>On the other hand, the call <code>R.Q</code> is not inlined under these
circumstances. If the <samp><span class="option">-gnatn</span></samp> switch is present when <code>Main</code>
is compiled, the call will be inlined if the body of <code>Q</code> is small
enough, but now <code>Main</code> depends on the body of <code>R</code> in
<samp><span class="file">r.adb</span></samp> as well as on the spec. This means that if this body is edited,
the main program must be recompiled. Note that this extra dependency
occurs whether or not the call is in fact inlined by <samp><span class="command">gcc</span></samp>.
<p>The use of front end inlining with <samp><span class="option">-gnatN</span></samp> generates similar
additional dependencies.
<p><a name="index-g_t_0040option_007b_002dfno_002dinline_007d-_0028_0040command_007bgcc_007d_0029-583"></a>Note: The <samp><span class="option">-fno-inline</span></samp> switch
can be used to prevent
all inlining. This switch overrides all other conditions and ensures
that no inlining occurs. The extra dependences resulting from
<samp><span class="option">-gnatn</span></samp> will still be active, even if
this switch is used to suppress the resulting inlining actions.
<p><a name="index-g_t_0040option_007b_002dfno_002dinline_002dfunctions_007d-_0028_0040command_007bgcc_007d_0029-584"></a>Note: The <samp><span class="option">-fno-inline-functions</span></samp> switch can be used to prevent
automatic inlining of subprograms if <samp><span class="option">-O3</span></samp> is used.
<p><a name="index-g_t_0040option_007b_002dfno_002dinline_002dsmall_002dfunctions_007d-_0028_0040command_007bgcc_007d_0029-585"></a>Note: The <samp><span class="option">-fno-inline-small-functions</span></samp> switch can be used to prevent
automatic inlining of small subprograms if <samp><span class="option">-O2</span></samp> is used.
<p><a name="index-g_t_0040option_007b_002dfno_002dinline_002dfunctions_002dcalled_002donce_007d-_0028_0040command_007bgcc_007d_0029-586"></a>Note: The <samp><span class="option">-fno-inline-functions-called-once</span></samp> switch
can be used to prevent inlining of subprograms local to the unit
and called once from within it if <samp><span class="option">-O1</span></samp> is used.
<p>Note regarding the use of <samp><span class="option">-O3</span></samp>: There is no difference in inlining
behavior between <samp><span class="option">-O2</span></samp> and <samp><span class="option">-O3</span></samp> for subprograms with an explicit
pragma <code>Inline</code> assuming the use of <samp><span class="option">-gnatn</span></samp>
or <samp><span class="option">-gnatN</span></samp> (the switches that activate inlining). If you have used
pragma <code>Inline</code> in appropriate cases, then it is usually much better
to use <samp><span class="option">-O2</span></samp> and <samp><span class="option">-gnatn</span></samp> and avoid the use of <samp><span class="option">-O3</span></samp> which
in this case only has the effect of inlining subprograms you did not
think should be inlined. We often find that the use of <samp><span class="option">-O3</span></samp> slows
down code by performing excessive inlining, leading to increased instruction
cache pressure from the increased code size. So the bottom line here is
that you should not automatically assume that <samp><span class="option">-O3</span></samp> is better than
<samp><span class="option">-O2</span></samp>, and indeed you should use <samp><span class="option">-O3</span></samp> only if tests show that
it actually improves performance.
<div class="node">
<a name="Other-Optimization-Switches"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Optimization-and-Strict-Aliasing">Optimization and Strict Aliasing</a>,
Previous: <a rel="previous" accesskey="p" href="#Inlining-of-Subprograms">Inlining of Subprograms</a>,
Up: <a rel="up" accesskey="u" href="#Performance-Considerations">Performance Considerations</a>
</div>
<h4 class="subsection">7.1.6 Other Optimization Switches</h4>
<p><a name="index-Optimization-Switches-587"></a>
Since <code>GNAT</code> uses the <samp><span class="command">gcc</span></samp> back end, all the specialized
<samp><span class="command">gcc</span></samp> optimization switches are potentially usable. These switches
have not been extensively tested with GNAT but can generally be expected
to work. Examples of switches in this category are
<samp><span class="option">-funroll-loops</span></samp> and
the various target-specific <samp><span class="option">-m</span></samp> options (in particular, it has been
observed that <samp><span class="option">-march=pentium4</span></samp> can significantly improve performance
on appropriate machines). For full details of these switches, see
<a href="gcc.html#Submodel-Options">Hardware Models and Configurations</a>.
<div class="node">
<a name="Optimization-and-Strict-Aliasing"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Other-Optimization-Switches">Other Optimization Switches</a>,
Up: <a rel="up" accesskey="u" href="#Performance-Considerations">Performance Considerations</a>
</div>
<h4 class="subsection">7.1.7 Optimization and Strict Aliasing</h4>
<p><a name="index-Aliasing-588"></a><a name="index-Strict-Aliasing-589"></a><a name="index-No_005fStrict_005fAliasing-590"></a>
The strong typing capabilities of Ada allow an optimizer to generate
efficient code in situations where other languages would be forced to
make worst case assumptions preventing such optimizations. Consider
the following example:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
procedure R is
type Int1 is new Integer;
type Int2 is new Integer;
type Int1A is access Int1;
type Int2A is access Int2;
Int1V : Int1A;
Int2V : Int2A;
...
begin
...
for J in Data'Range loop
if Data (J) = Int1V.all then
Int2V.all := Int2V.all + 1;
end if;
end loop;
...
end R;
</td></tr></table>
</pre>
<p class="noindent">In this example, since the variable <code>Int1V</code> can only access objects
of type <code>Int1</code>, and <code>Int2V</code> can only access objects of type
<code>Int2</code>, there is no possibility that the assignment to
<code>Int2V.all</code> affects the value of <code>Int1V.all</code>. This means that
the compiler optimizer can "know" that the value <code>Int1V.all</code> is constant
for all iterations of the loop and avoid the extra memory reference
required to dereference it each time through the loop.
<p>This kind of optimization, called strict aliasing analysis, is
triggered by specifying an optimization level of <samp><span class="option">-O2</span></samp> or
higher or <samp><span class="option">-Os</span></samp> and allows <code>GNAT</code> to generate more efficient code
when access values are involved.
<p>However, although this optimization is always correct in terms of
the formal semantics of the Ada Reference Manual, difficulties can
arise if features like <code>Unchecked_Conversion</code> are used to break
the typing system. Consider the following complete program example:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
package p1 is
type int1 is new integer;
type int2 is new integer;
type a1 is access int1;
type a2 is access int2;
end p1;
with p1; use p1;
package p2 is
function to_a2 (Input : a1) return a2;
end p2;
with Unchecked_Conversion;
package body p2 is
function to_a2 (Input : a1) return a2 is
function to_a2u is
new Unchecked_Conversion (a1, a2);
begin
return to_a2u (Input);
end to_a2;
end p2;
with p2; use p2;
with p1; use p1;
with Text_IO; use Text_IO;
procedure m is
v1 : a1 := new int1;
v2 : a2 := to_a2 (v1);
begin
v1.all := 1;
v2.all := 0;
put_line (int1'image (v1.all));
end;
</td></tr></table>
</pre>
<p class="noindent">This program prints out 0 in <samp><span class="option">-O0</span></samp> or <samp><span class="option">-O1</span></samp>
mode, but it prints out 1 in <samp><span class="option">-O2</span></samp> mode. That's
because in strict aliasing mode, the compiler can and
does assume that the assignment to <code>v2.all</code> could not
affect the value of <code>v1.all</code>, since different types
are involved.
<p>This behavior is not a case of non-conformance with the standard, since
the Ada RM specifies that an unchecked conversion where the resulting
bit pattern is not a correct value of the target type can result in an
abnormal value and attempting to reference an abnormal value makes the
execution of a program erroneous. That's the case here since the result
does not point to an object of type <code>int2</code>. This means that the
effect is entirely unpredictable.
<p>However, although that explanation may satisfy a language
lawyer, in practice an applications programmer expects an
unchecked conversion involving pointers to create true
aliases and the behavior of printing 1 seems plain wrong.
In this case, the strict aliasing optimization is unwelcome.
<p>Indeed the compiler recognizes this possibility, and the
unchecked conversion generates a warning:
<pre class="smallexample"> p2.adb:5:07: warning: possible aliasing problem with type "a2"
p2.adb:5:07: warning: use -fno-strict-aliasing switch for references
p2.adb:5:07: warning: or use "pragma No_Strict_Aliasing (a2);"
</pre>
<p class="noindent">Unfortunately the problem is recognized when compiling the body of
package <code>p2</code>, but the actual "bad" code is generated while
compiling the body of <code>m</code> and this latter compilation does not see
the suspicious <code>Unchecked_Conversion</code>.
<p>As implied by the warning message, there are approaches you can use to
avoid the unwanted strict aliasing optimization in a case like this.
<p>One possibility is to simply avoid the use of <samp><span class="option">-O2</span></samp>, but
that is a bit drastic, since it throws away a number of useful
optimizations that do not involve strict aliasing assumptions.
<p>A less drastic approach is to compile the program using the
option <samp><span class="option">-fno-strict-aliasing</span></samp>. Actually it is only the
unit containing the dereferencing of the suspicious pointer
that needs to be compiled. So in this case, if we compile
unit <code>m</code> with this switch, then we get the expected
value of zero printed. Analyzing which units might need
the switch can be painful, so a more reasonable approach
is to compile the entire program with options <samp><span class="option">-O2</span></samp>
and <samp><span class="option">-fno-strict-aliasing</span></samp>. If the performance is
satisfactory with this combination of options, then the
advantage is that the entire issue of possible "wrong"
optimization due to strict aliasing is avoided.
<p>To avoid the use of compiler switches, the configuration
pragma <code>No_Strict_Aliasing</code> with no parameters may be
used to specify that for all access types, the strict
aliasing optimization should be suppressed.
<p>However, these approaches are still overkill, in that they causes
all manipulations of all access values to be deoptimized. A more
refined approach is to concentrate attention on the specific
access type identified as problematic.
<p>First, if a careful analysis of uses of the pointer shows
that there are no possible problematic references, then
the warning can be suppressed by bracketing the
instantiation of <code>Unchecked_Conversion</code> to turn
the warning off:
<pre class="smallexample"> pragma Warnings (Off);
function to_a2u is
new Unchecked_Conversion (a1, a2);
pragma Warnings (On);
</pre>
<p class="noindent">Of course that approach is not appropriate for this particular
example, since indeed there is a problematic reference. In this
case we can take one of two other approaches.
<p>The first possibility is to move the instantiation of unchecked
conversion to the unit in which the type is declared. In
this example, we would move the instantiation of
<code>Unchecked_Conversion</code> from the body of package
<code>p2</code> to the spec of package <code>p1</code>. Now the
warning disappears. That's because any use of the
access type knows there is a suspicious unchecked
conversion, and the strict aliasing optimization
is automatically suppressed for the type.
<p>If it is not practical to move the unchecked conversion to the same unit
in which the destination access type is declared (perhaps because the
source type is not visible in that unit), you may use pragma
<code>No_Strict_Aliasing</code> for the type. This pragma must occur in the
same declarative sequence as the declaration of the access type:
<pre class="smallexample"> type a2 is access int2;
pragma No_Strict_Aliasing (a2);
</pre>
<p class="noindent">Here again, the compiler now knows that the strict aliasing optimization
should be suppressed for any reference to type <code>a2</code> and the
expected behavior is obtained.
<p>Finally, note that although the compiler can generate warnings for
simple cases of unchecked conversions, there are tricker and more
indirect ways of creating type incorrect aliases which the compiler
cannot detect. Examples are the use of address overlays and unchecked
conversions involving composite types containing access types as
components. In such cases, no warnings are generated, but there can
still be aliasing problems. One safe coding practice is to forbid the
use of address clauses for type overlaying, and to allow unchecked
conversion only for primitive types. This is not really a significant
restriction since any possible desired effect can be achieved by
unchecked conversion of access values.
<p>The aliasing analysis done in strict aliasing mode can certainly
have significant benefits. We have seen cases of large scale
application code where the time is increased by up to 5% by turning
this optimization off. If you have code that includes significant
usage of unchecked conversion, you might want to just stick with
<samp><span class="option">-O1</span></samp> and avoid the entire issue. If you get adequate
performance at this level of optimization level, that's probably
the safest approach. If tests show that you really need higher
levels of optimization, then you can experiment with <samp><span class="option">-O2</span></samp>
and <samp><span class="option">-O2 -fno-strict-aliasing</span></samp> to see how much effect this
has on size and speed of the code. If you really need to use
<samp><span class="option">-O2</span></samp> with strict aliasing in effect, then you should
review any uses of unchecked conversion of access types,
particularly if you are getting the warnings described above.
<div class="node">
<a name="Text_IO-Suggestions"></a>
<a name="Text_005fIO-Suggestions"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Reducing-Size-of-Ada-Executables-with-gnatelim">Reducing Size of Ada Executables with gnatelim</a>,
Previous: <a rel="previous" accesskey="p" href="#Performance-Considerations">Performance Considerations</a>,
Up: <a rel="up" accesskey="u" href="#Improving-Performance">Improving Performance</a>
</div>
<h3 class="section">7.2 <code>Text_IO</code> Suggestions</h3>
<p><a name="index-g_t_0040code_007bText_005fIO_007d-and-performance-591"></a>
The <code>Ada.Text_IO</code> package has fairly high overheads due in part to
the requirement of maintaining page and line counts. If performance
is critical, a recommendation is to use <code>Stream_IO</code> instead of
<code>Text_IO</code> for volume output, since this package has less overhead.
<p>If <code>Text_IO</code> must be used, note that by default output to the standard
output and standard error files is unbuffered (this provides better
behavior when output statements are used for debugging, or if the
progress of a program is observed by tracking the output, e.g. by
using the Unix <samp><span class="command">tail -f</span></samp> command to watch redirected output.
<p>If you are generating large volumes of output with <code>Text_IO</code> and
performance is an important factor, use a designated file instead
of the standard output file, or change the standard output file to
be buffered using <code>Interfaces.C_Streams.setvbuf</code>.
<div class="node">
<a name="Reducing-Size-of-Ada-Executables-with-gnatelim"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Reducing-Size-of-Executables-with-unused-subprogram_002fdata-elimination">Reducing Size of Executables with unused subprogram/data elimination</a>,
Previous: <a rel="previous" accesskey="p" href="#Text_005fIO-Suggestions">Text_IO Suggestions</a>,
Up: <a rel="up" accesskey="u" href="#Improving-Performance">Improving Performance</a>
</div>
<h3 class="section">7.3 Reducing Size of Ada Executables with <code>gnatelim</code></h3>
<p><a name="index-gnatelim-592"></a>
This section describes <samp><span class="command">gnatelim</span></samp>, a tool which detects unused
subprograms and helps the compiler to create a smaller executable for your
program.
<ul class="menu">
<li><a accesskey="1" href="#About-gnatelim">About gnatelim</a>
<li><a accesskey="2" href="#Running-gnatelim">Running gnatelim</a>
<li><a accesskey="3" href="#Processing-Precompiled-Libraries">Processing Precompiled Libraries</a>
<li><a accesskey="4" href="#Correcting-the-List-of-Eliminate-Pragmas">Correcting the List of Eliminate Pragmas</a>
<li><a accesskey="5" href="#Making-Your-Executables-Smaller">Making Your Executables Smaller</a>
<li><a accesskey="6" href="#Summary-of-the-gnatelim-Usage-Cycle">Summary of the gnatelim Usage Cycle</a>
</ul>
<div class="node">
<a name="About-gnatelim"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Running-gnatelim">Running gnatelim</a>,
Up: <a rel="up" accesskey="u" href="#Reducing-Size-of-Ada-Executables-with-gnatelim">Reducing Size of Ada Executables with gnatelim</a>
</div>
<h4 class="subsection">7.3.1 About <code>gnatelim</code></h4>
<p class="noindent">When a program shares a set of Ada
packages with other programs, it may happen that this program uses
only a fraction of the subprograms defined in these packages. The code
created for these unused subprograms increases the size of the executable.
<p><code>gnatelim</code> tracks unused subprograms in an Ada program and
outputs a list of GNAT-specific pragmas <code>Eliminate</code> marking all the
subprograms that are declared but never called. By placing the list of
<code>Eliminate</code> pragmas in the GNAT configuration file <samp><span class="file">gnat.adc</span></samp> and
recompiling your program, you may decrease the size of its executable,
because the compiler will not generate the code for 'eliminated' subprograms.
See <a href="gnat_rm.html#Pragma-Eliminate">Pragma Eliminate</a>, for more
information about this pragma.
<p><code>gnatelim</code> needs as its input data the name of the main subprogram.
<p>If a set of source files is specified as <code>gnatelim</code> arguments, it
treats these files as a complete set of sources making up a program to
analyse, and analyses only these sources.
<p>After a full successful build of the main subprogram <code>gnatelim</code> can be
called without specifying sources to analyse, in this case it computes
the source closure of the main unit from the <samp><span class="file">ALI</span></samp> files.
<p>The following command will create the set of <samp><span class="file">ALI</span></samp> files needed for
<code>gnatelim</code>:
<pre class="smallexample"> $ gnatmake -c Main_Prog
</pre>
<p>Note that <code>gnatelim</code> does not need object files.
<div class="node">
<a name="Running-gnatelim"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Processing-Precompiled-Libraries">Processing Precompiled Libraries</a>,
Previous: <a rel="previous" accesskey="p" href="#About-gnatelim">About gnatelim</a>,
Up: <a rel="up" accesskey="u" href="#Reducing-Size-of-Ada-Executables-with-gnatelim">Reducing Size of Ada Executables with gnatelim</a>
</div>
<h4 class="subsection">7.3.2 Running <code>gnatelim</code></h4>
<p class="noindent"><code>gnatelim</code> has the following command-line interface:
<pre class="smallexample"> $ gnatelim [<var>switches</var>] -main=<var>main_unit_name</var> {<var>filename</var>} <span class="roman">[</span>-cargs <var>gcc_switches</var><span class="roman">]</span>
</pre>
<p class="noindent"><var>main_unit_name</var> should be a name of a source file that contains the main
subprogram of a program (partition).
<p>Each <var>filename</var> is the name (including the extension) of a source
file to process. “Wildcards” are allowed, and
the file name may contain path information.
<p>‘<samp><var>gcc_switches</var></samp>’ is a list of switches for
<samp><span class="command">gcc</span></samp>. They will be passed on to all compiler invocations made by
<samp><span class="command">gnatelim</span></samp> to generate the ASIS trees. Here you can provide
<samp><span class="option">-I</span></samp> switches to form the source search path,
use the <samp><span class="option">-gnatec</span></samp> switch to set the configuration file,
use the <samp><span class="option">-gnat05</span></samp> switch if sources should be compiled in
Ada 2005 mode etc.
<p><code>gnatelim</code> has the following switches:
<dl>
<!-- !sort! -->
<dt><samp><span class="option">-files=</span><var>filename</var></samp><dd><a name="index-g_t_0040option_007b_002dfiles_007d-_0028_0040code_007bgnatelim_007d_0029-593"></a>Take the argument source files from the specified file. This file should be an
ordinary text file containing file names separated by spaces or
line breaks. You can use this switch more than once in the same call to
<samp><span class="command">gnatelim</span></samp>. You also can combine this switch with
an explicit list of files.
<br><dt><samp><span class="option">-log</span></samp><dd><a name="index-g_t_0040option_007b_002dlog_007d-_0028_0040command_007bgnatelim_007d_0029-594"></a>Duplicate all the output sent to <samp><span class="file">stderr</span></samp> into a log file. The log file
is named <samp><span class="file">gnatelim.log</span></samp> and is located in the current directory.
<br><dt><samp><span class="option">-log=</span><var>filename</var></samp><dd><a name="index-g_t_0040option_007b_002dlog_007d-_0028_0040command_007bgnatelim_007d_0029-595"></a>Duplicate all the output sent to <samp><span class="file">stderr</span></samp> into a specified log file.
<p><a name="index-g_t_0040option_007b_002d_002dno_002delim_002ddispatch_007d-_0028_0040command_007bgnatelim_007d_0029-596"></a><br><dt><samp><span class="option">--no-elim-dispatch</span></samp><dd>Do not generate pragmas for dispatching operations.
<br><dt><samp><span class="option">--ignore=</span><var>filename</var></samp><dd><a name="index-g_t_0040option_007b_002d_002dignore_007d-_0028_0040command_007bgnatelim_007d_0029-597"></a>Do not generate pragmas for subprograms declared in the sources
listed in a specified file
<p><a name="index-g_t_0040option_007b_002do_007d-_0028_0040command_007bgnatelim_007d_0029-598"></a><br><dt><samp><span class="option">-o=</span><var>report_file</var></samp><dd>Put <samp><span class="command">gnatelim</span></samp> output into a specified file. If this file already exists,
it is overridden. If this switch is not used, <samp><span class="command">gnatelim</span></samp> outputs its results
into <samp><span class="file">stderr</span></samp>
<br><dt><samp><span class="option">-q</span></samp><dd><a name="index-g_t_0040option_007b_002dq_007d-_0028_0040command_007bgnatelim_007d_0029-599"></a>Quiet mode: by default <code>gnatelim</code> outputs to the standard error
stream the number of program units left to be processed. This option turns
this trace off.
<p><a name="index-g_t_0040option_007b_002dt_007d-_0028_0040command_007bgnatelim_007d_0029-600"></a><br><dt><samp><span class="option">-t</span></samp><dd>Print out execution time.
<br><dt><samp><span class="option">-v</span></samp><dd><a name="index-g_t_0040option_007b_002dv_007d-_0028_0040command_007bgnatelim_007d_0029-601"></a>Verbose mode: <code>gnatelim</code> version information is printed as Ada
comments to the standard output stream. Also, in addition to the number of
program units left <code>gnatelim</code> will output the name of the current unit
being processed.
<br><dt><samp><span class="option">-wq</span></samp><dd><a name="index-g_t_0040option_007b_002dwq_007d-_0028_0040command_007bgnatelim_007d_0029-602"></a>Quiet warning mode - some warnings are suppressed. In particular warnings that
indicate that the analysed set of sources is incomplete to make up a
partition and that some subprogram bodies are missing are not generated.
</dl>
<div class="node">
<a name="Processing-Precompiled-Libraries"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Correcting-the-List-of-Eliminate-Pragmas">Correcting the List of Eliminate Pragmas</a>,
Previous: <a rel="previous" accesskey="p" href="#Running-gnatelim">Running gnatelim</a>,
Up: <a rel="up" accesskey="u" href="#Reducing-Size-of-Ada-Executables-with-gnatelim">Reducing Size of Ada Executables with gnatelim</a>
</div>
<h4 class="subsection">7.3.3 Processing Precompiled Libraries</h4>
<p class="noindent">If some program uses a precompiled Ada library, it can be processed by
<code>gnatelim</code> in a usual way. <code>gnatelim</code> will newer generate an
Eliminate pragma for a subprogram if the body of this subprogram has not
been analysed, this is a typical case for subprograms from precompiled
libraries. Switch <samp><span class="option">-wq</span></samp> may be used to suppress
warnings about missing source files and non-analyzed subprogram bodies
that can be generated when processing precompiled Ada libraries.
<div class="node">
<a name="Correcting-the-List-of-Eliminate-Pragmas"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Making-Your-Executables-Smaller">Making Your Executables Smaller</a>,
Previous: <a rel="previous" accesskey="p" href="#Processing-Precompiled-Libraries">Processing Precompiled Libraries</a>,
Up: <a rel="up" accesskey="u" href="#Reducing-Size-of-Ada-Executables-with-gnatelim">Reducing Size of Ada Executables with gnatelim</a>
</div>
<h4 class="subsection">7.3.4 Correcting the List of Eliminate Pragmas</h4>
<p class="noindent">In some rare cases <code>gnatelim</code> may try to eliminate
subprograms that are actually called in the program. In this case, the
compiler will generate an error message of the form:
<pre class="smallexample"> main.adb:4:08: cannot reference subprogram "P" eliminated at elim.out:5
</pre>
<p class="noindent">You will need to manually remove the wrong <code>Eliminate</code> pragmas from
the configuration file indicated in the error message. You should recompile
your program from scratch after that, because you need a consistent
configuration file(s) during the entire compilation.
<div class="node">
<a name="Making-Your-Executables-Smaller"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Summary-of-the-gnatelim-Usage-Cycle">Summary of the gnatelim Usage Cycle</a>,
Previous: <a rel="previous" accesskey="p" href="#Correcting-the-List-of-Eliminate-Pragmas">Correcting the List of Eliminate Pragmas</a>,
Up: <a rel="up" accesskey="u" href="#Reducing-Size-of-Ada-Executables-with-gnatelim">Reducing Size of Ada Executables with gnatelim</a>
</div>
<h4 class="subsection">7.3.5 Making Your Executables Smaller</h4>
<p class="noindent">In order to get a smaller executable for your program you now have to
recompile the program completely with the configuration file containing
pragmas Eliminate generated by gnatelim. If these pragmas are placed in
<samp><span class="file">gnat.adc</span></samp> file located in your current directory, just do:
<pre class="smallexample"> $ gnatmake -f main_prog
</pre>
<p class="noindent">(Use the <samp><span class="option">-f</span></samp> option for <samp><span class="command">gnatmake</span></samp> to
recompile everything
with the set of pragmas <code>Eliminate</code> that you have obtained with
<samp><span class="command">gnatelim</span></samp>).
<p>Be aware that the set of <code>Eliminate</code> pragmas is specific to each
program. It is not recommended to merge sets of <code>Eliminate</code>
pragmas created for different programs in one configuration file.
<div class="node">
<a name="Summary-of-the-gnatelim-Usage-Cycle"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Making-Your-Executables-Smaller">Making Your Executables Smaller</a>,
Up: <a rel="up" accesskey="u" href="#Reducing-Size-of-Ada-Executables-with-gnatelim">Reducing Size of Ada Executables with gnatelim</a>
</div>
<h4 class="subsection">7.3.6 Summary of the <code>gnatelim</code> Usage Cycle</h4>
<p class="noindent">Here is a quick summary of the steps to be taken in order to reduce
the size of your executables with <code>gnatelim</code>. You may use
other GNAT options to control the optimization level,
to produce the debugging information, to set search path, etc.
<ol type=1 start=1>
<li>Create a complete set of <samp><span class="file">ALI</span></samp> files (if the program has not been
built already)
<pre class="smallexample"> $ gnatmake -c main_prog
</pre>
<li>Generate a list of <code>Eliminate</code> pragmas in default configuration file
<samp><span class="file">gnat.adc</span></samp> in the current directory
<pre class="smallexample"> $ gnatelim main_prog ><span class="roman">[</span>><span class="roman">]</span> gnat.adc
</pre>
<li>Recompile the application
<pre class="smallexample"> $ gnatmake -f main_prog
</pre>
</ol>
<div class="node">
<a name="Reducing-Size-of-Executables-with-unused-subprogram%2fdata-elimination"></a>
<a name="Reducing-Size-of-Executables-with-unused-subprogram_002fdata-elimination"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Reducing-Size-of-Ada-Executables-with-gnatelim">Reducing Size of Ada Executables with gnatelim</a>,
Up: <a rel="up" accesskey="u" href="#Improving-Performance">Improving Performance</a>
</div>
<h3 class="section">7.4 Reducing Size of Executables with Unused Subprogram/Data Elimination</h3>
<p><a name="index-unused-subprogram_002fdata-elimination-603"></a>
This section describes how you can eliminate unused subprograms and data from
your executable just by setting options at compilation time.
<ul class="menu">
<li><a accesskey="1" href="#About-unused-subprogram_002fdata-elimination">About unused subprogram/data elimination</a>
<li><a accesskey="2" href="#Compilation-options">Compilation options</a>
<li><a accesskey="3" href="#Example-of-unused-subprogram_002fdata-elimination">Example of unused subprogram/data elimination</a>
</ul>
<div class="node">
<a name="About-unused-subprogram%2fdata-elimination"></a>
<a name="About-unused-subprogram_002fdata-elimination"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Compilation-options">Compilation options</a>,
Up: <a rel="up" accesskey="u" href="#Reducing-Size-of-Executables-with-unused-subprogram_002fdata-elimination">Reducing Size of Executables with unused subprogram/data elimination</a>
</div>
<h4 class="subsection">7.4.1 About unused subprogram/data elimination</h4>
<p class="noindent">By default, an executable contains all code and data of its composing objects
(directly linked or coming from statically linked libraries), even data or code
never used by this executable.
<p>This feature will allow you to eliminate such unused code from your
executable, making it smaller (in disk and in memory).
<p>This functionality is available on all Linux platforms except for the IA-64
architecture and on all cross platforms using the ELF binary file format.
In both cases GNU binutils version 2.16 or later are required to enable it.
<div class="node">
<a name="Compilation-options"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Example-of-unused-subprogram_002fdata-elimination">Example of unused subprogram/data elimination</a>,
Previous: <a rel="previous" accesskey="p" href="#About-unused-subprogram_002fdata-elimination">About unused subprogram/data elimination</a>,
Up: <a rel="up" accesskey="u" href="#Reducing-Size-of-Executables-with-unused-subprogram_002fdata-elimination">Reducing Size of Executables with unused subprogram/data elimination</a>
</div>
<h4 class="subsection">7.4.2 Compilation options</h4>
<p class="noindent">The operation of eliminating the unused code and data from the final executable
is directly performed by the linker.
<p>In order to do this, it has to work with objects compiled with the
following options:
<samp><span class="option">-ffunction-sections</span></samp> <samp><span class="option">-fdata-sections</span></samp>.
<a name="index-g_t_0040option_007b_002dffunction_002dsections_007d-_0028_0040command_007bgcc_007d_0029-604"></a><a name="index-g_t_0040option_007b_002dfdata_002dsections_007d-_0028_0040command_007bgcc_007d_0029-605"></a>These options are usable with C and Ada files.
They will place respectively each
function or data in a separate section in the resulting object file.
<p>Once the objects and static libraries are created with these options, the
linker can perform the dead code elimination. You can do this by setting
the <samp><span class="option">-Wl,--gc-sections</span></samp> option to gcc command or in the
<samp><span class="option">-largs</span></samp> section of <samp><span class="command">gnatmake</span></samp>. This will perform a
garbage collection of code and data never referenced.
<p>If the linker performs a partial link (<samp><span class="option">-r</span></samp> ld linker option), then you
will need to provide one or several entry point using the
<samp><span class="option">-e</span></samp> / <samp><span class="option">--entry</span></samp> ld option.
<p>Note that objects compiled without the <samp><span class="option">-ffunction-sections</span></samp> and
<samp><span class="option">-fdata-sections</span></samp> options can still be linked with the executable.
However, no dead code elimination will be performed on those objects (they will
be linked as is).
<p>The GNAT static library is now compiled with -ffunction-sections and
-fdata-sections on some platforms. This allows you to eliminate the unused code
and data of the GNAT library from your executable.
<div class="node">
<a name="Example-of-unused-subprogram%2fdata-elimination"></a>
<a name="Example-of-unused-subprogram_002fdata-elimination"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Compilation-options">Compilation options</a>,
Up: <a rel="up" accesskey="u" href="#Reducing-Size-of-Executables-with-unused-subprogram_002fdata-elimination">Reducing Size of Executables with unused subprogram/data elimination</a>
</div>
<h4 class="subsection">7.4.3 Example of unused subprogram/data elimination</h4>
<p class="noindent">Here is a simple example:
<pre class="smallexample"> with Aux;
procedure Test is
begin
Aux.Used (10);
end Test;
package Aux is
Used_Data : Integer;
Unused_Data : Integer;
procedure Used (Data : Integer);
procedure Unused (Data : Integer);
end Aux;
package body Aux is
procedure Used (Data : Integer) is
begin
Used_Data := Data;
end Used;
procedure Unused (Data : Integer) is
begin
Unused_Data := Data;
end Unused;
end Aux;
</pre>
<p class="noindent"><code>Unused</code> and <code>Unused_Data</code> are never referenced in this code
excerpt, and hence they may be safely removed from the final executable.
<pre class="smallexample"> $ gnatmake test
$ nm test | grep used
020015f0 T aux__unused
02005d88 B aux__unused_data
020015cc T aux__used
02005d84 B aux__used_data
$ gnatmake test -cargs -fdata-sections -ffunction-sections \
-largs -Wl,--gc-sections
$ nm test | grep used
02005350 T aux__used
0201ffe0 B aux__used_data
</pre>
<p class="noindent">It can be observed that the procedure <code>Unused</code> and the object
<code>Unused_Data</code> are removed by the linker when using the
appropriate options.
<!-- ******************************** -->
<div class="node">
<a name="Renaming-Files-Using-gnatchop"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Configuration-Pragmas">Configuration Pragmas</a>,
Previous: <a rel="previous" accesskey="p" href="#Improving-Performance">Improving Performance</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">8 Renaming Files Using <code>gnatchop</code></h2>
<p><a name="index-gnatchop-606"></a>
This chapter discusses how to handle files with multiple units by using
the <code>gnatchop</code> utility. This utility is also useful in renaming
files to meet the standard GNAT default file naming conventions.
<ul class="menu">
<li><a accesskey="1" href="#Handling-Files-with-Multiple-Units">Handling Files with Multiple Units</a>
<li><a accesskey="2" href="#Operating-gnatchop-in-Compilation-Mode">Operating gnatchop in Compilation Mode</a>
<li><a accesskey="3" href="#Command-Line-for-gnatchop">Command Line for gnatchop</a>
<li><a accesskey="4" href="#Switches-for-gnatchop">Switches for gnatchop</a>
<li><a accesskey="5" href="#Examples-of-gnatchop-Usage">Examples of gnatchop Usage</a>
</ul>
<div class="node">
<a name="Handling-Files-with-Multiple-Units"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Operating-gnatchop-in-Compilation-Mode">Operating gnatchop in Compilation Mode</a>,
Up: <a rel="up" accesskey="u" href="#Renaming-Files-Using-gnatchop">Renaming Files Using gnatchop</a>
</div>
<h3 class="section">8.1 Handling Files with Multiple Units</h3>
<p class="noindent">The basic compilation model of GNAT requires that a file submitted to the
compiler have only one unit and there be a strict correspondence
between the file name and the unit name.
<p>The <code>gnatchop</code> utility allows both of these rules to be relaxed,
allowing GNAT to process files which contain multiple compilation units
and files with arbitrary file names. <code>gnatchop</code>
reads the specified file and generates one or more output files,
containing one unit per file. The unit and the file name correspond,
as required by GNAT.
<p>If you want to permanently restructure a set of “foreign” files so that
they match the GNAT rules, and do the remaining development using the
GNAT structure, you can simply use <samp><span class="command">gnatchop</span></samp> once, generate the
new set of files and work with them from that point on.
<p>Alternatively, if you want to keep your files in the “foreign” format,
perhaps to maintain compatibility with some other Ada compilation
system, you can set up a procedure where you use <samp><span class="command">gnatchop</span></samp> each
time you compile, regarding the source files that it writes as temporary
files that you throw away.
<p>Note that if your file containing multiple units starts with a byte order
mark (BOM) specifying UTF-8 encoding, then the files generated by gnatchop
will each start with a copy of this BOM, meaning that they can be compiled
automatically in UTF-8 mode without needing to specify an explicit encoding.
<div class="node">
<a name="Operating-gnatchop-in-Compilation-Mode"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Command-Line-for-gnatchop">Command Line for gnatchop</a>,
Previous: <a rel="previous" accesskey="p" href="#Handling-Files-with-Multiple-Units">Handling Files with Multiple Units</a>,
Up: <a rel="up" accesskey="u" href="#Renaming-Files-Using-gnatchop">Renaming Files Using gnatchop</a>
</div>
<h3 class="section">8.2 Operating gnatchop in Compilation Mode</h3>
<p class="noindent">The basic function of <code>gnatchop</code> is to take a file with multiple units
and split it into separate files. The boundary between files is reasonably
clear, except for the issue of comments and pragmas. In default mode, the
rule is that any pragmas between units belong to the previous unit, except
that configuration pragmas always belong to the following unit. Any comments
belong to the following unit. These rules
almost always result in the right choice of
the split point without needing to mark it explicitly and most users will
find this default to be what they want. In this default mode it is incorrect to
submit a file containing only configuration pragmas, or one that ends in
configuration pragmas, to <code>gnatchop</code>.
<p>However, using a special option to activate “compilation mode”,
<code>gnatchop</code>
can perform another function, which is to provide exactly the semantics
required by the RM for handling of configuration pragmas in a compilation.
In the absence of configuration pragmas (at the main file level), this
option has no effect, but it causes such configuration pragmas to be handled
in a quite different manner.
<p>First, in compilation mode, if <code>gnatchop</code> is given a file that consists of
only configuration pragmas, then this file is appended to the
<samp><span class="file">gnat.adc</span></samp> file in the current directory. This behavior provides
the required behavior described in the RM for the actions to be taken
on submitting such a file to the compiler, namely that these pragmas
should apply to all subsequent compilations in the same compilation
environment. Using GNAT, the current directory, possibly containing a
<samp><span class="file">gnat.adc</span></samp> file is the representation
of a compilation environment. For more information on the
<samp><span class="file">gnat.adc</span></samp> file, see <a href="#Handling-of-Configuration-Pragmas">Handling of Configuration Pragmas</a>.
<p>Second, in compilation mode, if <code>gnatchop</code>
is given a file that starts with
configuration pragmas, and contains one or more units, then these
configuration pragmas are prepended to each of the chopped files. This
behavior provides the required behavior described in the RM for the
actions to be taken on compiling such a file, namely that the pragmas
apply to all units in the compilation, but not to subsequently compiled
units.
<p>Finally, if configuration pragmas appear between units, they are appended
to the previous unit. This results in the previous unit being illegal,
since the compiler does not accept configuration pragmas that follow
a unit. This provides the required RM behavior that forbids configuration
pragmas other than those preceding the first compilation unit of a
compilation.
<p>For most purposes, <code>gnatchop</code> will be used in default mode. The
compilation mode described above is used only if you need exactly
accurate behavior with respect to compilations, and you have files
that contain multiple units and configuration pragmas. In this
circumstance the use of <code>gnatchop</code> with the compilation mode
switch provides the required behavior, and is for example the mode
in which GNAT processes the ACVC tests.
<div class="node">
<a name="Command-Line-for-gnatchop"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Switches-for-gnatchop">Switches for gnatchop</a>,
Previous: <a rel="previous" accesskey="p" href="#Operating-gnatchop-in-Compilation-Mode">Operating gnatchop in Compilation Mode</a>,
Up: <a rel="up" accesskey="u" href="#Renaming-Files-Using-gnatchop">Renaming Files Using gnatchop</a>
</div>
<h3 class="section">8.3 Command Line for <code>gnatchop</code></h3>
<p class="noindent">The <code>gnatchop</code> command has the form:
<pre class="smallexample"> <!-- $ gnatchop switches @var{file name} @r{[}@var{file name} @dots{}@r{]} -->
<!-- @ovar{directory} -->
<!-- Expanding @ovar macro inline (explanation in macro def comments) -->
$ gnatchop switches <var>file name</var> <span class="roman">[</span><var>file name</var> ...<span class="roman">]</span>
<span class="roman">[</span><var>directory</var><span class="roman">]</span>
</pre>
<p class="noindent">The only required argument is the file name of the file to be chopped.
There are no restrictions on the form of this file name. The file itself
contains one or more Ada units, in normal GNAT format, concatenated
together. As shown, more than one file may be presented to be chopped.
<p>When run in default mode, <code>gnatchop</code> generates one output file in
the current directory for each unit in each of the files.
<p><var>directory</var>, if specified, gives the name of the directory to which
the output files will be written. If it is not specified, all files are
written to the current directory.
<p>For example, given a
file called <samp><span class="file">hellofiles</span></samp> containing
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
procedure hello;
with Text_IO; use Text_IO;
procedure hello is
begin
Put_Line ("Hello");
end hello;
</td></tr></table>
</pre>
<p class="noindent">the command
<pre class="smallexample"> $ gnatchop hellofiles
</pre>
<p class="noindent">generates two files in the current directory, one called
<samp><span class="file">hello.ads</span></samp> containing the single line that is the procedure spec,
and the other called <samp><span class="file">hello.adb</span></samp> containing the remaining text. The
original file is not affected. The generated files can be compiled in
the normal manner.
<p class="noindent">When gnatchop is invoked on a file that is empty or that contains only empty
lines and/or comments, gnatchop will not fail, but will not produce any
new sources.
<p>For example, given a
file called <samp><span class="file">toto.txt</span></samp> containing
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
-- Just a comment
</td></tr></table>
</pre>
<p class="noindent">the command
<pre class="smallexample"> $ gnatchop toto.txt
</pre>
<p class="noindent">will not produce any new file and will result in the following warnings:
<pre class="smallexample"> toto.txt:1:01: warning: empty file, contains no compilation units
no compilation units found
no source files written
</pre>
<div class="node">
<a name="Switches-for-gnatchop"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Examples-of-gnatchop-Usage">Examples of gnatchop Usage</a>,
Previous: <a rel="previous" accesskey="p" href="#Command-Line-for-gnatchop">Command Line for gnatchop</a>,
Up: <a rel="up" accesskey="u" href="#Renaming-Files-Using-gnatchop">Renaming Files Using gnatchop</a>
</div>
<h3 class="section">8.4 Switches for <code>gnatchop</code></h3>
<p class="noindent"><samp><span class="command">gnatchop</span></samp> recognizes the following switches:
<dl>
<!-- !sort! -->
<dt><samp><span class="option">--version</span></samp><dd><a name="index-g_t_0040option_007b_002d_002dversion_007d-_0040command_007bgnatchop_007d-607"></a>Display Copyright and version, then exit disregarding all other options.
<br><dt><samp><span class="option">--help</span></samp><dd><a name="index-g_t_0040option_007b_002d_002dhelp_007d-_0040command_007bgnatchop_007d-608"></a>If <samp><span class="option">--version</span></samp> was not used, display usage, then exit disregarding
all other options.
<br><dt><samp><span class="option">-c</span></samp><dd><a name="index-g_t_0040option_007b_002dc_007d-_0028_0040code_007bgnatchop_007d_0029-609"></a>Causes <code>gnatchop</code> to operate in compilation mode, in which
configuration pragmas are handled according to strict RM rules. See
previous section for a full description of this mode.
<br><dt><samp><span class="option">-gnat</span><var>xxx</var></samp><dd>This passes the given <samp><span class="option">-gnat</span><var>xxx</var></samp> switch to <code>gnat</code> which is
used to parse the given file. Not all <var>xxx</var> options make sense,
but for example, the use of <samp><span class="option">-gnati2</span></samp> allows <code>gnatchop</code> to
process a source file that uses Latin-2 coding for identifiers.
<br><dt><samp><span class="option">-h</span></samp><dd>Causes <code>gnatchop</code> to generate a brief help summary to the standard
output file showing usage information.
<br><dt><samp><span class="option">-k</span><var>mm</var></samp><dd><a name="index-g_t_0040option_007b_002dk_007d-_0028_0040code_007bgnatchop_007d_0029-610"></a>Limit generated file names to the specified number <code>mm</code>
of characters.
This is useful if the
resulting set of files is required to be interoperable with systems
which limit the length of file names.
No space is allowed between the <samp><span class="option">-k</span></samp> and the numeric value. The numeric
value may be omitted in which case a default of <samp><span class="option">-k8</span></samp>,
suitable for use
with DOS-like file systems, is used. If no <samp><span class="option">-k</span></samp> switch
is present then
there is no limit on the length of file names.
<br><dt><samp><span class="option">-p</span></samp><dd><a name="index-g_t_0040option_007b_002dp_007d-_0028_0040code_007bgnatchop_007d_0029-611"></a>Causes the file modification time stamp of the input file to be
preserved and used for the time stamp of the output file(s). This may be
useful for preserving coherency of time stamps in an environment where
<code>gnatchop</code> is used as part of a standard build process.
<br><dt><samp><span class="option">-q</span></samp><dd><a name="index-g_t_0040option_007b_002dq_007d-_0028_0040code_007bgnatchop_007d_0029-612"></a>Causes output of informational messages indicating the set of generated
files to be suppressed. Warnings and error messages are unaffected.
<br><dt><samp><span class="option">-r</span></samp><dd><a name="index-g_t_0040option_007b_002dr_007d-_0028_0040code_007bgnatchop_007d_0029-613"></a><a name="index-Source_005fReference-614"></a>Generate <code>Source_Reference</code> pragmas. Use this switch if the output
files are regarded as temporary and development is to be done in terms
of the original unchopped file. This switch causes
<code>Source_Reference</code> pragmas to be inserted into each of the
generated files to refers back to the original file name and line number.
The result is that all error messages refer back to the original
unchopped file.
In addition, the debugging information placed into the object file (when
the <samp><span class="option">-g</span></samp> switch of <samp><span class="command">gcc</span></samp> or <samp><span class="command">gnatmake</span></samp> is
specified)
also refers back to this original file so that tools like profilers and
debuggers will give information in terms of the original unchopped file.
<p>If the original file to be chopped itself contains
a <code>Source_Reference</code>
pragma referencing a third file, then gnatchop respects
this pragma, and the generated <code>Source_Reference</code> pragmas
in the chopped file refer to the original file, with appropriate
line numbers. This is particularly useful when <code>gnatchop</code>
is used in conjunction with <code>gnatprep</code> to compile files that
contain preprocessing statements and multiple units.
<br><dt><samp><span class="option">-v</span></samp><dd><a name="index-g_t_0040option_007b_002dv_007d-_0028_0040code_007bgnatchop_007d_0029-615"></a>Causes <code>gnatchop</code> to operate in verbose mode. The version
number and copyright notice are output, as well as exact copies of
the gnat1 commands spawned to obtain the chop control information.
<br><dt><samp><span class="option">-w</span></samp><dd><a name="index-g_t_0040option_007b_002dw_007d-_0028_0040code_007bgnatchop_007d_0029-616"></a>Overwrite existing file names. Normally <code>gnatchop</code> regards it as a
fatal error if there is already a file with the same name as a
file it would otherwise output, in other words if the files to be
chopped contain duplicated units. This switch bypasses this
check, and causes all but the last instance of such duplicated
units to be skipped.
<br><dt><samp><span class="option">--GCC=</span><var>xxxx</var></samp><dd><a name="index-g_t_0040option_007b_002d_002dGCC_003d_007d-_0028_0040code_007bgnatchop_007d_0029-617"></a>Specify the path of the GNAT parser to be used. When this switch is used,
no attempt is made to add the prefix to the GNAT parser executable.
</dl>
<div class="node">
<a name="Examples-of-gnatchop-Usage"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Switches-for-gnatchop">Switches for gnatchop</a>,
Up: <a rel="up" accesskey="u" href="#Renaming-Files-Using-gnatchop">Renaming Files Using gnatchop</a>
</div>
<h3 class="section">8.5 Examples of <code>gnatchop</code> Usage</h3>
<dl>
<dt><code>gnatchop -w hello_s.ada prerelease/files</code><dd>
Chops the source file <samp><span class="file">hello_s.ada</span></samp>. The output files will be
placed in the directory <samp><span class="file">prerelease/files</span></samp>,
overwriting any
files with matching names in that directory (no files in the current
directory are modified).
<br><dt><code>gnatchop archive</code><dd>Chops the source file <samp><span class="file">archive</span></samp>
into the current directory. One
useful application of <code>gnatchop</code> is in sending sets of sources
around, for example in email messages. The required sources are simply
concatenated (for example, using a Unix <code>cat</code>
command), and then
<samp><span class="command">gnatchop</span></samp> is used at the other end to reconstitute the original
file names.
<br><dt><code>gnatchop file1 file2 file3 direc</code><dd>Chops all units in files <samp><span class="file">file1</span></samp>, <samp><span class="file">file2</span></samp>, <samp><span class="file">file3</span></samp>, placing
the resulting files in the directory <samp><span class="file">direc</span></samp>. Note that if any units
occur more than once anywhere within this set of files, an error message
is generated, and no files are written. To override this check, use the
<samp><span class="option">-w</span></samp> switch,
in which case the last occurrence in the last file will
be the one that is output, and earlier duplicate occurrences for a given
unit will be skipped.
</dl>
<div class="node">
<a name="Configuration-Pragmas"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Handling-Arbitrary-File-Naming-Conventions-Using-gnatname">Handling Arbitrary File Naming Conventions Using gnatname</a>,
Previous: <a rel="previous" accesskey="p" href="#Renaming-Files-Using-gnatchop">Renaming Files Using gnatchop</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">9 Configuration Pragmas</h2>
<p><a name="index-Configuration-pragmas-618"></a><a name="index-Pragmas_002c-configuration-619"></a>
Configuration pragmas include those pragmas described as
such in the Ada Reference Manual, as well as
implementation-dependent pragmas that are configuration pragmas.
See <a href="gnat_rm.html#Implementation-Defined-Pragmas">Implementation Defined Pragmas</a>,
for details on these additional GNAT-specific configuration pragmas.
Most notably, the pragma <code>Source_File_Name</code>, which allows
specifying non-default names for source files, is a configuration
pragma. The following is a complete list of configuration pragmas
recognized by GNAT:
<pre class="smallexample"> Ada_83
Ada_95
Ada_05
Ada_2005
Ada_12
Ada_2012
Assertion_Policy
Assume_No_Invalid_Values
C_Pass_By_Copy
Check_Name
Check_Policy
Compile_Time_Error
Compile_Time_Warning
Compiler_Unit
Component_Alignment
Convention_Identifier
Debug_Policy
Detect_Blocking
Default_Storage_Pool
Discard_Names
Elaboration_Checks
Eliminate
Extend_System
Extensions_Allowed
External_Name_Casing
Fast_Math
Favor_Top_Level
Float_Representation
Implicit_Packing
Initialize_Scalars
Interrupt_State
License
Locking_Policy
Long_Float
No_Run_Time
No_Strict_Aliasing
Normalize_Scalars
Optimize_Alignment
Persistent_BSS
Polling
Priority_Specific_Dispatching
Profile
Profile_Warnings
Propagate_Exceptions
Queuing_Policy
Ravenscar
Restricted_Run_Time
Restrictions
Restrictions_Warnings
Reviewable
Short_Circuit_And_Or
Source_File_Name
Source_File_Name_Project
Style_Checks
Suppress
Suppress_Exception_Locations
Task_Dispatching_Policy
Universal_Data
Unsuppress
Use_VADS_Size
Validity_Checks
Warnings
Wide_Character_Encoding
</pre>
<ul class="menu">
<li><a accesskey="1" href="#Handling-of-Configuration-Pragmas">Handling of Configuration Pragmas</a>
<li><a accesskey="2" href="#The-Configuration-Pragmas-Files">The Configuration Pragmas Files</a>
</ul>
<div class="node">
<a name="Handling-of-Configuration-Pragmas"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#The-Configuration-Pragmas-Files">The Configuration Pragmas Files</a>,
Up: <a rel="up" accesskey="u" href="#Configuration-Pragmas">Configuration Pragmas</a>
</div>
<h3 class="section">9.1 Handling of Configuration Pragmas</h3>
<p>Configuration pragmas may either appear at the start of a compilation
unit, in which case they apply only to that unit, or they may apply to
all compilations performed in a given compilation environment.
<p>GNAT also provides the <code>gnatchop</code> utility to provide an automatic
way to handle configuration pragmas following the semantics for
compilations (that is, files with multiple units), described in the RM.
See <a href="#Operating-gnatchop-in-Compilation-Mode">Operating gnatchop in Compilation Mode</a> for details.
However, for most purposes, it will be more convenient to edit the
<samp><span class="file">gnat.adc</span></samp> file that contains configuration pragmas directly,
as described in the following section.
<div class="node">
<a name="The-Configuration-Pragmas-Files"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Handling-of-Configuration-Pragmas">Handling of Configuration Pragmas</a>,
Up: <a rel="up" accesskey="u" href="#Configuration-Pragmas">Configuration Pragmas</a>
</div>
<h3 class="section">9.2 The Configuration Pragmas Files</h3>
<p><a name="index-g_t_0040file_007bgnat_002eadc_007d-620"></a>
In GNAT a compilation environment is defined by the current
directory at the time that a compile command is given. This current
directory is searched for a file whose name is <samp><span class="file">gnat.adc</span></samp>. If
this file is present, it is expected to contain one or more
configuration pragmas that will be applied to the current compilation.
However, if the switch <samp><span class="option">-gnatA</span></samp> is used, <samp><span class="file">gnat.adc</span></samp> is not
considered.
<p>Configuration pragmas may be entered into the <samp><span class="file">gnat.adc</span></samp> file
either by running <code>gnatchop</code> on a source file that consists only of
configuration pragmas, or more conveniently by
direct editing of the <samp><span class="file">gnat.adc</span></samp> file, which is a standard format
source file.
<p>In addition to <samp><span class="file">gnat.adc</span></samp>, additional files containing configuration
pragmas may be applied to the current compilation using the switch
<samp><span class="option">-gnatec</span></samp><var>path</var>. <var>path</var> must designate an existing file that
contains only configuration pragmas. These configuration pragmas are
in addition to those found in <samp><span class="file">gnat.adc</span></samp> (provided <samp><span class="file">gnat.adc</span></samp>
is present and switch <samp><span class="option">-gnatA</span></samp> is not used).
<p>It is allowed to specify several switches <samp><span class="option">-gnatec</span></samp>, all of which
will be taken into account.
<p>If you are using project file, a separate mechanism is provided using
project attributes, see <a href="#Specifying-Configuration-Pragmas">Specifying Configuration Pragmas</a> for more
details.
<div class="node">
<a name="Handling-Arbitrary-File-Naming-Conventions-Using-gnatname"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#GNAT-Project-Manager">GNAT Project Manager</a>,
Previous: <a rel="previous" accesskey="p" href="#Configuration-Pragmas">Configuration Pragmas</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">10 Handling Arbitrary File Naming Conventions Using <code>gnatname</code></h2>
<p><a name="index-Arbitrary-File-Naming-Conventions-621"></a>
<ul class="menu">
<li><a accesskey="1" href="#Arbitrary-File-Naming-Conventions">Arbitrary File Naming Conventions</a>
<li><a accesskey="2" href="#Running-gnatname">Running gnatname</a>
<li><a accesskey="3" href="#Switches-for-gnatname">Switches for gnatname</a>
<li><a accesskey="4" href="#Examples-of-gnatname-Usage">Examples of gnatname Usage</a>
</ul>
<div class="node">
<a name="Arbitrary-File-Naming-Conventions"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Running-gnatname">Running gnatname</a>,
Up: <a rel="up" accesskey="u" href="#Handling-Arbitrary-File-Naming-Conventions-Using-gnatname">Handling Arbitrary File Naming Conventions Using gnatname</a>
</div>
<h3 class="section">10.1 Arbitrary File Naming Conventions</h3>
<p class="noindent">The GNAT compiler must be able to know the source file name of a compilation
unit. When using the standard GNAT default file naming conventions
(<code>.ads</code> for specs, <code>.adb</code> for bodies), the GNAT compiler
does not need additional information.
<p class="noindent">When the source file names do not follow the standard GNAT default file naming
conventions, the GNAT compiler must be given additional information through
a configuration pragmas file (see <a href="#Configuration-Pragmas">Configuration Pragmas</a>)
or a project file.
When the non-standard file naming conventions are well-defined,
a small number of pragmas <code>Source_File_Name</code> specifying a naming pattern
(see <a href="#Alternative-File-Naming-Schemes">Alternative File Naming Schemes</a>) may be sufficient. However,
if the file naming conventions are irregular or arbitrary, a number
of pragma <code>Source_File_Name</code> for individual compilation units
must be defined.
To help maintain the correspondence between compilation unit names and
source file names within the compiler,
GNAT provides a tool <code>gnatname</code> to generate the required pragmas for a
set of files.
<div class="node">
<a name="Running-gnatname"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Switches-for-gnatname">Switches for gnatname</a>,
Previous: <a rel="previous" accesskey="p" href="#Arbitrary-File-Naming-Conventions">Arbitrary File Naming Conventions</a>,
Up: <a rel="up" accesskey="u" href="#Handling-Arbitrary-File-Naming-Conventions-Using-gnatname">Handling Arbitrary File Naming Conventions Using gnatname</a>
</div>
<h3 class="section">10.2 Running <code>gnatname</code></h3>
<p class="noindent">The usual form of the <code>gnatname</code> command is
<pre class="smallexample"> <!-- $ gnatname @ovar{switches} @var{naming_pattern} @ovar{naming_patterns} -->
<!-- @r{[}-and @ovar{switches} @var{naming_pattern} @ovar{naming_patterns}@r{]} -->
<!-- Expanding @ovar macro inline (explanation in macro def comments) -->
$ gnatname <span class="roman">[</span><var>switches</var><span class="roman">]</span> <var>naming_pattern</var> <span class="roman">[</span><var>naming_patterns</var><span class="roman">]</span>
<span class="roman">[</span>--and <span class="roman">[</span><var>switches</var><span class="roman">]</span> <var>naming_pattern</var> <span class="roman">[</span><var>naming_patterns</var><span class="roman">]</span><span class="roman">]</span>
</pre>
<p class="noindent">All of the arguments are optional. If invoked without any argument,
<code>gnatname</code> will display its usage.
<p class="noindent">When used with at least one naming pattern, <code>gnatname</code> will attempt to
find all the compilation units in files that follow at least one of the
naming patterns. To find these compilation units,
<code>gnatname</code> will use the GNAT compiler in syntax-check-only mode on all
regular files.
<p class="noindent">One or several Naming Patterns may be given as arguments to <code>gnatname</code>.
Each Naming Pattern is enclosed between double quotes (or single
quotes on Windows).
A Naming Pattern is a regular expression similar to the wildcard patterns
used in file names by the Unix shells or the DOS prompt.
<p class="noindent"><code>gnatname</code> may be called with several sections of directories/patterns.
Sections are separated by switch <code>--and</code>. In each section, there must be
at least one pattern. If no directory is specified in a section, the current
directory (or the project directory is <code>-P</code> is used) is implied.
The options other that the directory switches and the patterns apply globally
even if they are in different sections.
<p class="noindent">Examples of Naming Patterns are
<pre class="smallexample"> "*.[12].ada"
"*.ad[sb]*"
"body_*" "spec_*"
</pre>
<p class="noindent">For a more complete description of the syntax of Naming Patterns,
see the second kind of regular expressions described in <samp><span class="file">g-regexp.ads</span></samp>
(the “Glob” regular expressions).
<p class="noindent">When invoked with no switch <code>-P</code>, <code>gnatname</code> will create a
configuration pragmas file <samp><span class="file">gnat.adc</span></samp> in the current working directory,
with pragmas <code>Source_File_Name</code> for each file that contains a valid Ada
unit.
<div class="node">
<a name="Switches-for-gnatname"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Examples-of-gnatname-Usage">Examples of gnatname Usage</a>,
Previous: <a rel="previous" accesskey="p" href="#Running-gnatname">Running gnatname</a>,
Up: <a rel="up" accesskey="u" href="#Handling-Arbitrary-File-Naming-Conventions-Using-gnatname">Handling Arbitrary File Naming Conventions Using gnatname</a>
</div>
<h3 class="section">10.3 Switches for <code>gnatname</code></h3>
<p class="noindent">Switches for <code>gnatname</code> must precede any specified Naming Pattern.
<p class="noindent">You may specify any of the following switches to <code>gnatname</code>:
<dl>
<!-- !sort! -->
<dt><samp><span class="option">--version</span></samp><dd><a name="index-g_t_0040option_007b_002d_002dversion_007d-_0040command_007bgnatname_007d-622"></a>Display Copyright and version, then exit disregarding all other options.
<br><dt><samp><span class="option">--help</span></samp><dd><a name="index-g_t_0040option_007b_002d_002dhelp_007d-_0040command_007bgnatname_007d-623"></a>If <samp><span class="option">--version</span></samp> was not used, display usage, then exit disregarding
all other options.
<br><dt><samp><span class="option">--and</span></samp><dd>Start another section of directories/patterns.
<br><dt><samp><span class="option">-c</span><samp><span class="file">file</span></samp></samp><dd><a name="index-g_t_0040option_007b_002dc_007d-_0028_0040code_007bgnatname_007d_0029-624"></a>Create a configuration pragmas file <samp><span class="file">file</span></samp> (instead of the default
<samp><span class="file">gnat.adc</span></samp>).
There may be zero, one or more space between <samp><span class="option">-c</span></samp> and
<samp><span class="file">file</span></samp>.
<samp><span class="file">file</span></samp> may include directory information. <samp><span class="file">file</span></samp> must be
writable. There may be only one switch <samp><span class="option">-c</span></samp>.
When a switch <samp><span class="option">-c</span></samp> is
specified, no switch <samp><span class="option">-P</span></samp> may be specified (see below).
<br><dt><samp><span class="option">-d</span><samp><span class="file">dir</span></samp></samp><dd><a name="index-g_t_0040option_007b_002dd_007d-_0028_0040code_007bgnatname_007d_0029-625"></a>Look for source files in directory <samp><span class="file">dir</span></samp>. There may be zero, one or more
spaces between <samp><span class="option">-d</span></samp> and <samp><span class="file">dir</span></samp>.
When a switch <samp><span class="option">-d</span></samp>
is specified, the current working directory will not be searched for source
files, unless it is explicitly specified with a <samp><span class="option">-d</span></samp>
or <samp><span class="option">-D</span></samp> switch.
Several switches <samp><span class="option">-d</span></samp> may be specified.
If <samp><span class="file">dir</span></samp> is a relative path, it is relative to the directory of
the configuration pragmas file specified with switch
<samp><span class="option">-c</span></samp>,
or to the directory of the project file specified with switch
<samp><span class="option">-P</span></samp> or,
if neither switch <samp><span class="option">-c</span></samp>
nor switch <samp><span class="option">-P</span></samp> are specified, it is relative to the
current working directory. The directory
specified with switch <samp><span class="option">-d</span></samp> must exist and be readable.
<br><dt><samp><span class="option">-D</span><samp><span class="file">file</span></samp></samp><dd><a name="index-g_t_0040option_007b_002dD_007d-_0028_0040code_007bgnatname_007d_0029-626"></a>Look for source files in all directories listed in text file <samp><span class="file">file</span></samp>.
There may be zero, one or more spaces between <samp><span class="option">-D</span></samp>
and <samp><span class="file">file</span></samp>.
<samp><span class="file">file</span></samp> must be an existing, readable text file.
Each nonempty line in <samp><span class="file">file</span></samp> must be a directory.
Specifying switch <samp><span class="option">-D</span></samp> is equivalent to specifying as many
switches <samp><span class="option">-d</span></samp> as there are nonempty lines in
<samp><span class="file">file</span></samp>.
<br><dt><samp><span class="option">-f</span><samp><span class="file">pattern</span></samp></samp><dd><a name="index-g_t_0040option_007b_002df_007d-_0028_0040code_007bgnatname_007d_0029-627"></a>Foreign patterns. Using this switch, it is possible to add sources of languages
other than Ada to the list of sources of a project file.
It is only useful if a -P switch is used.
For example,
<pre class="smallexample"> gnatname -Pprj -f"*.c" "*.ada"
</pre>
<p class="noindent">will look for Ada units in all files with the <samp><span class="file">.ada</span></samp> extension,
and will add to the list of file for project <samp><span class="file">prj.gpr</span></samp> the C files
with extension <samp><span class="file">.c</span></samp>.
<br><dt><samp><span class="option">-h</span></samp><dd><a name="index-g_t_0040option_007b_002dh_007d-_0028_0040code_007bgnatname_007d_0029-628"></a>Output usage (help) information. The output is written to <samp><span class="file">stdout</span></samp>.
<br><dt><samp><span class="option">-P</span><samp><span class="file">proj</span></samp></samp><dd><a name="index-g_t_0040option_007b_002dP_007d-_0028_0040code_007bgnatname_007d_0029-629"></a>Create or update project file <samp><span class="file">proj</span></samp>. There may be zero, one or more space
between <samp><span class="option">-P</span></samp> and <samp><span class="file">proj</span></samp>. <samp><span class="file">proj</span></samp> may include directory
information. <samp><span class="file">proj</span></samp> must be writable.
There may be only one switch <samp><span class="option">-P</span></samp>.
When a switch <samp><span class="option">-P</span></samp> is specified,
no switch <samp><span class="option">-c</span></samp> may be specified.
<br><dt><samp><span class="option">-v</span></samp><dd><a name="index-g_t_0040option_007b_002dv_007d-_0028_0040code_007bgnatname_007d_0029-630"></a>Verbose mode. Output detailed explanation of behavior to <samp><span class="file">stdout</span></samp>.
This includes name of the file written, the name of the directories to search
and, for each file in those directories whose name matches at least one of
the Naming Patterns, an indication of whether the file contains a unit,
and if so the name of the unit.
<br><dt><samp><span class="option">-v -v</span></samp><dd><a name="index-g_t_0040option_007b_002dv-_002dv_007d-_0028_0040code_007bgnatname_007d_0029-631"></a>Very Verbose mode. In addition to the output produced in verbose mode,
for each file in the searched directories whose name matches none of
the Naming Patterns, an indication is given that there is no match.
<br><dt><samp><span class="option">-x</span><samp><span class="file">pattern</span></samp></samp><dd><a name="index-g_t_0040option_007b_002dx_007d-_0028_0040code_007bgnatname_007d_0029-632"></a>Excluded patterns. Using this switch, it is possible to exclude some files
that would match the name patterns. For example,
<pre class="smallexample"> gnatname -x "*_nt.ada" "*.ada"
</pre>
<p class="noindent">will look for Ada units in all files with the <samp><span class="file">.ada</span></samp> extension,
except those whose names end with <samp><span class="file">_nt.ada</span></samp>.
</dl>
<div class="node">
<a name="Examples-of-gnatname-Usage"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Switches-for-gnatname">Switches for gnatname</a>,
Up: <a rel="up" accesskey="u" href="#Handling-Arbitrary-File-Naming-Conventions-Using-gnatname">Handling Arbitrary File Naming Conventions Using gnatname</a>
</div>
<h3 class="section">10.4 Examples of <code>gnatname</code> Usage</h3>
<pre class="smallexample"> $ gnatname -c /home/me/names.adc -d sources "[a-z]*.ada*"
</pre>
<p class="noindent">In this example, the directory <samp><span class="file">/home/me</span></samp> must already exist
and be writable. In addition, the directory
<samp><span class="file">/home/me/sources</span></samp> (specified by
<samp><span class="option">-d sources</span></samp>) must exist and be readable.
<p>Note the optional spaces after <samp><span class="option">-c</span></samp> and <samp><span class="option">-d</span></samp>.
<pre class="smallexample"> $ gnatname -P/home/me/proj -x "*_nt_body.ada"
-dsources -dsources/plus -Dcommon_dirs.txt "body_*" "spec_*"
</pre>
<p>Note that several switches <samp><span class="option">-d</span></samp> may be used,
even in conjunction with one or several switches
<samp><span class="option">-D</span></samp>. Several Naming Patterns and one excluded pattern
are used in this example.
<!-- ***************************************** -->
<!-- * G N A T P r o j e c t M a n a g e r * -->
<!-- ***************************************** -->
<!-- macros for projects.texi -->
<!-- These macros are needed when building the gprbuild documentation, but -->
<!-- should have no effect in the gnat user's guide -->
<!-- simulates a newline when in a @CODESAMPLE -->
<!-- projects.texi -->
<!-- This file is shared between the GNAT user's guide and gprbuild. It is not -->
<!-- compilable on its own, you should instead compile the other two manuals. -->
<!-- For that reason, there is no toplevel @menu -->
<!-- -->
<div class="node">
<a name="GNAT-Project-Manager"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Tools-Supporting-Project-Files">Tools Supporting Project Files</a>,
Previous: <a rel="previous" accesskey="p" href="#Handling-Arbitrary-File-Naming-Conventions-Using-gnatname">Handling Arbitrary File Naming Conventions Using gnatname</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">11 GNAT Project Manager</h2>
<!-- -->
<p class="noindent">
<ul class="menu">
<li><a accesskey="1" href="#Introduction">Introduction</a>
<li><a accesskey="2" href="#Building-With-Projects">Building With Projects</a>
<li><a accesskey="3" href="#Organizing-Projects-into-Subsystems">Organizing Projects into Subsystems</a>
<li><a accesskey="4" href="#Scenarios-in-Projects">Scenarios in Projects</a>
<li><a accesskey="5" href="#Library-Projects">Library Projects</a>
<li><a accesskey="6" href="#Project-Extension">Project Extension</a>
<li><a accesskey="7" href="#Project-File-Reference">Project File Reference</a>
</ul>
<!-- -->
<div class="node">
<a name="Introduction"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Building-With-Projects">Building With Projects</a>,
Up: <a rel="up" accesskey="u" href="#GNAT-Project-Manager">GNAT Project Manager</a>
</div>
<h3 class="section">11.1 Introduction</h3>
<!-- -->
<p class="noindent">This chapter describes GNAT's <em>Project Manager</em>, a facility that allows
you to manage complex builds involving a number of source files, directories,
and options for different system configurations. In particular,
project files allow you to specify:
<ul>
<li>The directory or set of directories containing the source files, and/or the
names of the specific source files themselves
<li>The directory in which the compiler's output
(<samp><span class="file">ALI</span></samp> files, object files, tree files, etc.) is to be placed
<li>The directory in which the executable programs are to be placed
<li>Switch settings for any of the project-enabled tools;
you can apply these settings either globally or to individual compilation units.
<li>The source files containing the main subprogram(s) to be built
<li>The source programming language(s)
<li>Source file naming conventions; you can specify these either globally or for
individual compilation units (see <a href="#Naming-Schemes">Naming Schemes</a>).
<li>Change any of the above settings depending on external values, thus enabling
the reuse of the projects in various <b>scenarios</b> (see <a href="#Scenarios-in-Projects">Scenarios in Projects</a>).
<li>Automatically build libraries as part of the build process
(see <a href="#Library-Projects">Library Projects</a>).
</ul>
<p class="noindent">Project files are written in a syntax close to that of Ada, using familiar
notions such as packages, context clauses, declarations, default values,
assignments, and inheritance (see <a href="#Project-File-Reference">Project File Reference</a>).
<p>Project files can be built hierarchically from other project files, simplifying
complex system integration and project reuse (see <a href="#Organizing-Projects-into-Subsystems">Organizing Projects into Subsystems</a>).
<ul>
<li>One project can import other projects containing needed source files.
More generally, the Project Manager lets you structure large development
efforts into hierarchical subsystems, where build decisions are delegated
to the subsystem level, and thus different compilation environments
(switch settings) used for different subsystems.
<li>You can organize GNAT projects in a hierarchy: a child project
can extend a parent project, inheriting the parent's source files and
optionally overriding any of them with alternative versions
(see <a href="#Project-Extension">Project Extension</a>).
</ul>
<p class="noindent">Several tools support project files, generally in addition to specifying
the information on the command line itself). They share common switches
to control the loading of the project (in particular
<samp><span class="option">-P</span><em>projectfile</em></samp> and
<samp><span class="option">-X</span><em>vbl</em><span class="option">=</span><em>value</em></samp>).
See <a href="#Switches-Related-to-Project-Files">Switches Related to Project Files</a>.
<p>The Project Manager supports a wide range of development strategies,
for systems of all sizes. Here are some typical practices that are
easily handled:
<ul>
<li>Using a common set of source files and generating object files in different
directories via different switch settings. It can be used for instance, for
generating separate sets of object files for debugging and for production.
<li>Using a mostly-shared set of source files with different versions of
some units or subunits. It can be used for instance, for grouping and hiding
</ul>
<p class="noindent">all OS dependencies in a small number of implementation units.
<p>Project files can be used to achieve some of the effects of a source
versioning system (for example, defining separate projects for
the different sets of sources that comprise different releases) but the
Project Manager is independent of any source configuration management tool
that might be used by the developers.
<p>The various sections below introduce the different concepts related to
projects. Each section starts with examples and use cases, and then goes into
the details of related project file capabilities.
<!-- -->
<div class="node">
<a name="Building-With-Projects"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Organizing-Projects-into-Subsystems">Organizing Projects into Subsystems</a>,
Previous: <a rel="previous" accesskey="p" href="#Introduction">Introduction</a>,
Up: <a rel="up" accesskey="u" href="#GNAT-Project-Manager">GNAT Project Manager</a>
</div>
<h3 class="section">11.2 Building With Projects</h3>
<!-- -->
<p class="noindent">In its simplest form, a unique project is used to build a single executable.
This section concentrates on such a simple setup. Later sections will extend
this basic model to more complex setups.
<p>The following concepts are the foundation of project files, and will be further
detailed later in this documentation. They are summarized here as a reference.
<dl>
<dt><b>Project file</b>:<dd> A text file using an Ada-like syntax, generally using the <samp><span class="file">.gpr</span></samp>
extension. It defines build-related characteristics of an application.
The characteristics include the list of sources, the location of those
sources, the location for the generated object files, the name of
the main program, and the options for the various tools involved in the
build process.
<br><dt><b>Project attribute</b>:<dd> A specific project characteristic is defined by an attribute clause. Its
value is a string or a sequence of strings. All settings in a project
are defined through a list of predefined attributes with precise
semantics. See <a href="#Attributes">Attributes</a>.
<br><dt><b>Package in a project</b>:<dd> Global attributes are defined at the top level of a project.
Attributes affecting specific tools are grouped in a
package whose name is related to tool's function. The most common
packages are <code>Builder</code>, <code>Compiler</code>, <code>Binder</code>,
and <code>Linker</code>. See <a href="#Packages">Packages</a>.
<br><dt><b>Project variables</b>:<dd> In addition to attributes, a project can use variables to store intermediate
values and avoid duplication in complex expressions. It can be initialized
with a value coming from the environment.
A frequent use of variables is to define scenarios.
See <a href="#External-Values">External Values</a>, See <a href="#Scenarios-in-Projects">Scenarios in Projects</a>, and See <a href="#Variables">Variables</a>.
<br><dt><b>Source files</b> and <b>source directories</b>:<dd> A source file is associated with a language through a naming convention. For
instance, <code>foo.c</code> is typically the name of a C source file;
<code>bar.ads</code> or <code>bar.1.ada</code> are two common naming conventions for a
file containing an Ada spec. A compilation unit is often composed of a main
source file and potentially several auxiliary ones, such as header files in C.
The naming conventions can be user defined See <a href="#Naming-Schemes">Naming Schemes</a>, and will
drive the builder to call the appropriate compiler for the given source file.
Source files are searched for in the source directories associated with the
project through the <b>Source_Dirs</b> attribute. By default, all the files (in
these source directories) following the naming conventions associated with the
declared languages are considered to be part of the project. It is also
possible to limit the list of source files using the <b>Source_Files</b> or
<b>Source_List_File</b> attributes. Note that those last two attributes only
accept basenames with no directory information.
<br><dt><b>Object files</b> and <b>object directory</b>:<dd> An object file is an intermediate file produced by the compiler from a
compilation unit. It is used by post-compilation tools to produce
final executables or libraries. Object files produced in the context of
a given project are stored in a single directory that can be specified by the
<b>Object_Dir</b> attribute. In order to store objects in
two or more object directories, the system must be split into
distinct subsystems with their own project file.
</dl>
<p>The following subsections introduce gradually all the attributes of interest
for simple build needs. Here is the simple setup that will be used in the
following examples.
<p>The Ada source files <samp><span class="file">pack.ads</span></samp>, <samp><span class="file">pack.adb</span></samp>, and <samp><span class="file">proc.adb</span></samp> are in
the <samp><span class="file">common/</span></samp> directory. The file <samp><span class="file">proc.adb</span></samp> contains an Ada main
subprogram <code>Proc</code> that <code>with</code>s package <code>Pack</code>. We want to compile
these source files with the switch <samp><span class="option">-O2</span></samp>, and put the resulting files in
the directory <samp><span class="file">obj/</span></samp>.
<pre class="smallexample"> common/
pack.ads
pack.adb
proc.adb
common/release/
proc.ali, proc.o pack.ali, pack.o
</pre>
<p class="noindent">Our project is to be called <em>Build</em>. The name of the
file is the name of the project (case-insensitive) with the
<samp><span class="file">.gpr</span></samp> extension, therefore the project file name is <samp><span class="file">build.gpr</span></samp>. This
is not mandatory, but a warning is issued when this convention is not followed.
<p>This is a very simple example, and as stated above, a single project
file is enough for it. We will thus create a new file, that for now
should contain the following code:
<pre class="smallexample"> <b>project</b> Build <b>is</b>
<b>end</b> Build;
</pre>
<ul class="menu">
<li><a accesskey="1" href="#Source-Files-and-Directories">Source Files and Directories</a>
<li><a accesskey="2" href="#Object-and-Exec-Directory">Object and Exec Directory</a>
<li><a accesskey="3" href="#Main-Subprograms">Main Subprograms</a>
<li><a accesskey="4" href="#Tools-Options-in-Project-Files">Tools Options in Project Files</a>
<li><a accesskey="5" href="#Compiling-with-Project-Files">Compiling with Project Files</a>
<li><a accesskey="6" href="#Executable-File-Names">Executable File Names</a>
<li><a accesskey="7" href="#Avoid-Duplication-With-Variables">Avoid Duplication With Variables</a>
<li><a accesskey="8" href="#Naming-Schemes">Naming Schemes</a>
</ul>
<!-- -->
<div class="node">
<a name="Source-Files-and-Directories"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Object-and-Exec-Directory">Object and Exec Directory</a>,
Up: <a rel="up" accesskey="u" href="#Building-With-Projects">Building With Projects</a>
</div>
<h4 class="subsection">11.2.1 Source Files and Directories</h4>
<!-- -->
<p class="noindent">When you create a new project, the first thing to describe is how to find the
corresponding source files. This is the only settings that are needed by all
the tools that will use this project (builder, compiler, binder and linker for
the compilation, IDEs to edit the source files,<small class="dots">...</small>).
<p><a name="index-Source-directories-633"></a>First step is to declare the source directories, which are the directories
to be searched to find source files. In the case of the example,
the <samp><span class="file">common</span></samp> directory is the only source directory.
<p><a name="index-g_t_0040code_007bSource_005fDirs_007d-634"></a>There are several ways of defining source directories:
<ul>
<li>When the attribute <b>Source_Dirs</b> is not used, a project contains a
single source directory which is the one where the project file itself
resides. In our example, if <samp><span class="file">build.gpr</span></samp> is placed in the <samp><span class="file">common</span></samp>
directory, the project has the needed implicit source directory.
<li>The attribute <b>Source_Dirs</b> can be set to a list of path names, one
for each of the source directories. Such paths can either be absolute
names (for instance <samp><span class="file">"/usr/local/common/"</span></samp> on UNIX), or relative to the
directory in which the project file resides (for instance "." if
<samp><span class="file">build.gpr</span></samp> is inside <samp><span class="file">common/</span></samp>, or "common" if it is one level up).
Each of the source directories must exist and be readable.
<p><a name="index-portability-635"></a> The syntax for directories is platform specific. For portability, however,
the project manager will always properly translate UNIX-like path names to
the native format of specific platform. For instance, when the same project
file is to be used both on Unix and Windows, "/" should be used as the
directory separator rather than "\".
<li>The attribute <b>Source_Dirs</b> can automatically include subdirectories
using a special syntax inspired by some UNIX shells. If any of the path in
the list ends with <em>"/**"</em>, then that path and all its subdirectories
(recursively) are included in the list of source directories. For instance,
<samp><span class="file">./**</span></samp> represent the complete directory tree rooted at ".".
<a name="index-Source-directories_002c-recursive-636"></a>
<a name="index-g_t_0040code_007bExcluded_005fSource_005fDirs_007d-637"></a> When using that construct, it can sometimes be convenient to also use the
attribute <b>Excluded_Source_Dirs</b>, which is also a list of paths. Each entry
specifies a directory whose immediate content, not including subdirs, is to
be excluded. It is also possible to exclude a complete directory subtree
using the "/**" notation.
<p><a name="index-g_t_0040code_007bIgnore_005fSource_005fSub_005fDirs_007d-638"></a> It is often desirable to remove, from the source directories, directory
subtrees rooted at some subdirectories. An example is the subdirectories
created by a Version Control System such as Subversion that creates directory
subtrees .svn/**. To do that, attribute <b>Ignore_Source_Sub_Dirs</b> can be
used. It specifies the list of simple file names for the root of these
undesirable directory subtrees.
</ul>
<p class="noindent">When applied to the simple example, and because we generally prefer to have
the project file at the toplevel directory rather than mixed with the sources,
we will create the following file
<pre class="smallexample"> build.gpr
<b>project</b> Build <b>is</b>
<b>for</b> Source_Dirs <b>use</b> ("common"); -- <<<<
<b>end</b> Build;
</pre>
<p class="noindent">Once source directories have been specified, one may need to indicate
source files of interest. By default, all source files present in the source
directories are considered by the project manager. When this is not desired,
it is possible to specify the list of sources to consider explicitly.
In such a case, only source file base names are indicated and not
their absolute or relative path names. The project manager is in charge of
locating the specified source files in the specified source directories.
<ul>
<li>By default, the project manager search for all source files of all
specified languages in all the source directories.
<p>Since the project manager was initially developed for Ada environments, the
default language is usually Ada and the above project file is complete: it
defines without ambiguity the sources composing the project: that is to say,
all the sources in subdirectory "common" for the default language (Ada) using
the default naming convention.
<p><a name="index-g_t_0040code_007bLanguages_007d-639"></a> However, when compiling a multi-language application, or a pure C
application, the project manager must be told which languages are of
interest, which is done by setting the <b>Languages</b> attribute to a list of
strings, each of which is the name of a language. Tools like
<samp><span class="command">gnatmake</span></samp> only know about Ada, while other tools like
<samp><span class="command">gprbuild</span></samp> know about many more languages such as C, C++, Fortran,
assembly and others can be added dynamically.
<p><a name="index-Naming-scheme-640"></a> Even when using only Ada, the default naming might not be suitable. Indeed,
how does the project manager recognizes an "Ada file" from any other
file? Project files can describe the naming scheme used for source files,
and override the default (see <a href="#Naming-Schemes">Naming Schemes</a>). The default is the
standard GNAT extension (<samp><span class="file">.adb</span></samp> for bodies and <samp><span class="file">.ads</span></samp> for
specs), which is what is used in our example, explaining why no naming scheme
is explicitly specified.
See <a href="#Naming-Schemes">Naming Schemes</a>.
<li><code>Source Files</code>
<a name="index-g_t_0040code_007bSource_005fFiles_007d-641"></a> In some cases, source directories might contain files that should not be
included in a project. One can specify the explicit list of file names to
be considered through the <b>Source_Files</b> attribute.
When this attribute is defined, instead of looking at every file in the
source directories, the project manager takes only those names into
consideration reports errors if they cannot be found in the source
directories or does not correspond to the naming scheme.
<li>For various reasons, it is sometimes useful to have a project with no
sources (most of the time because the attributes defined in the project
file will be reused in other projects, as explained in see <a href="#Organizing-Projects-into-Subsystems">Organizing Projects into Subsystems</a>. To do this, the attribute
<em>Source_Files</em> is set to the empty list, i.e. <code>()</code>. Alternatively,
<em>Source_Dirs</em> can be set to the empty list, with the same
result.
<li><code>Source_List_File</code>
<a name="index-g_t_0040code_007bSource_005fList_005fFile_007d-642"></a> If there is a great number of files, it might be more convenient to use
the attribute <b>Source_List_File</b>, which specifies the full path of a file.
This file must contain a list of source file names (one per line, no
directory information) that are searched as if they had been defined
through <em>Source_Files</em>. Such a file can easily be created through
external tools.
<p>A warning is issued if both attributes <code>Source_Files</code> and
<code>Source_List_File</code> are given explicit values. In this case, the
attribute <code>Source_Files</code> prevails.
<li><code>Excluded_Source_Files</code>
<a name="index-g_t_0040code_007bExcluded_005fSource_005fFiles_007d-643"></a><a name="index-g_t_0040code_007bLocally_005fRemoved_005fFiles_007d-644"></a><a name="index-g_t_0040code_007bExcluded_005fSource_005fList_005fFile_007d-645"></a> Specifying an explicit list of files is not always convenient.It might be
more convenient to use the default search rules with specific exceptions.
This can be done thanks to the attribute <b>Excluded_Source_Files</b>
(or its synonym <b>Locally_Removed_Files</b>).
Its value is the list of file names that should not be taken into account.
This attribute is often used when extending a project, See <a href="#Project-Extension">Project Extension</a>. A similar attribute <b>Excluded_Source_List_File</b> plays the same
role but takes the name of file containing file names similarly to
<code>Source_List_File</code>.
</ul>
<p class="noindent">In most simple cases, such as the above example, the default source file search
behavior provides the expected result, and we do not need to add anything after
setting <code>Source_Dirs</code>. The project manager automatically finds
<samp><span class="file">pack.ads</span></samp>, <samp><span class="file">pack.adb</span></samp> and <samp><span class="file">proc.adb</span></samp> as source files of the
project.
<p>Note that it is considered an error for a project file to have no sources
attached to it unless explicitly declared as mentioned above.
<p>If the order of the source directories is known statically, that is if
<code>"/**"</code> is not used in the string list <code>Source_Dirs</code>, then there may
be several files with the same source file name sitting in different
directories of the project. In this case, only the file in the first directory
is considered as a source of the project and the others are hidden. If
<code>"/**"</code> is not used in the string list <code>Source_Dirs</code>, it is an error
to have several files with the same source file name in the same directory
<code>"/**"</code> subtree, since there would be an ambiguity as to which one should
be used. However, two files with the same source file name may in two single
directories or directory subtrees. In this case, the one in the first directory
or directory subtree is a source of the project.
<!-- -->
<div class="node">
<a name="Object-and-Exec-Directory"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Main-Subprograms">Main Subprograms</a>,
Previous: <a rel="previous" accesskey="p" href="#Source-Files-and-Directories">Source Files and Directories</a>,
Up: <a rel="up" accesskey="u" href="#Building-With-Projects">Building With Projects</a>
</div>
<h4 class="subsection">11.2.2 Object and Exec Directory</h4>
<!-- -->
<p class="noindent">The next step when writing a project is to indicate where the compiler should
put the object files. In fact, the compiler and other tools might create
several different kind of files (for GNAT, there is the object file and the ALI
file for instance). One of the important concepts in projects is that most
tools may consider source directories as read-only and do not attempt to create
new or temporary files there. Instead, all files are created in the object
directory. It is of course not true for project-aware IDEs, whose purpose it is
to create the source files.
<p><a name="index-g_t_0040code_007bObject_005fDir_007d-646"></a>The object directory is specified through the <b>Object_Dir</b> attribute.
Its value is the path to the object directory, either absolute or
relative to the directory containing the project file. This
directory must already exist and be readable and writable, although
some tools have a switch to create the directory if needed (See
the switch <code>-p</code> for <samp><span class="command">gnatmake</span></samp> and <samp><span class="command">gprbuild</span></samp>).
<p>If the attribute <code>Object_Dir</code> is not specified, it defaults to
the project directory, that is the directory containing the project file.
<p>For our example, we can specify the object dir in this way:
<pre class="smallexample"> <b>project</b> Build <b>is</b>
<b>for</b> Source_Dirs <b>use</b> ("common");
<b>for</b> Object_Dir <b>use</b> "obj"; -- <<<<
<b>end</b> Build;
</pre>
<p class="noindent">As mentioned earlier, there is a single object directory per project. As a
result, if you have an existing system where the object files are spread in
several directories, you can either move all of them into the same directory if
you want to build it with a single project file, or study the section on
subsystems (see <a href="#Organizing-Projects-into-Subsystems">Organizing Projects into Subsystems</a>) to see how each
separate object directory can be associated with one of the subsystem
constituting the application.
<p>When the <samp><span class="command">linker</span></samp> is called, it usually creates an executable. By
default, this executable is placed in the object directory of the project. It
might be convenient to store it in its own directory.
<p><a name="index-g_t_0040code_007bExec_005fDir_007d-647"></a>This can be done through the <code>Exec_Dir</code> attribute, which, like
<em>Object_Dir</em> contains a single absolute or relative path and must point to
an existing and writable directory, unless you ask the tool to create it on
your behalf. When not specified, It defaults to the object directory and
therefore to the project file's directory if neither <em>Object_Dir</em> nor
<em>Exec_Dir</em> was specified.
<p>In the case of the example, let's place the executable in the root
of the hierarchy, ie the same directory as <samp><span class="file">build.gpr</span></samp>. Hence
the project file is now
<pre class="smallexample"> <b>project</b> Build <b>is</b>
<b>for</b> Source_Dirs <b>use</b> ("common");
<b>for</b> Object_Dir <b>use</b> "obj";
<b>for</b> Exec_Dir <b>use</b> "."; -- <<<<
<b>end</b> Build;
</pre>
<!-- -->
<div class="node">
<a name="Main-Subprograms"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Tools-Options-in-Project-Files">Tools Options in Project Files</a>,
Previous: <a rel="previous" accesskey="p" href="#Object-and-Exec-Directory">Object and Exec Directory</a>,
Up: <a rel="up" accesskey="u" href="#Building-With-Projects">Building With Projects</a>
</div>
<h4 class="subsection">11.2.3 Main Subprograms</h4>
<!-- -->
<p class="noindent">In the previous section, executables were mentioned. The project manager needs
to be taught what they are. In a project file, an executable is indicated by
pointing to source file of the main subprogram. In C this is the file that
contains the <code>main</code> function, and in Ada the file that contains the main
unit.
<p>There can be any number of such main files within a given project, and thus
several executables can be built in the context of a single project file. Of
course, one given executable might not (and in fact will not) need all the
source files referenced by the project. As opposed to other build environments
such as <samp><span class="command">makefile</span></samp>, one does not need to specify the list of
dependencies of each executable, the project-aware builders knows enough of the
semantics of the languages to build ands link only the necessary elements.
<p><a name="index-g_t_0040code_007bMain_007d-648"></a>The list of main files is specified via the <b>Main</b> attribute. It contains
a list of file names (no directories). If a project defines this
attribute, it is not necessary to identify main files on the
command line when invoking a builder, and editors like
<samp><span class="command">GPS</span></samp> will be able to create extra menus to spawn or debug the
corresponding executables.
<pre class="smallexample"> <b>project</b> Build <b>is</b>
<b>for</b> Source_Dirs <b>use</b> ("common");
<b>for</b> Object_Dir <b>use</b> "obj";
<b>for</b> Exec_Dir <b>use</b> ".";
<b>for</b> Main <b>use</b> ("proc.adb"); -- <<<<
<b>end</b> Build;
</pre>
<p class="noindent">If this attribute is defined in the project, then spawning the builder
with a command such as
<pre class="smallexample"> gnatmake -Pbuild
</pre>
<p class="noindent">automatically builds all the executables corresponding to the files
listed in the <em>Main</em> attribute. It is possible to specify one
or more executables on the command line to build a subset of them.
<!-- -->
<div class="node">
<a name="Tools-Options-in-Project-Files"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Compiling-with-Project-Files">Compiling with Project Files</a>,
Previous: <a rel="previous" accesskey="p" href="#Main-Subprograms">Main Subprograms</a>,
Up: <a rel="up" accesskey="u" href="#Building-With-Projects">Building With Projects</a>
</div>
<h4 class="subsection">11.2.4 Tools Options in Project Files</h4>
<!-- -->
<p class="noindent">We now have a project file that fully describes our environment, and can be
used to build the application with a simple <samp><span class="command">gnatmake</span></samp> command as seen
in the previous section. In fact, the empty project we showed immediately at
the beginning (with no attribute at all) could already fulfill that need if it
was put in the <samp><span class="file">common</span></samp> directory.
<p>Of course, we always want more control. This section will show you how to
specify the compilation switches that the various tools involved in the
building of the executable should use.
<p><a name="index-command-line-length-649"></a>Since source names and locations are described into the project file, it is not
necessary to use switches on the command line for this purpose (switches such
as -I for gcc). This removes a major source of command line length overflow.
Clearly, the builders will have to communicate this information one way or
another to the underlying compilers and tools they call but they usually use
response files for this and thus should not be subject to command line
overflows.
<p>Several tools are participating to the creation of an executable: the compiler
produces object files from the source files; the binder (in the Ada case)
creates an source file that takes care, among other things, of elaboration
issues and global variables initialization; and the linker gathers everything
into a single executable that users can execute. All these tools are known by
the project manager and will be called with user defined switches from the
project files. However, we need to introduce a new project file concept to
express which switches to be used for any of the tools involved in the build.
<p><a name="index-project-file-packages-650"></a>A project file is subdivided into zero or more <b>packages</b>, each of which
contains the attributes specific to one tool (or one set of tools). Project
files use an Ada-like syntax for packages. Package names permitted in project
files are restricted to a predefined set (see <a href="#Packages">Packages</a>), and the contents
of packages are limited to a small set of constructs and attributes
(see <a href="#Attributes">Attributes</a>).
<p>Our example project file can be extended with the following empty packages. At
this stage, they could all be omitted since they are empty, but they show which
packages would be involved in the build process.
<pre class="smallexample"> <b>project</b> Build <b>is</b>
<b>for</b> Source_Dirs <b>use</b> ("common");
<b>for</b> Object_Dir <b>use</b> "obj";
<b>for</b> Exec_Dir <b>use</b> ".";
<b>for</b> Main <b>use</b> ("proc.adb");
<b>end</b> Build;
<b>package</b> Builder <b>is</b> --<<< for gnatmake and gprbuild
<b>end</b> Builder;
<b>package</b> Compiler <b>is</b> --<<< for the compiler
<b>end</b> Compiler;
<b>package</b> Binder <b>is</b> --<<< for the binder
<b>end</b> Binder;
<b>package</b> Linker <b>is</b> --<<< for the linker
<b>end</b> Linker;
</pre>
<p class="noindent">Let's first examine the compiler switches. As stated in the initial description
of the example, we want to compile all files with <samp><span class="option">-O2</span></samp>. This is a
compiler switch, although it is usual, on the command line, to pass it to the
builder which then passes it to the compiler. It is recommended to use directly
the right package, which will make the setup easier to understand for other
people.
<p>Several attributes can be used to specify the switches:
<dl>
<dt><b>Default_Switches</b>:<dd><a name="index-g_t_0040code_007bDefault_005fSwitches_007d-651"></a> This is the first mention in this manual of an <b>indexed attribute</b>. When
this attribute is defined, one must supply an <em>index</em> in the form of a
literal string.
In the case of <em>Default_Switches</em>, the index is the name of the
language to which the switches apply (since a different compiler will
likely be used for each language, and each compiler has its own set of
switches). The value of the attribute is a list of switches.
<p>In this example, we want to compile all Ada source files with the
<samp><span class="option">-O2</span></samp> switch, and the resulting project file is as follows
(only the <code>Compiler</code> package is shown):
<pre class="smallexample"> <b>package</b> Compiler <b>is</b>
<b>for</b> Default_Switches ("Ada") <b>use</b> ("-O2");
<b>end</b> Compiler;
</pre>
<br><dt><b>Switches</b>:<dd><a name="index-g_t_0040code_007bSwitches_007d-652"></a> in some cases, we might want to use specific switches
for one or more files. For instance, compiling <samp><span class="file">proc.adb</span></samp> might not be
possible at high level of optimization because of a compiler issue.
In such a case, the <em>Switches</em>
attribute (indexed on the file name) can be used and will override the
switches defined by <em>Default_Switches</em>. Our project file would
become:
<pre class="smallexample"> <b>package</b> Compiler <b>is</b>
<b>for</b> Default_Switches ("Ada") <b>use</b> ("-O2");
<b>for</b> Switches ("proc.adb") <b>use</b> ("-O0");
<b>end</b> Compiler;
</pre>
<p class="noindent"><code>Switches</code> may take a pattern as an index, such as in:
<pre class="smallexample"> <b>package</b> Compiler <b>is</b>
<b>for</b> Default_Switches ("Ada") <b>use</b> ("-O2");
<b>for</b> Switches ("pkg*") <b>use</b> ("-O0");
<b>end</b> Compiler;
</pre>
<p class="noindent">Sources <samp><span class="file">pkg.adb</span></samp> and <samp><span class="file">pkg-child.adb</span></samp> would be compiled with -O0,
not -O2.
<p class="noindent"><code>Switches</code> can also be given a language name as index instead of a file
name in which case it has the same semantics as <em>Default_Switches</em>.
However, indexes with wild cards are never valid for language name.
<br><dt><b>Local_Configuration_Pragmas</b>:<dd><a name="index-g_t_0040code_007bLocal_005fConfiguration_005fPragmas_007d-653"></a> this attribute may specify the path
of a file containing configuration pragmas for use by the Ada compiler,
such as <code>pragma Restrictions (No_Tasking)</code>. These pragmas will be
used for all the sources of the project.
</dl>
<p>The switches for the other tools are defined in a similar manner through the
<b>Default_Switches</b> and <b>Switches</b> attributes, respectively in the
<em>Builder</em> package (for <samp><span class="command">gnatmake</span></samp> and <samp><span class="command">gprbuild</span></samp>),
the <em>Binder</em> package (binding Ada executables) and the <em>Linker</em>
package (for linking executables).
<!-- -->
<div class="node">
<a name="Compiling-with-Project-Files"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Executable-File-Names">Executable File Names</a>,
Previous: <a rel="previous" accesskey="p" href="#Tools-Options-in-Project-Files">Tools Options in Project Files</a>,
Up: <a rel="up" accesskey="u" href="#Building-With-Projects">Building With Projects</a>
</div>
<h4 class="subsection">11.2.5 Compiling with Project Files</h4>
<!-- -->
<p class="noindent">Now that our project files are written, let's build our executable.
Here is the command we would use from the command line:
<pre class="smallexample"> gnatmake -Pbuild
</pre>
<p class="noindent">This will automatically build the executables specified through the
<em>Main</em> attribute: for each, it will compile or recompile the
sources for which the object file does not exist or is not up-to-date; it
will then run the binder; and finally run the linker to create the
executable itself.
<p><samp><span class="command">gnatmake</span></samp> only knows how to handle Ada files. By using
<samp><span class="command">gprbuild</span></samp> as a builder, you could automatically manage C files the
same way: create the file <samp><span class="file">utils.c</span></samp> in the <samp><span class="file">common</span></samp> directory,
set the attribute <em>Languages</em> to <code>"(Ada, C)"</code>, and run
<pre class="smallexample"> gprbuild -Pbuild
</pre>
<p class="noindent">Gprbuild knows how to recompile the C files and will
recompile them only if one of their dependencies has changed. No direct
indication on how to build the various elements is given in the
project file, which describes the project properties rather than a
set of actions to be executed. Here is the invocation of
<samp><span class="command">gprbuild</span></samp> when building a multi-language program:
<pre class="smallexample"> $ gprbuild -Pbuild
gcc -c proc.adb
gcc -c pack.adb
gcc -c utils.c
gprbind proc
...
gcc proc.o -o proc
</pre>
<p class="noindent">Notice the three steps described earlier:
<ul>
<li>The first three gcc commands correspond to the compilation phase.
<li>The gprbind command corresponds to the post-compilation phase.
<li>The last gcc command corresponds to the final link.
</ul>
<p class="noindent"><a name="index-g_t_0040option_007b_002dv_007d-option-_0028for-GPRbuild_0029-654"></a>The default output of GPRbuild's execution is kept reasonably simple and easy
to understand. In particular, some of the less frequently used commands are not
shown, and some parameters are abbreviated. So it is not possible to rerun the
effect of the gprbuild command by cut-and-pasting its output. GPRbuild's option
<code>-v</code> provides a much more verbose output which includes, among other
information, more complete compilation, post-compilation and link commands.
<!-- -->
<div class="node">
<a name="Executable-File-Names"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Avoid-Duplication-With-Variables">Avoid Duplication With Variables</a>,
Previous: <a rel="previous" accesskey="p" href="#Compiling-with-Project-Files">Compiling with Project Files</a>,
Up: <a rel="up" accesskey="u" href="#Building-With-Projects">Building With Projects</a>
</div>
<h4 class="subsection">11.2.6 Executable File Names</h4>
<!-- -->
<p class="noindent"><a name="index-g_t_0040code_007bExecutable_007d-655"></a>By default, the executable name corresponding to a main file is
computed from the main source file name. Through the attribute
<b>Builder.Executable</b>, it is possible to change this default.
<p>For instance, instead of building <samp><span class="command">proc</span></samp> (or <samp><span class="command">proc.exe</span></samp>
on Windows), we could configure our project file to build "proc1"
(resp proc1.exe) with the following addition:
<pre class="smallexample"> project Build is
... -- same as before
package Builder is
for Executable ("proc.adb") use "proc1";
end Builder
end Build;
</pre>
<p class="noindent"><a name="index-g_t_0040code_007bExecutable_005fSuffix_007d-656"></a>Attribute <b>Executable_Suffix</b>, when specified, may change the suffix
of the executable files, when no attribute <code>Executable</code> applies:
its value replace the platform-specific executable suffix.
The default executable suffix is empty on UNIX and ".exe" on Windows.
<p>It is also possible to change the name of the produced executable by using the
command line switch <samp><span class="option">-o</span></samp>. When several mains are defined in the project,
it is not possible to use the <samp><span class="option">-o</span></samp> switch and the only way to change the
names of the executable is provided by Attributes <code>Executable</code> and
<code>Executable_Suffix</code>.
<!-- -->
<div class="node">
<a name="Avoid-Duplication-With-Variables"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Naming-Schemes">Naming Schemes</a>,
Previous: <a rel="previous" accesskey="p" href="#Executable-File-Names">Executable File Names</a>,
Up: <a rel="up" accesskey="u" href="#Building-With-Projects">Building With Projects</a>
</div>
<h4 class="subsection">11.2.7 Avoid Duplication With Variables</h4>
<!-- -->
<p class="noindent">To illustrate some other project capabilities, here is a slightly more complex
project using similar sources and a main program in C:
<pre class="smallexample"> project C_Main is
for Languages use ("Ada", "C");
for Source_Dirs use ("common");
for Object_Dir use "obj";
for Main use ("main.c");
package Compiler is
C_Switches := ("-pedantic");
for Default_Switches ("C") use C_Switches;
for Default_Switches ("Ada") use ("-gnaty");
for Switches ("main.c") use C_Switches & ("-g");
end Compiler;
end C_Main;
</pre>
<p class="noindent">This project has many similarities with the previous one.
As expected, its <code>Main</code> attribute now refers to a C source.
The attribute <em>Exec_Dir</em> is now omitted, thus the resulting
executable will be put in the directory <samp><span class="file">obj</span></samp>.
<p>The most noticeable difference is the use of a variable in the
<em>Compiler</em> package to store settings used in several attributes.
This avoids text duplication, and eases maintenance (a single place to
modify if we want to add new switches for C files). We will revisit
the use of variables in the context of scenarios (see <a href="#Scenarios-in-Projects">Scenarios in Projects</a>).
<p>In this example, we see how the file <samp><span class="file">main.c</span></samp> can be compiled with
the switches used for all the other C files, plus <samp><span class="option">-g</span></samp>.
In this specific situation the use of a variable could have been
replaced by a reference to the <code>Default_Switches</code> attribute:
<pre class="smallexample"> for Switches ("c_main.c") use Compiler'Default_Switches ("C") & ("-g");
</pre>
<p class="noindent">Note the tick (<em>'</em>) used to refer to attributes defined in a package.
<p>Here is the output of the GPRbuild command using this project:
<pre class="smallexample"> $gprbuild -Pc_main
gcc -c -pedantic -g main.c
gcc -c -gnaty proc.adb
gcc -c -gnaty pack.adb
gcc -c -pedantic utils.c
gprbind main.bexch
...
gcc main.o -o main
</pre>
<p class="noindent">The default switches for Ada sources,
the default switches for C sources (in the compilation of <samp><span class="file">lib.c</span></samp>),
and the specific switches for <samp><span class="file">main.c</span></samp> have all been taken into
account.
<!-- -->
<div class="node">
<a name="Naming-Schemes"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Avoid-Duplication-With-Variables">Avoid Duplication With Variables</a>,
Up: <a rel="up" accesskey="u" href="#Building-With-Projects">Building With Projects</a>
</div>
<h4 class="subsection">11.2.8 Naming Schemes</h4>
<!-- -->
<p class="noindent">Sometimes an Ada software system is ported from one compilation environment to
another (say GNAT), and the file are not named using the default GNAT
conventions. Instead of changing all the file names, which for a variety of
reasons might not be possible, you can define the relevant file naming scheme
in the <b>Naming</b> package of your project file.
<p>The naming scheme has two distinct goals for the project manager: it
allows finding of source files when searching in the source
directories, and given a source file name it makes it possible to guess
the associated language, and thus the compiler to use.
<p>Note that the use by the Ada compiler of pragmas Source_File_Name is not
supported when using project files. You must use the features described in this
paragraph. You can however specify other configuration pragmas
(see <a href="#Specifying-Configuration-Pragmas">Specifying Configuration Pragmas</a>).
<p>The following attributes can be defined in package <code>Naming</code>:
<dl>
<dt><b>Casing</b>:<dd><a name="index-g_t_0040code_007bCasing_007d-657"></a> Its value must be one of <code>"lowercase"</code> (the default if
unspecified), <code>"uppercase"</code> or <code>"mixedcase"</code>. It describes the
casing of file names with regards to the Ada unit name. Given an Ada unit
My_Unit, the file name will respectively be <samp><span class="file">my_unit.adb</span></samp> (lowercase),
<samp><span class="file">MY_UNIT.ADB</span></samp> (uppercase) or <samp><span class="file">My_Unit.adb</span></samp> (mixedcase).
On Windows, file names are case insensitive, so this attribute is
irrelevant.
<br><dt><b>Dot_Replacement</b>:<dd><a name="index-g_t_0040code_007bDot_005fReplacement_007d-658"></a> This attribute specifies the string that should replace the "." in unit
names. Its default value is <code>"-"</code> so that a unit
<code>Parent.Child</code> is expected to be found in the file
<samp><span class="file">parent-child.adb</span></samp>. The replacement string must satisfy the following
requirements to avoid ambiguities in the naming scheme:
<ul>
<li>It must not be empty
<li>It cannot start or end with an alphanumeric character
<li>It cannot be a single underscore
<li>It cannot start with an underscore followed by an alphanumeric
<li>It cannot contain a dot <code>'.'</code> except if the entire string
is <code>"."</code>
</ul>
<br><dt><b>Spec_Suffix</b> and <b>Specification_Suffix</b>:<dd><a name="index-g_t_0040code_007bSpec_005fSuffix_007d-659"></a><a name="index-g_t_0040code_007bSpecification_005fSuffix_007d-660"></a> For Ada, these attributes give the suffix used in file names that contain
specifications. For other languages, they give the extension for files
that contain declaration (header files in C for instance). The attribute
is indexed on the language.
The two attributes are equivalent, but the latter is obsolescent.
If <code>Spec_Suffix ("Ada")</code> is not specified, then the default is
<code>".ads"</code>.
The value must satisfy the following requirements:
<ul>
<li>It must not be empty
<li>It cannot start with an alphanumeric character
<li>It cannot start with an underscore followed by an alphanumeric character
<li>It must include at least one dot
</ul>
<br><dt><b>Body_Suffix</b> and <b>Implementation_Suffix</b>:<dd><a name="index-g_t_0040code_007bBody_005fSuffix_007d-661"></a><a name="index-g_t_0040code_007bImplementation_005fSuffix_007d-662"></a> These attributes give the extension used for file names that contain
code (bodies in Ada). They are indexed on the language. The second
version is obsolescent and fully replaced by the first attribute.
<p>These attributes must satisfy the same requirements as <code>Spec_Suffix</code>.
In addition, they must be different from any of the values in
<code>Spec_Suffix</code>.
If <code>Body_Suffix ("Ada")</code> is not specified, then the default is
<code>".adb"</code>.
<p>If <code>Body_Suffix ("Ada")</code> and <code>Spec_Suffix ("Ada")</code> end with the
same string, then a file name that ends with the longest of these two
suffixes will be a body if the longest suffix is <code>Body_Suffix ("Ada")</code>
or a spec if the longest suffix is <code>Spec_Suffix ("Ada")</code>.
<p>If the suffix does not start with a '.', a file with a name exactly equal
to the suffix will also be part of the project (for instance if you define
the suffix as <code>Makefile</code>, a file called <samp><span class="file">Makefile</span></samp> will be part
of the project. This capability is usually not interesting when building.
However, it might become useful when a project is also used to
find the list of source files in an editor, like the GNAT Programming System
(GPS).
<br><dt><b>Separate_Suffix</b>:<dd><a name="index-g_t_0040code_007bSeparate_005fSuffix_007d-663"></a> This attribute is specific to Ada. It denotes the suffix used in file names
that contain separate bodies. If it is not specified, then it defaults to
same value as <code>Body_Suffix ("Ada")</code>. The same rules apply as for the
<code>Body_Suffix</code> attribute. The only accepted index is "Ada".
<br><dt><b>Spec</b> or <b>Specification</b>:<dd><a name="index-g_t_0040code_007bSpec_007d-664"></a><a name="index-g_t_0040code_007bSpecification_007d-665"></a> This attribute <code>Spec</code> can be used to define the source file name for a
given Ada compilation unit's spec. The index is the literal name of the Ada
unit (case insensitive). The value is the literal base name of the file that
contains this unit's spec (case sensitive or insensitive depending on the
operating system). This attribute allows the definition of exceptions to the
general naming scheme, in case some files do not follow the usual
convention.
<p>When a source file contains several units, the relative position of the unit
can be indicated. The first unit in the file is at position 1
<pre class="smallexample"> for Spec ("MyPack.MyChild") use "mypack.mychild.spec";
for Spec ("top") use "foo.a" at 1;
for Spec ("foo") use "foo.a" at 2;
</pre>
<br><dt><b>Body</b> or <b>Implementation</b>:<dd><a name="index-g_t_0040code_007bBody_007d-666"></a><a name="index-g_t_0040code_007bImplementation_007d-667"></a> These attribute play the same role as <em>Spec</em> for Ada bodies.
<br><dt><b>Specification_Exceptions</b> and <b>Implementation_Exceptions</b>:<dd><a name="index-g_t_0040code_007bSpecification_005fExceptions_007d-668"></a><a name="index-g_t_0040code_007bImplementation_005fExceptions_007d-669"></a> These attributes define exceptions to the naming scheme for languages
other than Ada. They are indexed on the language name, and contain
a list of file names respectively for headers and source code.
</dl>
<p>For example, the following package models the Apex file naming rules:
<pre class="smallexample"> package Naming is
for Casing use "lowercase";
for Dot_Replacement use ".";
for Spec_Suffix ("Ada") use ".1.ada";
for Body_Suffix ("Ada") use ".2.ada";
end Naming;
</pre>
<!-- -->
<div class="node">
<a name="Organizing-Projects-into-Subsystems"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Scenarios-in-Projects">Scenarios in Projects</a>,
Previous: <a rel="previous" accesskey="p" href="#Building-With-Projects">Building With Projects</a>,
Up: <a rel="up" accesskey="u" href="#GNAT-Project-Manager">GNAT Project Manager</a>
</div>
<h3 class="section">11.3 Organizing Projects into Subsystems</h3>
<!-- -->
<p class="noindent">A <b>subsystem</b> is a coherent part of the complete system to be built. It is
represented by a set of sources and one single object directory. A system can
be composed of a single subsystem when it is simple as we have seen in the
first section. Complex systems are usually composed of several interdependent
subsystems. A subsystem is dependent on another subsystem if knowledge of the
other one is required to build it, and in particular if visibility on some of
the sources of this other subsystem is required. Each subsystem is usually
represented by its own project file.
<p>In this section, the previous example is being extended. Let's assume some
sources of our <code>Build</code> project depend on other sources.
For instance, when building a graphical interface, it is usual to depend upon
a graphical library toolkit such as GtkAda. Furthermore, we also need
sources from a logging module we had previously written.
<ul class="menu">
<li><a accesskey="1" href="#Project-Dependencies">Project Dependencies</a>
<li><a accesskey="2" href="#Cyclic-Project-Dependencies">Cyclic Project Dependencies</a>
<li><a accesskey="3" href="#Sharing-Between-Projects">Sharing Between Projects</a>
<li><a accesskey="4" href="#Global-Attributes">Global Attributes</a>
</ul>
<!-- -->
<div class="node">
<a name="Project-Dependencies"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Cyclic-Project-Dependencies">Cyclic Project Dependencies</a>,
Up: <a rel="up" accesskey="u" href="#Organizing-Projects-into-Subsystems">Organizing Projects into Subsystems</a>
</div>
<h4 class="subsection">11.3.1 Project Dependencies</h4>
<!-- -->
<p class="noindent">GtkAda comes with its own project file (appropriately called
<samp><span class="file">gtkada.gpr</span></samp>), and we will assume we have already built a project
called <samp><span class="file">logging.gpr</span></samp> for the logging module. With the information provided
so far in <samp><span class="file">build.gpr</span></samp>, building the application would fail with an error
indicating that the gtkada and logging units that are relied upon by the sources
of this project cannot be found.
<p>This is easily solved by adding the following <b>with</b> clauses at the beginning
of our project:
<pre class="smallexample"> with "gtkada.gpr";
with "a/b/logging.gpr";
project Build is
... -- as before
end Build;
</pre>
<p class="noindent"><a name="index-g_t_0040code_007bExternally_005fBuilt_007d-670"></a>When such a project is compiled, <samp><span class="command">gnatmake</span></samp> will automatically
check the other projects and recompile their sources when needed. It will also
recompile the sources from <code>Build</code> when needed, and finally create the
executable. In some cases, the implementation units needed to recompile a
project are not available, or come from some third-party and you do not want to
recompile it yourself. In this case, the attribute <b>Externally_Built</b> to
"true" can be set, indicating to the builder that this project can be assumed
to be up-to-date, and should not be considered for recompilation. In Ada, if
the sources of this externally built project were compiled with another version
of the compiler or with incompatible options, the binder will issue an error.
<p>The project's <code>with</code> clause has several effects. It provides source
visibility between projects during the compilation process. It also guarantees
that the necessary object files from <code>Logging</code> and <code>GtkAda</code> are
available when linking <code>Build</code>.
<p>As can be seen in this example, the syntax for importing projects is similar
to the syntax for importing compilation units in Ada. However, project files
use literal strings instead of names, and the <code>with</code> clause identifies
project files rather than packages.
<p>Each literal string after <code>with</code> is the path
(absolute or relative) to a project file. The <code>.gpr</code> extension is
optional, although we recommend adding it. If no extension is specified,
and no project file with the <samp><span class="file">.gpr</span></samp> extension is found, then
the file is searched for exactly as written in the <code>with</code> clause,
that is with no extension.
<p><a name="index-project-path-671"></a>When a relative path or a base name is used, the
project files are searched relative to each of the directories in the
<b>project path</b>. This path includes all the directories found with the
following algorithm, in that order, as soon as a matching file is found,
the search stops:
<ul>
<li>First, the file is searched relative to the directory that contains the
current project file.
<li><a name="index-g_t_0040code_007bADA_005fPROJECT_005fPATH_007d-672"></a><a name="index-g_t_0040code_007bGPR_005fPROJECT_005fPATH_007d-673"></a> Then it is searched relative to all the directories specified in the
environment variables <b>GPR_PROJECT_PATH</b> and
<b>ADA_PROJECT_PATH</b> (in that order) if they exist. The former is
recommended, the latter is kept for backward compatibility.
<li>Finally, it is searched relative to the default project directories.
Such directories depends on the tool used. For <samp><span class="command">gnatmake</span></samp>, there is
one default project directory: <samp><span class="file"><prefix>/lib/gnat/</span></samp>. In our example,
<samp><span class="file">gtkada.gpr</span></samp> is found in the predefined directory if it was installed at
the same root as GNAT.
</ul>
<p class="noindent">Some tools also support extending the project path from the command line,
generally through the <samp><span class="option">-aP</span></samp>. You can see the value of the project
path by using the <samp><span class="command">gnatls -v</span></samp> command.
<p>Any symbolic link will be fully resolved in the directory of the
importing project file before the imported project file is examined.
<p>Any source file in the imported project can be used by the sources of the
importing project, transitively.
Thus if <code>A</code> imports <code>B</code>, which imports <code>C</code>, the sources of
<code>A</code> may depend on the sources of <code>C</code>, even if <code>A</code> does not
import <code>C</code> explicitly. However, this is not recommended, because if
and when <code>B</code> ceases to import <code>C</code>, some sources in <code>A</code> will
no longer compile. <samp><span class="command">gprbuild</span></samp> has a switch <samp><span class="option">--no-indirect-imports</span></samp>
that will report such indirect dependencies.
<p>One very important aspect of a project hierarchy is that
<b>a given source can only belong to one project</b> (otherwise the project manager
would not know which settings apply to it and when to recompile it). It means
that different project files do not usually share source directories or
when they do, they need to specify precisely which project owns which sources
using attribute <code>Source_Files</code> or equivalent. By contrast, 2 projects
can each own a source with the same base file name as long as they live in
different directories. The latter is not true for Ada Sources because of the
correlation between source files and Ada units.
<!-- -->
<div class="node">
<a name="Cyclic-Project-Dependencies"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Sharing-Between-Projects">Sharing Between Projects</a>,
Previous: <a rel="previous" accesskey="p" href="#Project-Dependencies">Project Dependencies</a>,
Up: <a rel="up" accesskey="u" href="#Organizing-Projects-into-Subsystems">Organizing Projects into Subsystems</a>
</div>
<h4 class="subsection">11.3.2 Cyclic Project Dependencies</h4>
<!-- -->
<p class="noindent">Cyclic dependencies are mostly forbidden:
if <code>A</code> imports <code>B</code> (directly or indirectly) then <code>B</code>
is not allowed to import <code>A</code>. However, there are cases when cyclic
dependencies would be beneficial. For these cases, another form of import
between projects exists: the <b>limited with</b>. A project <code>A</code> that
imports a project <code>B</code> with a straight <code>with</code> may also be imported,
directly or indirectly, by <code>B</code> through a <code>limited with</code>.
<p>The difference between straight <code>with</code> and <code>limited with</code> is that
the name of a project imported with a <code>limited with</code> cannot be used in the
project importing it. In particular, its packages cannot be renamed and
its variables cannot be referred to.
<pre class="smallexample"> with "b.gpr";
with "c.gpr";
project A is
For Exec_Dir use B'Exec_Dir; -- ok
end A;
limited with "a.gpr"; -- Cyclic dependency: A -> B -> A
project B is
For Exec_Dir use A'Exec_Dir; -- not ok
end B;
with "d.gpr";
project C is
end C;
limited with "a.gpr"; -- Cyclic dependency: A -> C -> D -> A
project D is
For Exec_Dir use A'Exec_Dir; -- not ok
end D;
</pre>
<!-- -->
<div class="node">
<a name="Sharing-Between-Projects"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Global-Attributes">Global Attributes</a>,
Previous: <a rel="previous" accesskey="p" href="#Cyclic-Project-Dependencies">Cyclic Project Dependencies</a>,
Up: <a rel="up" accesskey="u" href="#Organizing-Projects-into-Subsystems">Organizing Projects into Subsystems</a>
</div>
<h4 class="subsection">11.3.3 Sharing Between Projects</h4>
<!-- -->
<p class="noindent">When building an application, it is common to have similar needs in several of
the projects corresponding to the subsystems under construction. For instance,
they will all have the same compilation switches.
<p>As seen before (see <a href="#Tools-Options-in-Project-Files">Tools Options in Project Files</a>), setting compilation
switches for all sources of a subsystem is simple: it is just a matter of
adding a <code>Compiler.Default_Switches</code> attribute to each project files with
the same value. Of course, that means duplication of data, and both places need
to be changed in order to recompile the whole application with different
switches. It can become a real problem if there are many subsystems and thus
many project files to edit.
<p>There are two main approaches to avoiding this duplication:
<ul>
<li>Since <samp><span class="file">build.gpr</span></samp> imports <samp><span class="file">logging.gpr</span></samp>, we could change it
to reference the attribute in Logging, either through a package renaming,
or by referencing the attribute. The following example shows both cases:
<pre class="smallexample"> project Logging is
package Compiler is
for Switches ("Ada") use ("-O2");
end Compiler;
package Binder is
for Switches ("Ada") use ("-E");
end Binder;
end Logging;
with "logging.gpr";
project Build is
package Compiler renames Logging.Compiler;
package Binder is
for Switches ("Ada") use Logging.Binder'Switches ("Ada");
end Binder;
end Build;
</pre>
<p class="noindent">The solution used for <code>Compiler</code> gets the same value for all
attributes of the package, but you cannot modify anything from the
package (adding extra switches or some exceptions). The second
version is more flexible, but more verbose.
<p>If you need to refer to the value of a variable in an imported
project, rather than an attribute, the syntax is similar but uses
a "." rather than an apostrophe. For instance:
<pre class="smallexample"> with "imported";
project Main is
Var1 := Imported.Var;
end Main;
</pre>
<li>The second approach is to define the switches in a third project.
That project is setup without any sources (so that, as opposed to
the first example, none of the project plays a special role), and
will only be used to define the attributes. Such a project is
typically called <samp><span class="file">shared.gpr</span></samp>.
<pre class="smallexample"> abstract project Shared is
for Source_Files use (); -- no project
package Compiler is
for Switches ("Ada") use ("-O2");
end Compiler;
end Shared;
with "shared.gpr";
project Logging is
package Compiler renames Shared.Compiler;
end Logging;
with "shared.gpr";
project Build is
package Compiler renames Shared.Compiler;
end Build;
</pre>
<p class="noindent">As for the first example, we could have chosen to set the attributes
one by one rather than to rename a package. The reason we explicitly
indicate that <code>Shared</code> has no sources is so that it can be created
in any directory and we are sure it shares no sources with <code>Build</code>
or <code>Logging</code>, which of course would be invalid.
<p><a name="index-project-qualifier-674"></a> Note the additional use of the <b>abstract</b> qualifier in <samp><span class="file">shared.gpr</span></samp>.
This qualifier is optional, but helps convey the message that we do not
intend this project to have sources (see <a href="#Qualified-Projects">Qualified Projects</a> for
more qualifiers).
</ul>
<!-- -->
<div class="node">
<a name="Global-Attributes"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Sharing-Between-Projects">Sharing Between Projects</a>,
Up: <a rel="up" accesskey="u" href="#Organizing-Projects-into-Subsystems">Organizing Projects into Subsystems</a>
</div>
<h4 class="subsection">11.3.4 Global Attributes</h4>
<!-- -->
<p class="noindent">We have already seen many examples of attributes used to specify a special
option of one of the tools involved in the build process. Most of those
attributes are project specific. That it to say, they only affect the invocation
of tools on the sources of the project where they are defined.
<p>There are a few additional attributes that apply to all projects in a
hierarchy as long as they are defined on the "main" project.
The main project is the project explicitly mentioned on the command-line.
The project hierarchy is the "with"-closure of the main project.
<p>Here is a list of commonly used global attributes:
<dl>
<dt><b>Builder.Global_Configuration_Pragmas</b>:<dd><a name="index-g_t_0040code_007bGlobal_005fConfiguration_005fPragmas_007d-675"></a> This attribute points to a file that contains configuration pragmas
to use when building executables. These pragmas apply for all
executables build from this project hierarchy. As we have seen before,
additional pragmas can be specified on a per-project basis by setting the
<code>Compiler.Local_Configuration_Pragmas</code> attribute.
<br><dt><b>Builder.Global_Compilation_Switches</b>:<dd><a name="index-g_t_0040code_007bGlobal_005fCompilation_005fSwitches_007d-676"></a> This attribute is a list of compiler switches to use when compiling any
source file in the project hierarchy. These switches are used in addition
to the ones defined in the <code>Compiler</code> package, which only apply to
the sources of the corresponding project. This attribute is indexed on
the name of the language.
</dl>
<p>Using such global capabilities is convenient. It can also lead to unexpected
behavior. Especially when several subsystems are shared among different main
projects and the different global attributes are not
compatible. Note that using aggregate projects can be a safer and more powerful
replacement to global attributes.
<!-- -->
<div class="node">
<a name="Scenarios-in-Projects"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Library-Projects">Library Projects</a>,
Previous: <a rel="previous" accesskey="p" href="#Organizing-Projects-into-Subsystems">Organizing Projects into Subsystems</a>,
Up: <a rel="up" accesskey="u" href="#GNAT-Project-Manager">GNAT Project Manager</a>
</div>
<h3 class="section">11.4 Scenarios in Projects</h3>
<!-- -->
<p class="noindent">Various aspects of the projects can be modified based on <b>scenarios</b>. These
are user-defined modes that change the behavior of a project. Typical
examples are the setup of platform-specific compiler options, or the use of
a debug and a release mode (the former would activate the generation of debug
information, when the second will focus on improving code optimization).
<p>Let's enhance our example to support a debug and a release modes.The issue is to
let the user choose what kind of system he is building:
use <samp><span class="option">-g</span></samp> as compiler switches in debug mode and <samp><span class="option">-O2</span></samp>
in release mode. We will also setup the projects so that we do not share the
same object directory in both modes, otherwise switching from one to the other
might trigger more recompilations than needed or mix objects from the 2 modes.
<p>One naive approach is to create two different project files, say
<samp><span class="file">build_debug.gpr</span></samp> and <samp><span class="file">build_release.gpr</span></samp>, that set the appropriate
attributes as explained in previous sections. This solution does not scale well,
because in presence of multiple projects depending on each other,
you will also have to duplicate the complete hierarchy and adapt the project
files to point to the right copies.
<p><a name="index-scenarios-677"></a>Instead, project files support the notion of scenarios controlled
by external values. Such values can come from several sources (in decreasing
order of priority):
<dl>
<dt><b>Command line</b>:<dd><a name="index-g_t_0040option_007b_002dX_007d-678"></a> When launching <samp><span class="command">gnatmake</span></samp> or <samp><span class="command">gprbuild</span></samp>, the user can pass
extra <samp><span class="option">-X</span></samp> switches to define the external value. In
our case, the command line might look like
<pre class="smallexample"> gnatmake -Pbuild.gpr -Xmode=debug
or gnatmake -Pbuild.gpr -Xmode=release
</pre>
<br><dt><b>Environment variables</b>:<dd> When the external value does not come from the command line, it can come from
the value of environment variables of the appropriate name.
In our case, if an environment variable called "mode"
exist, its value will be taken into account.
<br><dt><b>External function second parameter</b><dd>
</dl>
<p><a name="index-g_t_0040code_007bexternal_007d-679"></a>We now need to get that value in the project. The general form is to use
the predefined function <b>external</b> which returns the current value of
the external. For instance, we could setup the object directory to point to
either <samp><span class="file">obj/debug</span></samp> or <samp><span class="file">obj/release</span></samp> by changing our project to
<pre class="smallexample"> project Build is
for Object_Dir use "obj/" & external ("mode", "debug");
... -- as before
end Build;
</pre>
<p class="noindent">The second parameter to <code>external</code> is optional, and is the default
value to use if "mode" is not set from the command line or the environment.
<p>In order to set the switches according to the different scenarios, other
constructs have to be introduced such as typed variables and case statements.
<p><a name="index-typed-variable-680"></a><a name="index-case-statement-681"></a>A <b>typed variable</b> is a variable that
can take only a limited number of values, similar to an enumeration in Ada.
Such a variable can then be used in a <b>case statement</b> and create conditional
sections in the project. The following example shows how this can be done:
<pre class="smallexample"> project Build is
type Mode_Type is ("debug", "release"); -- all possible values
Mode : Mode_Type := external ("mode", "debug"); -- a typed variable
package Compiler is
case Mode is
when "debug" =>
for Switches ("Ada") use ("-g");
when "release" =>
for Switches ("Ada") use ("-O2");
end case;
end Compiler;
end Build;
</pre>
<p class="noindent">The project has suddenly grown in size, but has become much more flexible.
<code>Mode_Type</code> defines the only valid values for the <code>mode</code> variable. If
any other value is read from the environment, an error is reported and the
project is considered as invalid.
<p>The <code>Mode</code> variable is initialized with an external value
defaulting to <code>"debug"</code>. This default could be omitted and that would
force the user to define the value. Finally, we can use a case statement to set the
switches depending on the scenario the user has chosen.
<p>Most aspects of the projects can depend on scenarios. The notable exception
are project dependencies (<code>with</code> clauses), which may not depend on a scenario.
<p>Scenarios work the same way with <b>project hierarchies</b>: you can either
duplicate a variable similar to <code>Mode</code> in each of the project (as long
as the first argument to <code>external</code> is always the same and the type is
the same), or simply set the variable in the <samp><span class="file">shared.gpr</span></samp> project
(see <a href="#Sharing-Between-Projects">Sharing Between Projects</a>).
<!-- -->
<div class="node">
<a name="Library-Projects"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Project-Extension">Project Extension</a>,
Previous: <a rel="previous" accesskey="p" href="#Scenarios-in-Projects">Scenarios in Projects</a>,
Up: <a rel="up" accesskey="u" href="#GNAT-Project-Manager">GNAT Project Manager</a>
</div>
<h3 class="section">11.5 Library Projects</h3>
<!-- -->
<p class="noindent">So far, we have seen examples of projects that create executables. However,
it is also possible to create libraries instead. A <b>library</b> is a specific
type of subsystem where, for convenience, objects are grouped together
using system-specific means such as archives or windows DLLs.
<p>Library projects provide a system- and language-independent way of building both <b>static</b>
and <b>dynamic</b> libraries. They also support the concept of <b>standalone
libraries</b> (SAL) which offers two significant properties: the elaboration
(e.g. initialization) of the library is either automatic or very simple;
a change in the
implementation part of the library implies minimal post-compilation actions on
the complete system and potentially no action at all for the rest of the
system in the case of dynamic SALs.
<p>The GNAT Project Manager takes complete care of the library build, rebuild and
installation tasks, including recompilation of the source files for which
objects do not exist or are not up to date, assembly of the library archive, and
installation of the library (i.e., copying associated source, object and
<samp><span class="file">ALI</span></samp> files to the specified location).
<ul class="menu">
<li><a accesskey="1" href="#Building-Libraries">Building Libraries</a>
<li><a accesskey="2" href="#Using-Library-Projects">Using Library Projects</a>
<li><a accesskey="3" href="#Stand_002dalone-Library-Projects">Stand-alone Library Projects</a>
<li><a accesskey="4" href="#Installing-a-library-with-project-files">Installing a library with project files</a>
</ul>
<!-- -->
<div class="node">
<a name="Building-Libraries"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Using-Library-Projects">Using Library Projects</a>,
Up: <a rel="up" accesskey="u" href="#Library-Projects">Library Projects</a>
</div>
<h4 class="subsection">11.5.1 Building Libraries</h4>
<!-- -->
<p class="noindent">Let's enhance our example and transform the <code>logging</code> subsystem into a
library. In order to do so, a few changes need to be made to <samp><span class="file">logging.gpr</span></samp>.
A number of specific attributes needs to be defined: at least <code>Library_Name</code>
and <code>Library_Dir</code>; in addition, a number of other attributes can be used
to specify specific aspects of the library. For readability, it is also
recommended (although not mandatory), to use the qualifier <code>library</code> in
front of the <code>project</code> keyword.
<dl>
<dt><b>Library_Name</b>:<dd><a name="index-g_t_0040code_007bLibrary_005fName_007d-682"></a> This attribute is the name of the library to be built. There is no
restriction on the name of a library imposed by the project manager;
however, there may be system specific restrictions on the name.
In general, it is recommended to stick to alphanumeric characters
(and possibly underscores) to help portability.
<br><dt><b>Library_Dir</b>:<dd><a name="index-g_t_0040code_007bLibrary_005fDir_007d-683"></a> This attribute is the path (absolute or relative) of the directory where
the library is to be installed. In the process of building a library,
the sources are compiled, the object files end up in the explicit or
implicit <code>Object_Dir</code> directory. When all sources of a library
are compiled, some of the compilation artifacts, including the library itself,
are copied to the library_dir directory. This directory must exists and be
writable. It must also be different from the object directory so that cleanup
activities in the Library_Dir do not affect recompilation needs.
</dl>
<p>Here is the new version of <samp><span class="file">logging.gpr</span></samp> that makes it a library:
<pre class="smallexample"> library project Logging is -- "library" is optional
for Library_Name use "logging"; -- will create "liblogging.a" on Unix
for Object_Dir use "obj";
for Library_Dir use "lib"; -- different from object_dir
end Logging;
</pre>
<p class="noindent">Once the above two attributes are defined, the library project is valid and
is enough for building a library with default characteristics.
Other library-related attributes can be used to change the defaults:
<dl>
<dt><b>Library_Kind</b>:<dd><a name="index-g_t_0040code_007bLibrary_005fKind_007d-684"></a> The value of this attribute must be either <code>"static"</code>, <code>"dynamic"</code> or
<code>"relocatable"</code> (the latter is a synonym for dynamic). It indicates
which kind of library should be build (the default is to build a
static library, that is an archive of object files that can potentially
be linked into a static executable). When the library is set to be dynamic,
a separate image is created that will be loaded independently, usually
at the start of the main program execution. Support for dynamic libraries is
very platform specific, for instance on Windows it takes the form of a DLL
while on GNU/Linux, it is a dynamic elf image whose suffix is usually
<samp><span class="file">.so</span></samp>. Library project files, on the other hand, can be written in
a platform independent way so that the same project file can be used to build
a library on different operating systems.
<p>If you need to build both a static and a dynamic library, it is recommended
use two different object directories, since in some cases some extra code
needs to be generated for the latter. For such cases, one can
either define two different project files, or a single one which uses scenarios
to indicate at the various kinds of library to be build and their
corresponding object_dir.
<p><a name="index-g_t_0040code_007bLibrary_005fALI_005fDir_007d-685"></a><br><dt><b>Library_ALI_Dir</b>:<dd> This attribute may be specified to indicate the directory where the ALI
files of the library are installed. By default, they are copied into the
<code>Library_Dir</code> directory, but as for the executables where we have a
separate <code>Exec_Dir</code> attribute, you might want to put them in a separate
directory since there can be hundreds of them. The same restrictions as for
the <code>Library_Dir</code> attribute apply.
<p><a name="index-g_t_0040code_007bLibrary_005fVersion_007d-686"></a><br><dt><b>Library_Version</b>:<dd> This attribute is platform dependent, and has no effect on VMS and Windows.
On Unix, it is used only for dynamic libraries as the internal
name of the library (the <code>"soname"</code>). If the library file name (built
from the <code>Library_Name</code>) is different from the <code>Library_Version</code>,
then the library file will be a symbolic link to the actual file whose name
will be <code>Library_Version</code>. This follows the usual installation schemes
for dynamic libraries on many Unix systems.
<pre class="smallexample"> project Logging is
Version := "1";
for Library_Dir use "lib";
for Library_Name use "logging";
for Library_Kind use "dynamic";
for Library_Version use "liblogging.so." & Version;
end Logging;
</pre>
<p class="noindent">After the compilation, the directory <samp><span class="file">lib</span></samp> will contain both a
<samp><span class="file">libdummy.so.1</span></samp> library and a symbolic link to it called
<samp><span class="file">libdummy.so</span></samp>.
<p><a name="index-g_t_0040code_007bLibrary_005fGCC_007d-687"></a><br><dt><b>Library_GCC</b>:<dd> This attribute is the name of the tool to use instead of "gcc" to link shared
libraries. A common use of this attribute is to define a wrapper script that
accomplishes specific actions before calling gcc (which itself is calling the
linker to build the library image).
<br><dt><b>Library_Options</b>:<dd><a name="index-g_t_0040code_007bLibrary_005fOptions_007d-688"></a> This attribute may be used to specified additional switches (last switches)
when linking a shared library.
<br><dt><b>Leading_Library_Options</b>:<dd><a name="index-g_t_0040code_007bLeading_005fLibrary_005fOptions_007d-689"></a> This attribute, that is taken into account only by <samp><span class="command">gprbuild</span></samp>, may be
used to specified leading options (first switches) when linking a shared
library.
<p><a name="index-g_t_0040code_007bLinker_005fOptions_007d-690"></a><br><dt><b>Linker.Linker_Options</b>:<dd> This attribute specifies additional switches to be given to the linker when
linking an executable. It is ignored when defined in the main project and
taken into account in all other projects that are imported directly or
indirectly. These switches complement the <code>Linker.Switches</code>
defined in the main project. This is useful when a particular subsystem
depends on an external library: adding this dependency as a
<code>Linker_Options</code> in the project of the subsystem is more convenient than
adding it to all the <code>Linker.Switches</code> of the main projects that depend
upon this subsystem.
</dl>
<!-- -->
<div class="node">
<a name="Using-Library-Projects"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Stand_002dalone-Library-Projects">Stand-alone Library Projects</a>,
Previous: <a rel="previous" accesskey="p" href="#Building-Libraries">Building Libraries</a>,
Up: <a rel="up" accesskey="u" href="#Library-Projects">Library Projects</a>
</div>
<h4 class="subsection">11.5.2 Using Library Projects</h4>
<!-- -->
<p class="noindent">When the builder detects that a project file is a library project file, it
recompiles all sources of the project that need recompilation and rebuild the
library if any of the sources have been recompiled. It then groups all object
files into a single file, which is a shared or a static library. This library
can later on be linked with multiple executables. Note that the use
of shard libraries reduces the size of the final executable and can also reduce
the memory footprint at execution time when the library is shared among several
executables.
<p>It is also possible to build <b>multi-language libraries</b>. When using
<samp><span class="command">gprbuild</span></samp> as a builder, multi-language library projects allow naturally
the creation of multi-language libraries . <samp><span class="command">gnatmake</span></samp>, does not try to
compile non Ada sources. However, when the project is multi-language, it will
automatically link all object files found in the object directory, whether or
not they were compiled from an Ada source file. This specific behavior does not
apply to Ada-only projects which only take into account the objects
corresponding to the sources of the project.
<p>A non-library project can import a library project. When the builder is invoked
on the former, the library of the latter is only rebuilt when absolutely
necessary. For instance, if a unit of the
library is not up-to-date but non of the executables need this unit, then the
unit is not recompiled and the library is not reassembled.
For instance, let's assume in our example that logging has the following
sources: <samp><span class="file">log1.ads</span></samp>, <samp><span class="file">log1.adb</span></samp>, <samp><span class="file">log2.ads</span></samp> and
<samp><span class="file">log2.adb</span></samp>. If <samp><span class="file">log1.adb</span></samp> has been modified, then the library
<samp><span class="file">liblogging</span></samp> will be rebuilt when compiling all the sources of
<code>Build</code> only if <samp><span class="file">proc.ads</span></samp>, <samp><span class="file">pack.ads</span></samp> or <samp><span class="file">pack.adb</span></samp>
include a <code>"with Log1"</code>.
<p>To ensure that all the sources in the <code>Logging</code> library are
up to date, and that all the sources of <code>Build</code> are also up to date,
the following two commands needs to be used:
<pre class="smallexample"> gnatmake -Plogging.gpr
gnatmake -Pbuild.gpr
</pre>
<p class="noindent">All <samp><span class="file">ALI</span></samp> files will also be copied from the object directory to the
library directory. To build executables, <samp><span class="command">gnatmake</span></samp> will use the
library rather than the individual object files.
<p>Library projects can also be useful to describe a library that need to be used
but, for some reason, cannot be rebuilt. For instance, it is the case when some
of the library sources are not available. Such library projects need simply to
use the <code>Externally_Built</code> attribute as in the example below:
<pre class="smallexample"> library project Extern_Lib is
for Languages use ("Ada", "C");
for Source_Dirs use ("lib_src");
for Library_Dir use "lib2";
for Library_Kind use "dynamic";
for Library_Name use "l2";
for Externally_Built use "true"; -- <<<<
end Extern_Lib;
</pre>
<p class="noindent">In the case of externally built libraries, the <code>Object_Dir</code>
attribute does not need to be specified because it will never be
used.
<p>The main effect of using such an externally built library project is mostly to
affect the linker command in order to reference the desired library. It can
also be achieved by using <code>Linker.Linker_Options</code> or <code>Linker.Switches</code>
in the project corresponding to the subsystem needing this external library.
This latter method is more straightforward in simple cases but when several
subsystems depend upon the same external library, finding the proper place
for the <code>Linker.Linker_Options</code> might not be easy and if it is
not placed properly, the final link command is likely to present ordering issues.
In such a situation, it is better to use the externally built library project
so that all other subsystems depending on it can declare this dependency thanks
to a project <code>with</code> clause, which in turn will trigger the builder to find
the proper order of libraries in the final link command.
<!-- -->
<div class="node">
<a name="Stand-alone-Library-Projects"></a>
<a name="Stand_002dalone-Library-Projects"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Installing-a-library-with-project-files">Installing a library with project files</a>,
Previous: <a rel="previous" accesskey="p" href="#Using-Library-Projects">Using Library Projects</a>,
Up: <a rel="up" accesskey="u" href="#Library-Projects">Library Projects</a>
</div>
<h4 class="subsection">11.5.3 Stand-alone Library Projects</h4>
<!-- -->
<p class="noindent"><a name="index-standalone-libraries-691"></a>A <b>stand-alone library</b> is a library that contains the necessary code to
elaborate the Ada units that are included in the library. A stand-alone
library is a convenient way to add an Ada subsystem to a more global system
whose main is not in Ada since it makes the elaboration of the Ada part mostly
transparent. However, stand-alone libraries are also useful when the main is in
Ada: they provide a means for minimizing relinking & redeployment of complex
systems when localized changes are made.
<p>The most prominent characteristic of a stand-alone library is that it offers a
distinction between interface units and implementation units. Only the former
are visible to units outside the library. A stand-alone library project is thus
characterised by a third attribute, <b>Library_Interface</b>, in addition to the
two attributes that make a project a Library Project (<code>Library_Name</code> and
<code>Library_Dir</code>).
<dl>
<dt><b>Library_Interface</b>:<dd><a name="index-g_t_0040code_007bLibrary_005fInterface_007d-692"></a> This attribute defines an explicit subset of the units of the project.
Projects importing this library project may only "with" units whose sources
are listed in the <code>Library_Interface</code>. Other sources are considered
implementation units.
<pre class="smallexample"> for Library_Dir use "lib";
for Library_Name use "loggin";
for Library_Interface use ("lib1", "lib2"); -- unit names
</pre>
</dl>
<p>In order to include the elaboration code in the stand-alone library, the binder
is invoked on the closure of the library units creating a package whose name
depends on the library name (b~logging.ads/b in the example).
This binder-generated package includes <b>initialization</b> and <b>finalization</b>
procedures whose names depend on the library name (<code>logginginit</code> and
<code>loggingfinal</code> in the example). The object corresponding to this package is
included in the library.
<dl>
<dt><b>Library_Auto_Init</b>:<dd><a name="index-g_t_0040code_007bLibrary_005fAuto_005fInit_007d-693"></a> A dynamic stand-alone Library is automatically initialized
if automatic initialization of Stand-alone Libraries is supported on the
platform and if attribute <b>Library_Auto_Init</b> is not specified or
is specified with the value "true". A static Stand-alone Library is never
automatically initialized. Specifying "false" for this attribute
prevent automatic initialization.
<p>When a non-automatically initialized stand-alone library is used in an
executable, its initialization procedure must be called before any service of
the library is used. When the main subprogram is in Ada, it may mean that the
initialization procedure has to be called during elaboration of another
package.
<br><dt><b>Library_Dir</b>:<dd><a name="index-g_t_0040code_007bLibrary_005fDir_007d-694"></a> For a stand-alone library, only the <samp><span class="file">ALI</span></samp> files of the interface units
(those that are listed in attribute <code>Library_Interface</code>) are copied to
the library directory. As a consequence, only the interface units may be
imported from Ada units outside of the library. If other units are imported,
the binding phase will fail.
<br><dt><b>Binder.Default_Switches</b>:<dd> When a stand-alone library is bound, the switches that are specified in
the attribute <b>Binder.Default_Switches ("Ada")</b> are
used in the call to <samp><span class="command">gnatbind</span></samp>.
<br><dt><b>Library_Src_Dir</b>:<dd><a name="index-g_t_0040code_007bLibrary_005fSrc_005fDir_007d-695"></a> This attribute defines the location (absolute or relative to the project
directory) where the sources of the interface units are copied at
installation time.
These sources includes the specs of the interface units along with the closure
of sources necessary to compile them successfully. That may include bodies and
subunits, when pragmas <code>Inline</code> are used, or when there is a generic
units in the spec. This directory cannot point to the object directory or
one of the source directories, but it can point to the library directory,
which is the default value for this attribute.
<br><dt><b>Library_Symbol_Policy</b>:<dd><a name="index-g_t_0040code_007bLibrary_005fSymbol_005fPolicy_007d-696"></a> This attribute controls the export of symbols and, on some platforms (like
VMS) that have the notions of major and minor IDs built in the library
files, it controls the setting of these IDs. It is not supported on all
platforms (where it will just have no effect). It may have one of the
following values:
<ul>
<li><code>"autonomous"</code> or <code>"default"</code>: exported symbols are not controlled
<li><code>"compliant"</code>: if attribute <b>Library_Reference_Symbol_File</b>
is not defined, then it is equivalent to policy "autonomous". If there
are exported symbols in the reference symbol file that are not in the
object files of the interfaces, the major ID of the library is increased.
If there are symbols in the object files of the interfaces that are not
in the reference symbol file, these symbols are put at the end of the list
in the newly created symbol file and the minor ID is increased.
<li><code>"controlled"</code>: the attribute <b>Library_Reference_Symbol_File</b> must be
defined. The library will fail to build if the exported symbols in the
object files of the interfaces do not match exactly the symbol in the
symbol file.
<li><code>"restricted"</code>: The attribute <b>Library_Symbol_File</b> must be defined.
The library will fail to build if there are symbols in the symbol file that
are not in the exported symbols of the object files of the interfaces.
Additional symbols in the object files are not added to the symbol file.
<li><code>"direct"</code>: The attribute <b>Library_Symbol_File</b> must be defined and
must designate an existing file in the object directory. This symbol file
is passed directly to the underlying linker without any symbol processing.
</ul>
<br><dt><b>Library_Reference_Symbol_File</b><dd><a name="index-g_t_0040code_007bLibrary_005fReference_005fSymbol_005fFile_007d-697"></a> This attribute may define the path name of a reference symbol file that is
read when the symbol policy is either "compliant" or "controlled", on
platforms that support symbol control, such as VMS, when building a
stand-alone library. The path may be an absolute path or a path relative
to the project directory.
<br><dt><b>Library_Symbol_File</b><dd><a name="index-g_t_0040code_007bLibrary_005fSymbol_005fFile_007d-698"></a> This attribute may define the name of the symbol file to be created when
building a stand-alone library when the symbol policy is either "compliant",
"controlled" or "restricted", on platforms that support symbol control,
such as VMS. When symbol policy is "direct", then a file with this name
must exist in the object directory.
</dl>
<!-- -->
<div class="node">
<a name="Installing-a-library-with-project-files"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Stand_002dalone-Library-Projects">Stand-alone Library Projects</a>,
Up: <a rel="up" accesskey="u" href="#Library-Projects">Library Projects</a>
</div>
<h4 class="subsection">11.5.4 Installing a library with project files</h4>
<!-- -->
<p class="noindent">When using project files, library installation is part of the library build
process. Thus no further action is needed in order to make use of the
libraries that are built as part of the general application build. A usable
version of the library is installed in the directory specified by the
<code>Library_Dir</code> attribute of the library project file.
<p>You may want to install a library in a context different from where the library
is built. This situation arises with third party suppliers, who may want
to distribute a library in binary form where the user is not expected to be
able to recompile the library. The simplest option in this case is to provide
a project file slightly different from the one used to build the library, by
using the <code>externally_built</code> attribute. <a href="#Using-Library-Projects">Using Library Projects</a>
<!-- -->
<div class="node">
<a name="Project-Extension"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Project-File-Reference">Project File Reference</a>,
Previous: <a rel="previous" accesskey="p" href="#Library-Projects">Library Projects</a>,
Up: <a rel="up" accesskey="u" href="#GNAT-Project-Manager">GNAT Project Manager</a>
</div>
<h3 class="section">11.6 Project Extension</h3>
<!-- -->
<p class="noindent">During development of a large system, it is sometimes necessary to use
modified versions of some of the source files, without changing the original
sources. This can be achieved through the <b>project extension</b> facility.
<p>Suppose for instance that our example <code>Build</code> project is build every night
for the whole team, in some shared directory. A developer usually need to work
on a small part of the system, and might not want to have a copy of all the
sources and all the object files (mostly because that would require too much
disk space, time to recompile everything). He prefers to be able to override
some of the source files in his directory, while taking advantage of all the
object files generated at night.
<p>Another example can be taken from large software systems, where it is common to have
multiple implementations of a common interface; in Ada terms, multiple
versions of a package body for the same spec. For example, one implementation
might be safe for use in tasking programs, while another might only be used
in sequential applications. This can be modeled in GNAT using the concept
of <em>project extension</em>. If one project (the “child”) <em>extends</em>
another project (the “parent”) then by default all source files of the
parent project are inherited by the child, but the child project can
override any of the parent's source files with new versions, and can also
add new files or remove unnecessary ones.
This facility is the project analog of a type extension in
object-oriented programming. Project hierarchies are permitted (an extending
project may itself be extended), and a project that
extends a project can also import other projects.
<p>A third example is that of using project extensions to provide different
versions of the same system. For instance, assume that a <code>Common</code>
project is used by two development branches. One of the branches has now
been frozen, and no further change can be done to it or to <code>Common</code>.
However, the other development branch still needs evolution of <code>Common</code>.
Project extensions provide a flexible solution to create a new version
of a subsystem while sharing and reusing as much as possible from the original
one.
<p>A project extension inherits implicitly all the sources and objects from the
project it extends. It is possible to create a new version of some of the
sources in one of the additional source dirs of the extending project. Those new
versions hide the original versions. Adding new sources or removing existing
ones is also possible. Here is an example on how to extend the project
<code>Build</code> from previous examples:
<pre class="smallexample"> project Work extends "../bld/build.gpr" is
end Work;
</pre>
<p class="noindent">The project after <b>extends</b> is the one being extended. As usual, it can be
specified using an absolute path, or a path relative to any of the directories
in the project path (see <a href="#Project-Dependencies">Project Dependencies</a>). This project does not
specify source or object directories, so the default value for these attribute
will be used that is to say the current directory (where project <code>Work</code> is
placed). We can already compile that project with
<pre class="smallexample"> gnatmake -Pwork
</pre>
<p class="noindent">If no sources have been placed in the current directory, this command
won't do anything, since this project does not change the
sources it inherited from <code>Build</code>, therefore all the object files
in <code>Build</code> and its dependencies are still valid and are reused
automatically.
<p>Suppose we now want to supply an alternate version of <samp><span class="file">pack.adb</span></samp>
but use the existing versions of <samp><span class="file">pack.ads</span></samp> and <samp><span class="file">proc.adb</span></samp>.
We can create the new file Work's current directory (likely
by copying the one from the <code>Build</code> project and making changes to
it. If new packages are needed at the same time, we simply create
new files in the source directory of the extending project.
<p>When we recompile, <samp><span class="command">gnatmake</span></samp> will now automatically recompile
this file (thus creating <samp><span class="file">pack.o</span></samp> in the current directory) and
any file that depends on it (thus creating <samp><span class="file">proc.o</span></samp>). Finally, the
executable is also linked locally.
<p>Note that we could have obtained the desired behavior using project import
rather than project inheritance. A <code>base</code> project would contain the
sources for <samp><span class="file">pack.ads</span></samp> and <samp><span class="file">proc.adb</span></samp>, and <code>Work</code> would
import <code>base</code> and add <samp><span class="file">pack.adb</span></samp>. In this scenario, <code>base</code>
cannot contain the original version of <samp><span class="file">pack.adb</span></samp> otherwise there would be
2 versions of the same unit in the closure of the project and this is not
allowed. Generally speaking, it is not recommended to put the spec and the
body of a unit in different projects since this affects their autonomy and
reusability.
<p>In a project file that extends another project, it is possible to
indicate that an inherited source is <b>not part</b> of the sources of the
extending project. This is necessary sometimes when a package spec has
been overridden and no longer requires a body: in this case, it is
necessary to indicate that the inherited body is not part of the sources
of the project, otherwise there will be a compilation error
when compiling the spec.
<p><a name="index-g_t_0040code_007bExcluded_005fSource_005fFiles_007d-699"></a><a name="index-g_t_0040code_007bExcluded_005fSource_005fList_005fFile_007d-700"></a>For that purpose, the attribute <b>Excluded_Source_Files</b> is used.
Its value is a list of file names.
It is also possible to use attribute <code>Excluded_Source_List_File</code>.
Its value is the path of a text file containing one file name per
line.
<pre class="smallexample"> project Work extends "../bld/build.gpr" is
for Source_Files use ("pack.ads");
-- New spec of Pkg does not need a completion
for Excluded_Source_Files use ("pack.adb");
end Work;
</pre>
<p class="noindent">An extending project retains all the switches specified in the
extended project.
<ul class="menu">
<li><a accesskey="1" href="#Project-Hierarchy-Extension">Project Hierarchy Extension</a>
</ul>
<!-- -->
<div class="node">
<a name="Project-Hierarchy-Extension"></a>
<p><hr>
Up: <a rel="up" accesskey="u" href="#Project-Extension">Project Extension</a>
</div>
<h4 class="subsection">11.6.1 Project Hierarchy Extension</h4>
<!-- -->
<p class="noindent">One of the fundamental restrictions in project extension is the following:
<b>A project is not allowed to import directly or indirectly at the same time an
extending project and one of its ancestors</b>.
<p>By means of example, consider the following hierarchy of projects.
<pre class="smallexample"> a.gpr contains package A1
b.gpr, imports a.gpr and contains B1, which depends on A1
c.gpr, imports b.gpr and contains C1, which depends on B1
</pre>
<p class="noindent">If we want to locally extend the packages <code>A1</code> and <code>C1</code>, we need to
create several extending projects:
<pre class="smallexample"> a_ext.gpr which extends a.gpr, and overrides A1
b_ext.gpr which extends b.gpr and imports a_ext.gpr
c_ext.gpr which extends c.gpr, imports b_ext.gpr and overrides C1
</pre>
<p class="noindent">
<pre class="smallexample"> project A_Ext extends "a.gpr" is
for Source_Files use ("a1.adb", "a1.ads");
end A_Ext;
with "a_ext.gpr";
project B_Ext extends "b.gpr" is
end B_Ext;
with "b_ext.gpr";
project C_Ext extends "c.gpr" is
for Source_Files use ("c1.adb");
end C_Ext;
</pre>
<p class="noindent">The extension <samp><span class="file">b_ext.gpr</span></samp> is required, even though we are not overriding
any of the sources of <samp><span class="file">b.gpr</span></samp> because otherwise <samp><span class="file">c_expr.gpr</span></samp> would
import <samp><span class="file">b.gpr</span></samp> which itself knows nothing about <samp><span class="file">a_ext.gpr</span></samp>.
<p><a name="index-extends-all-701"></a>When extending a large system spanning multiple projects, it is often
inconvenient to extend every project in the hierarchy that is impacted by a
small change introduced in a low layer. In such cases, it is possible to create
an <b>implicit extension</b> of entire hierarchy using <b>extends all</b>
relationship.
<p>When the project is extended using <code>extends all</code> inheritance, all projects
that are imported by it, both directly and indirectly, are considered virtually
extended. That is, the project manager creates implicit projects
that extend every project in the hierarchy; all these implicit projects do not
control sources on their own and use the object directory of
the "extending all" project.
<p>It is possible to explicitly extend one or more projects in the hierarchy
in order to modify the sources. These extending projects must be imported by
the "extending all" project, which will replace the corresponding virtual
projects with the explicit ones.
<p>When building such a project hierarchy extension, the project manager will
ensure that both modified sources and sources in implicit extending projects
that depend on them, are recompiled.
<p>Thus, in our example we could create the following projects instead:
<pre class="smallexample"> a_ext.gpr, extends a.gpr and overrides A1
c_ext.gpr, "extends all" c.gpr, imports a_ext.gpr and overrides C1
</pre>
<p class="noindent">
<pre class="smallexample"> project A_Ext extends "a.gpr" is
for Source_Files use ("a1.adb", "a1.ads");
end A_Ext;
with "a_ext.gpr";
project C_Ext extends all "c.gpr" is
for Source_Files use ("c1.adb");
end C_Ext;
</pre>
<p class="noindent">When building project <samp><span class="file">c_ext.gpr</span></samp>, the entire modified project space is
considered for recompilation, including the sources of <samp><span class="file">b.gpr</span></samp> that are
impacted by the changes in <code>A1</code> and <code>C1</code>.
<!-- -->
<div class="node">
<a name="Project-File-Reference"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Project-Extension">Project Extension</a>,
Up: <a rel="up" accesskey="u" href="#GNAT-Project-Manager">GNAT Project Manager</a>
</div>
<h3 class="section">11.7 Project File Reference</h3>
<!-- -->
<p class="noindent">This section describes the syntactic structure of project files, the various
constructs that can be used. Finally, it ends with a summary of all available
attributes.
<ul class="menu">
<li><a accesskey="1" href="#Project-Declaration">Project Declaration</a>
<li><a accesskey="2" href="#Qualified-Projects">Qualified Projects</a>
<li><a accesskey="3" href="#Declarations">Declarations</a>
<li><a accesskey="4" href="#Packages">Packages</a>
<li><a accesskey="5" href="#Expressions">Expressions</a>
<li><a accesskey="6" href="#External-Values">External Values</a>
<li><a accesskey="7" href="#Typed-String-Declaration">Typed String Declaration</a>
<li><a accesskey="8" href="#Variables">Variables</a>
<li><a accesskey="9" href="#Attributes">Attributes</a>
<li><a href="#Case-Statements">Case Statements</a>
</ul>
<!-- -->
<div class="node">
<a name="Project-Declaration"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Qualified-Projects">Qualified Projects</a>,
Up: <a rel="up" accesskey="u" href="#Project-File-Reference">Project File Reference</a>
</div>
<h4 class="subsection">11.7.1 Project Declaration</h4>
<!-- -->
<p class="noindent">Project files have an Ada-like syntax. The minimal project file is:
<pre class="smallexample"> project Empty is
end Empty;
</pre>
<p class="noindent">The identifier <code>Empty</code> is the name of the project.
This project name must be present after the reserved
word <code>end</code> at the end of the project file, followed by a semi-colon.
<p><b>Identifiers</b> (i.e. the user-defined names such as project or variable names)
have the same syntax as Ada identifiers: they must start with a letter,
and be followed by zero or more letters, digits or underscore characters;
it is also illegal to have two underscores next to each other. Identifiers
are always case-insensitive ("Name" is the same as "name").
<pre class="smallexample"> simple_name ::= identifier
name ::= simple_name { . simple_name }
</pre>
<p class="noindent"><b>Strings</b> are used for values of attributes or as indexes for these
attributes. They are in general case sensitive, except when noted
otherwise (in particular, strings representing file names will be case
insensitive on some systems, so that "file.adb" and "File.adb" both
represent the same file).
<p><b>Reserved words</b> are the same as for standard Ada 95, and cannot
be used for identifiers. In particular, the following words are currently
used in project files, but others could be added later on. In bold are the
extra reserved words in project files: <code>all, at, case, end, for, is,
limited, null, others, package, renames, type, use, when, with, </code><b>extends</b><code>,
</code><b>external</b><code>, </code><b>project</b>.
<p><b>Comments</b> in project files have the same syntax as in Ada, two consecutive
hyphens through the end of the line.
<p>A project may be an <b>independent project</b>, entirely defined by a single
project file. Any source file in an independent project depends only
on the predefined library and other source files in the same project.
But a project may also depend on other projects, either by importing them
through <b>with clauses</b>, or by <b>extending</b> at most one other project. Both
types of dependency can be used in the same project.
<p>A path name denotes a project file. It can be absolute or relative.
An absolute path name includes a sequence of directories, in the syntax of
the host operating system, that identifies uniquely the project file in the
file system. A relative path name identifies the project file, relative
to the directory that contains the current project, or relative to a
directory listed in the environment variables ADA_PROJECT_PATH and
GPR_PROJECT_PATH. Path names are case sensitive if file names in the host
operating system are case sensitive. As a special case, the directory
separator can always be "/" even on Windows systems, so that project files
can be made portable across architectures.
The syntax of the environment variable ADA_PROJECT_PATH and
GPR_PROJECT_PATH is a list of directory names separated by colons on UNIX and
semicolons on Windows.
<p>A given project name can appear only once in a context clause.
<p>It is illegal for a project imported by a context clause to refer, directly
or indirectly, to the project in which this context clause appears (the
dependency graph cannot contain cycles), except when one of the with clause
in the cycle is a <b>limited with</b>.
<!-- ??? Need more details here -->
<pre class="smallexample"> with "other_project.gpr";
project My_Project extends "extended.gpr" is
end My_Project;
</pre>
<p class="noindent">These dependencies form a <b>directed graph</b>, potentially cyclic when using
<b>limited with</b>. The subprogram reflecting the <b>extends</b> relations is a
tree.
<p>A project's <b>immediate sources</b> are the source files directly defined by
that project, either implicitly by residing in the project source directories,
or explicitly through any of the source-related attributes.
More generally, a project sources are the immediate sources of the project
together with the immediate sources (unless overridden) of any
project on which it depends directly or indirectly.
<p>A <b>project hierarchy</b> can be created, where projects are children of
other projects. The name of such a child project must be <code>Parent.Child</code>,
where <code>Parent</code> is the name of the parent project. In particular, this
makes all <code>with</code> clauses of the parent project automatically visible
in the child project.
<pre class="smallexample"> project ::= context_clause project_declaration
context_clause ::= {with_clause}
with_clause ::= <i>with</i> path_name { , path_name } ;
path_name ::= string_literal
project_declaration ::= simple_project_declaration | project_extension
simple_project_declaration ::=
<i>project</i> <i><project_></i>name <i>is</i>
{declarative_item}
<i>end</i> <project_>simple_name;
</pre>
<!-- -->
<div class="node">
<a name="Qualified-Projects"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Declarations">Declarations</a>,
Previous: <a rel="previous" accesskey="p" href="#Project-Declaration">Project Declaration</a>,
Up: <a rel="up" accesskey="u" href="#Project-File-Reference">Project File Reference</a>
</div>
<h4 class="subsection">11.7.2 Qualified Projects</h4>
<!-- -->
<p class="noindent">Before the reserved <code>project</code>, there may be one or two <b>qualifiers</b>, that
is identifiers or reserved words, to qualify the project.
The current list of qualifiers is:
<dl>
<dt><b>abstract</b>: qualifies a project with no sources. Such a<dd> project must either have no declaration of attributes <code>Source_Dirs</code>,
<code>Source_Files</code>, <code>Languages</code> or <code>Source_List_File</code>, or one of
<code>Source_Dirs</code>, <code>Source_Files</code>, or <code>Languages</code> must be declared
as empty. If it extends another project, the project it extends must also be a
qualified abstract project.
<br><dt><b>standard</b>: a standard project is a non library project with sources.<dd> This is the default (implicit) qualifier.
<br><dt><b>aggregate</b>: for future extension<br><dt><b>aggregate library</b>: for future extension<br><dt><b>library</b>: a library project must declare both attributes<dd> <code>Library_Name</code> and <code>Library_Dir</code>.
<br><dt><b>configuration</b>: a configuration project cannot be in a project tree.<dd> It describes compilers and other tools to <code>gprbuild</code>.
</dl>
<!-- -->
<div class="node">
<a name="Declarations"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Packages">Packages</a>,
Previous: <a rel="previous" accesskey="p" href="#Qualified-Projects">Qualified Projects</a>,
Up: <a rel="up" accesskey="u" href="#Project-File-Reference">Project File Reference</a>
</div>
<h4 class="subsection">11.7.3 Declarations</h4>
<!-- -->
<p class="noindent">Declarations introduce new entities that denote types, variables, attributes,
and packages. Some declarations can only appear immediately within a project
declaration. Others can appear within a project or within a package.
<pre class="smallexample"> declarative_item ::= simple_declarative_item
| typed_string_declaration
| package_declaration
simple_declarative_item ::= variable_declaration
| typed_variable_declaration
| attribute_declaration
| case_construction
| empty_declaration
empty_declaration ::= <i>null</i> ;
</pre>
<p class="noindent">An empty declaration is allowed anywhere a declaration is allowed. It has
no effect.
<!-- -->
<div class="node">
<a name="Packages"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Expressions">Expressions</a>,
Previous: <a rel="previous" accesskey="p" href="#Declarations">Declarations</a>,
Up: <a rel="up" accesskey="u" href="#Project-File-Reference">Project File Reference</a>
</div>
<h4 class="subsection">11.7.4 Packages</h4>
<!-- -->
<p class="noindent">A project file may contain <b>packages</b>, that group attributes (typically
all the attributes that are used by one of the GNAT tools).
<p>A package with a given name may only appear once in a project file.
The following packages are currently supported in project files
(See see <a href="#Attributes">Attributes</a> for the list of attributes that each can contain).
<dl>
<dt><code>Binder</code><dd> This package specifies characteristics useful when invoking the binder either
directly via the <samp><span class="command">gnat</span></samp> driver or when using a builder such as
<samp><span class="command">gnatmake</span></samp> or <samp><span class="command">gprbuild</span></samp>. See <a href="#Main-Subprograms">Main Subprograms</a>.
<br><dt><code>Builder</code><dd> This package specifies the compilation options used when building an
executable or a library for a project. Most of the options should be
set in one of <code>Compiler</code>, <code>Binder</code> or <code>Linker</code> packages,
but there are some general options that should be defined in this
package. See <a href="#Main-Subprograms">Main Subprograms</a>, and see <a href="#Executable-File-Names">Executable File Names</a> in
particular.
<br><dt><code>Check</code><dd> This package specifies the options used when calling the checking tool
<samp><span class="command">gnatcheck</span></samp> via the <samp><span class="command">gnat</span></samp> driver. Its attribute
<b>Default_Switches</b> has the same semantics as for the package
<code>Builder</code>. The first string should always be <code>-rules</code> to specify
that all the other options belong to the <code>-rules</code> section of the
parameters to <samp><span class="command">gnatcheck</span></samp>.
<br><dt><code>Compiler</code><dd> This package specifies the compilation options used by the compiler for
each languages. See <a href="#Tools-Options-in-Project-Files">Tools Options in Project Files</a>.
<br><dt><code>Cross_Reference</code><dd> This package specifies the options used when calling the library tool
<samp><span class="command">gnatxref</span></samp> via the <samp><span class="command">gnat</span></samp> driver. Its attributes
<b>Default_Switches</b> and <b>Switches</b> have the same semantics as for the
package <code>Builder</code>.
<br><dt><code>Eliminate</code><dd> This package specifies the options used when calling the tool
<samp><span class="command">gnatelim</span></samp> via the <samp><span class="command">gnat</span></samp> driver. Its attributes
<b>Default_Switches</b> and <b>Switches</b> have the same semantics as for the
package <code>Builder</code>.
<br><dt><code>Finder</code><dd> This package specifies the options used when calling the search tool
<samp><span class="command">gnatfind</span></samp> via the <samp><span class="command">gnat</span></samp> driver. Its attributes
<b>Default_Switches</b> and <b>Switches</b> have the same semantics as for the
package <code>Builder</code>.
<br><dt><code>Gnatls</code><dd> This package the options to use when invoking <samp><span class="command">gnatls</span></samp> via the
<samp><span class="command">gnat</span></samp> driver.
<br><dt><code>Gnatstub</code><dd> This package specifies the options used when calling the tool
<samp><span class="command">gnatstub</span></samp> via the <samp><span class="command">gnat</span></samp> driver. Its attributes
<b>Default_Switches</b> and <b>Switches</b> have the same semantics as for the
package <code>Builder</code>.
<br><dt><code>IDE</code><dd> This package specifies the options used when starting an integrated
development environment, for instance <samp><span class="command">GPS</span></samp> or <samp><span class="command">Gnatbench</span></samp>.
See <a href="#The-Development-Environments">The Development Environments</a>.
<br><dt><code>Linker</code><dd> This package specifies the options used by the linker.
See <a href="#Main-Subprograms">Main Subprograms</a>.
<br><dt><code>Metrics</code><dd> This package specifies the options used when calling the tool
<samp><span class="command">gnatmetric</span></samp> via the <samp><span class="command">gnat</span></samp> driver. Its attributes
<b>Default_Switches</b> and <b>Switches</b> have the same semantics as for the
package <code>Builder</code>.
<br><dt><code>Naming</code><dd> This package specifies the naming conventions that apply
to the source files in a project. In particular, these conventions are
used to automatically find all source files in the source directories,
or given a file name to find out its language for proper processing.
See <a href="#Naming-Schemes">Naming Schemes</a>.
<br><dt><code>Pretty_Printer</code><dd> This package specifies the options used when calling the formatting tool
<samp><span class="command">gnatpp</span></samp> via the <samp><span class="command">gnat</span></samp> driver. Its attributes
<b>Default_Switches</b> and <b>Switches</b> have the same semantics as for the
package <code>Builder</code>.
<br><dt><code>Stack</code><dd> This package specifies the options used when calling the tool
<samp><span class="command">gnatstack</span></samp> via the <samp><span class="command">gnat</span></samp> driver. Its attributes
<b>Default_Switches</b> and <b>Switches</b> have the same semantics as for the
package <code>Builder</code>.
<br><dt><code>Synchronize</code><dd> This package specifies the options used when calling the tool
<samp><span class="command">gnatsync</span></samp> via the <samp><span class="command">gnat</span></samp> driver.
</dl>
<p>In its simplest form, a package may be empty:
<pre class="smallexample"> project Simple is
package Builder is
end Builder;
end Simple;
</pre>
<p class="noindent">A package may contain <b>attribute declarations</b>,
<b>variable declarations</b> and <b>case constructions</b>, as will be
described below.
<p>When there is ambiguity between a project name and a package name,
the name always designates the project. To avoid possible confusion, it is
always a good idea to avoid naming a project with one of the
names allowed for packages or any name that starts with <code>gnat</code>.
<p>A package can also be defined by a <b>renaming declaration</b>. The new package
renames a package declared in a different project file, and has the same
attributes as the package it renames. The name of the renamed package
must be the same as the name of the renaming package. The project must
contain a package declaration with this name, and the project
must appear in the context clause of the current project, or be its parent
project. It is not possible to add or override attributes to the renaming
project. If you need to do so, you should use an <b>extending declaration</b>
(see below).
<p>Packages that are renamed in other project files often come from project files
that have no sources: they are just used as templates. Any modification in the
template will be reflected automatically in all the project files that rename
a package from the template. This is a very common way to share settings
between projects.
<p>Finally, a package can also be defined by an <b>extending declaration</b>. This is
similar to a <b>renaming declaration</b>, except that it is possible to add or
override attributes.
<pre class="smallexample"> package_declaration ::= package_spec | package_renaming | package_extension
package_spec ::=
<i>package</i> <i><package_></i>simple_name <i>is</i>
{simple_declarative_item}
<i>end</i> package_identifier ;
package_renaming ::==
<i>package</i> <i><package_></i>simple_name <i>renames</i> <i><project_></i>simple_name.package_identifier ;
package_extension ::==
<i>package</i> <i><package_></i>simple_name <i>extends</i> <i><project_></i>simple_name.package_identifier <i>is</i>
{simple_declarative_item}
<i>end</i> package_identifier ;
</pre>
<!-- -->
<div class="node">
<a name="Expressions"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#External-Values">External Values</a>,
Previous: <a rel="previous" accesskey="p" href="#Packages">Packages</a>,
Up: <a rel="up" accesskey="u" href="#Project-File-Reference">Project File Reference</a>
</div>
<h4 class="subsection">11.7.5 Expressions</h4>
<!-- -->
<p class="noindent">An expression is any value that can be assigned to an attribute or a
variable. It is either a literal value, or a construct requiring runtime
computation by the project manager. In a project file, the computed value of
an expression is either a string or a list of strings.
<p>A string value is one of:
<ul>
<li>A literal string, for instance <code>"comm/my_proj.gpr"</code>
<li>The name of a variable that evaluates to a string (see <a href="#Variables">Variables</a>)
<li>The name of an attribute that evaluates to a string (see <a href="#Attributes">Attributes</a>)
<li>An external reference (see <a href="#External-Values">External Values</a>)
<li>A concatenation of the above, as in <code>"prefix_" & Var</code>.
</ul>
<p class="noindent">A list of strings is one of the following:
<ul>
<li>A parenthesized comma-separated list of zero or more string expressions, for
instance <code>(File_Name, "gnat.adc", File_Name & ".orig")</code> or <code>()</code>.
<li>The name of a variable that evaluates to a list of strings
<li>The name of an attribute that evaluates to a list of strings
<li>A concatenation of a list of strings and a string (as defined above), for
instance <code>("A", "B") & "C"</code>
<li>A concatenation of two lists of strings
</ul>
<p class="noindent">The following is the grammar for expressions
<pre class="smallexample"> string_literal ::= "{string_element}" -- Same as Ada
string_expression ::= string_literal
| <i>variable_</i>name
| external_value
| attribute_reference
| ( string_expression { & string_expression } )
string_list ::= ( string_expression { , string_expression } )
| <i>string_variable</i>_name
| <i>string_</i>attribute_reference
term ::= string_expression | string_list
expression ::= term { & term } -- Concatenation
</pre>
<p class="noindent">Concatenation involves strings and list of strings. As soon as a list of
strings is involved, the result of the concatenation is a list of strings. The
following Ada declarations show the existing operators:
<pre class="smallexample"> function "&" (X : String; Y : String) return String;
function "&" (X : String_List; Y : String) return String_List;
function "&" (X : String_List; Y : String_List) return String_List;
</pre>
<p class="noindent">Here are some specific examples:
<pre class="smallexample"> List := () & File_Name; -- One string in this list
List2 := List & (File_Name & ".orig"); -- Two strings
Big_List := List & Lists2; -- Three strings
Illegal := "gnat.adc" & List2; -- Illegal, must start with list
</pre>
<!-- -->
<div class="node">
<a name="External-Values"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Typed-String-Declaration">Typed String Declaration</a>,
Previous: <a rel="previous" accesskey="p" href="#Expressions">Expressions</a>,
Up: <a rel="up" accesskey="u" href="#Project-File-Reference">Project File Reference</a>
</div>
<h4 class="subsection">11.7.6 External Values</h4>
<!-- -->
<p class="noindent">An external value is an expression whose value is obtained from the command
that invoked the processing of the current project file (typically a
gnatmake or gprbuild command).
<p>There are two kinds of external values, one that returns a single string, and
one that returns a string list.
<p>The syntax of a single string external value is:
<pre class="smallexample"> external_value ::= <i>external</i> ( string_literal [, string_literal] )
</pre>
<p class="noindent">The first string_literal is the string to be used on the command line or
in the environment to specify the external value. The second string_literal,
if present, is the default to use if there is no specification for this
external value either on the command line or in the environment.
<p>Typically, the external value will either exist in the
environment variables
or be specified on the command line through the
<samp><span class="option">-X</span><em>vbl</em><span class="option">=</span><em>value</em></samp> switch. If both
are specified, then the command line value is used, so that a user can more
easily override the value.
<p>The function <code>external</code> always returns a string. It is an error if the
value was not found in the environment and no default was specified in the
call to <code>external</code>.
<p>An external reference may be part of a string expression or of a string
list expression, and can therefore appear in a variable declaration or
an attribute declaration.
<p>Most of the time, this construct is used to initialize typed variables, which
are then used in <b>case</b> statements to control the value assigned to
attributes in various scenarios. Thus such variables are often called
<b>scenario variables</b>.
<p>The syntax for a string list external value is:
<pre class="smallexample"> external_value ::= <i>external_as_list</i> ( string_literal , string_literal )
</pre>
<p class="noindent">The first string_literal is the string to be used on the command line or
in the environment to specify the external value. The second string_literal is
the separator between each component of the string list.
<p>If the external value does not exist in the environment or on the command line,
the result is an empty list. This is also the case, if the separator is an
empty string or if the external value is only one separator.
<p>Any separator at the beginning or at the end of the external value is
discarded. Then, if there is no separator in the external value, the result is
a string list with only one string. Otherwise, any string between the beginning
and the first separator, between two consecutive separators and between the
last separator and the end are components of the string list.
<pre class="smallexample"> <i>external_as_list</i> ("SWITCHES", ",")
</pre>
<p class="noindent">If the external value is "-O2,-g", the result is ("-O2", "-g").
<p>If the external value is ",-O2,-g,", the result is also ("-O2", "-g").
<p>if the external value is "-gnav", the result is ("-gnatv").
<p>If the external value is ",,", the result is ("").
<p>If the external value is ",", the result is (), the empty string list.
<!-- -->
<div class="node">
<a name="Typed-String-Declaration"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Variables">Variables</a>,
Previous: <a rel="previous" accesskey="p" href="#External-Values">External Values</a>,
Up: <a rel="up" accesskey="u" href="#Project-File-Reference">Project File Reference</a>
</div>
<h4 class="subsection">11.7.7 Typed String Declaration</h4>
<!-- -->
<p class="noindent">A <b>type declaration</b> introduces a discrete set of string literals.
If a string variable is declared to have this type, its value
is restricted to the given set of literals. These are the only named
types in project files. A string type may only be declared at the project
level, not inside a package.
<pre class="smallexample"> typed_string_declaration ::=
<i>type</i> <i><typed_string_></i>_simple_name <i>is</i> ( string_literal {, string_literal} );
</pre>
<p class="noindent">The string literals in the list are case sensitive and must all be different.
They may include any graphic characters allowed in Ada, including spaces.
Here is an example of a string type declaration:
<pre class="smallexample"> type OS is ("NT", "nt", "Unix", "GNU/Linux", "other OS");
</pre>
<p class="noindent">Variables of a string type are called <b>typed variables</b>; all other
variables are called <b>untyped variables</b>. Typed variables are
particularly useful in <code>case</code> constructions, to support conditional
attribute declarations. (see <a href="#Case-Statements">Case Statements</a>).
<p>A string type may be referenced by its name if it has been declared in the same
project file, or by an expanded name whose prefix is the name of the project
in which it is declared.
<!-- -->
<div class="node">
<a name="Variables"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Attributes">Attributes</a>,
Previous: <a rel="previous" accesskey="p" href="#Typed-String-Declaration">Typed String Declaration</a>,
Up: <a rel="up" accesskey="u" href="#Project-File-Reference">Project File Reference</a>
</div>
<h4 class="subsection">11.7.8 Variables</h4>
<!-- -->
<p class="noindent"><b>Variables</b> store values (strings or list of strings) and can appear
as part of an expression. The declaration of a variable creates the
variable and assigns the value of the expression to it. The name of the
variable is available immediately after the assignment symbol, if you
need to reuse its old value to compute the new value. Before the completion
of its first declaration, the value of a variable defaults to the empty
string ("").
<p>A <b>typed</b> variable can be used as part of a <b>case</b> expression to
compute the value, but it can only be declared once in the project file,
so that all case statements see the same value for the variable. This
provides more consistency and makes the project easier to understand.
The syntax for its declaration is identical to the Ada syntax for an
object declaration. In effect, a typed variable acts as a constant.
<p>An <b>untyped</b> variable can be declared and overridden multiple times
within the same project. It is declared implicitly through an Ada
assignment. The first declaration establishes the kind of the variable
(string or list of strings) and successive declarations must respect
the initial kind. Assignments are executed in the order in which they
appear, so the new value replaces the old one and any subsequent reference
to the variable uses the new value.
<p>A variable may be declared at the project file level, or within a package.
<pre class="smallexample"> typed_variable_declaration ::=
<i><typed_variable_></i>simple_name : <i><typed_string_></i>name := string_expression;
variable_declaration ::= <i><variable_></i>simple_name := expression;
</pre>
<p class="noindent">Here are some examples of variable declarations:
<pre class="smallexample"> This_OS : OS := external ("OS"); -- a typed variable declaration
That_OS := "GNU/Linux"; -- an untyped variable declaration
Name := "readme.txt";
Save_Name := Name & ".saved";
Empty_List := ();
List_With_One_Element := ("-gnaty");
List_With_Two_Elements := List_With_One_Element & "-gnatg";
Long_List := ("main.ada", "pack1_.ada", "pack1.ada", "pack2_.ada");
</pre>
<p class="noindent">A <b>variable reference</b> may take several forms:
<ul>
<li>The simple variable name, for a variable in the current package (if any)
or in the current project
<li>An expanded name, whose prefix is a context name.
</ul>
<p class="noindent">A <b>context</b> may be one of the following:
<ul>
<li>The name of an existing package in the current project
<li>The name of an imported project of the current project
<li>The name of an ancestor project (i.e., a project extended by the current
project, either directly or indirectly)
<li>An expanded name whose prefix is an imported/parent project name, and
whose selector is a package name in that project.
</ul>
<!-- -->
<div class="node">
<a name="Attributes"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Case-Statements">Case Statements</a>,
Previous: <a rel="previous" accesskey="p" href="#Variables">Variables</a>,
Up: <a rel="up" accesskey="u" href="#Project-File-Reference">Project File Reference</a>
</div>
<h4 class="subsection">11.7.9 Attributes</h4>
<!-- -->
<p class="noindent">A project (and its packages) may have <b>attributes</b> that define
the project's properties. Some attributes have values that are strings;
others have values that are string lists.
<pre class="smallexample"> attribute_declaration ::=
simple_attribute_declaration | indexed_attribute_declaration
simple_attribute_declaration ::= <i>for</i> attribute_designator <i>use</i> expression ;
indexed_attribute_declaration ::=
<i>for</i> <i><indexed_attribute_></i>simple_name ( string_literal) <i>use</i> expression ;
attribute_designator ::=
<i><simple_attribute_></i>simple_name
| <i><indexed_attribute_></i>simple_name ( string_literal )
</pre>
<p class="noindent">There are two categories of attributes: <b>simple attributes</b>
and <b>indexed attributes</b>.
Each simple attribute has a default value: the empty string (for string
attributes) and the empty list (for string list attributes).
An attribute declaration defines a new value for an attribute, and overrides
the previous value. The syntax of a simple attribute declaration is similar to
that of an attribute definition clause in Ada.
<p>Some attributes are indexed. These attributes are mappings whose
domain is a set of strings. They are declared one association
at a time, by specifying a point in the domain and the corresponding image
of the attribute.
Like untyped variables and simple attributes, indexed attributes
may be declared several times. Each declaration supplies a new value for the
attribute, and replaces the previous setting.
<p>Here are some examples of attribute declarations:
<pre class="smallexample"> -- simple attributes
for Object_Dir use "objects";
for Source_Dirs use ("units", "test/drivers");
-- indexed attributes
for Body ("main") use "Main.ada";
for Switches ("main.ada") use ("-v", "-gnatv");
for Switches ("main.ada") use Builder'Switches ("main.ada") & "-g";
-- indexed attributes copy (from package Builder in project Default)
-- The package name must always be specified, even if it is the current
-- package.
for Default_Switches use Default.Builder'Default_Switches;
</pre>
<p class="noindent">Attributes references may be appear anywhere in expressions, and are used
to retrieve the value previously assigned to the attribute. If an attribute
has not been set in a given package or project, its value defaults to the
empty string or the empty list.
<pre class="smallexample"> attribute_reference ::= attribute_prefix ' <i><simple_attribute>_</i>simple_name [ (string_literal) ]
attribute_prefix ::= <i>project</i>
| <i><project_></i>simple_name
| package_identifier
| <i><project_></i>simple_name . package_identifier
</pre>
<p class="noindent">Examples are:
<pre class="smallexample"> project'Object_Dir
Naming'Dot_Replacement
Imported_Project'Source_Dirs
Imported_Project.Naming'Casing
Builder'Default_Switches ("Ada")
</pre>
<p class="noindent">The prefix of an attribute may be:
<ul>
<li><code>project</code> for an attribute of the current project
<li>The name of an existing package of the current project
<li>The name of an imported project
<li>The name of a parent project that is extended by the current project
<li>An expanded name whose prefix is imported/parent project name,
and whose selector is a package name
</ul>
<p class="noindent">Legal attribute names are listed below, including the package in
which they must be declared. These names are case-insensitive. The
semantics for the attributes is explained in great details in other sections.
<p>The column <em>index</em> indicates whether the attribute is an indexed attribute,
and when it is whether its index is case sensitive (sensitive) or not (insensitive), or if case sensitivity depends is the same as file names sensitivity on the
system (file). The text is between brackets ([]) if the index is optional.
<p><table summary=""><tr align="left"><th valign="top" width="30%">Attribute Name </th><th valign="top" width="10%">Value </th><th valign="top" width="20%">Package </th><th valign="top" width="40%">Index
<br></th></tr><tr align="left"><th valign="top" width="30%">General attributes </th><th valign="top" width="10%"></th><th valign="top" width="20%"></th><th valign="top" width="40%">see <a href="#Building-With-Projects">Building With Projects</a>
<br></th></tr><tr align="left"><td valign="top" width="30%">Name </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">(Read-only, name of project)
<br></td></tr><tr align="left"><td valign="top" width="30%">Project_Dir </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">(Read-only, directory of project)
<br></td></tr><tr align="left"><td valign="top" width="30%">Source_Files </td><td valign="top" width="10%">list </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Source_Dirs </td><td valign="top" width="10%">list </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Source_List_File </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Locally_Removed_Files </td><td valign="top" width="10%">list </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Excluded_Source_Files </td><td valign="top" width="10%">list </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Object_Dir </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Exec_Dir </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Excluded_Source_Dirs </td><td valign="top" width="10%">list </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Excluded_Source_Files </td><td valign="top" width="10%">list </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Excluded_Source_List_File </td><td valign="top" width="10%">list </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Inherit_Source_Path </td><td valign="top" width="10%">list </td><td valign="top" width="20%">- </td><td valign="top" width="40%">insensitive
<br></td></tr><tr align="left"><td valign="top" width="30%">Languages </td><td valign="top" width="10%">list </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Main </td><td valign="top" width="10%">list </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Main_Language </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Externally_Built </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Roots </td><td valign="top" width="10%">list </td><td valign="top" width="20%">- </td><td valign="top" width="40%">file
<br></td></tr><tr align="left"><th valign="top" width="30%"> Library-related attributes </th><th valign="top" width="10%"></th><th valign="top" width="20%"></th><th valign="top" width="40%">see <a href="#Library-Projects">Library Projects</a>
<br></th></tr><tr align="left"><td valign="top" width="30%">Library_Dir </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Library_Name </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Library_Kind </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Library_Version </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Library_Interface </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Library_Auto_Init </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Library_Options </td><td valign="top" width="10%">list </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Leading_Library_Options </td><td valign="top" width="10%">list </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Library_Src_Dir </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Library_ALI_Dir </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Library_GCC </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Library_Symbol_File </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Library_Symbol_Policy </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Library_Reference_Symbol_File </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Interfaces </td><td valign="top" width="10%">list </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><th valign="top" width="30%"> Naming </th><th valign="top" width="10%"></th><th valign="top" width="20%"></th><th valign="top" width="40%">see <a href="#Naming-Schemes">Naming Schemes</a>
<br></th></tr><tr align="left"><td valign="top" width="30%">Spec_Suffix </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Naming </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Body_Suffix </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Naming </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Separate_Suffix </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Naming </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Casing </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Naming </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Dot_Replacement </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Naming </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Spec </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Naming </td><td valign="top" width="40%">insensitive (Ada unit)
<br></td></tr><tr align="left"><td valign="top" width="30%">Body </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Naming </td><td valign="top" width="40%">insensitive (Ada unit)
<br></td></tr><tr align="left"><td valign="top" width="30%">Specification_Exceptions </td><td valign="top" width="10%">list </td><td valign="top" width="20%">Naming </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Implementation_Exceptions </td><td valign="top" width="10%">list </td><td valign="top" width="20%">Naming </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><th valign="top" width="30%"> Building </th><th valign="top" width="10%"></th><th valign="top" width="20%"></th><th valign="top" width="40%">see <a href="#Switches-and-Project-Files">Switches and Project Files</a>
<br></th></tr><tr align="left"><td valign="top" width="30%">Default_Switches </td><td valign="top" width="10%">list </td><td valign="top" width="20%">Builder, Compiler, Binder, Linker, Cross_Reference, Finder, Pretty_Printer, gnatstub, Check, Synchronize, Eliminate, Metrics, IDE </td><td valign="top" width="40%">insensitive (language name)
<br></td></tr><tr align="left"><td valign="top" width="30%">Switches </td><td valign="top" width="10%">list </td><td valign="top" width="20%">Builder, Compiler, Binder, Linker, Cross_Reference, Finder, gnatls, Pretty_Printer, gnatstub, Check, Synchronize, Eliminate, Metrics, Stack </td><td valign="top" width="40%">[file] (file name)
<br></td></tr><tr align="left"><td valign="top" width="30%">Local_Configuration_Pragmas </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Compiler </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Local_Config_File </td><td valign="top" width="10%">string </td><td valign="top" width="20%">insensitive </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Global_Configuration_Pragmas </td><td valign="top" width="10%">list </td><td valign="top" width="20%">Builder </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Global_Compilation_Switches </td><td valign="top" width="10%">list </td><td valign="top" width="20%">Builder </td><td valign="top" width="40%">language
<br></td></tr><tr align="left"><td valign="top" width="30%">Executable </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Builder </td><td valign="top" width="40%">[file]
<br></td></tr><tr align="left"><td valign="top" width="30%">Executable_Suffix </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Builder </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Global_Config_File </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Builder </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><th valign="top" width="30%"> IDE (used and created by GPS) </th><th valign="top" width="10%"></th><th valign="top" width="20%"></th><th valign="top" width="40%">
<br></th></tr><tr align="left"><td valign="top" width="30%">Remote_Host </td><td valign="top" width="10%">string </td><td valign="top" width="20%">IDE </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Program_Host </td><td valign="top" width="10%">string </td><td valign="top" width="20%">IDE </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Communication_Protocol </td><td valign="top" width="10%">string </td><td valign="top" width="20%">IDE </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Compiler_Command </td><td valign="top" width="10%">string </td><td valign="top" width="20%">IDE </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Debugger_Command </td><td valign="top" width="10%">string </td><td valign="top" width="20%">IDE </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Gnatlist </td><td valign="top" width="10%">string </td><td valign="top" width="20%">IDE </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">VCS_Kind </td><td valign="top" width="10%">string </td><td valign="top" width="20%">IDE </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">VCS_File_Check </td><td valign="top" width="10%">string </td><td valign="top" width="20%">IDE </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">VCS_Log_Check </td><td valign="top" width="10%">string </td><td valign="top" width="20%">IDE </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Documentation_Dir </td><td valign="top" width="10%">string </td><td valign="top" width="20%">IDE </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><th valign="top" width="30%"> Configuration files </th><th valign="top" width="10%"></th><th valign="top" width="20%"></th><th valign="top" width="40%">See gprbuild manual
<br></th></tr><tr align="left"><td valign="top" width="30%">Default_Language </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Run_Path_Option </td><td valign="top" width="10%">list </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Run_Path_Origin </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Separate_Run_Path_Options </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Toolchain_Version </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">insensitive
<br></td></tr><tr align="left"><td valign="top" width="30%">Toolchain_Description </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">insensitive
<br></td></tr><tr align="left"><td valign="top" width="30%">Object_Generated </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">insensitive
<br></td></tr><tr align="left"><td valign="top" width="30%">Objects_Linked </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">insensitive
<br></td></tr><tr align="left"><td valign="top" width="30%">Target </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Library_Builder </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Library_Support </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Archive_Builder </td><td valign="top" width="10%">list </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Archive_Builder_Append_Option </td><td valign="top" width="10%">list </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Archive_Indexer </td><td valign="top" width="10%">list </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Archive_Suffix </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Library_Partial_Linker </td><td valign="top" width="10%">list </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Shared_Library_Prefix </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Shared_Library_Suffix </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Symbolic_Link_Supported </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Library_Major_Minor_Id_Supported </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Library_Auto_Init_Supported </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Shared_Library_Minimum_Switches </td><td valign="top" width="10%">list </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Library_Version_Switches </td><td valign="top" width="10%">list </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Library_Install_Name_Option </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Runtime_Library_Dir </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">insensitive
<br></td></tr><tr align="left"><td valign="top" width="30%">Runtime_Source_Dir </td><td valign="top" width="10%">string </td><td valign="top" width="20%">- </td><td valign="top" width="40%">insensitive
<br></td></tr><tr align="left"><td valign="top" width="30%">Driver </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Compiler,Binder,Linker </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Required_Switches </td><td valign="top" width="10%">list </td><td valign="top" width="20%">Compiler,Binder,Linker </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Leading_Required_Switches </td><td valign="top" width="10%">list </td><td valign="top" width="20%">Compiler </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Trailing_Required_Switches </td><td valign="top" width="10%">list </td><td valign="top" width="20%">Compiler </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Pic_Options </td><td valign="top" width="10%">list </td><td valign="top" width="20%">Compiler </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Path_Syntax </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Compiler </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Object_File_Suffix </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Compiler </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Object_File_Switches </td><td valign="top" width="10%">list </td><td valign="top" width="20%">Compiler </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Multi_Unit_Switches </td><td valign="top" width="10%">list </td><td valign="top" width="20%">Compiler </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Multi_Unit_Object_Separator </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Compiler </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Mapping_File_Switches </td><td valign="top" width="10%">list </td><td valign="top" width="20%">Compiler </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Mapping_Spec_Suffix </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Compiler </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Mapping_body_Suffix </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Compiler </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Config_File_Switches </td><td valign="top" width="10%">list </td><td valign="top" width="20%">Compiler </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Config_Body_File_Name </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Compiler </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Config_Body_File_Name_Index </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Compiler </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Config_Body_File_Name_Pattern </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Compiler </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Config_Spec_File_Name </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Compiler </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Config_Spec_File_Name_Index </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Compiler </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Config_Spec_File_Name_Pattern </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Compiler </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Config_File_Unique </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Compiler </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Dependency_Switches </td><td valign="top" width="10%">list </td><td valign="top" width="20%">Compiler </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Dependency_Driver </td><td valign="top" width="10%">list </td><td valign="top" width="20%">Compiler </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Include_Switches </td><td valign="top" width="10%">list </td><td valign="top" width="20%">Compiler </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Include_Path </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Compiler </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Include_Path_File </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Compiler </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Prefix </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Binder </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Objects_Path </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Binder </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Objects_Path_File </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Binder </td><td valign="top" width="40%">insensitive (language)
<br></td></tr><tr align="left"><td valign="top" width="30%">Linker_Options </td><td valign="top" width="10%">list </td><td valign="top" width="20%">Linker </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Leading_Switches </td><td valign="top" width="10%">list </td><td valign="top" width="20%">Linker </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Map_File_Options </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Linker </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Executable_Switches </td><td valign="top" width="10%">list </td><td valign="top" width="20%">Linker </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Lib_Dir_Switch </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Linker </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Lib_Name_Switch </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Linker </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Max_Command_Line_Length </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Linker </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Response_File_Format </td><td valign="top" width="10%">string </td><td valign="top" width="20%">Linker </td><td valign="top" width="40%">-
<br></td></tr><tr align="left"><td valign="top" width="30%">Response_File_Switches </td><td valign="top" width="10%">list </td><td valign="top" width="20%">Linker </td><td valign="top" width="40%">-
<br></td></tr></table>
<!-- -->
<div class="node">
<a name="Case-Statements"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Attributes">Attributes</a>,
Up: <a rel="up" accesskey="u" href="#Project-File-Reference">Project File Reference</a>
</div>
<h4 class="subsection">11.7.10 Case Statements</h4>
<!-- -->
<p class="noindent">A <b>case</b> statement is used in a project file to effect conditional
behavior. Through this statement, you can set the value of attributes
and variables depending on the value previously assigned to a typed
variable.
<p>All choices in a choice list must be distinct. Unlike Ada, the choice
lists of all alternatives do not need to include all values of the type.
An <code>others</code> choice must appear last in the list of alternatives.
<p>The syntax of a <code>case</code> construction is based on the Ada case statement
(although the <code>null</code> statement for empty alternatives is optional).
<p>The case expression must be a typed string variable, whose value is often
given by an external reference (see <a href="#External-Values">External Values</a>).
<p>Each alternative starts with the reserved word <code>when</code>, either a list of
literal strings separated by the <code>"|"</code> character or the reserved word
<code>others</code>, and the <code>"=>"</code> token.
Each literal string must belong to the string type that is the type of the
case variable.
After each <code>=></code>, there are zero or more statements. The only
statements allowed in a case construction are other case statements,
attribute declarations and variable declarations. String type declarations and
package declarations are not allowed. Variable declarations are restricted to
variables that have already been declared before the case construction.
<pre class="smallexample"> case_statement ::=
<i>case</i> <i><typed_variable_></i>name <i>is</i> {case_item} <i>end case</i> ;
case_item ::=
<i>when</i> discrete_choice_list =>
{case_statement
| attribute_declaration
| variable_declaration
| empty_declaration}
discrete_choice_list ::= string_literal {| string_literal} | <i>others</i>
</pre>
<p class="noindent">Here is a typical example:
<pre class="smallexample"> project MyProj is
type OS_Type is ("GNU/Linux", "Unix", "NT", "VMS");
OS : OS_Type := external ("OS", "GNU/Linux");
package Compiler is
case OS is
when "GNU/Linux" | "Unix" =>
for Switches ("Ada") use ("-gnath");
when "NT" =>
for Switches ("Ada") use ("-gnatP");
when others =>
null;
end case;
end Compiler;
end MyProj;
</pre>
<!-- -->
<div class="node">
<a name="Tools-Supporting-Project-Files"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#The-Cross_002dReferencing-Tools-gnatxref-and-gnatfind">The Cross-Referencing Tools gnatxref and gnatfind</a>,
Previous: <a rel="previous" accesskey="p" href="#GNAT-Project-Manager">GNAT Project Manager</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">12 Tools Supporting Project Files</h2>
<!-- -->
<p class="noindent">
<ul class="menu">
<li><a accesskey="1" href="#gnatmake-and-Project-Files">gnatmake and Project Files</a>
<li><a accesskey="2" href="#The-GNAT-Driver-and-Project-Files">The GNAT Driver and Project Files</a>
<li><a accesskey="3" href="#The-Development-Environments">The Development Environments</a>
<li><a accesskey="4" href="#Cleaning-up-with-GPRclean">Cleaning up with GPRclean</a>
</ul>
<!-- -->
<div class="node">
<a name="gnatmake-and-Project-Files"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#The-GNAT-Driver-and-Project-Files">The GNAT Driver and Project Files</a>,
Up: <a rel="up" accesskey="u" href="#Tools-Supporting-Project-Files">Tools Supporting Project Files</a>
</div>
<h3 class="section">12.1 gnatmake and Project Files</h3>
<!-- -->
<p class="noindent">This section covers several topics related to <samp><span class="command">gnatmake</span></samp> and
project files: defining switches for <samp><span class="command">gnatmake</span></samp>
and for the tools that it invokes; specifying configuration pragmas;
the use of the <code>Main</code> attribute; building and rebuilding library project
files.
<ul class="menu">
<li><a accesskey="1" href="#Switches-Related-to-Project-Files">Switches Related to Project Files</a>
<li><a accesskey="2" href="#Switches-and-Project-Files">Switches and Project Files</a>
<li><a accesskey="3" href="#Specifying-Configuration-Pragmas">Specifying Configuration Pragmas</a>
<li><a accesskey="4" href="#Project-Files-and-Main-Subprograms">Project Files and Main Subprograms</a>
<li><a accesskey="5" href="#Library-Project-Files">Library Project Files</a>
</ul>
<!-- -->
<div class="node">
<a name="Switches-Related-to-Project-Files"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Switches-and-Project-Files">Switches and Project Files</a>,
Up: <a rel="up" accesskey="u" href="#gnatmake-and-Project-Files">gnatmake and Project Files</a>
</div>
<h4 class="subsection">12.1.1 Switches Related to Project Files</h4>
<!-- -->
<p class="noindent">The following switches are used by GNAT tools that support project files:
<dl>
<dt><samp><span class="option">-P</span><var>project</var></samp><dd><a name="index-g_t_0040option_007b_002dP_007d-_0028any-project_002daware-tool_0029-702"></a>Indicates the name of a project file. This project file will be parsed with
the verbosity indicated by <samp><span class="option">-vP</span><em>x</em></samp>,
if any, and using the external references indicated
by <samp><span class="option">-X</span></samp> switches, if any.
There may zero, one or more spaces between <samp><span class="option">-P</span></samp> and <var>project</var>.
<p>There must be only one <samp><span class="option">-P</span></samp> switch on the command line.
<p>Since the Project Manager parses the project file only after all the switches
on the command line are checked, the order of the switches
<samp><span class="option">-P</span></samp>,
<samp><span class="option">-vP</span><em>x</em></samp>
or <samp><span class="option">-X</span></samp> is not significant.
<br><dt><samp><span class="option">-X</span><var>name=value</var></samp><dd><a name="index-g_t_0040option_007b_002dX_007d-_0028any-project_002daware-tool_0029-703"></a>Indicates that external variable <var>name</var> has the value <var>value</var>.
The Project Manager will use this value for occurrences of
<code>external(name)</code> when parsing the project file.
<p>If <var>name</var> or <var>value</var> includes a space, then <var>name=value</var> should be
put between quotes.
<pre class="smallexample"> -XOS=NT
-X"user=John Doe"
</pre>
<p>Several <samp><span class="option">-X</span></samp> switches can be used simultaneously.
If several <samp><span class="option">-X</span></samp> switches specify the same
<var>name</var>, only the last one is used.
<p>An external variable specified with a <samp><span class="option">-X</span></samp> switch
takes precedence over the value of the same name in the environment.
<br><dt><samp><span class="option">-vP</span><em>x</em></samp><dd><a name="index-g_t_0040option_007b_002dvP_007d-_0028any-project_002daware-tool_0029-704"></a>Indicates the verbosity of the parsing of GNAT project files.
<p><samp><span class="option">-vP0</span></samp> means Default;
<samp><span class="option">-vP1</span></samp> means Medium;
<samp><span class="option">-vP2</span></samp> means High.
<p>The default is Default: no output for syntactically correct
project files.
If several <samp><span class="option">-vP</span><em>x</em></samp> switches are present,
only the last one is used.
<br><dt><samp><span class="option">-aP<dir></span></samp><dd><a name="index-g_t_0040option_007b_002daP_007d-_0028any-project_002daware-tool_0029-705"></a>Add directory <dir> at the beginning of the project search path, in order,
after the current working directory.
<br><dt><samp><span class="option">-eL</span></samp><dd><a name="index-g_t_0040option_007b_002deL_007d-_0028any-project_002daware-tool_0029-706"></a>Follow all symbolic links when processing project files.
<br><dt><samp><span class="option">--subdirs=<subdir></span></samp><dd><a name="index-g_t_0040option_007b_002d_002dsubdirs_003d_007d-_0028gnatmake-and-gnatclean_0029-707"></a>This switch is recognized by gnatmake and gnatclean. It indicate that the real
directories (except the source directories) are the subdirectories <subdir>
of the directories specified in the project files. This applies in particular
to object directories, library directories and exec directories. If the
subdirectories do not exist, they are created automatically.
</dl>
<!-- -->
<div class="node">
<a name="Switches-and-Project-Files"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Specifying-Configuration-Pragmas">Specifying Configuration Pragmas</a>,
Previous: <a rel="previous" accesskey="p" href="#Switches-Related-to-Project-Files">Switches Related to Project Files</a>,
Up: <a rel="up" accesskey="u" href="#gnatmake-and-Project-Files">gnatmake and Project Files</a>
</div>
<h4 class="subsection">12.1.2 Switches and Project Files</h4>
<!-- -->
<p class="noindent">For each of the packages <code>Builder</code>, <code>Compiler</code>, <code>Binder</code>, and
<code>Linker</code>, you can specify a <code>Default_Switches</code>
attribute, a <code>Switches</code> attribute, or both;
as their names imply, these switch-related
attributes affect the switches that are used for each of these GNAT
components when
<samp><span class="command">gnatmake</span></samp> is invoked. As will be explained below, these
component-specific switches precede
the switches provided on the <samp><span class="command">gnatmake</span></samp> command line.
<p>The <code>Default_Switches</code> attribute is an attribute
indexed by language name (case insensitive) whose value is a string list.
For example:
<pre class="smallexample"> package Compiler is
for Default_Switches ("Ada")
use ("-gnaty",
"-v");
end Compiler;
</pre>
<p class="noindent">The <code>Switches</code> attribute is indexed on a file name (which may or may
not be case sensitive, depending
on the operating system) whose value is a string list. For example:
<pre class="smallexample"> package Builder is
for Switches ("main1.adb")
use ("-O2");
for Switches ("main2.adb")
use ("-g");
end Builder;
</pre>
<p class="noindent">For the <code>Builder</code> package, the file names must designate source files
for main subprograms. For the <code>Binder</code> and <code>Linker</code> packages, the
file names must designate <samp><span class="file">ALI</span></samp> or source files for main subprograms.
In each case just the file name without an explicit extension is acceptable.
<p>For each tool used in a program build (<samp><span class="command">gnatmake</span></samp>, the compiler, the
binder, and the linker), the corresponding package <dfn>contributes</dfn> a set of
switches for each file on which the tool is invoked, based on the
switch-related attributes defined in the package.
In particular, the switches
that each of these packages contributes for a given file <var>f</var> comprise:
<ul>
<li>the value of attribute <code>Switches (</code><var>f</var><code>)</code>,
if it is specified in the package for the given file,
<li>otherwise, the value of <code>Default_Switches ("Ada")</code>,
if it is specified in the package.
</ul>
<p class="noindent">If neither of these attributes is defined in the package, then the package does
not contribute any switches for the given file.
<p>When <samp><span class="command">gnatmake</span></samp> is invoked on a file, the switches comprise
two sets, in the following order: those contributed for the file
by the <code>Builder</code> package;
and the switches passed on the command line.
<p>When <samp><span class="command">gnatmake</span></samp> invokes a tool (compiler, binder, linker) on a file,
the switches passed to the tool comprise three sets,
in the following order:
<ol type=1 start=1>
<li>the applicable switches contributed for the file
by the <code>Builder</code> package in the project file supplied on the command line;
<li>those contributed for the file by the package (in the relevant project file –
see below) corresponding to the tool; and
<li>the applicable switches passed on the command line.
</ol>
<p>The term <em>applicable switches</em> reflects the fact that
<samp><span class="command">gnatmake</span></samp> switches may or may not be passed to individual
tools, depending on the individual switch.
<p><samp><span class="command">gnatmake</span></samp> may invoke the compiler on source files from different
projects. The Project Manager will use the appropriate project file to
determine the <code>Compiler</code> package for each source file being compiled.
Likewise for the <code>Binder</code> and <code>Linker</code> packages.
<p>As an example, consider the following package in a project file:
<pre class="smallexample"> project Proj1 is
package Compiler is
for Default_Switches ("Ada")
use ("-g");
for Switches ("a.adb")
use ("-O1");
for Switches ("b.adb")
use ("-O2",
"-gnaty");
end Compiler;
end Proj1;
</pre>
<p class="noindent">If <samp><span class="command">gnatmake</span></samp> is invoked with this project file, and it needs to
compile, say, the files <samp><span class="file">a.adb</span></samp>, <samp><span class="file">b.adb</span></samp>, and <samp><span class="file">c.adb</span></samp>, then
<samp><span class="file">a.adb</span></samp> will be compiled with the switch
<samp><span class="option">-O1</span></samp>,
<samp><span class="file">b.adb</span></samp> with switches
<samp><span class="option">-O2</span></samp>
and <samp><span class="option">-gnaty</span></samp>,
and <samp><span class="file">c.adb</span></samp> with <samp><span class="option">-g</span></samp>.
<p>The following example illustrates the ordering of the switches
contributed by different packages:
<pre class="smallexample"> project Proj2 is
package Builder is
for Switches ("main.adb")
use ("-g",
"-O1",
"-f");
end Builder;
package Compiler is
for Switches ("main.adb")
use ("-O2");
end Compiler;
end Proj2;
</pre>
<p class="noindent">If you issue the command:
<pre class="smallexample"> gnatmake -Pproj2 -O0 main
</pre>
<p class="noindent">then the compiler will be invoked on <samp><span class="file">main.adb</span></samp> with the following
sequence of switches
<pre class="smallexample"> -g -O1 -O2 -O0
</pre>
<p class="noindent">with the last <samp><span class="option">-O</span></samp>
switch having precedence over the earlier ones;
several other switches
(such as <samp><span class="option">-c</span></samp>) are added implicitly.
<p>The switches
<samp><span class="option">-g</span></samp>
and <samp><span class="option">-O1</span></samp> are contributed by package
<code>Builder</code>, <samp><span class="option">-O2</span></samp> is contributed
by the package <code>Compiler</code>
and <samp><span class="option">-O0</span></samp> comes from the command line.
<p>The <samp><span class="option">-g</span></samp>
switch will also be passed in the invocation of
<samp><span class="command">Gnatlink.</span></samp>
<p>A final example illustrates switch contributions from packages in different
project files:
<pre class="smallexample"> project Proj3 is
for Source_Files use ("pack.ads", "pack.adb");
package Compiler is
for Default_Switches ("Ada")
use ("-gnata");
end Compiler;
end Proj3;
with "Proj3";
project Proj4 is
for Source_Files use ("foo_main.adb", "bar_main.adb");
package Builder is
for Switches ("foo_main.adb")
use ("-s",
"-g");
end Builder;
end Proj4;
-- Ada source file:
with Pack;
procedure Foo_Main is
...
end Foo_Main;
</pre>
<p class="noindent">If the command is
<pre class="smallexample"> gnatmake -PProj4 foo_main.adb -cargs -gnato
</pre>
<p class="noindent">then the switches passed to the compiler for <samp><span class="file">foo_main.adb</span></samp> are
<samp><span class="option">-g</span></samp> (contributed by the package <code>Proj4.Builder</code>) and
<samp><span class="option">-gnato</span></samp> (passed on the command line).
When the imported package <code>Pack</code> is compiled, the switches used
are <samp><span class="option">-g</span></samp> from <code>Proj4.Builder</code>,
<samp><span class="option">-gnata</span></samp> (contributed from package <code>Proj3.Compiler</code>,
and <samp><span class="option">-gnato</span></samp> from the command line.
<p>When using <samp><span class="command">gnatmake</span></samp> with project files, some switches or
arguments may be expressed as relative paths. As the working directory where
compilation occurs may change, these relative paths are converted to absolute
paths. For the switches found in a project file, the relative paths
are relative to the project file directory, for the switches on the command
line, they are relative to the directory where <samp><span class="command">gnatmake</span></samp> is invoked.
The switches for which this occurs are:
-I,
-A,
-L,
-aO,
-aL,
-aI, as well as all arguments that are not switches (arguments to
switch
-o, object files specified in package <code>Linker</code> or after
-largs on the command line). The exception to this rule is the switch
–RTS= for which a relative path argument is never converted.
<!-- -->
<div class="node">
<a name="Specifying-Configuration-Pragmas"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Project-Files-and-Main-Subprograms">Project Files and Main Subprograms</a>,
Previous: <a rel="previous" accesskey="p" href="#Switches-and-Project-Files">Switches and Project Files</a>,
Up: <a rel="up" accesskey="u" href="#gnatmake-and-Project-Files">gnatmake and Project Files</a>
</div>
<h4 class="subsection">12.1.3 Specifying Configuration Pragmas</h4>
<!-- -->
<p class="noindent">When using <samp><span class="command">gnatmake</span></samp> with project files, if there exists a file
<samp><span class="file">gnat.adc</span></samp> that contains configuration pragmas, this file will be
ignored.
<p>Configuration pragmas can be defined by means of the following attributes in
project files: <code>Global_Configuration_Pragmas</code> in package <code>Builder</code>
and <code>Local_Configuration_Pragmas</code> in package <code>Compiler</code>.
<p>Both these attributes are single string attributes. Their values is the path
name of a file containing configuration pragmas. If a path name is relative,
then it is relative to the project directory of the project file where the
attribute is defined.
<p>When compiling a source, the configuration pragmas used are, in order,
those listed in the file designated by attribute
<code>Global_Configuration_Pragmas</code> in package <code>Builder</code> of the main
project file, if it is specified, and those listed in the file designated by
attribute <code>Local_Configuration_Pragmas</code> in package <code>Compiler</code> of
the project file of the source, if it exists.
<!-- -->
<div class="node">
<a name="Project-Files-and-Main-Subprograms"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Library-Project-Files">Library Project Files</a>,
Previous: <a rel="previous" accesskey="p" href="#Specifying-Configuration-Pragmas">Specifying Configuration Pragmas</a>,
Up: <a rel="up" accesskey="u" href="#gnatmake-and-Project-Files">gnatmake and Project Files</a>
</div>
<h4 class="subsection">12.1.4 Project Files and Main Subprograms</h4>
<!-- -->
<p class="noindent">When using a project file, you can invoke <samp><span class="command">gnatmake</span></samp>
with one or several main subprograms, by specifying their source files on the
command line.
<pre class="smallexample"> gnatmake -Pprj main1 main2 main3
</pre>
<p class="noindent">Each of these needs to be a source file of the same project, except
when the switch -u is used.
<p>When -u is not used, all the mains need to be sources of the
same project, one of the project in the tree rooted at the project specified
on the command line. The package <code>Builder</code> of this common project, the
"main project" is the one that is considered by <samp><span class="command">gnatmake</span></samp>.
<p>When -u is used, the specified source files may be in projects
imported directly or indirectly by the project specified on the command line.
Note that if such a source file is not part of the project specified on the
command line, the switches found in package <code>Builder</code> of the
project specified on the command line, if any, that are transmitted
to the compiler will still be used, not those found in the project file of
the source file.
<p>When using a project file, you can also invoke <samp><span class="command">gnatmake</span></samp> without
explicitly specifying any main, and the effect depends on whether you have
defined the <code>Main</code> attribute. This attribute has a string list value,
where each element in the list is the name of a source file (the file
extension is optional) that contains a unit that can be a main subprogram.
<p>If the <code>Main</code> attribute is defined in a project file as a non-empty
string list and the switch <samp><span class="option">-u</span></samp> is not used on the command
line, then invoking <samp><span class="command">gnatmake</span></samp> with this project file but without any
main on the command line is equivalent to invoking <samp><span class="command">gnatmake</span></samp> with all
the file names in the <code>Main</code> attribute on the command line.
<p>Example:
<pre class="smallexample"> project Prj is
for Main use ("main1", "main2", "main3");
end Prj;
</pre>
<p class="noindent">With this project file, <code>"gnatmake -Pprj"</code>
is equivalent to
<code>"gnatmake -Pprj main1 main2 main3"</code>.
<p>When the project attribute <code>Main</code> is not specified, or is specified
as an empty string list, or when the switch <samp><span class="option">-u</span></samp> is used on the command
line, then invoking <samp><span class="command">gnatmake</span></samp> with no main on the command line will
result in all immediate sources of the project file being checked, and
potentially recompiled. Depending on the presence of the switch <samp><span class="option">-u</span></samp>,
sources from other project files on which the immediate sources of the main
project file depend are also checked and potentially recompiled. In other
words, the <samp><span class="option">-u</span></samp> switch is applied to all of the immediate sources of the
main project file.
<p>When no main is specified on the command line and attribute <code>Main</code> exists
and includes several mains, or when several mains are specified on the
command line, the default switches in package <code>Builder</code> will
be used for all mains, even if there are specific switches
specified for one or several mains.
<p>But the switches from package <code>Binder</code> or <code>Linker</code> will be
the specific switches for each main, if they are specified.
<!-- -->
<div class="node">
<a name="Library-Project-Files"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Project-Files-and-Main-Subprograms">Project Files and Main Subprograms</a>,
Up: <a rel="up" accesskey="u" href="#gnatmake-and-Project-Files">gnatmake and Project Files</a>
</div>
<h4 class="subsection">12.1.5 Library Project Files</h4>
<!-- -->
<p class="noindent">When <samp><span class="command">gnatmake</span></samp> is invoked with a main project file that is a library
project file, it is not allowed to specify one or more mains on the command
line.
<p>When a library project file is specified, switches -b and
-l have special meanings.
<ul>
<li>-b is only allowed for stand-alone libraries. It indicates
to <samp><span class="command">gnatmake</span></samp> that <samp><span class="command">gnatbind</span></samp> should be invoked for the
library.
<li>-l may be used for all library projects. It indicates
to <samp><span class="command">gnatmake</span></samp> that the binder generated file should be compiled
(in the case of a stand-alone library) and that the library should be built.
</ul>
<!-- -->
<div class="node">
<a name="The-GNAT-Driver-and-Project-Files"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#The-Development-Environments">The Development Environments</a>,
Previous: <a rel="previous" accesskey="p" href="#gnatmake-and-Project-Files">gnatmake and Project Files</a>,
Up: <a rel="up" accesskey="u" href="#Tools-Supporting-Project-Files">Tools Supporting Project Files</a>
</div>
<h3 class="section">12.2 The GNAT Driver and Project Files</h3>
<!-- -->
<p class="noindent">A number of GNAT tools, other than <samp><span class="command">gnatmake</span></samp>
can benefit from project files:
(<samp><span class="command">gnatbind</span></samp>,
<samp><span class="command">gnatcheck</span></samp>,
<samp><span class="command">gnatclean</span></samp>,
<samp><span class="command">gnatelim</span></samp>,
<samp><span class="command">gnatfind</span></samp>,
<samp><span class="command">gnatlink</span></samp>,
<samp><span class="command">gnatls</span></samp>,
<samp><span class="command">gnatmetric</span></samp>,
<samp><span class="command">gnatpp</span></samp>,
<samp><span class="command">gnatstub</span></samp>,
and <samp><span class="command">gnatxref</span></samp>). However, none of these tools can be invoked
directly with a project file switch (<samp><span class="option">-P</span></samp>).
They must be invoked through the <samp><span class="command">gnat</span></samp> driver.
<p>The <samp><span class="command">gnat</span></samp> driver is a wrapper that accepts a number of commands and
calls the corresponding tool. It was designed initially for VMS platforms (to
convert VMS qualifiers to Unix-style switches), but it is now available on all
GNAT platforms.
<p>On non-VMS platforms, the <samp><span class="command">gnat</span></samp> driver accepts the following commands
(case insensitive):
<ul>
<li>BIND to invoke <samp><span class="command">gnatbind</span></samp>
<li>CHOP to invoke <samp><span class="command">gnatchop</span></samp>
<li>CLEAN to invoke <samp><span class="command">gnatclean</span></samp>
<li>COMP or COMPILE to invoke the compiler
<li>ELIM to invoke <samp><span class="command">gnatelim</span></samp>
<li>FIND to invoke <samp><span class="command">gnatfind</span></samp>
<li>KR or KRUNCH to invoke <samp><span class="command">gnatkr</span></samp>
<li>LINK to invoke <samp><span class="command">gnatlink</span></samp>
<li>LS or LIST to invoke <samp><span class="command">gnatls</span></samp>
<li>MAKE to invoke <samp><span class="command">gnatmake</span></samp>
<li>NAME to invoke <samp><span class="command">gnatname</span></samp>
<li>PREP or PREPROCESS to invoke <samp><span class="command">gnatprep</span></samp>
<li>PP or PRETTY to invoke <samp><span class="command">gnatpp</span></samp>
<li>METRIC to invoke <samp><span class="command">gnatmetric</span></samp>
<li>STUB to invoke <samp><span class="command">gnatstub</span></samp>
<li>XREF to invoke <samp><span class="command">gnatxref</span></samp>
</ul>
<p class="noindent">(note that the compiler is invoked using the command
<samp><span class="command">gnatmake -f -u -c</span></samp>).
<p>On non-VMS platforms, between <samp><span class="command">gnat</span></samp> and the command, two
special switches may be used:
<ul>
<li><samp><span class="command">-v</span></samp> to display the invocation of the tool.
<li><samp><span class="command">-dn</span></samp> to prevent the <samp><span class="command">gnat</span></samp> driver from removing
the temporary files it has created. These temporary files are
configuration files and temporary file list files.
</ul>
<p class="noindent">The command may be followed by switches and arguments for the invoked
tool.
<pre class="smallexample"> gnat bind -C main.ali
gnat ls -a main
gnat chop foo.txt
</pre>
<p class="noindent">Switches may also be put in text files, one switch per line, and the text
files may be specified with their path name preceded by '@'.
<pre class="smallexample"> gnat bind @args.txt main.ali
</pre>
<p class="noindent">In addition, for commands BIND, COMP or COMPILE, FIND, ELIM, LS or LIST, LINK,
METRIC, PP or PRETTY, STUB and XREF, the project file related switches
(<samp><span class="option">-P</span></samp>,
<samp><span class="option">-X</span></samp> and
<samp><span class="option">-vPx</span></samp>) may be used in addition to
the switches of the invoking tool.
<p>When GNAT PP or GNAT PRETTY is used with a project file, but with no source
specified on the command line, it invokes <samp><span class="command">gnatpp</span></samp> with all
the immediate sources of the specified project file.
<p>When GNAT METRIC is used with a project file, but with no source
specified on the command line, it invokes <samp><span class="command">gnatmetric</span></samp>
with all the immediate sources of the specified project file and with
<samp><span class="option">-d</span></samp> with the parameter pointing to the object directory
of the project.
<p>In addition, when GNAT PP, GNAT PRETTY or GNAT METRIC is used with
a project file, no source is specified on the command line and
switch -U is specified on the command line, then
the underlying tool (gnatpp or
gnatmetric) is invoked for all sources of all projects,
not only for the immediate sources of the main project.
(-U stands for Universal or Union of the project files of the project tree)
<p>For each of the following commands, there is optionally a corresponding
package in the main project.
<ul>
<li>package <code>Binder</code> for command BIND (invoking <code>gnatbind</code>)
<li>package <code>Check</code> for command CHECK (invoking
<code>gnatcheck</code>)
<li>package <code>Compiler</code> for command COMP or COMPILE (invoking the compiler)
<li>package <code>Cross_Reference</code> for command XREF (invoking
<code>gnatxref</code>)
<li>package <code>Eliminate</code> for command ELIM (invoking
<code>gnatelim</code>)
<li>package <code>Finder</code> for command FIND (invoking <code>gnatfind</code>)
<li>package <code>Gnatls</code> for command LS or LIST (invoking <code>gnatls</code>)
<li>package <code>Gnatstub</code> for command STUB
(invoking <code>gnatstub</code>)
<li>package <code>Linker</code> for command LINK (invoking <code>gnatlink</code>)
<li>package <code>Check</code> for command CHECK
(invoking <code>gnatcheck</code>)
<li>package <code>Metrics</code> for command METRIC
(invoking <code>gnatmetric</code>)
<li>package <code>Pretty_Printer</code> for command PP or PRETTY
(invoking <code>gnatpp</code>)
</ul>
<p class="noindent">Package <code>Gnatls</code> has a unique attribute <code>Switches</code>,
a simple variable with a string list value. It contains switches
for the invocation of <code>gnatls</code>.
<pre class="smallexample"> project Proj1 is
package gnatls is
for Switches
use ("-a",
"-v");
end gnatls;
end Proj1;
</pre>
<p class="noindent">All other packages have two attribute <code>Switches</code> and
<code>Default_Switches</code>.
<p><code>Switches</code> is an indexed attribute, indexed by the
source file name, that has a string list value: the switches to be
used when the tool corresponding to the package is invoked for the specific
source file.
<p><code>Default_Switches</code> is an attribute,
indexed by the programming language that has a string list value.
<code>Default_Switches ("Ada")</code> contains the
switches for the invocation of the tool corresponding
to the package, except if a specific <code>Switches</code> attribute
is specified for the source file.
<pre class="smallexample"> project Proj is
for Source_Dirs use ("./**");
package gnatls is
for Switches use
("-a",
"-v");
end gnatls;
package Compiler is
for Default_Switches ("Ada")
use ("-gnatv",
"-gnatwa");
end Binder;
package Binder is
for Default_Switches ("Ada")
use ("-C",
"-e");
end Binder;
package Linker is
for Default_Switches ("Ada")
use ("-C");
for Switches ("main.adb")
use ("-C",
"-v",
"-v");
end Linker;
package Finder is
for Default_Switches ("Ada")
use ("-a",
"-f");
end Finder;
package Cross_Reference is
for Default_Switches ("Ada")
use ("-a",
"-f",
"-d",
"-u");
end Cross_Reference;
end Proj;
</pre>
<p class="noindent">With the above project file, commands such as
<pre class="smallexample"> gnat comp -Pproj main
gnat ls -Pproj main
gnat xref -Pproj main
gnat bind -Pproj main.ali
gnat link -Pproj main.ali
</pre>
<p class="noindent">will set up the environment properly and invoke the tool with the switches
found in the package corresponding to the tool:
<code>Default_Switches ("Ada")</code> for all tools,
except <code>Switches ("main.adb")</code>
for <code>gnatlink</code>.
It is also possible to invoke some of the tools,
(<code>gnatcheck</code>,
<code>gnatmetric</code>,
and <code>gnatpp</code>)
on a set of project units thanks to the combination of the switches
<samp><span class="option">-P</span></samp>, <samp><span class="option">-U</span></samp> and possibly the main unit when one is interested
in its closure. For instance,
<pre class="smallexample"> gnat metric -Pproj
</pre>
<p class="noindent">will compute the metrics for all the immediate units of project
<code>proj</code>.
<pre class="smallexample"> gnat metric -Pproj -U
</pre>
<p class="noindent">will compute the metrics for all the units of the closure of projects
rooted at <code>proj</code>.
<pre class="smallexample"> gnat metric -Pproj -U main_unit
</pre>
<p class="noindent">will compute the metrics for the closure of units rooted at
<code>main_unit</code>. This last possibility relies implicitly
on <samp><span class="command">gnatbind</span></samp>'s option <samp><span class="option">-R</span></samp>. But if the argument files for the
tool invoked by the <samp><span class="command">gnat</span></samp> driver are explicitly specified
either directly or through the tool <samp><span class="option">-files</span></samp> option, then the tool
is called only for these explicitly specified files.
<!-- -->
<div class="node">
<a name="The-Development-Environments"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Cleaning-up-with-GPRclean">Cleaning up with GPRclean</a>,
Previous: <a rel="previous" accesskey="p" href="#The-GNAT-Driver-and-Project-Files">The GNAT Driver and Project Files</a>,
Up: <a rel="up" accesskey="u" href="#Tools-Supporting-Project-Files">Tools Supporting Project Files</a>
</div>
<h3 class="section">12.3 The Development Environments</h3>
<!-- -->
<p class="noindent">See the appropriate manuals for more details. These environments will
store a number of settings in the project itself, when they are meant
to be shared by the whole team working on the project. Here are the
attributes defined in the package <b>IDE</b> in projects.
<dl>
<dt><code>Remote_Host</code><dd>This is a simple attribute. Its value is a string that designates the remote
host in a cross-compilation environment, to be used for remote compilation and
debugging. This field should not be specified when running on the local
machine.
<br><dt><code>Program_Host</code><dd>This is a simple attribute. Its value is a string that specifies the
name of IP address of the embedded target in a cross-compilation environment,
on which the program should execute.
<br><dt><code>Communication_Protocol</code><dd>This is a simple string attribute. Its value is the name of the protocol
to use to communicate with the target in a cross-compilation environment,
e.g. <code>"wtx"</code> or <code>"vxworks"</code>.
<br><dt><code>Compiler_Command</code><dd>This is an associative array attribute, whose domain is a language name. Its
value is string that denotes the command to be used to invoke the compiler.
The value of <code>Compiler_Command ("Ada")</code> is expected to be compatible with
gnatmake, in particular in the handling of switches.
<br><dt><code>Debugger_Command</code><dd>This is simple attribute, Its value is a string that specifies the name of
the debugger to be used, such as gdb, powerpc-wrs-vxworks-gdb or gdb-4.
<br><dt><code>Default_Switches</code><dd>This is an associative array attribute. Its indexes are the name of the
external tools that the GNAT Programming System (GPS) is supporting. Its
value is a list of switches to use when invoking that tool.
<br><dt><code>Gnatlist</code><dd>This is a simple attribute. Its value is a string that specifies the name
of the <samp><span class="command">gnatls</span></samp> utility to be used to retrieve information about the
predefined path; e.g., <code>"gnatls"</code>, <code>"powerpc-wrs-vxworks-gnatls"</code>.
<br><dt><code>VCS_Kind</code><dd>This is a simple attribute. Its value is a string used to specify the
Version Control System (VCS) to be used for this project, e.g. CVS, RCS
ClearCase or Perforce.
<br><dt><code>VCS_File_Check</code><dd>This is a simple attribute. Its value is a string that specifies the
command used by the VCS to check the validity of a file, either
when the user explicitly asks for a check, or as a sanity check before
doing the check-in.
<br><dt><code>VCS_Log_Check</code><dd>This is a simple attribute. Its value is a string that specifies
the command used by the VCS to check the validity of a log file.
<br><dt><code>VCS_Repository_Root</code><dd>The VCS repository root path. This is used to create tags or branches
of the repository. For subversion the value should be the <code>URL</code>
as specified to check-out the working copy of the repository.
<br><dt><code>VCS_Patch_Root</code><dd>The local root directory to use for building patch file. All patch chunks
will be relative to this path. The root project directory is used if
this value is not defined.
</dl>
<!-- -->
<div class="node">
<a name="Cleaning-up-with-GPRclean"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#The-Development-Environments">The Development Environments</a>,
Up: <a rel="up" accesskey="u" href="#Tools-Supporting-Project-Files">Tools Supporting Project Files</a>
</div>
<h3 class="section">12.4 Cleaning up with GPRclean</h3>
<!-- -->
<p class="noindent">The GPRclean tool removes the files created by GPRbuild.
At a minimum, to invoke GPRclean you must specify a main project file
in a command such as <code>gprclean proj.gpr</code> or <code>gprclean -P proj.gpr</code>.
<p>Examples of invocation of GPRclean:
<pre class="smallexample"> gprclean -r prj1.gpr
gprclean -c -P prj2.gpr
</pre>
<ul class="menu">
<li><a accesskey="1" href="#Switches-for-GPRclean">Switches for GPRclean</a>
</ul>
<!-- -->
<div class="node">
<a name="Switches-for-GPRclean"></a>
<p><hr>
Up: <a rel="up" accesskey="u" href="#Cleaning-up-with-GPRclean">Cleaning up with GPRclean</a>
</div>
<h4 class="subsection">12.4.1 Switches for GPRclean</h4>
<!-- -->
<p class="noindent">The switches for GPRclean are:
<ul>
<li><samp><span class="option">--config=<main config project file name></span></samp> : Specify the
configuration project file name
<li><samp><span class="option">--autoconf=<config project file name></span></samp>
<p>This specifies a configuration project file name that already exists or will
be created automatically. Option <samp><span class="option">--autoconf=</span></samp>
cannot be specified more than once. If the configuration project file
specified with <samp><span class="option">--autoconf=</span></samp> exists, then it is used. Otherwise,
GPRconfig is invoked to create it automatically.
<li><samp><span class="option">-c</span></samp> : Only delete compiler-generated files. Do not delete
executables and libraries.
<li><samp><span class="option">-f</span></samp> : Force deletions of unwritable files
<li><samp><span class="option">-F</span></samp> : Display full project path name in brief error messages
<li><samp><span class="option">-h</span></samp> : Display this message
<li><samp><span class="option">-n</span></samp> : Do not delete files, only list files to delete
<li><samp><span class="option">-P<proj></span></samp> : Use Project File <em><proj></em>.
<li><samp><span class="option">-q</span></samp> : Be quiet/terse. There is no output, except to report
problems.
<li><samp><span class="option">-r</span></samp> : (recursive) Clean all projects referenced by the main
project directly or indirectly. Without this switch, GPRclean only
cleans the main project.
<li><samp><span class="option">-v</span></samp> : Verbose mode
<li><samp><span class="option">-vPx</span></samp> : Specify verbosity when parsing Project Files.
x = 0 (default), 1 or 2.
<li><samp><span class="option">-Xnm=val</span></samp> : Specify an external reference for Project Files.
</ul>
<!-- ***************************************** -->
<!-- * Cross-referencing tools -->
<!-- ***************************************** -->
<div class="node">
<a name="The-Cross-Referencing-Tools-gnatxref-and-gnatfind"></a>
<a name="The-Cross_002dReferencing-Tools-gnatxref-and-gnatfind"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#The-GNAT-Pretty_002dPrinter-gnatpp">The GNAT Pretty-Printer gnatpp</a>,
Previous: <a rel="previous" accesskey="p" href="#Tools-Supporting-Project-Files">Tools Supporting Project Files</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">13 The Cross-Referencing Tools <code>gnatxref</code> and <code>gnatfind</code></h2>
<p><a name="index-gnatxref-708"></a><a name="index-gnatfind-709"></a>
The compiler generates cross-referencing information (unless
you set the ‘<samp><span class="samp">-gnatx</span></samp>’ switch), which are saved in the <samp><span class="file">.ali</span></samp> files.
This information indicates where in the source each entity is declared and
referenced. Note that entities in package Standard are not included, but
entities in all other predefined units are included in the output.
<p>Before using any of these two tools, you need to compile successfully your
application, so that GNAT gets a chance to generate the cross-referencing
information.
<p>The two tools <code>gnatxref</code> and <code>gnatfind</code> take advantage of this
information to provide the user with the capability to easily locate the
declaration and references to an entity. These tools are quite similar,
the difference being that <code>gnatfind</code> is intended for locating
definitions and/or references to a specified entity or entities, whereas
<code>gnatxref</code> is oriented to generating a full report of all
cross-references.
<p>To use these tools, you must not compile your application using the
<samp><span class="option">-gnatx</span></samp> switch on the <samp><span class="command">gnatmake</span></samp> command line
(see <a href="#The-GNAT-Make-Program-gnatmake">The GNAT Make Program gnatmake</a>). Otherwise, cross-referencing
information will not be generated.
<p>Note: to invoke <code>gnatxref</code> or <code>gnatfind</code> with a project file,
use the <code>gnat</code> driver (see <a href="#The-GNAT-Driver-and-Project-Files">The GNAT Driver and Project Files</a>).
<ul class="menu">
<li><a accesskey="1" href="#Switches-for-gnatxref">Switches for gnatxref</a>
<li><a accesskey="2" href="#Switches-for-gnatfind">Switches for gnatfind</a>
<li><a accesskey="3" href="#Project-Files-for-gnatxref-and-gnatfind">Project Files for gnatxref and gnatfind</a>
<li><a accesskey="4" href="#Regular-Expressions-in-gnatfind-and-gnatxref">Regular Expressions in gnatfind and gnatxref</a>
<li><a accesskey="5" href="#Examples-of-gnatxref-Usage">Examples of gnatxref Usage</a>
<li><a accesskey="6" href="#Examples-of-gnatfind-Usage">Examples of gnatfind Usage</a>
</ul>
<div class="node">
<a name="Switches-for-gnatxref"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Switches-for-gnatfind">Switches for gnatfind</a>,
Up: <a rel="up" accesskey="u" href="#The-Cross_002dReferencing-Tools-gnatxref-and-gnatfind">The Cross-Referencing Tools gnatxref and gnatfind</a>
</div>
<h3 class="section">13.1 <code>gnatxref</code> Switches</h3>
<p class="noindent">The command invocation for <code>gnatxref</code> is:
<pre class="smallexample"> <!-- $ gnatxref @ovar{switches} @var{sourcefile1} @r{[}@var{sourcefile2} @dots{}@r{]} -->
<!-- Expanding @ovar macro inline (explanation in macro def comments) -->
$ gnatxref <span class="roman">[</span><var>switches</var><span class="roman">]</span> <var>sourcefile1</var> <span class="roman">[</span><var>sourcefile2</var> ...<span class="roman">]</span>
</pre>
<p class="noindent">where
<dl>
<dt><var>sourcefile1</var><dt><var>sourcefile2</var><dd>identifies the source files for which a report is to be generated. The
“with”ed units will be processed too. You must provide at least one file.
<p>These file names are considered to be regular expressions, so for instance
specifying <samp><span class="file">source*.adb</span></samp> is the same as giving every file in the current
directory whose name starts with <samp><span class="file">source</span></samp> and whose extension is
<samp><span class="file">adb</span></samp>.
<p>You shouldn't specify any directory name, just base names. <samp><span class="command">gnatxref</span></samp>
and <samp><span class="command">gnatfind</span></samp> will be able to locate these files by themselves using
the source path. If you specify directories, no result is produced.
</dl>
<p class="noindent">The switches can be:
<dl>
<!-- !sort! -->
<dt><samp><span class="option">--version</span></samp><dd><a name="index-g_t_0040option_007b_002d_002dversion_007d-_0040command_007bgnatxref_007d-710"></a>Display Copyright and version, then exit disregarding all other options.
<br><dt><samp><span class="option">--help</span></samp><dd><a name="index-g_t_0040option_007b_002d_002dhelp_007d-_0040command_007bgnatxref_007d-711"></a>If <samp><span class="option">--version</span></samp> was not used, display usage, then exit disregarding
all other options.
<br><dt><samp><span class="option">-a</span></samp><dd><a name="index-g_t_0040option_007b_002da_007d-_0028_0040command_007bgnatxref_007d_0029-712"></a>If this switch is present, <code>gnatfind</code> and <code>gnatxref</code> will parse
the read-only files found in the library search path. Otherwise, these files
will be ignored. This option can be used to protect Gnat sources or your own
libraries from being parsed, thus making <code>gnatfind</code> and <code>gnatxref</code>
much faster, and their output much smaller. Read-only here refers to access
or permissions status in the file system for the current user.
<br><dt><samp><span class="option">-aIDIR</span></samp><dd><a name="index-g_t_0040option_007b_002daIDIR_007d-_0028_0040command_007bgnatxref_007d_0029-713"></a>When looking for source files also look in directory DIR. The order in which
source file search is undertaken is the same as for <samp><span class="command">gnatmake</span></samp>.
<br><dt><samp><span class="option">-aODIR</span></samp><dd><a name="index-g_t_0040option_007b_002daODIR_007d-_0028_0040command_007bgnatxref_007d_0029-714"></a>When searching for library and object files, look in directory
DIR. The order in which library files are searched is the same as for
<samp><span class="command">gnatmake</span></samp>.
<br><dt><samp><span class="option">-nostdinc</span></samp><dd><a name="index-g_t_0040option_007b_002dnostdinc_007d-_0028_0040command_007bgnatxref_007d_0029-715"></a>Do not look for sources in the system default directory.
<br><dt><samp><span class="option">-nostdlib</span></samp><dd><a name="index-g_t_0040option_007b_002dnostdlib_007d-_0028_0040command_007bgnatxref_007d_0029-716"></a>Do not look for library files in the system default directory.
<br><dt><samp><span class="option">--ext=</span><var>extension</var></samp><dd><a name="index-g_t_0040option_007b_002d_002dext_007d-_0028_0040command_007bgnatxref_007d_0029-717"></a>Specify an alternate ali file extension. The default is <code>ali</code> and other
extensions (e.g. <code>sli</code> for SPARK library files) may be specified via this
switch. Note that if this switch overrides the default, which means that only
the new extension will be considered.
<br><dt><samp><span class="option">--RTS=</span><var>rts-path</var></samp><dd><a name="index-g_t_0040option_007b_002d_002dRTS_007d-_0028_0040command_007bgnatxref_007d_0029-718"></a>Specifies the default location of the runtime library. Same meaning as the
equivalent <samp><span class="command">gnatmake</span></samp> flag (see <a href="#Switches-for-gnatmake">Switches for gnatmake</a>).
<br><dt><samp><span class="option">-d</span></samp><dd><a name="index-g_t_0040option_007b_002dd_007d-_0028_0040command_007bgnatxref_007d_0029-719"></a>If this switch is set <code>gnatxref</code> will output the parent type
reference for each matching derived types.
<br><dt><samp><span class="option">-f</span></samp><dd><a name="index-g_t_0040option_007b_002df_007d-_0028_0040command_007bgnatxref_007d_0029-720"></a>If this switch is set, the output file names will be preceded by their
directory (if the file was found in the search path). If this switch is
not set, the directory will not be printed.
<br><dt><samp><span class="option">-g</span></samp><dd><a name="index-g_t_0040option_007b_002dg_007d-_0028_0040command_007bgnatxref_007d_0029-721"></a>If this switch is set, information is output only for library-level
entities, ignoring local entities. The use of this switch may accelerate
<code>gnatfind</code> and <code>gnatxref</code>.
<br><dt><samp><span class="option">-IDIR</span></samp><dd><a name="index-g_t_0040option_007b_002dIDIR_007d-_0028_0040command_007bgnatxref_007d_0029-722"></a>Equivalent to ‘<samp><span class="samp">-aODIR -aIDIR</span></samp>’.
<br><dt><samp><span class="option">-pFILE</span></samp><dd><a name="index-g_t_0040option_007b_002dpFILE_007d-_0028_0040command_007bgnatxref_007d_0029-723"></a>Specify a project file to use See <a href="#GNAT-Project-Manager">GNAT Project Manager</a>.
If you need to use the <samp><span class="file">.gpr</span></samp>
project files, you should use gnatxref through the GNAT driver
(<samp><span class="command">gnat xref -Pproject</span></samp>).
<p>By default, <code>gnatxref</code> and <code>gnatfind</code> will try to locate a
project file in the current directory.
<p>If a project file is either specified or found by the tools, then the content
of the source directory and object directory lines are added as if they
had been specified respectively by ‘<samp><span class="samp">-aI</span></samp>’
and ‘<samp><span class="samp">-aO</span></samp>’.
<br><dt><samp><span class="option">-u</span></samp><dd>Output only unused symbols. This may be really useful if you give your
main compilation unit on the command line, as <code>gnatxref</code> will then
display every unused entity and 'with'ed package.
<br><dt><samp><span class="option">-v</span></samp><dd>Instead of producing the default output, <code>gnatxref</code> will generate a
<samp><span class="file">tags</span></samp> file that can be used by vi. For examples how to use this
feature, see <a href="#Examples-of-gnatxref-Usage">Examples of gnatxref Usage</a>. The tags file is output
to the standard output, thus you will have to redirect it to a file.
</dl>
<p class="noindent">All these switches may be in any order on the command line, and may even
appear after the file names. They need not be separated by spaces, thus
you can say ‘<samp><span class="samp">gnatxref -ag</span></samp>’ instead of
‘<samp><span class="samp">gnatxref -a -g</span></samp>’.
<div class="node">
<a name="Switches-for-gnatfind"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Project-Files-for-gnatxref-and-gnatfind">Project Files for gnatxref and gnatfind</a>,
Previous: <a rel="previous" accesskey="p" href="#Switches-for-gnatxref">Switches for gnatxref</a>,
Up: <a rel="up" accesskey="u" href="#The-Cross_002dReferencing-Tools-gnatxref-and-gnatfind">The Cross-Referencing Tools gnatxref and gnatfind</a>
</div>
<h3 class="section">13.2 <code>gnatfind</code> Switches</h3>
<p class="noindent">The command line for <code>gnatfind</code> is:
<pre class="smallexample"> <!-- $ gnatfind @ovar{switches} @var{pattern}@r{[}:@var{sourcefile}@r{[}:@var{line}@r{[}:@var{column}@r{]]]} -->
<!-- @r{[}@var{file1} @var{file2} @dots{}] -->
<!-- Expanding @ovar macro inline (explanation in macro def comments) -->
$ gnatfind <span class="roman">[</span><var>switches</var><span class="roman">]</span> <var>pattern</var><span class="roman">[</span>:<var>sourcefile</var><span class="roman">[</span>:<var>line</var><span class="roman">[</span>:<var>column</var><span class="roman">]]]</span>
<span class="roman">[</span><var>file1</var> <var>file2</var> ...<span class="roman">]</span>
</pre>
<p class="noindent">where
<dl>
<dt><var>pattern</var><dd>An entity will be output only if it matches the regular expression found
in <var>pattern</var>, see <a href="#Regular-Expressions-in-gnatfind-and-gnatxref">Regular Expressions in gnatfind and gnatxref</a>.
<p>Omitting the pattern is equivalent to specifying ‘<samp><span class="samp">*</span></samp>’, which
will match any entity. Note that if you do not provide a pattern, you
have to provide both a sourcefile and a line.
<p>Entity names are given in Latin-1, with uppercase/lowercase equivalence
for matching purposes. At the current time there is no support for
8-bit codes other than Latin-1, or for wide characters in identifiers.
<br><dt><var>sourcefile</var><dd><code>gnatfind</code> will look for references, bodies or declarations
of symbols referenced in <samp><var>sourcefile</var></samp>, at line <var>line</var>
and column <var>column</var>. See <a href="#Examples-of-gnatfind-Usage">Examples of gnatfind Usage</a>
for syntax examples.
<br><dt><var>line</var><dd>is a decimal integer identifying the line number containing
the reference to the entity (or entities) to be located.
<br><dt><var>column</var><dd>is a decimal integer identifying the exact location on the
line of the first character of the identifier for the
entity reference. Columns are numbered from 1.
<br><dt><var>file1 file2 <small class="dots">...</small></var><dd>The search will be restricted to these source files. If none are given, then
the search will be done for every library file in the search path.
These file must appear only after the pattern or sourcefile.
<p>These file names are considered to be regular expressions, so for instance
specifying <samp><span class="file">source*.adb</span></samp> is the same as giving every file in the current
directory whose name starts with <samp><span class="file">source</span></samp> and whose extension is
<samp><span class="file">adb</span></samp>.
<p>The location of the spec of the entity will always be displayed, even if it
isn't in one of <samp><var>file1</var></samp>, <samp><var>file2</var></samp>,<small class="enddots">...</small> The
occurrences of the entity in the separate units of the ones given on the
command line will also be displayed.
<p>Note that if you specify at least one file in this part, <code>gnatfind</code> may
sometimes not be able to find the body of the subprograms.
</dl>
<p class="noindent">At least one of 'sourcefile' or 'pattern' has to be present on
the command line.
<p>The following switches are available:
<dl>
<!-- !sort! -->
<p><a name="index-g_t_0040option_007b_002d_002dversion_007d-_0040command_007bgnatfind_007d-724"></a>Display Copyright and version, then exit disregarding all other options.
<dt><samp><span class="option">--help</span></samp><dd><a name="index-g_t_0040option_007b_002d_002dhelp_007d-_0040command_007bgnatfind_007d-725"></a>If <samp><span class="option">--version</span></samp> was not used, display usage, then exit disregarding
all other options.
<br><dt><samp><span class="option">-a</span></samp><dd><a name="index-g_t_0040option_007b_002da_007d-_0028_0040command_007bgnatfind_007d_0029-726"></a>If this switch is present, <code>gnatfind</code> and <code>gnatxref</code> will parse
the read-only files found in the library search path. Otherwise, these files
will be ignored. This option can be used to protect Gnat sources or your own
libraries from being parsed, thus making <code>gnatfind</code> and <code>gnatxref</code>
much faster, and their output much smaller. Read-only here refers to access
or permission status in the file system for the current user.
<br><dt><samp><span class="option">-aIDIR</span></samp><dd><a name="index-g_t_0040option_007b_002daIDIR_007d-_0028_0040command_007bgnatfind_007d_0029-727"></a>When looking for source files also look in directory DIR. The order in which
source file search is undertaken is the same as for <samp><span class="command">gnatmake</span></samp>.
<br><dt><samp><span class="option">-aODIR</span></samp><dd><a name="index-g_t_0040option_007b_002daODIR_007d-_0028_0040command_007bgnatfind_007d_0029-728"></a>When searching for library and object files, look in directory
DIR. The order in which library files are searched is the same as for
<samp><span class="command">gnatmake</span></samp>.
<br><dt><samp><span class="option">-nostdinc</span></samp><dd><a name="index-g_t_0040option_007b_002dnostdinc_007d-_0028_0040command_007bgnatfind_007d_0029-729"></a>Do not look for sources in the system default directory.
<br><dt><samp><span class="option">-nostdlib</span></samp><dd><a name="index-g_t_0040option_007b_002dnostdlib_007d-_0028_0040command_007bgnatfind_007d_0029-730"></a>Do not look for library files in the system default directory.
<br><dt><samp><span class="option">--ext=</span><var>extension</var></samp><dd><a name="index-g_t_0040option_007b_002d_002dext_007d-_0028_0040command_007bgnatfind_007d_0029-731"></a>Specify an alternate ali file extension. The default is <code>ali</code> and other
extensions (e.g. <code>sli</code> for SPARK library files) may be specified via this
switch. Note that if this switch overrides the default, which means that only
the new extension will be considered.
<br><dt><samp><span class="option">--RTS=</span><var>rts-path</var></samp><dd><a name="index-g_t_0040option_007b_002d_002dRTS_007d-_0028_0040command_007bgnatfind_007d_0029-732"></a>Specifies the default location of the runtime library. Same meaning as the
equivalent <samp><span class="command">gnatmake</span></samp> flag (see <a href="#Switches-for-gnatmake">Switches for gnatmake</a>).
<br><dt><samp><span class="option">-d</span></samp><dd><a name="index-g_t_0040option_007b_002dd_007d-_0028_0040code_007bgnatfind_007d_0029-733"></a>If this switch is set, then <code>gnatfind</code> will output the parent type
reference for each matching derived types.
<br><dt><samp><span class="option">-e</span></samp><dd><a name="index-g_t_0040option_007b_002de_007d-_0028_0040command_007bgnatfind_007d_0029-734"></a>By default, <code>gnatfind</code> accept the simple regular expression set for
‘<samp><span class="samp">pattern</span></samp>’. If this switch is set, then the pattern will be
considered as full Unix-style regular expression.
<br><dt><samp><span class="option">-f</span></samp><dd><a name="index-g_t_0040option_007b_002df_007d-_0028_0040command_007bgnatfind_007d_0029-735"></a>If this switch is set, the output file names will be preceded by their
directory (if the file was found in the search path). If this switch is
not set, the directory will not be printed.
<br><dt><samp><span class="option">-g</span></samp><dd><a name="index-g_t_0040option_007b_002dg_007d-_0028_0040command_007bgnatfind_007d_0029-736"></a>If this switch is set, information is output only for library-level
entities, ignoring local entities. The use of this switch may accelerate
<code>gnatfind</code> and <code>gnatxref</code>.
<br><dt><samp><span class="option">-IDIR</span></samp><dd><a name="index-g_t_0040option_007b_002dIDIR_007d-_0028_0040command_007bgnatfind_007d_0029-737"></a>Equivalent to ‘<samp><span class="samp">-aODIR -aIDIR</span></samp>’.
<br><dt><samp><span class="option">-pFILE</span></samp><dd><a name="index-g_t_0040option_007b_002dpFILE_007d-_0028_0040command_007bgnatfind_007d_0029-738"></a>Specify a project file (see <a href="#GNAT-Project-Manager">GNAT Project Manager</a>) to use.
By default, <code>gnatxref</code> and <code>gnatfind</code> will try to locate a
project file in the current directory.
<p>If a project file is either specified or found by the tools, then the content
of the source directory and object directory lines are added as if they
had been specified respectively by ‘<samp><span class="samp">-aI</span></samp>’ and
‘<samp><span class="samp">-aO</span></samp>’.
<br><dt><samp><span class="option">-r</span></samp><dd><a name="index-g_t_0040option_007b_002dr_007d-_0028_0040command_007bgnatfind_007d_0029-739"></a>By default, <code>gnatfind</code> will output only the information about the
declaration, body or type completion of the entities. If this switch is
set, the <code>gnatfind</code> will locate every reference to the entities in
the files specified on the command line (or in every file in the search
path if no file is given on the command line).
<br><dt><samp><span class="option">-s</span></samp><dd><a name="index-g_t_0040option_007b_002ds_007d-_0028_0040command_007bgnatfind_007d_0029-740"></a>If this switch is set, then <code>gnatfind</code> will output the content
of the Ada source file lines were the entity was found.
<br><dt><samp><span class="option">-t</span></samp><dd><a name="index-g_t_0040option_007b_002dt_007d-_0028_0040command_007bgnatfind_007d_0029-741"></a>If this switch is set, then <code>gnatfind</code> will output the type hierarchy for
the specified type. It act like -d option but recursively from parent
type to parent type. When this switch is set it is not possible to
specify more than one file.
</dl>
<p class="noindent">All these switches may be in any order on the command line, and may even
appear after the file names. They need not be separated by spaces, thus
you can say ‘<samp><span class="samp">gnatxref -ag</span></samp>’ instead of
‘<samp><span class="samp">gnatxref -a -g</span></samp>’.
<p>As stated previously, gnatfind will search in every directory in the
search path. You can force it to look only in the current directory if
you specify <code>*</code> at the end of the command line.
<div class="node">
<a name="Project-Files-for-gnatxref-and-gnatfind"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Regular-Expressions-in-gnatfind-and-gnatxref">Regular Expressions in gnatfind and gnatxref</a>,
Previous: <a rel="previous" accesskey="p" href="#Switches-for-gnatfind">Switches for gnatfind</a>,
Up: <a rel="up" accesskey="u" href="#The-Cross_002dReferencing-Tools-gnatxref-and-gnatfind">The Cross-Referencing Tools gnatxref and gnatfind</a>
</div>
<h3 class="section">13.3 Project Files for <samp><span class="command">gnatxref</span></samp> and <samp><span class="command">gnatfind</span></samp></h3>
<p class="noindent">Project files allow a programmer to specify how to compile its
application, where to find sources, etc. These files are used
primarily by GPS, but they can also be used
by the two tools
<code>gnatxref</code> and <code>gnatfind</code>.
<p>A project file name must end with <samp><span class="file">.gpr</span></samp>. If a single one is
present in the current directory, then <code>gnatxref</code> and <code>gnatfind</code> will
extract the information from it. If multiple project files are found, none of
them is read, and you have to use the ‘<samp><span class="samp">-p</span></samp>’ switch to specify the one
you want to use.
<p>The following lines can be included, even though most of them have default
values which can be used in most cases.
The lines can be entered in any order in the file.
Except for <samp><span class="file">src_dir</span></samp> and <samp><span class="file">obj_dir</span></samp>, you can only have one instance of
each line. If you have multiple instances, only the last one is taken into
account.
<dl>
<dt><code>src_dir=DIR</code><dd>[default: <code>"./"</code>]
specifies a directory where to look for source files. Multiple <code>src_dir</code>
lines can be specified and they will be searched in the order they
are specified.
<br><dt><code>obj_dir=DIR</code><dd>[default: <code>"./"</code>]
specifies a directory where to look for object and library files. Multiple
<code>obj_dir</code> lines can be specified, and they will be searched in the order
they are specified
<br><dt><code>comp_opt=SWITCHES</code><dd>[default: <code>""</code>]
creates a variable which can be referred to subsequently by using
the <code>${comp_opt}</code> notation. This is intended to store the default
switches given to <samp><span class="command">gnatmake</span></samp> and <samp><span class="command">gcc</span></samp>.
<br><dt><code>bind_opt=SWITCHES</code><dd>[default: <code>""</code>]
creates a variable which can be referred to subsequently by using
the ‘<samp><span class="samp">${bind_opt}</span></samp>’ notation. This is intended to store the default
switches given to <samp><span class="command">gnatbind</span></samp>.
<br><dt><code>link_opt=SWITCHES</code><dd>[default: <code>""</code>]
creates a variable which can be referred to subsequently by using
the ‘<samp><span class="samp">${link_opt}</span></samp>’ notation. This is intended to store the default
switches given to <samp><span class="command">gnatlink</span></samp>.
<br><dt><code>main=EXECUTABLE</code><dd>[default: <code>""</code>]
specifies the name of the executable for the application. This variable can
be referred to in the following lines by using the ‘<samp><span class="samp">${main}</span></samp>’ notation.
<br><dt><code>comp_cmd=COMMAND</code><dd>[default: <code>"gcc -c -I${src_dir} -g -gnatq"</code>]
specifies the command used to compile a single file in the application.
<br><dt><code>make_cmd=COMMAND</code><dd>[default: <code>"gnatmake ${main} -aI${src_dir}
-aO${obj_dir} -g -gnatq -cargs ${comp_opt}
-bargs ${bind_opt} -largs ${link_opt}"</code>]
specifies the command used to recompile the whole application.
<br><dt><code>run_cmd=COMMAND</code><dd>[default: <code>"${main}"</code>]
specifies the command used to run the application.
<br><dt><code>debug_cmd=COMMAND</code><dd>[default: <code>"gdb ${main}"</code>]
specifies the command used to debug the application
</dl>
<p class="noindent"><samp><span class="command">gnatxref</span></samp> and <samp><span class="command">gnatfind</span></samp> only take into account the
<code>src_dir</code> and <code>obj_dir</code> lines, and ignore the others.
<div class="node">
<a name="Regular-Expressions-in-gnatfind-and-gnatxref"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Examples-of-gnatxref-Usage">Examples of gnatxref Usage</a>,
Previous: <a rel="previous" accesskey="p" href="#Project-Files-for-gnatxref-and-gnatfind">Project Files for gnatxref and gnatfind</a>,
Up: <a rel="up" accesskey="u" href="#The-Cross_002dReferencing-Tools-gnatxref-and-gnatfind">The Cross-Referencing Tools gnatxref and gnatfind</a>
</div>
<h3 class="section">13.4 Regular Expressions in <code>gnatfind</code> and <code>gnatxref</code></h3>
<p class="noindent">As specified in the section about <samp><span class="command">gnatfind</span></samp>, the pattern can be a
regular expression. Actually, there are to set of regular expressions
which are recognized by the program:
<dl>
<dt><code>globbing patterns</code><dd>These are the most usual regular expression. They are the same that you
generally used in a Unix shell command line, or in a DOS session.
<p>Here is a more formal grammar:
<pre class="smallexample"> regexp ::= term
term ::= elmt -- matches elmt
term ::= elmt elmt -- concatenation (elmt then elmt)
term ::= * -- any string of 0 or more characters
term ::= ? -- matches any character
term ::= [char {char}] -- matches any character listed
term ::= [char - char] -- matches any character in range
</pre>
<br><dt><code>full regular expression</code><dd>The second set of regular expressions is much more powerful. This is the
type of regular expressions recognized by utilities such a <samp><span class="file">grep</span></samp>.
<p>The following is the form of a regular expression, expressed in Ada
reference manual style BNF is as follows
<pre class="smallexample"> regexp ::= term {| term} -- alternation (term or term ...)
term ::= item {item} -- concatenation (item then item)
item ::= elmt -- match elmt
item ::= elmt * -- zero or more elmt's
item ::= elmt + -- one or more elmt's
item ::= elmt ? -- matches elmt or nothing
elmt ::= nschar -- matches given character
elmt ::= [nschar {nschar}] -- matches any character listed
elmt ::= [^ nschar {nschar}] -- matches any character not listed
elmt ::= [char - char] -- matches chars in given range
elmt ::= \ char -- matches given character
elmt ::= . -- matches any single character
elmt ::= ( regexp ) -- parens used for grouping
char ::= any character, including special characters
nschar ::= any character except ()[].*+?^
</pre>
<p>Following are a few examples:
<dl>
<dt>‘<samp><span class="samp">abcde|fghi</span></samp>’<dd>will match any of the two strings ‘<samp><span class="samp">abcde</span></samp>’ and ‘<samp><span class="samp">fghi</span></samp>’,
<br><dt>‘<samp><span class="samp">abc*d</span></samp>’<dd>will match any string like ‘<samp><span class="samp">abd</span></samp>’, ‘<samp><span class="samp">abcd</span></samp>’, ‘<samp><span class="samp">abccd</span></samp>’,
‘<samp><span class="samp">abcccd</span></samp>’, and so on,
<br><dt>‘<samp><span class="samp">[a-z]+</span></samp>’<dd>will match any string which has only lowercase characters in it (and at
least one character.
</dl>
</dl>
<div class="node">
<a name="Examples-of-gnatxref-Usage"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Examples-of-gnatfind-Usage">Examples of gnatfind Usage</a>,
Previous: <a rel="previous" accesskey="p" href="#Regular-Expressions-in-gnatfind-and-gnatxref">Regular Expressions in gnatfind and gnatxref</a>,
Up: <a rel="up" accesskey="u" href="#The-Cross_002dReferencing-Tools-gnatxref-and-gnatfind">The Cross-Referencing Tools gnatxref and gnatfind</a>
</div>
<h3 class="section">13.5 Examples of <code>gnatxref</code> Usage</h3>
<h4 class="subsection">13.5.1 General Usage</h4>
<p class="noindent">For the following examples, we will consider the following units:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
main.ads:
1: with Bar;
2: package Main is
3: procedure Foo (B : in Integer);
4: C : Integer;
5: private
6: D : Integer;
7: end Main;
main.adb:
1: package body Main is
2: procedure Foo (B : in Integer) is
3: begin
4: C := B;
5: D := B;
6: Bar.Print (B);
7: Bar.Print (C);
8: end Foo;
9: end Main;
bar.ads:
1: package Bar is
2: procedure Print (B : Integer);
3: end bar;
</td></tr></table>
</pre>
<dl>
The first thing to do is to recompile your application (for instance, in
that case just by doing a ‘<samp><span class="samp">gnatmake main</span></samp>’, so that GNAT generates
the cross-referencing information.
You can then issue any of the following commands:
<dt><code>gnatxref main.adb</code><dd><code>gnatxref</code> generates cross-reference information for main.adb
and every unit 'with'ed by main.adb.
<p>The output would be:
<pre class="smallexample"> B Type: Integer
Decl: bar.ads 2:22
B Type: Integer
Decl: main.ads 3:20
Body: main.adb 2:20
Ref: main.adb 4:13 5:13 6:19
Bar Type: Unit
Decl: bar.ads 1:9
Ref: main.adb 6:8 7:8
main.ads 1:6
C Type: Integer
Decl: main.ads 4:5
Modi: main.adb 4:8
Ref: main.adb 7:19
D Type: Integer
Decl: main.ads 6:5
Modi: main.adb 5:8
Foo Type: Unit
Decl: main.ads 3:15
Body: main.adb 2:15
Main Type: Unit
Decl: main.ads 2:9
Body: main.adb 1:14
Print Type: Unit
Decl: bar.ads 2:15
Ref: main.adb 6:12 7:12
</pre>
<p class="noindent">that is the entity <code>Main</code> is declared in main.ads, line 2, column 9,
its body is in main.adb, line 1, column 14 and is not referenced any where.
<p>The entity <code>Print</code> is declared in bar.ads, line 2, column 15 and it
it referenced in main.adb, line 6 column 12 and line 7 column 12.
<br><dt><code>gnatxref package1.adb package2.ads</code><dd><code>gnatxref</code> will generates cross-reference information for
package1.adb, package2.ads and any other package 'with'ed by any
of these.
</dl>
<h4 class="subsection">13.5.2 Using gnatxref with vi</h4>
<p><code>gnatxref</code> can generate a tags file output, which can be used
directly from <samp><span class="command">vi</span></samp>. Note that the standard version of <samp><span class="command">vi</span></samp>
will not work properly with overloaded symbols. Consider using another
free implementation of <samp><span class="command">vi</span></samp>, such as <samp><span class="command">vim</span></samp>.
<pre class="smallexample"> $ gnatxref -v gnatfind.adb > tags
</pre>
<p class="noindent">will generate the tags file for <code>gnatfind</code> itself (if the sources
are in the search path!).
<p>From <samp><span class="command">vi</span></samp>, you can then use the command ‘<samp><span class="samp">:tag </span><var>entity</var></samp>’
(replacing <var>entity</var> by whatever you are looking for), and vi will
display a new file with the corresponding declaration of entity.
<div class="node">
<a name="Examples-of-gnatfind-Usage"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Examples-of-gnatxref-Usage">Examples of gnatxref Usage</a>,
Up: <a rel="up" accesskey="u" href="#The-Cross_002dReferencing-Tools-gnatxref-and-gnatfind">The Cross-Referencing Tools gnatxref and gnatfind</a>
</div>
<h3 class="section">13.6 Examples of <code>gnatfind</code> Usage</h3>
<dl>
<dt><code>gnatfind -f xyz:main.adb</code><dd>Find declarations for all entities xyz referenced at least once in
main.adb. The references are search in every library file in the search
path.
<p>The directories will be printed as well (as the ‘<samp><span class="samp">-f</span></samp>’
switch is set)
<p>The output will look like:
<pre class="smallexample"> directory/main.ads:106:14: xyz <= declaration
directory/main.adb:24:10: xyz <= body
directory/foo.ads:45:23: xyz <= declaration
</pre>
<p class="noindent">that is to say, one of the entities xyz found in main.adb is declared at
line 12 of main.ads (and its body is in main.adb), and another one is
declared at line 45 of foo.ads
<br><dt><code>gnatfind -fs xyz:main.adb</code><dd>This is the same command as the previous one, instead <code>gnatfind</code> will
display the content of the Ada source file lines.
<p>The output will look like:
<pre class="smallexample"> directory/main.ads:106:14: xyz <= declaration
procedure xyz;
directory/main.adb:24:10: xyz <= body
procedure xyz is
directory/foo.ads:45:23: xyz <= declaration
xyz : Integer;
</pre>
<p class="noindent">This can make it easier to find exactly the location your are looking
for.
<br><dt><code>gnatfind -r "*x*":main.ads:123 foo.adb</code><dd>Find references to all entities containing an x that are
referenced on line 123 of main.ads.
The references will be searched only in main.ads and foo.adb.
<br><dt><code>gnatfind main.ads:123</code><dd>Find declarations and bodies for all entities that are referenced on
line 123 of main.ads.
<p>This is the same as <code>gnatfind "*":main.adb:123</code>.
<br><dt><code>gnatfind mydir/main.adb:123:45</code><dd>Find the declaration for the entity referenced at column 45 in
line 123 of file main.adb in directory mydir. Note that it
is usual to omit the identifier name when the column is given,
since the column position identifies a unique reference.
<p>The column has to be the beginning of the identifier, and should not
point to any character in the middle of the identifier.
</dl>
<!-- ********************************* -->
<div class="node">
<a name="The-GNAT-Pretty-Printer-gnatpp"></a>
<a name="The-GNAT-Pretty_002dPrinter-gnatpp"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#The-GNAT-Metric-Tool-gnatmetric">The GNAT Metric Tool gnatmetric</a>,
Previous: <a rel="previous" accesskey="p" href="#The-Cross_002dReferencing-Tools-gnatxref-and-gnatfind">The Cross-Referencing Tools gnatxref and gnatfind</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">14 The GNAT Pretty-Printer <samp><span class="command">gnatpp</span></samp></h2>
<p><a name="index-gnatpp-742"></a><a name="index-Pretty_002dPrinter-743"></a>
The <samp><span class="command">gnatpp</span></samp> tool is an ASIS-based utility
for source reformatting / pretty-printing.
It takes an Ada source file as input and generates a reformatted
version as output.
You can specify various style directives via switches; e.g.,
identifier case conventions, rules of indentation, and comment layout.
<p>To produce a reformatted file, <samp><span class="command">gnatpp</span></samp> generates and uses the ASIS
tree for the input source and thus requires the input to be syntactically and
semantically legal.
If this condition is not met, <samp><span class="command">gnatpp</span></samp> will terminate with an
error message; no output file will be generated.
<p>If the source files presented to <samp><span class="command">gnatpp</span></samp> contain
preprocessing directives, then the output file will
correspond to the generated source after all
preprocessing is carried out. There is no way
using <samp><span class="command">gnatpp</span></samp> to obtain pretty printed files that
include the preprocessing directives.
<p>If the compilation unit
contained in the input source depends semantically upon units located
outside the current directory, you have to provide the source search path
when invoking <samp><span class="command">gnatpp</span></samp>, if these units are contained in files with
names that do not follow the GNAT file naming rules, you have to provide
the configuration file describing the corresponding naming scheme;
see the description of the <samp><span class="command">gnatpp</span></samp>
switches below. Another possibility is to use a project file and to
call <samp><span class="command">gnatpp</span></samp> through the <samp><span class="command">gnat</span></samp> driver
<p>The <samp><span class="command">gnatpp</span></samp> command has the form
<pre class="smallexample"> <!-- $ gnatpp @ovar{switches} @var{filename} -->
<!-- Expanding @ovar macro inline (explanation in macro def comments) -->
$ gnatpp <span class="roman">[</span><var>switches</var><span class="roman">]</span> <var>filename</var> <span class="roman">[</span>-cargs <var>gcc_switches</var><span class="roman">]</span>
</pre>
<p class="noindent">where
<ul>
<li><var>switches</var> is an optional sequence of switches defining such properties as
the formatting rules, the source search path, and the destination for the
output source file
<li><var>filename</var> is the name (including the extension) of the source file to
reformat; “wildcards” or several file names on the same gnatpp command are
allowed. The file name may contain path information; it does not have to
follow the GNAT file naming rules
<li>‘<samp><var>gcc_switches</var></samp>’ is a list of switches for
<samp><span class="command">gcc</span></samp>. They will be passed on to all compiler invocations made by
<samp><span class="command">gnatelim</span></samp> to generate the ASIS trees. Here you can provide
<samp><span class="option">-I</span></samp> switches to form the source search path,
use the <samp><span class="option">-gnatec</span></samp> switch to set the configuration file,
use the <samp><span class="option">-gnat05</span></samp> switch if sources should be compiled in
Ada 2005 mode etc.
</ul>
<ul class="menu">
<li><a accesskey="1" href="#Switches-for-gnatpp">Switches for gnatpp</a>
<li><a accesskey="2" href="#Formatting-Rules">Formatting Rules</a>
</ul>
<div class="node">
<a name="Switches-for-gnatpp"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Formatting-Rules">Formatting Rules</a>,
Up: <a rel="up" accesskey="u" href="#The-GNAT-Pretty_002dPrinter-gnatpp">The GNAT Pretty-Printer gnatpp</a>
</div>
<h3 class="section">14.1 Switches for <samp><span class="command">gnatpp</span></samp></h3>
<p class="noindent">The following subsections describe the various switches accepted by
<samp><span class="command">gnatpp</span></samp>, organized by category.
<p>You specify a switch by supplying a name and generally also a value.
In many cases the values for a switch with a given name are incompatible with
each other
(for example the switch that controls the casing of a reserved word may have
exactly one value: upper case, lower case, or
mixed case) and thus exactly one such switch can be in effect for an
invocation of <samp><span class="command">gnatpp</span></samp>.
If more than one is supplied, the last one is used.
However, some values for the same switch are mutually compatible.
You may supply several such switches to <samp><span class="command">gnatpp</span></samp>, but then
each must be specified in full, with both the name and the value.
Abbreviated forms (the name appearing once, followed by each value) are
not permitted.
For example, to set
the alignment of the assignment delimiter both in declarations and in
assignment statements, you must write <samp><span class="option">-A2A3</span></samp>
(or <samp><span class="option">-A2 -A3</span></samp>), but not <samp><span class="option">-A23</span></samp>.
<p>In most cases, it is obvious whether or not the
values for a switch with a given name
are compatible with each other.
When the semantics might not be evident, the summaries below explicitly
indicate the effect.
<ul class="menu">
<li><a accesskey="1" href="#Alignment-Control">Alignment Control</a>
<li><a accesskey="2" href="#Casing-Control">Casing Control</a>
<li><a accesskey="3" href="#Construct-Layout-Control">Construct Layout Control</a>
<li><a accesskey="4" href="#General-Text-Layout-Control">General Text Layout Control</a>
<li><a accesskey="5" href="#Other-Formatting-Options">Other Formatting Options</a>
<li><a accesskey="6" href="#Setting-the-Source-Search-Path">Setting the Source Search Path</a>
<li><a accesskey="7" href="#Output-File-Control">Output File Control</a>
<li><a accesskey="8" href="#Other-gnatpp-Switches">Other gnatpp Switches</a>
</ul>
<div class="node">
<a name="Alignment-Control"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Casing-Control">Casing Control</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gnatpp">Switches for gnatpp</a>
</div>
<h4 class="subsection">14.1.1 Alignment Control</h4>
<p><a name="index-Alignment-control-in-_0040command_007bgnatpp_007d-744"></a>
Programs can be easier to read if certain constructs are vertically aligned.
By default all alignments are set ON.
Through the <samp><span class="option">-A0</span></samp> switch you may reset the default to
OFF, and then use one or more of the other
<samp><span class="option">-A</span><var>n</var></samp> switches
to activate alignment for specific constructs.
<a name="index-g_t_0040option_007b_002dA_0040var_007bn_007d_007d-_0028_0040command_007bgnatpp_007d_0029-745"></a>
<dl>
<dt><samp><span class="option">-A0</span></samp><dd>Set all alignments to OFF
<br><dt><samp><span class="option">-A1</span></samp><dd>Align <code>:</code> in declarations
<br><dt><samp><span class="option">-A2</span></samp><dd>Align <code>:=</code> in initializations in declarations
<br><dt><samp><span class="option">-A3</span></samp><dd>Align <code>:=</code> in assignment statements
<br><dt><samp><span class="option">-A4</span></samp><dd>Align <code>=></code> in associations
<br><dt><samp><span class="option">-A5</span></samp><dd>Align <code>at</code> keywords in the component clauses in record
representation clauses
</dl>
<p class="noindent">The <samp><span class="option">-A</span></samp> switches are mutually compatible; any combination
is allowed.
<div class="node">
<a name="Casing-Control"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Construct-Layout-Control">Construct Layout Control</a>,
Previous: <a rel="previous" accesskey="p" href="#Alignment-Control">Alignment Control</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gnatpp">Switches for gnatpp</a>
</div>
<h4 class="subsection">14.1.2 Casing Control</h4>
<p><a name="index-Casing-control-in-_0040command_007bgnatpp_007d-746"></a>
<samp><span class="command">gnatpp</span></samp> allows you to specify the casing for reserved words,
pragma names, attribute designators and identifiers.
For identifiers you may define a
general rule for name casing but also override this rule
via a set of dictionary files.
<p>Three types of casing are supported: lower case, upper case, and mixed case.
Lower and upper case are self-explanatory (but since some letters in
Latin1 and other GNAT-supported character sets
exist only in lower-case form, an upper case conversion will have no
effect on them.)
“Mixed case” means that the first letter, and also each letter immediately
following an underscore, are converted to their uppercase forms;
all the other letters are converted to their lowercase forms.
<a name="index-g_t_0040option_007b_002da_0040var_007bx_007d_007d-_0028_0040command_007bgnatpp_007d_0029-747"></a>
<dl><dt><samp><span class="option">-aL</span></samp><dd>Attribute designators are lower case
<br><dt><samp><span class="option">-aU</span></samp><dd>Attribute designators are upper case
<br><dt><samp><span class="option">-aM</span></samp><dd>Attribute designators are mixed case (this is the default)
<p><a name="index-g_t_0040option_007b_002dk_0040var_007bx_007d_007d-_0028_0040command_007bgnatpp_007d_0029-748"></a><br><dt><samp><span class="option">-kL</span></samp><dd>Keywords (technically, these are known in Ada as <em>reserved words</em>) are
lower case (this is the default)
<br><dt><samp><span class="option">-kU</span></samp><dd>Keywords are upper case
<p><a name="index-g_t_0040option_007b_002dn_0040var_007bx_007d_007d-_0028_0040command_007bgnatpp_007d_0029-749"></a><br><dt><samp><span class="option">-nD</span></samp><dd>Name casing for defining occurrences are as they appear in the source file
(this is the default)
<br><dt><samp><span class="option">-nU</span></samp><dd>Names are in upper case
<br><dt><samp><span class="option">-nL</span></samp><dd>Names are in lower case
<br><dt><samp><span class="option">-nM</span></samp><dd>Names are in mixed case
<p><a name="index-g_t_0040option_007b_002dp_0040var_007bx_007d_007d-_0028_0040command_007bgnatpp_007d_0029-750"></a><br><dt><samp><span class="option">-pL</span></samp><dd>Pragma names are lower case
<br><dt><samp><span class="option">-pU</span></samp><dd>Pragma names are upper case
<br><dt><samp><span class="option">-pM</span></samp><dd>Pragma names are mixed case (this is the default)
<br><dt><samp><span class="option">-D</span><var>file</var></samp><dd><a name="index-g_t_0040option_007b_002dD_007d-_0028_0040command_007bgnatpp_007d_0029-751"></a>Use <var>file</var> as a <em>dictionary file</em> that defines
the casing for a set of specified names,
thereby overriding the effect on these names by
any explicit or implicit
-n switch.
To supply more than one dictionary file,
use several <samp><span class="option">-D</span></samp> switches.
<p class="noindent"><samp><span class="option">gnatpp</span></samp> implicitly uses a <em>default dictionary file</em>
to define the casing for the Ada predefined names and
the names declared in the GNAT libraries.
<br><dt><samp><span class="option">-D-</span></samp><dd><a name="index-g_t_0040option_007b_002dD_002d_007d-_0028_0040command_007bgnatpp_007d_0029-752"></a>Do not use the default dictionary file;
instead, use the casing
defined by a <samp><span class="option">-n</span></samp> switch and any explicit
dictionary file(s)
</dl>
<p class="noindent">The structure of a dictionary file, and details on the conventions
used in the default dictionary file, are defined in <a href="#Name-Casing">Name Casing</a>.
<p>The <samp><span class="option">-D-</span></samp> and
<samp><span class="option">-D</span><var>file</var></samp> switches are mutually
compatible.
<div class="node">
<a name="Construct-Layout-Control"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#General-Text-Layout-Control">General Text Layout Control</a>,
Previous: <a rel="previous" accesskey="p" href="#Casing-Control">Casing Control</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gnatpp">Switches for gnatpp</a>
</div>
<h4 class="subsection">14.1.3 Construct Layout Control</h4>
<p><a name="index-Layout-control-in-_0040command_007bgnatpp_007d-753"></a>
This group of <samp><span class="command">gnatpp</span></samp> switches controls the layout of comments and
complex syntactic constructs. See <a href="#Formatting-Comments">Formatting Comments</a> for details
on their effect.
<a name="index-g_t_0040option_007b_002dc_0040var_007bn_007d_007d-_0028_0040command_007bgnatpp_007d_0029-754"></a>
<dl><dt><samp><span class="option">-c0</span></samp><dd>All the comments remain unchanged
<br><dt><samp><span class="option">-c1</span></samp><dd>GNAT-style comment line indentation (this is the default).
<br><dt><samp><span class="option">-c2</span></samp><dd>Reference-manual comment line indentation.
<br><dt><samp><span class="option">-c3</span></samp><dd>GNAT-style comment beginning
<br><dt><samp><span class="option">-c4</span></samp><dd>Reformat comment blocks
<br><dt><samp><span class="option">-c5</span></samp><dd>Keep unchanged special form comments
<p>Reformat comment blocks
<p><a name="index-g_t_0040option_007b_002dl_0040var_007bn_007d_007d-_0028_0040command_007bgnatpp_007d_0029-755"></a><br><dt><samp><span class="option">-l1</span></samp><dd>GNAT-style layout (this is the default)
<br><dt><samp><span class="option">-l2</span></samp><dd>Compact layout
<br><dt><samp><span class="option">-l3</span></samp><dd>Uncompact layout
<p><a name="index-g_t_0040option_007b_002dN_007d-_0028_0040command_007bgnatpp_007d_0029-756"></a><br><dt><samp><span class="option">-N</span></samp><dd>All the VT characters are removed from the comment text. All the HT characters
are expanded with the sequences of space characters to get to the next tab
stops.
<p><a name="index-g_t_0040option_007b_002d_002dno_002dseparate_002dis_007d-_0028_0040command_007bgnatpp_007d_0029-757"></a><br><dt><samp><span class="option">--no-separate-is</span></samp><dd>Do not place the keyword <code>is</code> on a separate line in a subprogram body in
case if the spec occupies more then one line.
<p><a name="index-g_t_0040option_007b_002d_002dseparate_002dlabel_007d-_0028_0040command_007bgnatpp_007d_0029-758"></a><br><dt><samp><span class="option">--separate-label</span></samp><dd>Place statement label(s) on a separate line, with the following statement
on the next line.
<p><a name="index-g_t_0040option_007b_002d_002dseparate_002dloop_002dthen_007d-_0028_0040command_007bgnatpp_007d_0029-759"></a><br><dt><samp><span class="option">--separate-loop-then</span></samp><dd>Place the keyword <code>loop</code> in FOR and WHILE loop statements and the
keyword <code>then</code> in IF statements on a separate line.
<p><a name="index-g_t_0040option_007b_002d_002dno_002dseparate_002dloop_002dthen_007d-_0028_0040command_007bgnatpp_007d_0029-760"></a><br><dt><samp><span class="option">--no-separate-loop-then</span></samp><dd>Do not place the keyword <code>loop</code> in FOR and WHILE loop statements and the
keyword <code>then</code> in IF statements on a separate line. This option is
incompatible with <samp><span class="option">--separate-loop-then</span></samp> option.
<p><a name="index-g_t_0040option_007b_002d_002duse_002don_002dnew_002dline_007d-_0028_0040command_007bgnatpp_007d_0029-761"></a><br><dt><samp><span class="option">--use-on-new-line</span></samp><dd>Start each USE clause in a context clause from a separate line.
<p><a name="index-g_t_0040option_007b_002d_002dseparate_002dstmt_002dname_007d-_0028_0040command_007bgnatpp_007d_0029-762"></a><br><dt><samp><span class="option">--separate-stmt-name</span></samp><dd>Use a separate line for a loop or block statement name, but do not use an extra
indentation level for the statement itself.
</dl>
<p class="noindent">The <samp><span class="option">-c1</span></samp> and <samp><span class="option">-c2</span></samp> switches are incompatible.
The <samp><span class="option">-c3</span></samp> and <samp><span class="option">-c4</span></samp> switches are compatible with each other and
also with <samp><span class="option">-c1</span></samp> and <samp><span class="option">-c2</span></samp>. The <samp><span class="option">-c0</span></samp> switch disables all
the other comment formatting switches.
<p>The <samp><span class="option">-l1</span></samp>, <samp><span class="option">-l2</span></samp>, and <samp><span class="option">-l3</span></samp> switches are incompatible.
<div class="node">
<a name="General-Text-Layout-Control"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Other-Formatting-Options">Other Formatting Options</a>,
Previous: <a rel="previous" accesskey="p" href="#Construct-Layout-Control">Construct Layout Control</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gnatpp">Switches for gnatpp</a>
</div>
<h4 class="subsection">14.1.4 General Text Layout Control</h4>
<p class="noindent">These switches allow control over line length and indentation.
<dl>
<dt><samp><span class="option">-M</span><var>nnn</var></samp><dd><a name="index-g_t_0040option_007b_002dM_007d-_0028_0040command_007bgnatpp_007d_0029-763"></a>Maximum line length, <var>nnn</var> from 32<small class="dots">...</small>256, the default value is 79
<br><dt><samp><span class="option">-i</span><var>nnn</var></samp><dd><a name="index-g_t_0040option_007b_002di_007d-_0028_0040command_007bgnatpp_007d_0029-764"></a>Indentation level, <var>nnn</var> from 1<small class="dots">...</small>9, the default value is 3
<br><dt><samp><span class="option">-cl</span><var>nnn</var></samp><dd><a name="index-g_t_0040option_007b_002dcl_007d-_0028_0040command_007bgnatpp_007d_0029-765"></a>Indentation level for continuation lines (relative to the line being
continued), <var>nnn</var> from 1<small class="dots">...</small>9.
The default
value is one less then the (normal) indentation level, unless the
indentation is set to 1 (in which case the default value for continuation
line indentation is also 1)
</dl>
<div class="node">
<a name="Other-Formatting-Options"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Setting-the-Source-Search-Path">Setting the Source Search Path</a>,
Previous: <a rel="previous" accesskey="p" href="#General-Text-Layout-Control">General Text Layout Control</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gnatpp">Switches for gnatpp</a>
</div>
<h4 class="subsection">14.1.5 Other Formatting Options</h4>
<p class="noindent">These switches control the inclusion of missing end/exit labels, and
the indentation level in <b>case</b> statements.
<dl>
<dt><samp><span class="option">-e</span></samp><dd><a name="index-g_t_0040option_007b_002de_007d-_0028_0040command_007bgnatpp_007d_0029-766"></a>Do not insert missing end/exit labels. An end label is the name of
a construct that may optionally be repeated at the end of the
construct's declaration;
e.g., the names of packages, subprograms, and tasks.
An exit label is the name of a loop that may appear as target
of an exit statement within the loop.
By default, <samp><span class="command">gnatpp</span></samp> inserts these end/exit labels when
they are absent from the original source. This option suppresses such
insertion, so that the formatted source reflects the original.
<br><dt><samp><span class="option">-ff</span></samp><dd><a name="index-g_t_0040option_007b_002dff_007d-_0028_0040command_007bgnatpp_007d_0029-767"></a>Insert a Form Feed character after a pragma Page.
<br><dt><samp><span class="option">-T</span><var>nnn</var></samp><dd><a name="index-g_t_0040option_007b_002dT_007d-_0028_0040command_007bgnatpp_007d_0029-768"></a>Do not use an additional indentation level for <b>case</b> alternatives
and variants if there are <var>nnn</var> or more (the default
value is 10).
If <var>nnn</var> is 0, an additional indentation level is
used for <b>case</b> alternatives and variants regardless of their number.
</dl>
<div class="node">
<a name="Setting-the-Source-Search-Path"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Output-File-Control">Output File Control</a>,
Previous: <a rel="previous" accesskey="p" href="#Other-Formatting-Options">Other Formatting Options</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gnatpp">Switches for gnatpp</a>
</div>
<h4 class="subsection">14.1.6 Setting the Source Search Path</h4>
<p class="noindent">To define the search path for the input source file, <samp><span class="command">gnatpp</span></samp>
uses the same switches as the GNAT compiler, with the same effects.
<dl>
<dt><samp><span class="option">-I</span><var>dir</var></samp><dd><a name="index-g_t_0040option_007b_002dI_007d-_0028_0040code_007bgnatpp_007d_0029-769"></a>The same as the corresponding gcc switch
<br><dt><samp><span class="option">-I-</span></samp><dd><a name="index-g_t_0040option_007b_002dI_002d_007d-_0028_0040code_007bgnatpp_007d_0029-770"></a>The same as the corresponding gcc switch
<br><dt><samp><span class="option">-gnatec=</span><var>path</var></samp><dd><a name="index-g_t_0040option_007b_002dgnatec_007d-_0028_0040code_007bgnatpp_007d_0029-771"></a>The same as the corresponding gcc switch
<br><dt><samp><span class="option">--RTS=</span><var>path</var></samp><dd><a name="index-g_t_0040option_007b_002d_002dRTS_007d-_0028_0040code_007bgnatpp_007d_0029-772"></a>The same as the corresponding gcc switch
</dl>
<div class="node">
<a name="Output-File-Control"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Other-gnatpp-Switches">Other gnatpp Switches</a>,
Previous: <a rel="previous" accesskey="p" href="#Setting-the-Source-Search-Path">Setting the Source Search Path</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gnatpp">Switches for gnatpp</a>
</div>
<h4 class="subsection">14.1.7 Output File Control</h4>
<p class="noindent">By default the output is sent to the file whose name is obtained by appending
the <samp><span class="file">.pp</span></samp> suffix to the name of the input file
(if the file with this name already exists, it is unconditionally overwritten).
Thus if the input file is <samp><span class="file">my_ada_proc.adb</span></samp> then
<samp><span class="command">gnatpp</span></samp> will produce <samp><span class="file">my_ada_proc.adb.pp</span></samp>
as output file.
The output may be redirected by the following switches:
<dl>
<dt><samp><span class="option">-pipe</span></samp><dd><a name="index-g_t_0040option_007b_002dpipe_007d-_0028_0040code_007bgnatpp_007d_0029-773"></a>Send the output to <code>Standard_Output</code>
<br><dt><samp><span class="option">-o </span><var>output_file</var></samp><dd><a name="index-g_t_0040option_007b_002do_007d-_0028_0040code_007bgnatpp_007d_0029-774"></a>Write the output into <var>output_file</var>.
If <var>output_file</var> already exists, <samp><span class="command">gnatpp</span></samp> terminates without
reading or processing the input file.
<br><dt><samp><span class="option">-of </span><var>output_file</var></samp><dd><a name="index-g_t_0040option_007b_002dof_007d-_0028_0040code_007bgnatpp_007d_0029-775"></a>Write the output into <var>output_file</var>, overwriting the existing file
(if one is present).
<br><dt><samp><span class="option">-r</span></samp><dd><a name="index-g_t_0040option_007b_002dr_007d-_0028_0040code_007bgnatpp_007d_0029-776"></a>Replace the input source file with the reformatted output, and copy the
original input source into the file whose name is obtained by appending the
<samp><span class="file">.npp</span></samp> suffix to the name of the input file.
If a file with this name already exists, <samp><span class="command">gnatpp</span></samp> terminates without
reading or processing the input file.
<br><dt><samp><span class="option">-rf</span></samp><dd><a name="index-g_t_0040option_007b_002drf_007d-_0028_0040code_007bgnatpp_007d_0029-777"></a>Like <samp><span class="option">-r</span></samp> except that if the file with the specified name
already exists, it is overwritten.
<br><dt><samp><span class="option">-rnb</span></samp><dd><a name="index-g_t_0040option_007b_002drnb_007d-_0028_0040code_007bgnatpp_007d_0029-778"></a>Replace the input source file with the reformatted output without
creating any backup copy of the input source.
<br><dt><samp><span class="option">--eol=</span><var>xxx</var></samp><dd><a name="index-g_t_0040option_007b_002d_002deol_007d-_0028_0040code_007bgnatpp_007d_0029-779"></a>Specifies the format of the reformatted output file. The <var>xxx</var>
string specified with the switch may be either
<ul>
<li>“<samp><span class="option">dos</span></samp>” MS DOS style, lines end with CR LF characters
<li>“<samp><span class="option">crlf</span></samp>”
the same as <samp><span class="option">crlf</span></samp>
<li>“<samp><span class="option">unix</span></samp>” UNIX style, lines end with LF character
<li>“<samp><span class="option">lf</span></samp>”
the same as <samp><span class="option">unix</span></samp>
</ul>
<br><dt><samp><span class="option">-W</span><var>e</var></samp><dd><a name="index-g_t_0040option_007b_002dW_007d-_0028_0040command_007bgnatpp_007d_0029-780"></a>Specify the wide character encoding method used to write the code in the
result file
<var>e</var> is one of the following:
<ul>
<li>h
Hex encoding
<li>u
Upper half encoding
<li>s
Shift/JIS encoding
<li>e
EUC encoding
<li>8
UTF-8 encoding
<li>b
Brackets encoding (default value)
</ul>
</dl>
<p class="noindent">Options <samp><span class="option">-pipe</span></samp>,
<samp><span class="option">-o</span></samp> and
<samp><span class="option">-of</span></samp> are allowed only if the call to gnatpp
contains only one file to reformat.
Option
<samp><span class="option">--eol</span></samp>
and
<samp><span class="option">-W</span></samp>
cannot be used together
with <samp><span class="option">-pipe</span></samp> option.
<div class="node">
<a name="Other-gnatpp-Switches"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Output-File-Control">Output File Control</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gnatpp">Switches for gnatpp</a>
</div>
<h4 class="subsection">14.1.8 Other <code>gnatpp</code> Switches</h4>
<p class="noindent">The additional <samp><span class="command">gnatpp</span></samp> switches are defined in this subsection.
<dl>
<dt><samp><span class="option">-files </span><var>filename</var></samp><dd><a name="index-g_t_0040option_007b_002dfiles_007d-_0028_0040code_007bgnatpp_007d_0029-781"></a>Take the argument source files from the specified file. This file should be an
ordinary text file containing file names separated by spaces or
line breaks. You can use this switch more than once in the same call to
<samp><span class="command">gnatpp</span></samp>. You also can combine this switch with an explicit list of
files.
<br><dt><samp><span class="option">-v</span></samp><dd><a name="index-g_t_0040option_007b_002dv_007d-_0028_0040code_007bgnatpp_007d_0029-782"></a>Verbose mode;
<samp><span class="command">gnatpp</span></samp> generates version information and then
a trace of the actions it takes to produce or obtain the ASIS tree.
<br><dt><samp><span class="option">-w</span></samp><dd><a name="index-g_t_0040option_007b_002dw_007d-_0028_0040code_007bgnatpp_007d_0029-783"></a>Warning mode;
<samp><span class="command">gnatpp</span></samp> generates a warning whenever it cannot provide
a required layout in the result source.
</dl>
<div class="node">
<a name="Formatting-Rules"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Switches-for-gnatpp">Switches for gnatpp</a>,
Up: <a rel="up" accesskey="u" href="#The-GNAT-Pretty_002dPrinter-gnatpp">The GNAT Pretty-Printer gnatpp</a>
</div>
<h3 class="section">14.2 Formatting Rules</h3>
<p class="noindent">The following subsections show how <samp><span class="command">gnatpp</span></samp> treats “white space”,
comments, program layout, and name casing.
They provide the detailed descriptions of the switches shown above.
<ul class="menu">
<li><a accesskey="1" href="#White-Space-and-Empty-Lines">White Space and Empty Lines</a>
<li><a accesskey="2" href="#Formatting-Comments">Formatting Comments</a>
<li><a accesskey="3" href="#Construct-Layout">Construct Layout</a>
<li><a accesskey="4" href="#Name-Casing">Name Casing</a>
</ul>
<div class="node">
<a name="White-Space-and-Empty-Lines"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Formatting-Comments">Formatting Comments</a>,
Up: <a rel="up" accesskey="u" href="#Formatting-Rules">Formatting Rules</a>
</div>
<h4 class="subsection">14.2.1 White Space and Empty Lines</h4>
<p class="noindent"><samp><span class="command">gnatpp</span></samp> does not have an option to control space characters.
It will add or remove spaces according to the style illustrated by the
examples in the <cite>Ada Reference Manual</cite>.
<p>The only format effectors
(see <cite>Ada Reference Manual</cite>, paragraph 2.1(13))
that will appear in the output file are platform-specific line breaks,
and also format effectors within (but not at the end of) comments.
In particular, each horizontal tab character that is not inside
a comment will be treated as a space and thus will appear in the
output file as zero or more spaces depending on
the reformatting of the line in which it appears.
The only exception is a Form Feed character, which is inserted after a
pragma <code>Page</code> when <samp><span class="option">-ff</span></samp> is set.
<p>The output file will contain no lines with trailing “white space” (spaces,
format effectors).
<p>Empty lines in the original source are preserved
only if they separate declarations or statements.
In such contexts, a
sequence of two or more empty lines is replaced by exactly one empty line.
Note that a blank line will be removed if it separates two “comment blocks”
(a comment block is a sequence of whole-line comments).
In order to preserve a visual separation between comment blocks, use an
“empty comment” (a line comprising only hyphens) rather than an empty line.
Likewise, if for some reason you wish to have a sequence of empty lines,
use a sequence of empty comments instead.
<div class="node">
<a name="Formatting-Comments"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Construct-Layout">Construct Layout</a>,
Previous: <a rel="previous" accesskey="p" href="#White-Space-and-Empty-Lines">White Space and Empty Lines</a>,
Up: <a rel="up" accesskey="u" href="#Formatting-Rules">Formatting Rules</a>
</div>
<h4 class="subsection">14.2.2 Formatting Comments</h4>
<p class="noindent">Comments in Ada code are of two kinds:
<ul>
<li>a <em>whole-line comment</em>, which appears by itself (possibly preceded by
“white space”) on a line
<li>an <em>end-of-line comment</em>, which follows some other Ada lexical element
on the same line.
</ul>
<p class="noindent">The indentation of a whole-line comment is that of either
the preceding or following line in
the formatted source, depending on switch settings as will be described below.
<p>For an end-of-line comment, <samp><span class="command">gnatpp</span></samp> leaves the same number of spaces
between the end of the preceding Ada lexical element and the beginning
of the comment as appear in the original source,
unless either the comment has to be split to
satisfy the line length limitation, or else the next line contains a
whole line comment that is considered a continuation of this end-of-line
comment (because it starts at the same position).
In the latter two
cases, the start of the end-of-line comment is moved right to the nearest
multiple of the indentation level.
This may result in a “line overflow” (the right-shifted comment extending
beyond the maximum line length), in which case the comment is split as
described below.
<p>There is a difference between <samp><span class="option">-c1</span></samp>
(GNAT-style comment line indentation)
and <samp><span class="option">-c2</span></samp>
(reference-manual comment line indentation).
With reference-manual style, a whole-line comment is indented as if it
were a declaration or statement at the same place
(i.e., according to the indentation of the preceding line(s)).
With GNAT style, a whole-line comment that is immediately followed by an
<b>if</b> or <b>case</b> statement alternative, a record variant, or the reserved
word <b>begin</b>, is indented based on the construct that follows it.
<p>For example:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
if A then
null;
-- some comment
else
null;
end if;
</td></tr></table>
</pre>
<p class="noindent">Reference-manual indentation produces:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
if A then
null;
-- some comment
else
null;
end if;
</td></tr></table>
</pre>
<p class="noindent">while GNAT-style indentation produces:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
if A then
null;
-- some comment
else
null;
end if;
</td></tr></table>
</pre>
<p class="noindent">The <samp><span class="option">-c3</span></samp> switch
(GNAT style comment beginning) has the following
effect:
<ul>
<li>For each whole-line comment that does not end with two hyphens,
<samp><span class="command">gnatpp</span></samp> inserts spaces if necessary after the starting two hyphens
to ensure that there are at least two spaces between these hyphens and the
first non-blank character of the comment.
</ul>
<p class="noindent">For an end-of-line comment, if in the original source the next line is a
whole-line comment that starts at the same position
as the end-of-line comment,
then the whole-line comment (and all whole-line comments
that follow it and that start at the same position)
will start at this position in the output file.
<p class="noindent">That is, if in the original source we have:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
begin
A := B + C; -- B must be in the range Low1..High1
-- C must be in the range Low2..High2
--B+C will be in the range Low1+Low2..High1+High2
X := X + 1;
</td></tr></table>
</pre>
<p class="noindent">Then in the formatted source we get
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
begin
A := B + C; -- B must be in the range Low1..High1
-- C must be in the range Low2..High2
-- B+C will be in the range Low1+Low2..High1+High2
X := X + 1;
</td></tr></table>
</pre>
<p class="noindent">A comment that exceeds the line length limit will be split.
Unless switch
<samp><span class="option">-c4</span></samp> (reformat comment blocks) is set and
the line belongs to a reformattable block, splitting the line generates a
<samp><span class="command">gnatpp</span></samp> warning.
The <samp><span class="option">-c4</span></samp> switch specifies that whole-line
comments may be reformatted in typical
word processor style (that is, moving words between lines and putting as
many words in a line as possible).
<p class="noindent">The <samp><span class="option">-c5</span></samp> switch specifies, that comments
that has a special format (that is, a character that is neither a letter nor digit
not white space nor line break immediately following the leading <code>--</code> of
the comment) should be without any change moved from the argument source
into reformatted source. This switch allows to preserve comments that are used
as a special marks in the code (e.g. SPARK annotation).
<div class="node">
<a name="Construct-Layout"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Name-Casing">Name Casing</a>,
Previous: <a rel="previous" accesskey="p" href="#Formatting-Comments">Formatting Comments</a>,
Up: <a rel="up" accesskey="u" href="#Formatting-Rules">Formatting Rules</a>
</div>
<h4 class="subsection">14.2.3 Construct Layout</h4>
<p class="noindent">In several cases the suggested layout in the Ada Reference Manual includes
an extra level of indentation that many programmers prefer to avoid. The
affected cases include:
<ul>
<li>Record type declaration (RM 3.8)
<li>Record representation clause (RM 13.5.1)
<li>Loop statement in case if a loop has a statement identifier (RM 5.6)
<li>Block statement in case if a block has a statement identifier (RM 5.6)
</ul>
<p class="noindent">In compact mode (when GNAT style layout or compact layout is set),
the pretty printer uses one level of indentation instead
of two. This is achieved in the record definition and record representation
clause cases by putting the <code>record</code> keyword on the same line as the
start of the declaration or representation clause, and in the block and loop
case by putting the block or loop header on the same line as the statement
identifier.
<p class="noindent">The difference between GNAT style <samp><span class="option">-l1</span></samp>
and compact <samp><span class="option">-l2</span></samp>
layout on the one hand, and uncompact layout
<samp><span class="option">-l3</span></samp> on the other hand,
can be illustrated by the following examples:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
GNAT style, compact layout Uncompact layout
type q is record type q is
a : integer; record
b : integer; a : integer;
end record; b : integer;
end record;
for q use record for q use
a at 0 range 0 .. 31; record
b at 4 range 0 .. 31; a at 0 range 0 .. 31;
end record; b at 4 range 0 .. 31;
end record;
Block : declare Block :
A : Integer := 3; declare
begin A : Integer := 3;
Proc (A, A); begin
end Block; Proc (A, A);
end Block;
Clear : for J in 1 .. 10 loop Clear :
A (J) := 0; for J in 1 .. 10 loop
end loop Clear; A (J) := 0;
end loop Clear;
</td></tr></table>
</pre>
<p class="noindent">A further difference between GNAT style layout and compact layout is that
GNAT style layout inserts empty lines as separation for
compound statements, return statements and bodies.
<p>Note that the layout specified by
<samp><span class="option">--separate-stmt-name</span></samp>
for named block and loop statements overrides the layout defined by these
constructs by <samp><span class="option">-l1</span></samp>,
<samp><span class="option">-l2</span></samp> or
<samp><span class="option">-l3</span></samp> option.
<div class="node">
<a name="Name-Casing"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Construct-Layout">Construct Layout</a>,
Up: <a rel="up" accesskey="u" href="#Formatting-Rules">Formatting Rules</a>
</div>
<h4 class="subsection">14.2.4 Name Casing</h4>
<p class="noindent"><samp><span class="command">gnatpp</span></samp> always converts the usage occurrence of a (simple) name to
the same casing as the corresponding defining identifier.
<p>You control the casing for defining occurrences via the
<samp><span class="option">-n</span></samp> switch.
With <samp><span class="option">-nD</span></samp> (“as declared”, which is the default),
defining occurrences appear exactly as in the source file
where they are declared.
The other values for this switch —
<samp><span class="option">-nU</span></samp>,
<samp><span class="option">-nL</span></samp>,
<samp><span class="option">-nM</span></samp> —
result in
upper, lower, or mixed case, respectively.
If <samp><span class="command">gnatpp</span></samp> changes the casing of a defining
occurrence, it analogously changes the casing of all the
usage occurrences of this name.
<p>If the defining occurrence of a name is not in the source compilation unit
currently being processed by <samp><span class="command">gnatpp</span></samp>, the casing of each reference to
this name is changed according to the value of the <samp><span class="option">-n</span></samp>
switch (subject to the dictionary file mechanism described below).
Thus <samp><span class="command">gnatpp</span></samp> acts as though the <samp><span class="option">-n</span></samp> switch
had affected the
casing for the defining occurrence of the name.
<p>Some names may need to be spelled with casing conventions that are not
covered by the upper-, lower-, and mixed-case transformations.
You can arrange correct casing by placing such names in a
<em>dictionary file</em>,
and then supplying a <samp><span class="option">-D</span></samp> switch.
The casing of names from dictionary files overrides
any <samp><span class="option">-n</span></samp> switch.
<p>To handle the casing of Ada predefined names and the names from GNAT libraries,
<samp><span class="command">gnatpp</span></samp> assumes a default dictionary file.
The name of each predefined entity is spelled with the same casing as is used
for the entity in the <cite>Ada Reference Manual</cite>.
The name of each entity in the GNAT libraries is spelled with the same casing
as is used in the declaration of that entity.
<p>The <samp><span class="option">-D-</span></samp><!-- /@w --> switch suppresses the use of the
default dictionary file.
Instead, the casing for predefined and GNAT-defined names will be established
by the <samp><span class="option">-n</span></samp> switch or explicit dictionary files.
For example, by default the names <code>Ada.Text_IO</code> and <code>GNAT.OS_Lib</code>
will appear as just shown,
even in the presence of a <samp><span class="option">-nU</span></samp> switch.
To ensure that even such names are rendered in uppercase,
additionally supply the <samp><span class="option">-D-</span></samp><!-- /@w --> switch
(or else, less conveniently, place these names in upper case in a dictionary
file).
<p>A dictionary file is
a plain text file; each line in this file can be either a blank line
(containing only space characters and ASCII.HT characters), an Ada comment
line, or the specification of exactly one <em>casing schema</em>.
<p>A casing schema is a string that has the following syntax:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
<var>casing_schema</var> ::= <var>identifier</var> | *<var>simple_identifier</var>*
<var>simple_identifier</var> ::= <var>letter</var>{<var>letter_or_digit</var>}
</td></tr></table>
</pre>
<p class="noindent">(See <cite>Ada Reference Manual</cite>, Section 2.3) for the definition of the
<var>identifier</var> lexical element and the <var>letter_or_digit</var> category.)
<p>The casing schema string can be followed by white space and/or an Ada-style
comment; any amount of white space is allowed before the string.
<p>If a dictionary file is passed as
the value of a <samp><span class="option">-D</span><var>file</var></samp> switch
then for every
simple name and every identifier, <samp><span class="command">gnatpp</span></samp> checks if the dictionary
defines the casing for the name or for some of its parts (the term “subword”
is used below to denote the part of a name which is delimited by “_” or by
the beginning or end of the word and which does not contain any “_” inside):
<ul>
<li>if the whole name is in the dictionary, <samp><span class="command">gnatpp</span></samp> uses for this name
the casing defined by the dictionary; no subwords are checked for this word
<li>for every subword <samp><span class="command">gnatpp</span></samp> checks if the dictionary contains the
corresponding string of the form <code>*</code><var>simple_identifier</var><code>*</code>,
and if it does, the casing of this <var>simple_identifier</var> is used
for this subword
<li>if the whole name does not contain any “_” inside, and if for this name
the dictionary contains two entries - one of the form <var>identifier</var>,
and another - of the form *<var>simple_identifier</var>*, then the first one
is applied to define the casing of this name
<li>if more than one dictionary file is passed as <samp><span class="command">gnatpp</span></samp> switches, each
dictionary adds new casing exceptions and overrides all the existing casing
exceptions set by the previous dictionaries
<li>when <samp><span class="command">gnatpp</span></samp> checks if the word or subword is in the dictionary,
this check is not case sensitive
</ul>
<p class="noindent">For example, suppose we have the following source to reformat:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
procedure test is
name1 : integer := 1;
name4_name3_name2 : integer := 2;
name2_name3_name4 : Boolean;
name1_var : Float;
begin
name2_name3_name4 := name4_name3_name2 > name1;
end;
</td></tr></table>
</pre>
<p class="noindent">And suppose we have two dictionaries:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
<i>dict1:</i>
NAME1
*NaMe3*
*Name1*
</td></tr></table>
<p><table class="cartouche" summary="cartouche" border="1"><tr><td>
<i>dict2:</i>
*NAME3*
</td></tr></table>
</pre>
<p class="noindent">If <samp><span class="command">gnatpp</span></samp> is called with the following switches:
<pre class="smallexample"> <samp><span class="command">gnatpp -nM -D dict1 -D dict2 test.adb</span></samp>
</pre>
<p class="noindent">then we will get the following name casing in the <samp><span class="command">gnatpp</span></samp> output:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
procedure Test is
NAME1 : Integer := 1;
Name4_NAME3_Name2 : Integer := 2;
Name2_NAME3_Name4 : Boolean;
Name1_Var : Float;
begin
Name2_NAME3_Name4 := Name4_NAME3_Name2 > NAME1;
end Test;
</td></tr></table>
</pre>
<!-- ********************************* -->
<div class="node">
<a name="The-GNAT-Metric-Tool-gnatmetric"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#File-Name-Krunching-Using-gnatkr">File Name Krunching Using gnatkr</a>,
Previous: <a rel="previous" accesskey="p" href="#The-GNAT-Pretty_002dPrinter-gnatpp">The GNAT Pretty-Printer gnatpp</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">15 The GNAT Metric Tool <samp><span class="command">gnatmetric</span></samp></h2>
<p><a name="index-gnatmetric-784"></a><a name="index-Metric-tool-785"></a>
The <samp><span class="command">gnatmetric</span></samp> tool is an ASIS-based utility
for computing various program metrics.
It takes an Ada source file as input and generates a file containing the
metrics data as output. Various switches control which
metrics are computed and output.
<p><samp><span class="command">gnatmetric</span></samp> generates and uses the ASIS
tree for the input source and thus requires the input to be syntactically and
semantically legal.
If this condition is not met, <samp><span class="command">gnatmetric</span></samp> will generate
an error message; no metric information for this file will be
computed and reported.
<p>If the compilation unit contained in the input source depends semantically
upon units in files located outside the current directory, you have to provide
the source search path when invoking <samp><span class="command">gnatmetric</span></samp>.
If it depends semantically upon units that are contained
in files with names that do not follow the GNAT file naming rules, you have to
provide the configuration file describing the corresponding naming scheme (see
the description of the <samp><span class="command">gnatmetric</span></samp> switches below.)
Alternatively, you may use a project file and invoke <samp><span class="command">gnatmetric</span></samp>
through the <samp><span class="command">gnat</span></samp> driver.
<p>The <samp><span class="command">gnatmetric</span></samp> command has the form
<pre class="smallexample"> <!-- $ gnatmetric @ovar{switches} @{@var{filename}@} @r{[}-cargs @var{gcc_switches}@r{]} -->
<!-- Expanding @ovar macro inline (explanation in macro def comments) -->
$ gnatmetric <span class="roman">[</span><var>switches</var><span class="roman">]</span> {<var>filename</var>} <span class="roman">[</span>-cargs <var>gcc_switches</var><span class="roman">]</span>
</pre>
<p class="noindent">where
<ul>
<li><var>switches</var> specify the metrics to compute and define the destination for
the output
<li>Each <var>filename</var> is the name (including the extension) of a source
file to process. “Wildcards” are allowed, and
the file name may contain path information.
If no <var>filename</var> is supplied, then the <var>switches</var> list must contain
at least one
<samp><span class="option">-files</span></samp> switch (see <a href="#Other-gnatmetric-Switches">Other gnatmetric Switches</a>).
Including both a <samp><span class="option">-files</span></samp> switch and one or more
<var>filename</var> arguments is permitted.
<li>‘<samp><var>gcc_switches</var></samp>’ is a list of switches for
<samp><span class="command">gcc</span></samp>. They will be passed on to all compiler invocations made by
<samp><span class="command">gnatmetric</span></samp> to generate the ASIS trees. Here you can provide
<samp><span class="option">-I</span></samp> switches to form the source search path,
and use the <samp><span class="option">-gnatec</span></samp> switch to set the configuration file,
use the <samp><span class="option">-gnat05</span></samp> switch if sources should be compiled in
Ada 2005 mode etc.
</ul>
<ul class="menu">
<li><a accesskey="1" href="#Switches-for-gnatmetric">Switches for gnatmetric</a>
</ul>
<div class="node">
<a name="Switches-for-gnatmetric"></a>
<p><hr>
Up: <a rel="up" accesskey="u" href="#The-GNAT-Metric-Tool-gnatmetric">The GNAT Metric Tool gnatmetric</a>
</div>
<h3 class="section">15.1 Switches for <samp><span class="command">gnatmetric</span></samp></h3>
<p class="noindent">The following subsections describe the various switches accepted by
<samp><span class="command">gnatmetric</span></samp>, organized by category.
<ul class="menu">
<li><a accesskey="1" href="#Output-Files-Control">Output Files Control</a>
<li><a accesskey="2" href="#Disable-Metrics-For-Local-Units">Disable Metrics For Local Units</a>
<li><a accesskey="3" href="#Specifying-a-set-of-metrics-to-compute">Specifying a set of metrics to compute</a>
<li><a accesskey="4" href="#Other-gnatmetric-Switches">Other gnatmetric Switches</a>
<li><a accesskey="5" href="#Generate-project_002dwide-metrics">Generate project-wide metrics</a>
</ul>
<div class="node">
<a name="Output-Files-Control"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Disable-Metrics-For-Local-Units">Disable Metrics For Local Units</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gnatmetric">Switches for gnatmetric</a>
</div>
<h4 class="subsection">15.1.1 Output File Control</h4>
<p><a name="index-Output-file-control-in-_0040command_007bgnatmetric_007d-786"></a>
<samp><span class="command">gnatmetric</span></samp> has two output formats. It can generate a
textual (human-readable) form, and also XML. By default only textual
output is generated.
<p>When generating the output in textual form, <samp><span class="command">gnatmetric</span></samp> creates
for each Ada source file a corresponding text file
containing the computed metrics, except for the case when the set of metrics
specified by gnatmetric parameters consists only of metrics that are computed
for the whole set of analyzed sources, but not for each Ada source.
By default, this file is placed in the same directory as where the source
file is located, and its name is obtained
by appending the <samp><span class="file">.metrix</span></samp> suffix to the name of the
input file.
<p>All the output information generated in XML format is placed in a single
file. By default this file is placed in the current directory and has the
name <samp><span class="file">metrix.xml</span></samp>.
<p>Some of the computed metrics are summed over the units passed to
<samp><span class="command">gnatmetric</span></samp>; for example, the total number of lines of code.
By default this information is sent to <samp><span class="file">stdout</span></samp>, but a file
can be specified with the <samp><span class="option">-og</span></samp> switch.
<p>The following switches control the <samp><span class="command">gnatmetric</span></samp> output:
<a name="index-g_t_0040option_007b_002dx_007d-_0028_0040command_007bgnatmetric_007d_0029-787"></a>
<dl><dt><samp><span class="option">-x</span></samp><dd>Generate the XML output
<p><a name="index-g_t_0040option_007b_002dxs_007d-_0028_0040command_007bgnatmetric_007d_0029-788"></a><br><dt><samp><span class="option">-xs</span></samp><dd>Generate the XML output and the XML schema file that describes the structure
of the XML metric report, this schema is assigned to the XML file. The schema
file has the same name as the XML output file with <samp><span class="file">.xml</span></samp> suffix replaced
with <samp><span class="file">.xsd</span></samp>
<p><a name="index-g_t_0040option_007b_002dnt_007d-_0028_0040command_007bgnatmetric_007d_0029-789"></a><br><dt><samp><span class="option">-nt</span></samp><dd>Do not generate the output in text form (implies <samp><span class="option">-x</span></samp>)
<p><a name="index-g_t_0040option_007b_002dd_007d-_0028_0040command_007bgnatmetric_007d_0029-790"></a><br><dt><samp><span class="option">-d </span><var>output_dir</var></samp><dd>Put text files with detailed metrics into <var>output_dir</var>
<p><a name="index-g_t_0040option_007b_002do_007d-_0028_0040command_007bgnatmetric_007d_0029-791"></a><br><dt><samp><span class="option">-o </span><var>file_suffix</var></samp><dd>Use <var>file_suffix</var>, instead of <samp><span class="file">.metrix</span></samp>
in the name of the output file.
<p><a name="index-g_t_0040option_007b_002dog_007d-_0028_0040command_007bgnatmetric_007d_0029-792"></a><br><dt><samp><span class="option">-og </span><var>file_name</var></samp><dd>Put global metrics into <var>file_name</var>
<p><a name="index-g_t_0040option_007b_002dox_007d-_0028_0040command_007bgnatmetric_007d_0029-793"></a><br><dt><samp><span class="option">-ox </span><var>file_name</var></samp><dd>Put the XML output into <var>file_name</var> (also implies <samp><span class="option">-x</span></samp>)
<p><a name="index-g_t_0040option_007b_002dsfn_007d-_0028_0040command_007bgnatmetric_007d_0029-794"></a><br><dt><samp><span class="option">-sfn</span></samp><dd>Use “short” source file names in the output. (The <samp><span class="command">gnatmetric</span></samp>
output includes the name(s) of the Ada source file(s) from which the metrics
are computed. By default each name includes the absolute path. The
<samp><span class="option">-sfn</span></samp> switch causes <samp><span class="command">gnatmetric</span></samp>
to exclude all directory information from the file names that are output.)
</dl>
<div class="node">
<a name="Disable-Metrics-For-Local-Units"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Specifying-a-set-of-metrics-to-compute">Specifying a set of metrics to compute</a>,
Previous: <a rel="previous" accesskey="p" href="#Output-Files-Control">Output Files Control</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gnatmetric">Switches for gnatmetric</a>
</div>
<h4 class="subsection">15.1.2 Disable Metrics For Local Units</h4>
<p><a name="index-Disable-Metrics-For-Local-Units-in-_0040command_007bgnatmetric_007d-795"></a>
<samp><span class="command">gnatmetric</span></samp> relies on the GNAT compilation model −
one compilation
unit per one source file. It computes line metrics for the whole source
file, and it also computes syntax
and complexity metrics for the file's outermost unit.
<p>By default, <samp><span class="command">gnatmetric</span></samp> will also compute all metrics for certain
kinds of locally declared program units:
<ul>
<li>subprogram (and generic subprogram) bodies;
<li>package (and generic package) specs and bodies;
<li>task object and type specifications and bodies;
<li>protected object and type specifications and bodies.
</ul>
<p class="noindent">These kinds of entities will be referred to as
<em>eligible local program units</em>, or simply <em>eligible local units</em>,
<a name="index-Eligible-local-unit-_0028for-_0040command_007bgnatmetric_007d_0029-796"></a>in the discussion below.
<p>Note that a subprogram declaration, generic instantiation,
or renaming declaration only receives metrics
computation when it appear as the outermost entity
in a source file.
<p>Suppression of metrics computation for eligible local units can be
obtained via the following switch:
<a name="index-g_t_0040option_007b_002dn_0040var_007bx_007d_007d-_0028_0040command_007bgnatmetric_007d_0029-797"></a>
<dl><dt><samp><span class="option">-nolocal</span></samp><dd>Do not compute detailed metrics for eligible local program units
</dl>
<div class="node">
<a name="Specifying-a-set-of-metrics-to-compute"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Other-gnatmetric-Switches">Other gnatmetric Switches</a>,
Previous: <a rel="previous" accesskey="p" href="#Disable-Metrics-For-Local-Units">Disable Metrics For Local Units</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gnatmetric">Switches for gnatmetric</a>
</div>
<h4 class="subsection">15.1.3 Specifying a set of metrics to compute</h4>
<p class="noindent">By default all the metrics are computed and reported. The switches
described in this subsection allow you to control, on an individual
basis, whether metrics are computed and
reported. If at least one positive metric
switch is specified (that is, a switch that defines that a given
metric or set of metrics is to be computed), then only
explicitly specified metrics are reported.
<ul class="menu">
<li><a accesskey="1" href="#Line-Metrics-Control">Line Metrics Control</a>
<li><a accesskey="2" href="#Syntax-Metrics-Control">Syntax Metrics Control</a>
<li><a accesskey="3" href="#Complexity-Metrics-Control">Complexity Metrics Control</a>
<li><a accesskey="4" href="#Object_002dOriented-Metrics-Control">Object-Oriented Metrics Control</a>
</ul>
<div class="node">
<a name="Line-Metrics-Control"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Syntax-Metrics-Control">Syntax Metrics Control</a>,
Up: <a rel="up" accesskey="u" href="#Specifying-a-set-of-metrics-to-compute">Specifying a set of metrics to compute</a>
</div>
<h5 class="subsubsection">15.1.3.1 Line Metrics Control</h5>
<p><a name="index-Line-metrics-control-in-_0040command_007bgnatmetric_007d-798"></a>
For any (legal) source file, and for each of its
eligible local program units, <samp><span class="command">gnatmetric</span></samp> computes the following
metrics:
<ul>
<li>the total number of lines;
<li>the total number of code lines (i.e., non-blank lines that are not comments)
<li>the number of comment lines
<li>the number of code lines containing end-of-line comments;
<li>the comment percentage: the ratio between the number of lines that contain
comments and the number of all non-blank lines, expressed as a percentage;
<li>the number of empty lines and lines containing only space characters and/or
format effectors (blank lines)
<li>the average number of code lines in subprogram bodies, task bodies, entry
bodies and statement sequences in package bodies (this metric is only computed
across the whole set of the analyzed units)
</ul>
<p class="noindent"><samp><span class="command">gnatmetric</span></samp> sums the values of the line metrics for all the
files being processed and then generates the cumulative results. The tool
also computes for all the files being processed the average number of code
lines in bodies.
<p>You can use the following switches to select the specific line metrics
to be computed and reported.
<a name="index-g_t_0040option_007b_002d_002dlines_0040var_007bx_007d_007d-_0028_0040command_007bgnatmetric_007d_0029-799"></a>
<a name="index-g_t_0040option_007b_002d_002dno_002dlines_0040var_007bx_007d_007d-800"></a>
<dl>
<dt><samp><span class="option">--lines-all</span></samp><dd>Report all the line metrics
<br><dt><samp><span class="option">--no-lines-all</span></samp><dd>Do not report any of line metrics
<br><dt><samp><span class="option">--lines</span></samp><dd>Report the number of all lines
<br><dt><samp><span class="option">--no-lines</span></samp><dd>Do not report the number of all lines
<br><dt><samp><span class="option">--lines-code</span></samp><dd>Report the number of code lines
<br><dt><samp><span class="option">--no-lines-code</span></samp><dd>Do not report the number of code lines
<br><dt><samp><span class="option">--lines-comment</span></samp><dd>Report the number of comment lines
<br><dt><samp><span class="option">--no-lines-comment</span></samp><dd>Do not report the number of comment lines
<br><dt><samp><span class="option">--lines-eol-comment</span></samp><dd>Report the number of code lines containing
end-of-line comments
<br><dt><samp><span class="option">--no-lines-eol-comment</span></samp><dd>Do not report the number of code lines containing
end-of-line comments
<br><dt><samp><span class="option">--lines-ratio</span></samp><dd>Report the comment percentage in the program text
<br><dt><samp><span class="option">--no-lines-ratio</span></samp><dd>Do not report the comment percentage in the program text
<br><dt><samp><span class="option">--lines-blank</span></samp><dd>Report the number of blank lines
<br><dt><samp><span class="option">--no-lines-blank</span></samp><dd>Do not report the number of blank lines
<br><dt><samp><span class="option">--lines-average</span></samp><dd>Report the average number of code lines in subprogram bodies, task bodies,
entry bodies and statement sequences in package bodies. The metric is computed
and reported for the whole set of processed Ada sources only.
<br><dt><samp><span class="option">--no-lines-average</span></samp><dd>Do not report the average number of code lines in subprogram bodies,
task bodies, entry bodies and statement sequences in package bodies.
</dl>
<div class="node">
<a name="Syntax-Metrics-Control"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Complexity-Metrics-Control">Complexity Metrics Control</a>,
Previous: <a rel="previous" accesskey="p" href="#Line-Metrics-Control">Line Metrics Control</a>,
Up: <a rel="up" accesskey="u" href="#Specifying-a-set-of-metrics-to-compute">Specifying a set of metrics to compute</a>
</div>
<h5 class="subsubsection">15.1.3.2 Syntax Metrics Control</h5>
<p><a name="index-Syntax-metrics-control-in-_0040command_007bgnatmetric_007d-801"></a>
<samp><span class="command">gnatmetric</span></samp> computes various syntactic metrics for the
outermost unit and for each eligible local unit:
<dl>
<dt><em>LSLOC (“Logical Source Lines Of Code”)</em><dd>The total number of declarations and the total number of statements
<br><dt><em>Maximal static nesting level of inner program units</em><dd>According to
<cite>Ada Reference Manual</cite>, 10.1(1), “A program unit is either a
package, a task unit, a protected unit, a
protected entry, a generic unit, or an explicitly declared subprogram other
than an enumeration literal.”
<br><dt><em>Maximal nesting level of composite syntactic constructs</em><dd>This corresponds to the notion of the
maximum nesting level in the GNAT built-in style checks
(see <a href="#Style-Checking">Style Checking</a>)
</dl>
<p class="noindent">For the outermost unit in the file, <samp><span class="command">gnatmetric</span></samp> additionally computes
the following metrics:
<dl>
<dt><em>Public subprograms</em><dd>This metric is computed for package specs. It is the
number of subprograms and generic subprograms declared in the visible
part (including the visible part of nested packages, protected objects, and
protected types).
<br><dt><em>All subprograms</em><dd>This metric is computed for bodies and subunits. The
metric is equal to a total number of subprogram bodies in the compilation
unit.
Neither generic instantiations nor renamings-as-a-body nor body stubs
are counted. Any subprogram body is counted, independently of its nesting
level and enclosing constructs. Generic bodies and bodies of protected
subprograms are counted in the same way as “usual” subprogram bodies.
<br><dt><em>Public types</em><dd>This metric is computed for package specs and
generic package declarations. It is the total number of types
that can be referenced from outside this compilation unit, plus the
number of types from all the visible parts of all the visible generic
packages. Generic formal types are not counted. Only types, not subtypes,
are included.
<p class="noindent">Along with the total number of public types, the following
types are counted and reported separately:
<ul>
<li>Abstract types
<li>Root tagged types (abstract, non-abstract, private, non-private). Type
extensions are <em>not</em> counted
<li>Private types (including private extensions)
<li>Task types
<li>Protected types
</ul>
<br><dt><em>All types</em><dd>This metric is computed for any compilation unit. It is equal to the total
number of the declarations of different types given in the compilation unit.
The private and the corresponding full type declaration are counted as one
type declaration. Incomplete type declarations and generic formal types
are not counted.
No distinction is made among different kinds of types (abstract,
private etc.); the total number of types is computed and reported.
</dl>
<p class="noindent">By default, all the syntax metrics are computed and reported. You can use the
following switches to select specific syntax metrics.
<a name="index-g_t_0040option_007b_002d_002dsyntax_0040var_007bx_007d_007d-_0028_0040command_007bgnatmetric_007d_0029-802"></a>
<a name="index-g_t_0040option_007b_002d_002dno_002dsyntax_0040var_007bx_007d_007d-_0028_0040command_007bgnatmetric_007d_0029-803"></a>
<dl>
<dt><samp><span class="option">--syntax-all</span></samp><dd>Report all the syntax metrics
<br><dt><samp><span class="option">--no-syntax-all</span></samp><dd>Do not report any of syntax metrics
<br><dt><samp><span class="option">--declarations</span></samp><dd>Report the total number of declarations
<br><dt><samp><span class="option">--no-declarations</span></samp><dd>Do not report the total number of declarations
<br><dt><samp><span class="option">--statements</span></samp><dd>Report the total number of statements
<br><dt><samp><span class="option">--no-statements</span></samp><dd>Do not report the total number of statements
<br><dt><samp><span class="option">--public-subprograms</span></samp><dd>Report the number of public subprograms in a compilation unit
<br><dt><samp><span class="option">--no-public-subprograms</span></samp><dd>Do not report the number of public subprograms in a compilation unit
<br><dt><samp><span class="option">--all-subprograms</span></samp><dd>Report the number of all the subprograms in a compilation unit
<br><dt><samp><span class="option">--no-all-subprograms</span></samp><dd>Do not report the number of all the subprograms in a compilation unit
<br><dt><samp><span class="option">--public-types</span></samp><dd>Report the number of public types in a compilation unit
<br><dt><samp><span class="option">--no-public-types</span></samp><dd>Do not report the number of public types in a compilation unit
<br><dt><samp><span class="option">--all-types</span></samp><dd>Report the number of all the types in a compilation unit
<br><dt><samp><span class="option">--no-all-types</span></samp><dd>Do not report the number of all the types in a compilation unit
<br><dt><samp><span class="option">--unit-nesting</span></samp><dd>Report the maximal program unit nesting level
<br><dt><samp><span class="option">--no-unit-nesting</span></samp><dd>Do not report the maximal program unit nesting level
<br><dt><samp><span class="option">--construct-nesting</span></samp><dd>Report the maximal construct nesting level
<br><dt><samp><span class="option">--no-construct-nesting</span></samp><dd>Do not report the maximal construct nesting level
</dl>
<div class="node">
<a name="Complexity-Metrics-Control"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Object_002dOriented-Metrics-Control">Object-Oriented Metrics Control</a>,
Previous: <a rel="previous" accesskey="p" href="#Syntax-Metrics-Control">Syntax Metrics Control</a>,
Up: <a rel="up" accesskey="u" href="#Specifying-a-set-of-metrics-to-compute">Specifying a set of metrics to compute</a>
</div>
<h5 class="subsubsection">15.1.3.3 Complexity Metrics Control</h5>
<p><a name="index-Complexity-metrics-control-in-_0040command_007bgnatmetric_007d-804"></a>
For a program unit that is an executable body (a subprogram body (including
generic bodies), task body, entry body or a package body containing
its own statement sequence) <samp><span class="command">gnatmetric</span></samp> computes the following
complexity metrics:
<ul>
<li>McCabe cyclomatic complexity;
<li>McCabe essential complexity;
<li>maximal loop nesting level
</ul>
<p class="noindent">The McCabe complexity metrics are defined
in <a href="http://www.mccabe.com/pdf/nist235r.pdf">http://www.mccabe.com/pdf/nist235r.pdf</a>
<p>According to McCabe, both control statements and short-circuit control forms
should be taken into account when computing cyclomatic complexity. For each
body, we compute three metric values:
<ul>
<li>the complexity introduced by control
statements only, without taking into account short-circuit forms,
<li>the complexity introduced by short-circuit control forms only, and
<li>the total
cyclomatic complexity, which is the sum of these two values.
</ul>
<p class="noindent">When computing cyclomatic and essential complexity, <samp><span class="command">gnatmetric</span></samp> skips
the code in the exception handlers and in all the nested program units.
<p>By default, all the complexity metrics are computed and reported.
For more fine-grained control you can use
the following switches:
<a name="index-g_t_0040option_007b_002dcomplexity_0040var_007bx_007d_007d-_0028_0040command_007bgnatmetric_007d_0029-805"></a>
<a name="index-g_t_0040option_007b_002d_002dno_002dcomplexity_0040var_007bx_007d_007d-806"></a>
<dl>
<dt><samp><span class="option">--complexity-all</span></samp><dd>Report all the complexity metrics
<br><dt><samp><span class="option">--no-complexity-all</span></samp><dd>Do not report any of complexity metrics
<br><dt><samp><span class="option">--complexity-cyclomatic</span></samp><dd>Report the McCabe Cyclomatic Complexity
<br><dt><samp><span class="option">--no-complexity-cyclomatic</span></samp><dd>Do not report the McCabe Cyclomatic Complexity
<br><dt><samp><span class="option">--complexity-essential</span></samp><dd>Report the Essential Complexity
<br><dt><samp><span class="option">--no-complexity-essential</span></samp><dd>Do not report the Essential Complexity
<br><dt><samp><span class="option">--loop-nesting</span></samp><dd>Report maximal loop nesting level
<br><dt><samp><span class="option">--no-loop-nesting</span></samp><dd>Do not report maximal loop nesting level
<br><dt><samp><span class="option">--complexity-average</span></samp><dd>Report the average McCabe Cyclomatic Complexity for all the subprogram bodies,
task bodies, entry bodies and statement sequences in package bodies.
The metric is computed and reported for whole set of processed Ada sources
only.
<br><dt><samp><span class="option">--no-complexity-average</span></samp><dd>Do not report the average McCabe Cyclomatic Complexity for all the subprogram
bodies, task bodies, entry bodies and statement sequences in package bodies
<p><a name="index-g_t_0040option_007b_002dne_007d-_0028_0040command_007bgnatmetric_007d_0029-807"></a><br><dt><samp><span class="option">-ne</span></samp><dd>Do not consider <code>exit</code> statements as <code>goto</code>s when
computing Essential Complexity
<br><dt><samp><span class="option">--extra-exit-points</span></samp><dd>Report the extra exit points for subprogram bodies. As an exit point, this
metric counts <code>return</code> statements and raise statements in case when the
raised exception is not handled in the same body. In case of a function this
metric subtracts 1 from the number of exit points, because a function body
must contain at least one <code>return</code> statement.
<br><dt><samp><span class="option">--no-extra-exit-points</span></samp><dd>Do not report the extra exit points for subprogram bodies
</dl>
<div class="node">
<a name="Object-Oriented-Metrics-Control"></a>
<a name="Object_002dOriented-Metrics-Control"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Complexity-Metrics-Control">Complexity Metrics Control</a>,
Up: <a rel="up" accesskey="u" href="#Specifying-a-set-of-metrics-to-compute">Specifying a set of metrics to compute</a>
</div>
<h5 class="subsubsection">15.1.3.4 Object-Oriented Metrics Control</h5>
<p><a name="index-Object_002dOriented-metrics-control-in-_0040command_007bgnatmetric_007d-808"></a>
<a name="index-Coupling-metrics-_0028in-in-_0040command_007bgnatmetric_007d_0029-809"></a>Coupling metrics are object-oriented metrics that measure the
dependencies between a given class (or a group of classes) and the
“external world” (that is, the other classes in the program). In this
subsection the term “class” is used in its
traditional object-oriented programming sense
(an instantiable module that contains data and/or method members).
A <em>category</em> (of classes)
is a group of closely related classes that are reused and/or
modified together.
<p>A class <code>K</code>'s <em>efferent coupling</em> is the number of classes
that <code>K</code> depends upon.
A category's efferent coupling is the number of classes outside the
category that the classes inside the category depend upon.
<p>A class <code>K</code>'s <em>afferent coupling</em> is the number of classes
that depend upon <code>K</code>.
A category's afferent coupling is the number of classes outside the
category that depend on classes belonging to the category.
<p>Ada's implementation of the object-oriented paradigm does not use the
traditional class notion, so the definition of the coupling
metrics for Ada maps the class and class category notions
onto Ada constructs.
<p>For the coupling metrics, several kinds of modules – a library package,
a library generic package, and a library generic package instantiation –
that define a tagged type or an interface type are
considered to be a class. A category consists of a library package (or
a library generic package) that defines a tagged or an interface type,
together with all its descendant (generic) packages that define tagged
or interface types. For any package counted as a class,
its body and subunits (if any) are considered
together with its spec when counting the dependencies, and coupling
metrics are reported for spec units only. For dependencies
between classes, the Ada semantic dependencies are considered.
For coupling metrics, only dependencies on units that are considered as
classes, are considered.
<p>When computing coupling metrics, <samp><span class="command">gnatmetric</span></samp> counts only
dependencies between units that are arguments of the gnatmetric call.
Coupling metrics are program-wide (or project-wide) metrics, so to
get a valid result, you should call <samp><span class="command">gnatmetric</span></samp> for
the whole set of sources that make up your program. It can be done
by calling <samp><span class="command">gnatmetric</span></samp> from the GNAT driver with <samp><span class="option">-U</span></samp>
option (see See <a href="#The-GNAT-Driver-and-Project-Files">The GNAT Driver and Project Files</a> for details.
<p>By default, all the coupling metrics are disabled. You can use the following
switches to specify the coupling metrics to be computed and reported:
<a name="index-g_t_0040option_007b_002d_002dpackage_0040var_007bx_007d_007d-_0028_0040command_007bgnatmetric_007d_0029-810"></a>
<a name="index-g_t_0040option_007b_002d_002dno_002dpackage_0040var_007bx_007d_007d-_0028_0040command_007bgnatmetric_007d_0029-811"></a>
<a name="index-g_t_0040option_007b_002d_002dcategory_0040var_007bx_007d_007d-_0028_0040command_007bgnatmetric_007d_0029-812"></a>
<a name="index-g_t_0040option_007b_002d_002dno_002dcategory_0040var_007bx_007d_007d-_0028_0040command_007bgnatmetric_007d_0029-813"></a>
<dl>
<dt><samp><span class="option">--coupling-all</span></samp><dd>Report all the coupling metrics
<br><dt><samp><span class="option">--no-coupling-all</span></samp><dd>Do not report any of metrics
<br><dt><samp><span class="option">--package-efferent-coupling</span></samp><dd>Report package efferent coupling
<br><dt><samp><span class="option">--no-package-efferent-coupling</span></samp><dd>Do not report package efferent coupling
<br><dt><samp><span class="option">--package-afferent-coupling</span></samp><dd>Report package afferent coupling
<br><dt><samp><span class="option">--no-package-afferent-coupling</span></samp><dd>Do not report package afferent coupling
<br><dt><samp><span class="option">--category-efferent-coupling</span></samp><dd>Report category efferent coupling
<br><dt><samp><span class="option">--no-category-efferent-coupling</span></samp><dd>Do not report category efferent coupling
<br><dt><samp><span class="option">--category-afferent-coupling</span></samp><dd>Report category afferent coupling
<br><dt><samp><span class="option">--no-category-afferent-coupling</span></samp><dd>Do not report category afferent coupling
</dl>
<div class="node">
<a name="Other-gnatmetric-Switches"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Generate-project_002dwide-metrics">Generate project-wide metrics</a>,
Previous: <a rel="previous" accesskey="p" href="#Specifying-a-set-of-metrics-to-compute">Specifying a set of metrics to compute</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gnatmetric">Switches for gnatmetric</a>
</div>
<h4 class="subsection">15.1.4 Other <code>gnatmetric</code> Switches</h4>
<p class="noindent">Additional <samp><span class="command">gnatmetric</span></samp> switches are as follows:
<dl>
<dt><samp><span class="option">-files </span><var>filename</var></samp><dd><a name="index-g_t_0040option_007b_002dfiles_007d-_0028_0040code_007bgnatmetric_007d_0029-814"></a>Take the argument source files from the specified file. This file should be an
ordinary text file containing file names separated by spaces or
line breaks. You can use this switch more than once in the same call to
<samp><span class="command">gnatmetric</span></samp>. You also can combine this switch with
an explicit list of files.
<br><dt><samp><span class="option">-v</span></samp><dd><a name="index-g_t_0040option_007b_002dv_007d-_0028_0040code_007bgnatmetric_007d_0029-815"></a>Verbose mode;
<samp><span class="command">gnatmetric</span></samp> generates version information and then
a trace of sources being processed.
<br><dt><samp><span class="option">-q</span></samp><dd><a name="index-g_t_0040option_007b_002dq_007d-_0028_0040code_007bgnatmetric_007d_0029-816"></a>Quiet mode.
</dl>
<div class="node">
<a name="Generate-project-wide-metrics"></a>
<a name="Generate-project_002dwide-metrics"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Other-gnatmetric-Switches">Other gnatmetric Switches</a>,
Up: <a rel="up" accesskey="u" href="#Switches-for-gnatmetric">Switches for gnatmetric</a>
</div>
<h4 class="subsection">15.1.5 Generate project-wide metrics</h4>
<p>In order to compute metrics on all units of a given project, you can use
the <samp><span class="command">gnat</span></samp> driver along with the <samp><span class="option">-P</span></samp> option:
<pre class="smallexample"> gnat metric -Pproj
</pre>
<p class="noindent">If the project <code>proj</code> depends upon other projects, you can compute
the metrics on the project closure using the <samp><span class="option">-U</span></samp> option:
<pre class="smallexample"> gnat metric -Pproj -U
</pre>
<p class="noindent">Finally, if not all the units are relevant to a particular main
program in the project closure, you can generate metrics for the set
of units needed to create a given main program (unit closure) using
the <samp><span class="option">-U</span></samp> option followed by the name of the main unit:
<pre class="smallexample"> gnat metric -Pproj -U main
</pre>
<!-- *********************************** -->
<div class="node">
<a name="File-Name-Krunching-Using-gnatkr"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Preprocessing-Using-gnatprep">Preprocessing Using gnatprep</a>,
Previous: <a rel="previous" accesskey="p" href="#The-GNAT-Metric-Tool-gnatmetric">The GNAT Metric Tool gnatmetric</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">16 File Name Krunching Using <code>gnatkr</code></h2>
<p><a name="index-gnatkr-817"></a>
This chapter discusses the method used by the compiler to shorten
the default file names chosen for Ada units so that they do not
exceed the maximum length permitted. It also describes the
<code>gnatkr</code> utility that can be used to determine the result of
applying this shortening.
<ul class="menu">
<li><a accesskey="1" href="#About-gnatkr">About gnatkr</a>
<li><a accesskey="2" href="#Using-gnatkr">Using gnatkr</a>
<li><a accesskey="3" href="#Krunching-Method">Krunching Method</a>
<li><a accesskey="4" href="#Examples-of-gnatkr-Usage">Examples of gnatkr Usage</a>
</ul>
<div class="node">
<a name="About-gnatkr"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Using-gnatkr">Using gnatkr</a>,
Up: <a rel="up" accesskey="u" href="#File-Name-Krunching-Using-gnatkr">File Name Krunching Using gnatkr</a>
</div>
<h3 class="section">16.1 About <code>gnatkr</code></h3>
<p class="noindent">The default file naming rule in GNAT
is that the file name must be derived from
the unit name. The exact default rule is as follows:
<ul>
<li>Take the unit name and replace all dots by hyphens.
<li>If such a replacement occurs in the
second character position of a name, and the first character is
‘<samp><span class="samp">a</span></samp>’, ‘<samp><span class="samp">g</span></samp>’, ‘<samp><span class="samp">s</span></samp>’, or ‘<samp><span class="samp">i</span></samp>’,
then replace the dot by the character
‘<samp><span class="samp">~</span></samp>’ (tilde)
instead of a minus.
</ul>
The reason for this exception is to avoid clashes
with the standard names for children of System, Ada, Interfaces,
and GNAT, which use the prefixes
‘<samp><span class="samp">s-</span></samp>’, ‘<samp><span class="samp">a-</span></samp>’, ‘<samp><span class="samp">i-</span></samp>’, and ‘<samp><span class="samp">g-</span></samp>’,
respectively.
<p>The <samp><span class="option">-gnatk</span><var>nn</var></samp>
switch of the compiler activates a “krunching”
circuit that limits file names to nn characters (where nn is a decimal
integer). For example, using OpenVMS,
where the maximum file name length is
39, the value of nn is usually set to 39, but if you want to generate
a set of files that would be usable if ported to a system with some
different maximum file length, then a different value can be specified.
The default value of 39 for OpenVMS need not be specified.
<p>The <code>gnatkr</code> utility can be used to determine the krunched name for
a given file, when krunched to a specified maximum length.
<div class="node">
<a name="Using-gnatkr"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Krunching-Method">Krunching Method</a>,
Previous: <a rel="previous" accesskey="p" href="#About-gnatkr">About gnatkr</a>,
Up: <a rel="up" accesskey="u" href="#File-Name-Krunching-Using-gnatkr">File Name Krunching Using gnatkr</a>
</div>
<h3 class="section">16.2 Using <code>gnatkr</code></h3>
<p class="noindent">The <code>gnatkr</code> command has the form
<pre class="smallexample"> <!-- $ gnatkr @var{name} @ovar{length} -->
<!-- Expanding @ovar macro inline (explanation in macro def comments) -->
$ gnatkr <var>name</var> <span class="roman">[</span><var>length</var><span class="roman">]</span>
</pre>
<p class="noindent"><var>name</var> is the uncrunched file name, derived from the name of the unit
in the standard manner described in the previous section (i.e., in particular
all dots are replaced by hyphens). The file name may or may not have an
extension (defined as a suffix of the form period followed by arbitrary
characters other than period). If an extension is present then it will
be preserved in the output. For example, when krunching <samp><span class="file">hellofile.ads</span></samp>
to eight characters, the result will be hellofil.ads.
<p>Note: for compatibility with previous versions of <code>gnatkr</code> dots may
appear in the name instead of hyphens, but the last dot will always be
taken as the start of an extension. So if <code>gnatkr</code> is given an argument
such as <samp><span class="file">Hello.World.adb</span></samp> it will be treated exactly as if the first
period had been a hyphen, and for example krunching to eight characters
gives the result <samp><span class="file">hellworl.adb</span></samp>.
<p>Note that the result is always all lower case (except on OpenVMS where it is
all upper case). Characters of the other case are folded as required.
<p><var>length</var> represents the length of the krunched name. The default
when no argument is given is 8 characters. A length of zero stands for
unlimited, in other words do not chop except for system files where the
implied crunching length is always eight characters.
<p class="noindent">The output is the krunched name. The output has an extension only if the
original argument was a file name with an extension.
<div class="node">
<a name="Krunching-Method"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Examples-of-gnatkr-Usage">Examples of gnatkr Usage</a>,
Previous: <a rel="previous" accesskey="p" href="#Using-gnatkr">Using gnatkr</a>,
Up: <a rel="up" accesskey="u" href="#File-Name-Krunching-Using-gnatkr">File Name Krunching Using gnatkr</a>
</div>
<h3 class="section">16.3 Krunching Method</h3>
<p class="noindent">The initial file name is determined by the name of the unit that the file
contains. The name is formed by taking the full expanded name of the
unit and replacing the separating dots with hyphens and
using lowercase
for all letters, except that a hyphen in the second character position is
replaced by a tilde if the first character is
‘<samp><span class="samp">a</span></samp>’, ‘<samp><span class="samp">i</span></samp>’, ‘<samp><span class="samp">g</span></samp>’, or ‘<samp><span class="samp">s</span></samp>’.
The extension is <code>.ads</code> for a
spec and <code>.adb</code> for a body.
Krunching does not affect the extension, but the file name is shortened to
the specified length by following these rules:
<ul>
<li>The name is divided into segments separated by hyphens, tildes or
underscores and all hyphens, tildes, and underscores are
eliminated. If this leaves the name short enough, we are done.
<li>If the name is too long, the longest segment is located (left-most
if there are two of equal length), and shortened by dropping
its last character. This is repeated until the name is short enough.
<p>As an example, consider the krunching of <br><samp><span class="file">our-strings-wide_fixed.adb</span></samp>
to fit the name into 8 characters as required by some operating systems.
<pre class="smallexample"> our-strings-wide_fixed 22
our strings wide fixed 19
our string wide fixed 18
our strin wide fixed 17
our stri wide fixed 16
our stri wide fixe 15
our str wide fixe 14
our str wid fixe 13
our str wid fix 12
ou str wid fix 11
ou st wid fix 10
ou st wi fix 9
ou st wi fi 8
Final file name: oustwifi.adb
</pre>
<li>The file names for all predefined units are always krunched to eight
characters. The krunching of these predefined units uses the following
special prefix replacements:
<dl>
<dt><samp><span class="file">ada-</span></samp><dd>replaced by <samp><span class="file">a-</span></samp>
<br><dt><samp><span class="file">gnat-</span></samp><dd>replaced by <samp><span class="file">g-</span></samp>
<br><dt><samp><span class="file">interfaces-</span></samp><dd>replaced by <samp><span class="file">i-</span></samp>
<br><dt><samp><span class="file">system-</span></samp><dd>replaced by <samp><span class="file">s-</span></samp>
</dl>
<p>These system files have a hyphen in the second character position. That
is why normal user files replace such a character with a
tilde, to
avoid confusion with system file names.
<p>As an example of this special rule, consider
<br><samp><span class="file">ada-strings-wide_fixed.adb</span></samp>, which gets krunched as follows:
<pre class="smallexample"> ada-strings-wide_fixed 22
a- strings wide fixed 18
a- string wide fixed 17
a- strin wide fixed 16
a- stri wide fixed 15
a- stri wide fixe 14
a- str wide fixe 13
a- str wid fixe 12
a- str wid fix 11
a- st wid fix 10
a- st wi fix 9
a- st wi fi 8
Final file name: a-stwifi.adb
</pre>
</ul>
<p>Of course no file shortening algorithm can guarantee uniqueness over all
possible unit names, and if file name krunching is used then it is your
responsibility to ensure that no name clashes occur. The utility
program <code>gnatkr</code> is supplied for conveniently determining the
krunched name of a file.
<div class="node">
<a name="Examples-of-gnatkr-Usage"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Krunching-Method">Krunching Method</a>,
Up: <a rel="up" accesskey="u" href="#File-Name-Krunching-Using-gnatkr">File Name Krunching Using gnatkr</a>
</div>
<h3 class="section">16.4 Examples of <code>gnatkr</code> Usage</h3>
<pre class="smallexample"> $ gnatkr very_long_unit_name.ads --> velounna.ads
$ gnatkr grandparent-parent-child.ads --> grparchi.ads
$ gnatkr Grandparent.Parent.Child.ads --> grparchi.ads
$ gnatkr grandparent-parent-child --> grparchi
$ gnatkr very_long_unit_name.ads/count=6 --> vlunna.ads
$ gnatkr very_long_unit_name.ads/count=0 --> very_long_unit_name.ads
</pre>
<div class="node">
<a name="Preprocessing-Using-gnatprep"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#The-GNAT-Library-Browser-gnatls">The GNAT Library Browser gnatls</a>,
Previous: <a rel="previous" accesskey="p" href="#File-Name-Krunching-Using-gnatkr">File Name Krunching Using gnatkr</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">17 Preprocessing Using <code>gnatprep</code></h2>
<p><a name="index-gnatprep-818"></a>
This chapter discusses how to use GNAT's <code>gnatprep</code> utility for simple
preprocessing.
Although designed for use with GNAT, <code>gnatprep</code> does not depend on any
special GNAT features.
For further discussion of conditional compilation in general, see
<a href="#Conditional-Compilation">Conditional Compilation</a>.
<ul class="menu">
<li><a accesskey="1" href="#Preprocessing-Symbols">Preprocessing Symbols</a>
<li><a accesskey="2" href="#Using-gnatprep">Using gnatprep</a>
<li><a accesskey="3" href="#Switches-for-gnatprep">Switches for gnatprep</a>
<li><a accesskey="4" href="#Form-of-Definitions-File">Form of Definitions File</a>
<li><a accesskey="5" href="#Form-of-Input-Text-for-gnatprep">Form of Input Text for gnatprep</a>
</ul>
<div class="node">
<a name="Preprocessing-Symbols"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Using-gnatprep">Using gnatprep</a>,
Up: <a rel="up" accesskey="u" href="#Preprocessing-Using-gnatprep">Preprocessing Using gnatprep</a>
</div>
<h3 class="section">17.1 Preprocessing Symbols</h3>
<p class="noindent">Preprocessing symbols are defined in definition files and referred to in
sources to be preprocessed. A Preprocessing symbol is an identifier, following
normal Ada (case-insensitive) rules for its syntax, with the restriction that
all characters need to be in the ASCII set (no accented letters).
<div class="node">
<a name="Using-gnatprep"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Switches-for-gnatprep">Switches for gnatprep</a>,
Previous: <a rel="previous" accesskey="p" href="#Preprocessing-Symbols">Preprocessing Symbols</a>,
Up: <a rel="up" accesskey="u" href="#Preprocessing-Using-gnatprep">Preprocessing Using gnatprep</a>
</div>
<h3 class="section">17.2 Using <code>gnatprep</code></h3>
<p class="noindent">To call <code>gnatprep</code> use
<pre class="smallexample"> <!-- $ gnatprep @ovar{switches} @var{infile} @var{outfile} @ovar{deffile} -->
<!-- Expanding @ovar macro inline (explanation in macro def comments) -->
$ gnatprep <span class="roman">[</span><var>switches</var><span class="roman">]</span> <var>infile</var> <var>outfile</var> <span class="roman">[</span><var>deffile</var><span class="roman">]</span>
</pre>
<p class="noindent">where
<dl>
<dt><var>switches</var><dd>is an optional sequence of switches as described in the next section.
<br><dt><var>infile</var><dd>is the full name of the input file, which is an Ada source
file containing preprocessor directives.
<br><dt><var>outfile</var><dd>is the full name of the output file, which is an Ada source
in standard Ada form. When used with GNAT, this file name will
normally have an ads or adb suffix.
<br><dt><var>deffile</var><dd>is the full name of a text file containing definitions of
preprocessing symbols to be referenced by the preprocessor. This argument is
optional, and can be replaced by the use of the <samp><span class="option">-D</span></samp> switch.
</dl>
<div class="node">
<a name="Switches-for-gnatprep"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Form-of-Definitions-File">Form of Definitions File</a>,
Previous: <a rel="previous" accesskey="p" href="#Using-gnatprep">Using gnatprep</a>,
Up: <a rel="up" accesskey="u" href="#Preprocessing-Using-gnatprep">Preprocessing Using gnatprep</a>
</div>
<h3 class="section">17.3 Switches for <code>gnatprep</code></h3>
<dl>
<!-- !sort! -->
<dt><samp><span class="option">-b</span></samp><dd><a name="index-g_t_0040option_007b_002db_007d-_0028_0040command_007bgnatprep_007d_0029-819"></a>Causes both preprocessor lines and the lines deleted by
preprocessing to be replaced by blank lines in the output source file,
preserving line numbers in the output file.
<br><dt><samp><span class="option">-c</span></samp><dd><a name="index-g_t_0040option_007b_002dc_007d-_0028_0040command_007bgnatprep_007d_0029-820"></a>Causes both preprocessor lines and the lines deleted
by preprocessing to be retained in the output source as comments marked
with the special string <code>"--! "</code>. This option will result in line numbers
being preserved in the output file.
<br><dt><samp><span class="option">-C</span></samp><dd><a name="index-g_t_0040option_007b_002dC_007d-_0028_0040command_007bgnatprep_007d_0029-821"></a>Causes comments to be scanned. Normally comments are ignored by gnatprep.
If this option is specified, then comments are scanned and any $symbol
substitutions performed as in program text. This is particularly useful
when structured comments are used (e.g., when writing programs in the
SPARK dialect of Ada). Note that this switch is not available when
doing integrated preprocessing (it would be useless in this context
since comments are ignored by the compiler in any case).
<br><dt><samp><span class="option">-Dsymbol=value</span></samp><dd><a name="index-g_t_0040option_007b_002dD_007d-_0028_0040command_007bgnatprep_007d_0029-822"></a>Defines a new preprocessing symbol, associated with value. If no value is given
on the command line, then symbol is considered to be <code>True</code>. This switch
can be used in place of a definition file.
<br><dt><samp><span class="option">-r</span></samp><dd><a name="index-g_t_0040option_007b_002dr_007d-_0028_0040command_007bgnatprep_007d_0029-823"></a>Causes a <code>Source_Reference</code> pragma to be generated that
references the original input file, so that error messages will use
the file name of this original file. The use of this switch implies
that preprocessor lines are not to be removed from the file, so its
use will force <samp><span class="option">-b</span></samp> mode if
<samp><span class="option">-c</span></samp>
has not been specified explicitly.
<p>Note that if the file to be preprocessed contains multiple units, then
it will be necessary to <code>gnatchop</code> the output file from
<code>gnatprep</code>. If a <code>Source_Reference</code> pragma is present
in the preprocessed file, it will be respected by
<code>gnatchop -r</code>
so that the final chopped files will correctly refer to the original
input source file for <code>gnatprep</code>.
<br><dt><samp><span class="option">-s</span></samp><dd><a name="index-g_t_0040option_007b_002ds_007d-_0028_0040command_007bgnatprep_007d_0029-824"></a>Causes a sorted list of symbol names and values to be
listed on the standard output file.
<br><dt><samp><span class="option">-u</span></samp><dd><a name="index-g_t_0040option_007b_002du_007d-_0028_0040command_007bgnatprep_007d_0029-825"></a>Causes undefined symbols to be treated as having the value FALSE in the context
of a preprocessor test. In the absence of this option, an undefined symbol in
a <code>#if</code> or <code>#elsif</code> test will be treated as an error.
</dl>
<p class="noindent">Note: if neither <samp><span class="option">-b</span></samp> nor <samp><span class="option">-c</span></samp> is present,
then preprocessor lines and
deleted lines are completely removed from the output, unless -r is
specified, in which case -b is assumed.
<div class="node">
<a name="Form-of-Definitions-File"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Form-of-Input-Text-for-gnatprep">Form of Input Text for gnatprep</a>,
Previous: <a rel="previous" accesskey="p" href="#Switches-for-gnatprep">Switches for gnatprep</a>,
Up: <a rel="up" accesskey="u" href="#Preprocessing-Using-gnatprep">Preprocessing Using gnatprep</a>
</div>
<h3 class="section">17.4 Form of Definitions File</h3>
<p class="noindent">The definitions file contains lines of the form
<pre class="smallexample"> symbol := value
</pre>
<p class="noindent">where symbol is a preprocessing symbol, and value is one of the following:
<ul>
<li>Empty, corresponding to a null substitution
<li>A string literal using normal Ada syntax
<li>Any sequence of characters from the set
(letters, digits, period, underline).
</ul>
<p class="noindent">Comment lines may also appear in the definitions file, starting with
the usual <code>--</code>,
and comments may be added to the definitions lines.
<div class="node">
<a name="Form-of-Input-Text-for-gnatprep"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Form-of-Definitions-File">Form of Definitions File</a>,
Up: <a rel="up" accesskey="u" href="#Preprocessing-Using-gnatprep">Preprocessing Using gnatprep</a>
</div>
<h3 class="section">17.5 Form of Input Text for <code>gnatprep</code></h3>
<p class="noindent">The input text may contain preprocessor conditional inclusion lines,
as well as general symbol substitution sequences.
<p>The preprocessor conditional inclusion commands have the form
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
#if <i>expression</i> <span class="roman">[</span>then<span class="roman">]</span>
lines
#elsif <i>expression</i> <span class="roman">[</span>then<span class="roman">]</span>
lines
#elsif <i>expression</i> <span class="roman">[</span>then<span class="roman">]</span>
lines
...
#else
lines
#end if;
</td></tr></table>
</pre>
<p class="noindent">In this example, <i>expression</i> is defined by the following grammar:
<pre class="smallexample"> <i>expression</i> ::= <symbol>
<i>expression</i> ::= <symbol> = "<value>"
<i>expression</i> ::= <symbol> = <symbol>
<i>expression</i> ::= <symbol> 'Defined
<i>expression</i> ::= not <i>expression</i>
<i>expression</i> ::= <i>expression</i> and <i>expression</i>
<i>expression</i> ::= <i>expression</i> or <i>expression</i>
<i>expression</i> ::= <i>expression</i> and then <i>expression</i>
<i>expression</i> ::= <i>expression</i> or else <i>expression</i>
<i>expression</i> ::= ( <i>expression</i> )
</pre>
<p>The following restriction exists: it is not allowed to have "and" or "or"
following "not" in the same expression without parentheses. For example, this
is not allowed:
<pre class="smallexample"> not X or Y
</pre>
<p>This should be one of the following:
<pre class="smallexample"> (not X) or Y
not (X or Y)
</pre>
<p class="noindent">For the first test (<i>expression</i> ::= <symbol>) the symbol must have
either the value true or false, that is to say the right-hand of the
symbol definition must be one of the (case-insensitive) literals
<code>True</code> or <code>False</code>. If the value is true, then the
corresponding lines are included, and if the value is false, they are
excluded.
<p>The test (<i>expression</i> ::= <symbol> <code>'Defined</code>) is true only if
the symbol has been defined in the definition file or by a <samp><span class="option">-D</span></samp>
switch on the command line. Otherwise, the test is false.
<p>The equality tests are case insensitive, as are all the preprocessor lines.
<p>If the symbol referenced is not defined in the symbol definitions file,
then the effect depends on whether or not switch <samp><span class="option">-u</span></samp>
is specified. If so, then the symbol is treated as if it had the value
false and the test fails. If this switch is not specified, then
it is an error to reference an undefined symbol. It is also an error to
reference a symbol that is defined with a value other than <code>True</code>
or <code>False</code>.
<p>The use of the <code>not</code> operator inverts the sense of this logical test.
The <code>not</code> operator cannot be combined with the <code>or</code> or <code>and</code>
operators, without parentheses. For example, "if not X or Y then" is not
allowed, but "if (not X) or Y then" and "if not (X or Y) then" are.
<p>The <code>then</code> keyword is optional as shown
<p>The <code>#</code> must be the first non-blank character on a line, but
otherwise the format is free form. Spaces or tabs may appear between
the <code>#</code> and the keyword. The keywords and the symbols are case
insensitive as in normal Ada code. Comments may be used on a
preprocessor line, but other than that, no other tokens may appear on a
preprocessor line. Any number of <code>elsif</code> clauses can be present,
including none at all. The <code>else</code> is optional, as in Ada.
<p>The <code>#</code> marking the start of a preprocessor line must be the first
non-blank character on the line, i.e., it must be preceded only by
spaces or horizontal tabs.
<p>Symbol substitution outside of preprocessor lines is obtained by using
the sequence
<pre class="smallexample"> $symbol
</pre>
<p class="noindent">anywhere within a source line, except in a comment or within a
string literal. The identifier
following the <code>$</code> must match one of the symbols defined in the symbol
definition file, and the result is to substitute the value of the
symbol in place of <code>$symbol</code> in the output file.
<p>Note that although the substitution of strings within a string literal
is not possible, it is possible to have a symbol whose defined value is
a string literal. So instead of setting XYZ to <code>hello</code> and writing:
<pre class="smallexample"> Header : String := "$XYZ";
</pre>
<p class="noindent">you should set XYZ to <code>"hello"</code> and write:
<pre class="smallexample"> Header : String := $XYZ;
</pre>
<p class="noindent">and then the substitution will occur as desired.
<div class="node">
<a name="The-GNAT-Library-Browser-gnatls"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Cleaning-Up-Using-gnatclean">Cleaning Up Using gnatclean</a>,
Previous: <a rel="previous" accesskey="p" href="#Preprocessing-Using-gnatprep">Preprocessing Using gnatprep</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">18 The GNAT Library Browser <code>gnatls</code></h2>
<p><a name="index-gnatls-826"></a><a name="index-Library-browser-827"></a>
<code>gnatls</code> is a tool that outputs information about compiled
units. It gives the relationship between objects, unit names and source
files. It can also be used to check the source dependencies of a unit
as well as various characteristics.
<p>Note: to invoke <code>gnatls</code> with a project file, use the <code>gnat</code>
driver (see <a href="#The-GNAT-Driver-and-Project-Files">The GNAT Driver and Project Files</a>).
<ul class="menu">
<li><a accesskey="1" href="#Running-gnatls">Running gnatls</a>
<li><a accesskey="2" href="#Switches-for-gnatls">Switches for gnatls</a>
<li><a accesskey="3" href="#Examples-of-gnatls-Usage">Examples of gnatls Usage</a>
</ul>
<div class="node">
<a name="Running-gnatls"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Switches-for-gnatls">Switches for gnatls</a>,
Up: <a rel="up" accesskey="u" href="#The-GNAT-Library-Browser-gnatls">The GNAT Library Browser gnatls</a>
</div>
<h3 class="section">18.1 Running <code>gnatls</code></h3>
<p class="noindent">The <code>gnatls</code> command has the form
<pre class="smallexample"> $ gnatls switches <var>object_or_ali_file</var>
</pre>
<p class="noindent">The main argument is the list of object or <samp><span class="file">ali</span></samp> files
(see <a href="#The-Ada-Library-Information-Files">The Ada Library Information Files</a>)
for which information is requested.
<p>In normal mode, without additional option, <code>gnatls</code> produces a
four-column listing. Each line represents information for a specific
object. The first column gives the full path of the object, the second
column gives the name of the principal unit in this object, the third
column gives the status of the source and the fourth column gives the
full path of the source representing this unit.
Here is a simple example of use:
<pre class="smallexample"> $ gnatls *.o
./demo1.o demo1 DIF demo1.adb
./demo2.o demo2 OK demo2.adb
./hello.o h1 OK hello.adb
./instr-child.o instr.child MOK instr-child.adb
./instr.o instr OK instr.adb
./tef.o tef DIF tef.adb
./text_io_example.o text_io_example OK text_io_example.adb
./tgef.o tgef DIF tgef.adb
</pre>
<p class="noindent">The first line can be interpreted as follows: the main unit which is
contained in
object file <samp><span class="file">demo1.o</span></samp> is demo1, whose main source is in
<samp><span class="file">demo1.adb</span></samp>. Furthermore, the version of the source used for the
compilation of demo1 has been modified (DIF). Each source file has a status
qualifier which can be:
<dl>
<dt><code>OK (unchanged)</code><dd>The version of the source file used for the compilation of the
specified unit corresponds exactly to the actual source file.
<br><dt><code>MOK (slightly modified)</code><dd>The version of the source file used for the compilation of the
specified unit differs from the actual source file but not enough to
require recompilation. If you use gnatmake with the qualifier
<samp><span class="option">-m (minimal recompilation)</span></samp>, a file marked
MOK will not be recompiled.
<br><dt><code>DIF (modified)</code><dd>No version of the source found on the path corresponds to the source
used to build this object.
<br><dt><code>??? (file not found)</code><dd>No source file was found for this unit.
<br><dt><code>HID (hidden, unchanged version not first on PATH)</code><dd>The version of the source that corresponds exactly to the source used
for compilation has been found on the path but it is hidden by another
version of the same source that has been modified.
</dl>
<div class="node">
<a name="Switches-for-gnatls"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Examples-of-gnatls-Usage">Examples of gnatls Usage</a>,
Previous: <a rel="previous" accesskey="p" href="#Running-gnatls">Running gnatls</a>,
Up: <a rel="up" accesskey="u" href="#The-GNAT-Library-Browser-gnatls">The GNAT Library Browser gnatls</a>
</div>
<h3 class="section">18.2 Switches for <code>gnatls</code></h3>
<p class="noindent"><code>gnatls</code> recognizes the following switches:
<dl>
<!-- !sort! -->
<a name="index-g_t_0040option_007b_002d_002dversion_007d-_0040command_007bgnatls_007d-828"></a>Display Copyright and version, then exit disregarding all other options.
<dt><samp><span class="option">--help</span></samp><dd><a name="index-g_t_0040option_007b_002d_002dhelp_007d-_0040command_007bgnatls_007d-829"></a>If <samp><span class="option">--version</span></samp> was not used, display usage, then exit disregarding
all other options.
<br><dt><samp><span class="option">-a</span></samp><dd><a name="index-g_t_0040option_007b_002da_007d-_0028_0040code_007bgnatls_007d_0029-830"></a>Consider all units, including those of the predefined Ada library.
Especially useful with <samp><span class="option">-d</span></samp>.
<br><dt><samp><span class="option">-d</span></samp><dd><a name="index-g_t_0040option_007b_002dd_007d-_0028_0040code_007bgnatls_007d_0029-831"></a>List sources from which specified units depend on.
<br><dt><samp><span class="option">-h</span></samp><dd><a name="index-g_t_0040option_007b_002dh_007d-_0028_0040code_007bgnatls_007d_0029-832"></a>Output the list of options.
<br><dt><samp><span class="option">-o</span></samp><dd><a name="index-g_t_0040option_007b_002do_007d-_0028_0040code_007bgnatls_007d_0029-833"></a>Only output information about object files.
<br><dt><samp><span class="option">-s</span></samp><dd><a name="index-g_t_0040option_007b_002ds_007d-_0028_0040code_007bgnatls_007d_0029-834"></a>Only output information about source files.
<br><dt><samp><span class="option">-u</span></samp><dd><a name="index-g_t_0040option_007b_002du_007d-_0028_0040code_007bgnatls_007d_0029-835"></a>Only output information about compilation units.
<br><dt><samp><span class="option">-files=</span><var>file</var></samp><dd><a name="index-g_t_0040option_007b_002dfiles_007d-_0028_0040code_007bgnatls_007d_0029-836"></a>Take as arguments the files listed in text file <var>file</var>.
Text file <var>file</var> may contain empty lines that are ignored.
Each nonempty line should contain the name of an existing file.
Several such switches may be specified simultaneously.
<br><dt><samp><span class="option">-aO</span><var>dir</var></samp><dt><samp><span class="option">-aI</span><var>dir</var></samp><dt><samp><span class="option">-I</span><var>dir</var></samp><dt><samp><span class="option">-I-</span></samp><dt><samp><span class="option">-nostdinc</span></samp><dd><a name="index-g_t_0040option_007b_002daO_007d-_0028_0040code_007bgnatls_007d_0029-837"></a><a name="index-g_t_0040option_007b_002daI_007d-_0028_0040code_007bgnatls_007d_0029-838"></a><a name="index-g_t_0040option_007b_002dI_007d-_0028_0040code_007bgnatls_007d_0029-839"></a><a name="index-g_t_0040option_007b_002dI_002d_007d-_0028_0040code_007bgnatls_007d_0029-840"></a>Source path manipulation. Same meaning as the equivalent <samp><span class="command">gnatmake</span></samp>
flags (see <a href="#Switches-for-gnatmake">Switches for gnatmake</a>).
<br><dt><samp><span class="option">--RTS=</span><var>rts-path</var></samp><dd><a name="index-g_t_0040option_007b_002d_002dRTS_007d-_0028_0040code_007bgnatls_007d_0029-841"></a>Specifies the default location of the runtime library. Same meaning as the
equivalent <samp><span class="command">gnatmake</span></samp> flag (see <a href="#Switches-for-gnatmake">Switches for gnatmake</a>).
<br><dt><samp><span class="option">-v</span></samp><dd><a name="index-g_t_0040option_007b_002dv_007d-_0028_0040code_007bgnatls_007d_0029-842"></a>Verbose mode. Output the complete source, object and project paths. Do not use
the default column layout but instead use long format giving as much as
information possible on each requested units, including special
characteristics such as:
<dl>
<dt><code>Preelaborable</code><dd>The unit is preelaborable in the Ada sense.
<br><dt><code>No_Elab_Code</code><dd>No elaboration code has been produced by the compiler for this unit.
<br><dt><code>Pure</code><dd>The unit is pure in the Ada sense.
<br><dt><code>Elaborate_Body</code><dd>The unit contains a pragma Elaborate_Body.
<br><dt><code>Remote_Types</code><dd>The unit contains a pragma Remote_Types.
<br><dt><code>Shared_Passive</code><dd>The unit contains a pragma Shared_Passive.
<br><dt><code>Predefined</code><dd>This unit is part of the predefined environment and cannot be modified
by the user.
<br><dt><code>Remote_Call_Interface</code><dd>The unit contains a pragma Remote_Call_Interface.
</dl>
</dl>
<div class="node">
<a name="Examples-of-gnatls-Usage"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Switches-for-gnatls">Switches for gnatls</a>,
Up: <a rel="up" accesskey="u" href="#The-GNAT-Library-Browser-gnatls">The GNAT Library Browser gnatls</a>
</div>
<h3 class="section">18.3 Example of <code>gnatls</code> Usage</h3>
<p class="noindent">Example of using the verbose switch. Note how the source and
object paths are affected by the -I switch.
<pre class="smallexample"> $ gnatls -v -I.. demo1.o
GNATLS 5.03w (20041123-34)
Copyright 1997-2004 Free Software Foundation, Inc.
Source Search Path:
<Current_Directory>
../
/home/comar/local/adainclude/
Object Search Path:
<Current_Directory>
../
/home/comar/local/lib/gcc-lib/x86-linux/3.4.3/adalib/
Project Search Path:
<Current_Directory>
/home/comar/local/lib/gnat/
./demo1.o
Unit =>
Name => demo1
Kind => subprogram body
Flags => No_Elab_Code
Source => demo1.adb modified
</pre>
<p class="noindent">The following is an example of use of the dependency list.
Note the use of the -s switch
which gives a straight list of source files. This can be useful for
building specialized scripts.
<pre class="smallexample"> $ gnatls -d demo2.o
./demo2.o demo2 OK demo2.adb
OK gen_list.ads
OK gen_list.adb
OK instr.ads
OK instr-child.ads
$ gnatls -d -s -a demo1.o
demo1.adb
/home/comar/local/adainclude/ada.ads
/home/comar/local/adainclude/a-finali.ads
/home/comar/local/adainclude/a-filico.ads
/home/comar/local/adainclude/a-stream.ads
/home/comar/local/adainclude/a-tags.ads
gen_list.ads
gen_list.adb
/home/comar/local/adainclude/gnat.ads
/home/comar/local/adainclude/g-io.ads
instr.ads
/home/comar/local/adainclude/system.ads
/home/comar/local/adainclude/s-exctab.ads
/home/comar/local/adainclude/s-finimp.ads
/home/comar/local/adainclude/s-finroo.ads
/home/comar/local/adainclude/s-secsta.ads
/home/comar/local/adainclude/s-stalib.ads
/home/comar/local/adainclude/s-stoele.ads
/home/comar/local/adainclude/s-stratt.ads
/home/comar/local/adainclude/s-tasoli.ads
/home/comar/local/adainclude/s-unstyp.ads
/home/comar/local/adainclude/unchconv.ads
</pre>
<div class="node">
<a name="Cleaning-Up-Using-gnatclean"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#GNAT-and-Libraries">GNAT and Libraries</a>,
Previous: <a rel="previous" accesskey="p" href="#The-GNAT-Library-Browser-gnatls">The GNAT Library Browser gnatls</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">19 Cleaning Up Using <code>gnatclean</code></h2>
<p><a name="index-gnatclean-843"></a><a name="index-Cleaning-tool-844"></a>
<code>gnatclean</code> is a tool that allows the deletion of files produced by the
compiler, binder and linker, including ALI files, object files, tree files,
expanded source files, library files, interface copy source files, binder
generated files and executable files.
<ul class="menu">
<li><a accesskey="1" href="#Running-gnatclean">Running gnatclean</a>
<li><a accesskey="2" href="#Switches-for-gnatclean">Switches for gnatclean</a>
<!-- * Examples of gnatclean Usage:: -->
</ul>
<div class="node">
<a name="Running-gnatclean"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Switches-for-gnatclean">Switches for gnatclean</a>,
Up: <a rel="up" accesskey="u" href="#Cleaning-Up-Using-gnatclean">Cleaning Up Using gnatclean</a>
</div>
<h3 class="section">19.1 Running <code>gnatclean</code></h3>
<p class="noindent">The <code>gnatclean</code> command has the form:
<pre class="smallexample"> $ gnatclean switches <var>names</var>
</pre>
<p class="noindent"><var>names</var> is a list of source file names. Suffixes <code>.ads</code> and
<code>adb</code> may be omitted. If a project file is specified using switch
<code>-P</code>, then <var>names</var> may be completely omitted.
<p class="noindent">In normal mode, <code>gnatclean</code> delete the files produced by the compiler and,
if switch <code>-c</code> is not specified, by the binder and
the linker. In informative-only mode, specified by switch
<code>-n</code>, the list of files that would have been deleted in
normal mode is listed, but no file is actually deleted.
<div class="node">
<a name="Switches-for-gnatclean"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Running-gnatclean">Running gnatclean</a>,
Up: <a rel="up" accesskey="u" href="#Cleaning-Up-Using-gnatclean">Cleaning Up Using gnatclean</a>
</div>
<h3 class="section">19.2 Switches for <code>gnatclean</code></h3>
<p class="noindent"><code>gnatclean</code> recognizes the following switches:
<dl>
<!-- !sort! -->
<a name="index-g_t_0040option_007b_002d_002dversion_007d-_0040command_007bgnatclean_007d-845"></a>Display Copyright and version, then exit disregarding all other options.
<dt><samp><span class="option">--help</span></samp><dd><a name="index-g_t_0040option_007b_002d_002dhelp_007d-_0040command_007bgnatclean_007d-846"></a>If <samp><span class="option">--version</span></samp> was not used, display usage, then exit disregarding
all other options.
<br><dt><samp><span class="option">--subdirs=subdir</span></samp><dd>Actual object directory of each project file is the subdirectory subdir of the
object directory specified or defaulted in the project file.
<br><dt><samp><span class="option">--unchecked-shared-lib-imports</span></samp><dd>By default, shared library projects are not allowed to import static library
projects. When this switch is used on the command line, this restriction is
relaxed.
<br><dt><samp><span class="option">-c</span></samp><dd><a name="index-g_t_0040option_007b_002dc_007d-_0028_0040code_007bgnatclean_007d_0029-847"></a>Only attempt to delete the files produced by the compiler, not those produced
by the binder or the linker. The files that are not to be deleted are library
files, interface copy files, binder generated files and executable files.
<br><dt><samp><span class="option">-D </span><var>dir</var></samp><dd><a name="index-g_t_0040option_007b_002dD_007d-_0028_0040code_007bgnatclean_007d_0029-848"></a>Indicate that ALI and object files should normally be found in directory
<var>dir</var>.
<br><dt><samp><span class="option">-F</span></samp><dd><a name="index-g_t_0040option_007b_002dF_007d-_0028_0040code_007bgnatclean_007d_0029-849"></a>When using project files, if some errors or warnings are detected during
parsing and verbose mode is not in effect (no use of switch
-v), then error lines start with the full path name of the project
file, rather than its simple file name.
<br><dt><samp><span class="option">-h</span></samp><dd><a name="index-g_t_0040option_007b_002dh_007d-_0028_0040code_007bgnatclean_007d_0029-850"></a>Output a message explaining the usage of <code>gnatclean</code>.
<br><dt><samp><span class="option">-n</span></samp><dd><a name="index-g_t_0040option_007b_002dn_007d-_0028_0040code_007bgnatclean_007d_0029-851"></a>Informative-only mode. Do not delete any files. Output the list of the files
that would have been deleted if this switch was not specified.
<br><dt><samp><span class="option">-P</span><var>project</var></samp><dd><a name="index-g_t_0040option_007b_002dP_007d-_0028_0040code_007bgnatclean_007d_0029-852"></a>Use project file <var>project</var>. Only one such switch can be used.
When cleaning a project file, the files produced by the compilation of the
immediate sources or inherited sources of the project files are to be
deleted. This is not depending on the presence or not of executable names
on the command line.
<br><dt><samp><span class="option">-q</span></samp><dd><a name="index-g_t_0040option_007b_002dq_007d-_0028_0040code_007bgnatclean_007d_0029-853"></a>Quiet output. If there are no errors, do not output anything, except in
verbose mode (switch -v) or in informative-only mode
(switch -n).
<br><dt><samp><span class="option">-r</span></samp><dd><a name="index-g_t_0040option_007b_002dr_007d-_0028_0040code_007bgnatclean_007d_0029-854"></a>When a project file is specified (using switch -P),
clean all imported and extended project files, recursively. If this switch
is not specified, only the files related to the main project file are to be
deleted. This switch has no effect if no project file is specified.
<br><dt><samp><span class="option">-v</span></samp><dd><a name="index-g_t_0040option_007b_002dv_007d-_0028_0040code_007bgnatclean_007d_0029-855"></a>Verbose mode.
<br><dt><samp><span class="option">-vP</span><em>x</em></samp><dd><a name="index-g_t_0040option_007b_002dvP_007d-_0028_0040code_007bgnatclean_007d_0029-856"></a>Indicates the verbosity of the parsing of GNAT project files.
See <a href="#Switches-Related-to-Project-Files">Switches Related to Project Files</a>.
<br><dt><samp><span class="option">-X</span><var>name=value</var></samp><dd><a name="index-g_t_0040option_007b_002dX_007d-_0028_0040code_007bgnatclean_007d_0029-857"></a>Indicates that external variable <var>name</var> has the value <var>value</var>.
The Project Manager will use this value for occurrences of
<code>external(name)</code> when parsing the project file.
See <a href="#Switches-Related-to-Project-Files">Switches Related to Project Files</a>.
<br><dt><samp><span class="option">-aO</span><var>dir</var></samp><dd><a name="index-g_t_0040option_007b_002daO_007d-_0028_0040code_007bgnatclean_007d_0029-858"></a>When searching for ALI and object files, look in directory
<var>dir</var>.
<br><dt><samp><span class="option">-I</span><var>dir</var></samp><dd><a name="index-g_t_0040option_007b_002dI_007d-_0028_0040code_007bgnatclean_007d_0029-859"></a>Equivalent to <samp><span class="option">-aO</span><var>dir</var></samp>.
<br><dt><samp><span class="option">-I-</span></samp><dd><a name="index-g_t_0040option_007b_002dI_002d_007d-_0028_0040code_007bgnatclean_007d_0029-860"></a><a name="index-Source-files_002c-suppressing-search-861"></a>Do not look for ALI or object files in the directory
where <code>gnatclean</code> was invoked.
</dl>
<!-- @node Examples of gnatclean Usage -->
<!-- @section Examples of @code{gnatclean} Usage -->
<div class="node">
<a name="GNAT-and-Libraries"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Using-the-GNU-make-Utility">Using the GNU make Utility</a>,
Previous: <a rel="previous" accesskey="p" href="#Cleaning-Up-Using-gnatclean">Cleaning Up Using gnatclean</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">20 GNAT and Libraries</h2>
<p><a name="index-Library_002c-building_002c-installing_002c-using-862"></a>
This chapter describes how to build and use libraries with GNAT, and also shows
how to recompile the GNAT run-time library. You should be familiar with the
Project Manager facility (see <a href="#GNAT-Project-Manager">GNAT Project Manager</a>) before reading this
chapter.
<ul class="menu">
<li><a accesskey="1" href="#Introduction-to-Libraries-in-GNAT">Introduction to Libraries in GNAT</a>
<li><a accesskey="2" href="#General-Ada-Libraries">General Ada Libraries</a>
<li><a accesskey="3" href="#Stand_002dalone-Ada-Libraries">Stand-alone Ada Libraries</a>
<li><a accesskey="4" href="#Rebuilding-the-GNAT-Run_002dTime-Library">Rebuilding the GNAT Run-Time Library</a>
</ul>
<div class="node">
<a name="Introduction-to-Libraries-in-GNAT"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#General-Ada-Libraries">General Ada Libraries</a>,
Up: <a rel="up" accesskey="u" href="#GNAT-and-Libraries">GNAT and Libraries</a>
</div>
<h3 class="section">20.1 Introduction to Libraries in GNAT</h3>
<p class="noindent">A library is, conceptually, a collection of objects which does not have its
own main thread of execution, but rather provides certain services to the
applications that use it. A library can be either statically linked with the
application, in which case its code is directly included in the application,
or, on platforms that support it, be dynamically linked, in which case
its code is shared by all applications making use of this library.
<p>GNAT supports both types of libraries.
In the static case, the compiled code can be provided in different ways. The
simplest approach is to provide directly the set of objects resulting from
compilation of the library source files. Alternatively, you can group the
objects into an archive using whatever commands are provided by the operating
system. For the latter case, the objects are grouped into a shared library.
<p>In the GNAT environment, a library has three types of components:
<ul>
<li>Source files.
<li><samp><span class="file">ALI</span></samp> files.
See <a href="#The-Ada-Library-Information-Files">The Ada Library Information Files</a>.
<li>Object files, an archive or a shared library.
</ul>
<p class="noindent">A GNAT library may expose all its source files, which is useful for
documentation purposes. Alternatively, it may expose only the units needed by
an external user to make use of the library. That is to say, the specs
reflecting the library services along with all the units needed to compile
those specs, which can include generic bodies or any body implementing an
inlined routine. In the case of <em>stand-alone libraries</em> those exposed
units are called <em>interface units</em> (see <a href="#Stand_002dalone-Ada-Libraries">Stand-alone Ada Libraries</a>).
<p>All compilation units comprising an application, including those in a library,
need to be elaborated in an order partially defined by Ada's semantics. GNAT
computes the elaboration order from the <samp><span class="file">ALI</span></samp> files and this is why they
constitute a mandatory part of GNAT libraries.
<em>Stand-alone libraries</em> are the exception to this rule because a specific
library elaboration routine is produced independently of the application(s)
using the library.
<div class="node">
<a name="General-Ada-Libraries"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Stand_002dalone-Ada-Libraries">Stand-alone Ada Libraries</a>,
Previous: <a rel="previous" accesskey="p" href="#Introduction-to-Libraries-in-GNAT">Introduction to Libraries in GNAT</a>,
Up: <a rel="up" accesskey="u" href="#GNAT-and-Libraries">GNAT and Libraries</a>
</div>
<h3 class="section">20.2 General Ada Libraries</h3>
<ul class="menu">
<li><a accesskey="1" href="#Building-a-library">Building a library</a>
<li><a accesskey="2" href="#Installing-a-library">Installing a library</a>
<li><a accesskey="3" href="#Using-a-library">Using a library</a>
</ul>
<div class="node">
<a name="Building-a-library"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Installing-a-library">Installing a library</a>,
Up: <a rel="up" accesskey="u" href="#General-Ada-Libraries">General Ada Libraries</a>
</div>
<h4 class="subsection">20.2.1 Building a library</h4>
<p class="noindent">The easiest way to build a library is to use the Project Manager,
which supports a special type of project called a <em>Library Project</em>
(see <a href="#Library-Projects">Library Projects</a>).
<p>A project is considered a library project, when two project-level attributes
are defined in it: <code>Library_Name</code> and <code>Library_Dir</code>. In order to
control different aspects of library configuration, additional optional
project-level attributes can be specified:
<dl>
<dt><code>Library_Kind</code><dd>This attribute controls whether the library is to be static or dynamic
<br><dt><code>Library_Version</code><dd>This attribute specifies the library version; this value is used
during dynamic linking of shared libraries to determine if the currently
installed versions of the binaries are compatible.
<br><dt><code>Library_Options</code><br><dt><code>Library_GCC</code><dd>These attributes specify additional low-level options to be used during
library generation, and redefine the actual application used to generate
library.
</dl>
<p class="noindent">The GNAT Project Manager takes full care of the library maintenance task,
including recompilation of the source files for which objects do not exist
or are not up to date, assembly of the library archive, and installation of
the library (i.e., copying associated source, object and <samp><span class="file">ALI</span></samp> files
to the specified location).
<p>Here is a simple library project file:
<pre class="smallexample"> project My_Lib is
for Source_Dirs use ("src1", "src2");
for Object_Dir use "obj";
for Library_Name use "mylib";
for Library_Dir use "lib";
for Library_Kind use "dynamic";
end My_lib;
</pre>
<p class="noindent">and the compilation command to build and install the library:
<pre class="smallexample"> $ gnatmake -Pmy_lib
</pre>
<p class="noindent">It is not entirely trivial to perform manually all the steps required to
produce a library. We recommend that you use the GNAT Project Manager
for this task. In special cases where this is not desired, the necessary
steps are discussed below.
<p>There are various possibilities for compiling the units that make up the
library: for example with a Makefile (see <a href="#Using-the-GNU-make-Utility">Using the GNU make Utility</a>) or
with a conventional script. For simple libraries, it is also possible to create
a dummy main program which depends upon all the packages that comprise the
interface of the library. This dummy main program can then be given to
<samp><span class="command">gnatmake</span></samp>, which will ensure that all necessary objects are built.
<p>After this task is accomplished, you should follow the standard procedure
of the underlying operating system to produce the static or shared library.
<p>Here is an example of such a dummy program:
<pre class="smallexample"> with My_Lib.Service1;
with My_Lib.Service2;
with My_Lib.Service3;
procedure My_Lib_Dummy is
begin
null;
end;
</pre>
<p class="noindent">Here are the generic commands that will build an archive or a shared library.
<pre class="smallexample"> # compiling the library
$ gnatmake -c my_lib_dummy.adb
# we don't need the dummy object itself
$ rm my_lib_dummy.o my_lib_dummy.ali
# create an archive with the remaining objects
$ ar rc libmy_lib.a *.o
# some systems may require "ranlib" to be run as well
# or create a shared library
$ gcc -shared -o libmy_lib.so *.o
# some systems may require the code to have been compiled with -fPIC
# remove the object files that are now in the library
$ rm *.o
# Make the ALI files read-only so that gnatmake will not try to
# regenerate the objects that are in the library
$ chmod -w *.ali
</pre>
<p class="noindent">Please note that the library must have a name of the form <samp><span class="file">lib</span><var>xxx</var><span class="file">.a</span></samp>
or <samp><span class="file">lib</span><var>xxx</var><span class="file">.so</span></samp> (or <samp><span class="file">lib</span><var>xxx</var><span class="file">.dll</span></samp> on Windows) in order to
be accessed by the directive <samp><span class="option">-l</span><var>xxx</var></samp> at link time.
<div class="node">
<a name="Installing-a-library"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Using-a-library">Using a library</a>,
Previous: <a rel="previous" accesskey="p" href="#Building-a-library">Building a library</a>,
Up: <a rel="up" accesskey="u" href="#General-Ada-Libraries">General Ada Libraries</a>
</div>
<h4 class="subsection">20.2.2 Installing a library</h4>
<p><a name="index-g_t_0040code_007bADA_005fPROJECT_005fPATH_007d-863"></a><a name="index-g_t_0040code_007bGPR_005fPROJECT_005fPATH_007d-864"></a>
If you use project files, library installation is part of the library build
process (see <a href="#Installing-a-library-with-project-files">Installing a library with project files</a>).
<p>When project files are not an option, it is also possible, but not recommended,
to install the library so that the sources needed to use the library are on the
Ada source path and the ALI files & libraries be on the Ada Object path (see
<a href="#Search-Paths-and-the-Run_002dTime-Library-_0028RTL_0029">Search Paths and the Run-Time Library (RTL)</a>. Alternatively, the system
administrator can place general-purpose libraries in the default compiler
paths, by specifying the libraries' location in the configuration files
<samp><span class="file">ada_source_path</span></samp> and <samp><span class="file">ada_object_path</span></samp>. These configuration files
must be located in the GNAT installation tree at the same place as the gcc spec
file. The location of the gcc spec file can be determined as follows:
<pre class="smallexample"> $ gcc -v
</pre>
<p class="noindent">The configuration files mentioned above have a simple format: each line
must contain one unique directory name.
Those names are added to the corresponding path
in their order of appearance in the file. The names can be either absolute
or relative; in the latter case, they are relative to where theses files
are located.
<p>The files <samp><span class="file">ada_source_path</span></samp> and <samp><span class="file">ada_object_path</span></samp> might not be
present in a
GNAT installation, in which case, GNAT will look for its run-time library in
the directories <samp><span class="file">adainclude</span></samp> (for the sources) and <samp><span class="file">adalib</span></samp> (for the
objects and <samp><span class="file">ALI</span></samp> files). When the files exist, the compiler does not
look in <samp><span class="file">adainclude</span></samp> and <samp><span class="file">adalib</span></samp>, and thus the
<samp><span class="file">ada_source_path</span></samp> file
must contain the location for the GNAT run-time sources (which can simply
be <samp><span class="file">adainclude</span></samp>). In the same way, the <samp><span class="file">ada_object_path</span></samp> file must
contain the location for the GNAT run-time objects (which can simply
be <samp><span class="file">adalib</span></samp>).
<p>You can also specify a new default path to the run-time library at compilation
time with the switch <samp><span class="option">--RTS=rts-path</span></samp>. You can thus choose / change
the run-time library you want your program to be compiled with. This switch is
recognized by <samp><span class="command">gcc</span></samp>, <samp><span class="command">gnatmake</span></samp>, <samp><span class="command">gnatbind</span></samp>,
<samp><span class="command">gnatls</span></samp>, <samp><span class="command">gnatfind</span></samp> and <samp><span class="command">gnatxref</span></samp>.
<p>It is possible to install a library before or after the standard GNAT
library, by reordering the lines in the configuration files. In general, a
library must be installed before the GNAT library if it redefines
any part of it.
<div class="node">
<a name="Using-a-library"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Installing-a-library">Installing a library</a>,
Up: <a rel="up" accesskey="u" href="#General-Ada-Libraries">General Ada Libraries</a>
</div>
<h4 class="subsection">20.2.3 Using a library</h4>
<p class="noindent">Once again, the project facility greatly simplifies the use of
libraries. In this context, using a library is just a matter of adding a
<code>with</code> clause in the user project. For instance, to make use of the
library <code>My_Lib</code> shown in examples in earlier sections, you can
write:
<pre class="smallexample"> with "my_lib";
project My_Proj is
...
end My_Proj;
</pre>
<p>Even if you have a third-party, non-Ada library, you can still use GNAT's
Project Manager facility to provide a wrapper for it. For example, the
following project, when <code>with</code>ed by your main project, will link with the
third-party library <samp><span class="file">liba.a</span></samp>:
<pre class="smallexample"> project Liba is
for Externally_Built use "true";
for Source_Files use ();
for Library_Dir use "lib";
for Library_Name use "a";
for Library_Kind use "static";
end Liba;
</pre>
<p>This is an alternative to the use of <code>pragma Linker_Options</code>. It is
especially interesting in the context of systems with several interdependent
static libraries where finding a proper linker order is not easy and best be
left to the tools having visibility over project dependence information.
<p class="noindent">In order to use an Ada library manually, you need to make sure that this
library is on both your source and object path
(see <a href="#Search-Paths-and-the-Run_002dTime-Library-_0028RTL_0029">Search Paths and the Run-Time Library (RTL)</a>
and <a href="#Search-Paths-for-gnatbind">Search Paths for gnatbind</a>). Furthermore, when the objects are grouped
in an archive or a shared library, you need to specify the desired
library at link time.
<p>For example, you can use the library <samp><span class="file">mylib</span></samp> installed in
<samp><span class="file">/dir/my_lib_src</span></samp> and <samp><span class="file">/dir/my_lib_obj</span></samp> with the following commands:
<pre class="smallexample"> $ gnatmake -aI/dir/my_lib_src -aO/dir/my_lib_obj my_appl \
-largs -lmy_lib
</pre>
<p class="noindent">This can be expressed more simply:
<pre class="smallexample"> $ gnatmake my_appl
</pre>
<p class="noindent">when the following conditions are met:
<ul>
<li><samp><span class="file">/dir/my_lib_src</span></samp> has been added by the user to the environment
variable <samp><span class="env">ADA_INCLUDE_PATH</span></samp>, or by the administrator to the file
<samp><span class="file">ada_source_path</span></samp>
<li><samp><span class="file">/dir/my_lib_obj</span></samp> has been added by the user to the environment
variable <samp><span class="env">ADA_OBJECTS_PATH</span></samp>, or by the administrator to the file
<samp><span class="file">ada_object_path</span></samp>
<li>a pragma <code>Linker_Options</code> has been added to one of the sources.
For example:
<pre class="smallexample"> pragma Linker_Options ("-lmy_lib");
</pre>
</ul>
<div class="node">
<a name="Stand-alone-Ada-Libraries"></a>
<a name="Stand_002dalone-Ada-Libraries"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Rebuilding-the-GNAT-Run_002dTime-Library">Rebuilding the GNAT Run-Time Library</a>,
Previous: <a rel="previous" accesskey="p" href="#General-Ada-Libraries">General Ada Libraries</a>,
Up: <a rel="up" accesskey="u" href="#GNAT-and-Libraries">GNAT and Libraries</a>
</div>
<h3 class="section">20.3 Stand-alone Ada Libraries</h3>
<p><a name="index-Stand_002dalone-library_002c-building_002c-using-865"></a>
<ul class="menu">
<li><a accesskey="1" href="#Introduction-to-Stand_002dalone-Libraries">Introduction to Stand-alone Libraries</a>
<li><a accesskey="2" href="#Building-a-Stand_002dalone-Library">Building a Stand-alone Library</a>
<li><a accesskey="3" href="#Creating-a-Stand_002dalone-Library-to-be-used-in-a-non_002dAda-context">Creating a Stand-alone Library to be used in a non-Ada context</a>
<li><a accesskey="4" href="#Restrictions-in-Stand_002dalone-Libraries">Restrictions in Stand-alone Libraries</a>
</ul>
<div class="node">
<a name="Introduction-to-Stand-alone-Libraries"></a>
<a name="Introduction-to-Stand_002dalone-Libraries"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Building-a-Stand_002dalone-Library">Building a Stand-alone Library</a>,
Up: <a rel="up" accesskey="u" href="#Stand_002dalone-Ada-Libraries">Stand-alone Ada Libraries</a>
</div>
<h4 class="subsection">20.3.1 Introduction to Stand-alone Libraries</h4>
<p class="noindent">A Stand-alone Library (abbreviated “SAL”) is a library that contains the
necessary code to
elaborate the Ada units that are included in the library. In contrast with
an ordinary library, which consists of all sources, objects and <samp><span class="file">ALI</span></samp>
files of the
library, a SAL may specify a restricted subset of compilation units
to serve as a library interface. In this case, the fully
self-sufficient set of files will normally consist of an objects
archive, the sources of interface units' specs, and the <samp><span class="file">ALI</span></samp>
files of interface units.
If an interface spec contains a generic unit or an inlined subprogram,
the body's
source must also be provided; if the units that must be provided in the source
form depend on other units, the source and <samp><span class="file">ALI</span></samp> files of those must
also be provided.
<p>The main purpose of a SAL is to minimize the recompilation overhead of client
applications when a new version of the library is installed. Specifically,
if the interface sources have not changed, client applications do not need to
be recompiled. If, furthermore, a SAL is provided in the shared form and its
version, controlled by <code>Library_Version</code> attribute, is not changed,
then the clients do not need to be relinked.
<p>SALs also allow the library providers to minimize the amount of library source
text exposed to the clients. Such “information hiding” might be useful or
necessary for various reasons.
<p>Stand-alone libraries are also well suited to be used in an executable whose
main routine is not written in Ada.
<div class="node">
<a name="Building-a-Stand-alone-Library"></a>
<a name="Building-a-Stand_002dalone-Library"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Creating-a-Stand_002dalone-Library-to-be-used-in-a-non_002dAda-context">Creating a Stand-alone Library to be used in a non-Ada context</a>,
Previous: <a rel="previous" accesskey="p" href="#Introduction-to-Stand_002dalone-Libraries">Introduction to Stand-alone Libraries</a>,
Up: <a rel="up" accesskey="u" href="#Stand_002dalone-Ada-Libraries">Stand-alone Ada Libraries</a>
</div>
<h4 class="subsection">20.3.2 Building a Stand-alone Library</h4>
<p class="noindent">GNAT's Project facility provides a simple way of building and installing
stand-alone libraries; see <a href="#Stand_002dalone-Library-Projects">Stand-alone Library Projects</a>.
To be a Stand-alone Library Project, in addition to the two attributes
that make a project a Library Project (<code>Library_Name</code> and
<code>Library_Dir</code>; see <a href="#Library-Projects">Library Projects</a>), the attribute
<code>Library_Interface</code> must be defined. For example:
<pre class="smallexample"> for Library_Dir use "lib_dir";
for Library_Name use "dummy";
for Library_Interface use ("int1", "int1.child");
</pre>
<p class="noindent">Attribute <code>Library_Interface</code> has a non-empty string list value,
each string in the list designating a unit contained in an immediate source
of the project file.
<p>When a Stand-alone Library is built, first the binder is invoked to build
a package whose name depends on the library name
(<samp><span class="file">b~dummy.ads/b</span></samp> in the example above).
This binder-generated package includes initialization and
finalization procedures whose
names depend on the library name (<code>dummyinit</code> and <code>dummyfinal</code>
in the example
above). The object corresponding to this package is included in the library.
<p>You must ensure timely (e.g., prior to any use of interfaces in the SAL)
calling of these procedures if a static SAL is built, or if a shared SAL
is built
with the project-level attribute <code>Library_Auto_Init</code> set to
<code>"false"</code>.
<p>For a Stand-Alone Library, only the <samp><span class="file">ALI</span></samp> files of the Interface Units
(those that are listed in attribute <code>Library_Interface</code>) are copied to
the Library Directory. As a consequence, only the Interface Units may be
imported from Ada units outside of the library. If other units are imported,
the binding phase will fail.
<p>The attribute <code>Library_Src_Dir</code> may be specified for a
Stand-Alone Library. <code>Library_Src_Dir</code> is a simple attribute that has a
single string value. Its value must be the path (absolute or relative to the
project directory) of an existing directory. This directory cannot be the
object directory or one of the source directories, but it can be the same as
the library directory. The sources of the Interface
Units of the library that are needed by an Ada client of the library will be
copied to the designated directory, called the Interface Copy directory.
These sources include the specs of the Interface Units, but they may also
include bodies and subunits, when pragmas <code>Inline</code> or <code>Inline_Always</code>
are used, or when there is a generic unit in the spec. Before the sources
are copied to the Interface Copy directory, an attempt is made to delete all
files in the Interface Copy directory.
<p>Building stand-alone libraries by hand is somewhat tedious, but for those
occasions when it is necessary here are the steps that you need to perform:
<ul>
<li>Compile all library sources.
<li>Invoke the binder with the switch <samp><span class="option">-n</span></samp> (No Ada main program),
with all the <samp><span class="file">ALI</span></samp> files of the interfaces, and
with the switch <samp><span class="option">-L</span></samp> to give specific names to the <code>init</code>
and <code>final</code> procedures. For example:
<pre class="smallexample"> gnatbind -n int1.ali int2.ali -Lsal1
</pre>
<li>Compile the binder generated file:
<pre class="smallexample"> gcc -c b~int2.adb
</pre>
<li>Link the dynamic library with all the necessary object files,
indicating to the linker the names of the <code>init</code> (and possibly
<code>final</code>) procedures for automatic initialization (and finalization).
The built library should be placed in a directory different from
the object directory.
<li>Copy the <code>ALI</code> files of the interface to the library directory,
add in this copy an indication that it is an interface to a SAL
(i.e., add a word <samp><span class="option">SL</span></samp> on the line in the <samp><span class="file">ALI</span></samp> file that starts
with letter “P”) and make the modified copy of the <samp><span class="file">ALI</span></samp> file
read-only.
</ul>
<p class="noindent">Using SALs is not different from using other libraries
(see <a href="#Using-a-library">Using a library</a>).
<div class="node">
<a name="Creating-a-Stand-alone-Library-to-be-used-in-a-non-Ada-context"></a>
<a name="Creating-a-Stand_002dalone-Library-to-be-used-in-a-non_002dAda-context"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Restrictions-in-Stand_002dalone-Libraries">Restrictions in Stand-alone Libraries</a>,
Previous: <a rel="previous" accesskey="p" href="#Building-a-Stand_002dalone-Library">Building a Stand-alone Library</a>,
Up: <a rel="up" accesskey="u" href="#Stand_002dalone-Ada-Libraries">Stand-alone Ada Libraries</a>
</div>
<h4 class="subsection">20.3.3 Creating a Stand-alone Library to be used in a non-Ada context</h4>
<p class="noindent">It is easy to adapt the SAL build procedure discussed above for use of a SAL in
a non-Ada context.
<p>The only extra step required is to ensure that library interface subprograms
are compatible with the main program, by means of <code>pragma Export</code>
or <code>pragma Convention</code>.
<p>Here is an example of simple library interface for use with C main program:
<pre class="smallexample"> package My_Package is
procedure Do_Something;
pragma Export (C, Do_Something, "do_something");
procedure Do_Something_Else;
pragma Export (C, Do_Something_Else, "do_something_else");
end My_Package;
</pre>
<p class="noindent">On the foreign language side, you must provide a “foreign” view of the
library interface; remember that it should contain elaboration routines in
addition to interface subprograms.
<p>The example below shows the content of <code>mylib_interface.h</code> (note
that there is no rule for the naming of this file, any name can be used)
<pre class="smallexample"> /* the library elaboration procedure */
extern void mylibinit (void);
/* the library finalization procedure */
extern void mylibfinal (void);
/* the interface exported by the library */
extern void do_something (void);
extern void do_something_else (void);
</pre>
<p class="noindent">Libraries built as explained above can be used from any program, provided
that the elaboration procedures (named <code>mylibinit</code> in the previous
example) are called before the library services are used. Any number of
libraries can be used simultaneously, as long as the elaboration
procedure of each library is called.
<p>Below is an example of a C program that uses the <code>mylib</code> library.
<pre class="smallexample"> #include "mylib_interface.h"
int
main (void)
{
/* First, elaborate the library before using it */
mylibinit ();
/* Main program, using the library exported entities */
do_something ();
do_something_else ();
/* Library finalization at the end of the program */
mylibfinal ();
return 0;
}
</pre>
<p class="noindent">Note that invoking any library finalization procedure generated by
<code>gnatbind</code> shuts down the Ada run-time environment.
Consequently, the
finalization of all Ada libraries must be performed at the end of the program.
No call to these libraries or to the Ada run-time library should be made
after the finalization phase.
<div class="node">
<a name="Restrictions-in-Stand-alone-Libraries"></a>
<a name="Restrictions-in-Stand_002dalone-Libraries"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Creating-a-Stand_002dalone-Library-to-be-used-in-a-non_002dAda-context">Creating a Stand-alone Library to be used in a non-Ada context</a>,
Up: <a rel="up" accesskey="u" href="#Stand_002dalone-Ada-Libraries">Stand-alone Ada Libraries</a>
</div>
<h4 class="subsection">20.3.4 Restrictions in Stand-alone Libraries</h4>
<p class="noindent">The pragmas listed below should be used with caution inside libraries,
as they can create incompatibilities with other Ada libraries:
<ul>
<li>pragma <code>Locking_Policy</code>
<li>pragma <code>Queuing_Policy</code>
<li>pragma <code>Task_Dispatching_Policy</code>
<li>pragma <code>Unreserve_All_Interrupts</code>
</ul>
<p class="noindent">When using a library that contains such pragmas, the user must make sure
that all libraries use the same pragmas with the same values. Otherwise,
<code>Program_Error</code> will
be raised during the elaboration of the conflicting
libraries. The usage of these pragmas and its consequences for the user
should therefore be well documented.
<p>Similarly, the traceback in the exception occurrence mechanism should be
enabled or disabled in a consistent manner across all libraries.
Otherwise, Program_Error will be raised during the elaboration of the
conflicting libraries.
<p>If the <code>Version</code> or <code>Body_Version</code>
attributes are used inside a library, then you need to
perform a <code>gnatbind</code> step that specifies all <samp><span class="file">ALI</span></samp> files in all
libraries, so that version identifiers can be properly computed.
In practice these attributes are rarely used, so this is unlikely
to be a consideration.
<div class="node">
<a name="Rebuilding-the-GNAT-Run-Time-Library"></a>
<a name="Rebuilding-the-GNAT-Run_002dTime-Library"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Stand_002dalone-Ada-Libraries">Stand-alone Ada Libraries</a>,
Up: <a rel="up" accesskey="u" href="#GNAT-and-Libraries">GNAT and Libraries</a>
</div>
<h3 class="section">20.4 Rebuilding the GNAT Run-Time Library</h3>
<p><a name="index-GNAT-Run_002dTime-Library_002c-rebuilding-866"></a><a name="index-Building-the-GNAT-Run_002dTime-Library-867"></a><a name="index-Rebuilding-the-GNAT-Run_002dTime-Library-868"></a><a name="index-Run_002dTime-Library_002c-rebuilding-869"></a>
It may be useful to recompile the GNAT library in various contexts, the
most important one being the use of partition-wide configuration pragmas
such as <code>Normalize_Scalars</code>. A special Makefile called
<code>Makefile.adalib</code> is provided to that effect and can be found in
the directory containing the GNAT library. The location of this
directory depends on the way the GNAT environment has been installed and can
be determined by means of the command:
<pre class="smallexample"> $ gnatls -v
</pre>
<p class="noindent">The last entry in the object search path usually contains the
gnat library. This Makefile contains its own documentation and in
particular the set of instructions needed to rebuild a new library and
to use it.
<div class="node">
<a name="Using-the-GNU-make-Utility"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Memory-Management-Issues">Memory Management Issues</a>,
Previous: <a rel="previous" accesskey="p" href="#GNAT-and-Libraries">GNAT and Libraries</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">21 Using the GNU <code>make</code> Utility</h2>
<p><a name="index-make-870"></a>
This chapter offers some examples of makefiles that solve specific
problems. It does not explain how to write a makefile (see <a href="make.html#Top">GNU make</a>), nor does it try to replace the
<samp><span class="command">gnatmake</span></samp> utility (see <a href="#The-GNAT-Make-Program-gnatmake">The GNAT Make Program gnatmake</a>).
<p>All the examples in this section are specific to the GNU version of
make. Although <samp><span class="command">make</span></samp> is a standard utility, and the basic language
is the same, these examples use some advanced features found only in
<code>GNU make</code>.
<ul class="menu">
<li><a accesskey="1" href="#Using-gnatmake-in-a-Makefile">Using gnatmake in a Makefile</a>
<li><a accesskey="2" href="#Automatically-Creating-a-List-of-Directories">Automatically Creating a List of Directories</a>
<li><a accesskey="3" href="#Generating-the-Command-Line-Switches">Generating the Command Line Switches</a>
<li><a accesskey="4" href="#Overcoming-Command-Line-Length-Limits">Overcoming Command Line Length Limits</a>
</ul>
<div class="node">
<a name="Using-gnatmake-in-a-Makefile"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Automatically-Creating-a-List-of-Directories">Automatically Creating a List of Directories</a>,
Up: <a rel="up" accesskey="u" href="#Using-the-GNU-make-Utility">Using the GNU make Utility</a>
</div>
<h3 class="section">21.1 Using gnatmake in a Makefile</h3>
<p><a name="index-makefile-871"></a><a name="index-GNU-make-872"></a>
Complex project organizations can be handled in a very powerful way by
using GNU make combined with gnatmake. For instance, here is a Makefile
which allows you to build each subsystem of a big project into a separate
shared library. Such a makefile allows you to significantly reduce the link
time of very big applications while maintaining full coherence at
each step of the build process.
<p>The list of dependencies are handled automatically by
<samp><span class="command">gnatmake</span></samp>. The Makefile is simply used to call gnatmake in each of
the appropriate directories.
<p>Note that you should also read the example on how to automatically
create the list of directories
(see <a href="#Automatically-Creating-a-List-of-Directories">Automatically Creating a List of Directories</a>)
which might help you in case your project has a lot of subdirectories.
<pre class="smallexample"> ## This Makefile is intended to be used with the following directory
## configuration:
## - The sources are split into a series of csc (computer software components)
## Each of these csc is put in its own directory.
## Their name are referenced by the directory names.
## They will be compiled into shared library (although this would also work
## with static libraries
## - The main program (and possibly other packages that do not belong to any
## csc is put in the top level directory (where the Makefile is).
## toplevel_dir __ first_csc (sources) __ lib (will contain the library)
## \_ second_csc (sources) __ lib (will contain the library)
## \_ ...
## Although this Makefile is build for shared library, it is easy to modify
## to build partial link objects instead (modify the lines with -shared and
## gnatlink below)
##
## With this makefile, you can change any file in the system or add any new
## file, and everything will be recompiled correctly (only the relevant shared
## objects will be recompiled, and the main program will be re-linked).
# The list of computer software component for your project. This might be
# generated automatically.
CSC_LIST=aa bb cc
# Name of the main program (no extension)
MAIN=main
# If we need to build objects with -fPIC, uncomment the following line
#NEED_FPIC=-fPIC
# The following variable should give the directory containing libgnat.so
# You can get this directory through 'gnatls -v'. This is usually the last
# directory in the Object_Path.
GLIB=...
# The directories for the libraries
# (This macro expands the list of CSC to the list of shared libraries, you
# could simply use the expanded form:
# LIB_DIR=aa/lib/libaa.so bb/lib/libbb.so cc/lib/libcc.so
LIB_DIR=${foreach dir,${CSC_LIST},${dir}/lib/lib${dir}.so}
${MAIN}: objects ${LIB_DIR}
gnatbind ${MAIN} ${CSC_LIST:%=-aO%/lib} -shared
gnatlink ${MAIN} ${CSC_LIST:%=-l%}
objects::
# recompile the sources
gnatmake -c -i ${MAIN}.adb ${NEED_FPIC} ${CSC_LIST:%=-I%}
# Note: In a future version of GNAT, the following commands will be simplified
# by a new tool, gnatmlib
${LIB_DIR}:
mkdir -p ${dir $@ }
cd ${dir $@ } && gcc -shared -o ${notdir $@ } ../*.o -L${GLIB} -lgnat
cd ${dir $@ } && cp -f ../*.ali .
# The dependencies for the modules
# Note that we have to force the expansion of *.o, since in some cases
# make won't be able to do it itself.
aa/lib/libaa.so: ${wildcard aa/*.o}
bb/lib/libbb.so: ${wildcard bb/*.o}
cc/lib/libcc.so: ${wildcard cc/*.o}
# Make sure all of the shared libraries are in the path before starting the
# program
run::
LD_LIBRARY_PATH=`pwd`/aa/lib:`pwd`/bb/lib:`pwd`/cc/lib ./${MAIN}
clean::
${RM} -rf ${CSC_LIST:%=%/lib}
${RM} ${CSC_LIST:%=%/*.ali}
${RM} ${CSC_LIST:%=%/*.o}
${RM} *.o *.ali ${MAIN}
</pre>
<div class="node">
<a name="Automatically-Creating-a-List-of-Directories"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Generating-the-Command-Line-Switches">Generating the Command Line Switches</a>,
Previous: <a rel="previous" accesskey="p" href="#Using-gnatmake-in-a-Makefile">Using gnatmake in a Makefile</a>,
Up: <a rel="up" accesskey="u" href="#Using-the-GNU-make-Utility">Using the GNU make Utility</a>
</div>
<h3 class="section">21.2 Automatically Creating a List of Directories</h3>
<p class="noindent">In most makefiles, you will have to specify a list of directories, and
store it in a variable. For small projects, it is often easier to
specify each of them by hand, since you then have full control over what
is the proper order for these directories, which ones should be
included.
<p>However, in larger projects, which might involve hundreds of
subdirectories, it might be more convenient to generate this list
automatically.
<p>The example below presents two methods. The first one, although less
general, gives you more control over the list. It involves wildcard
characters, that are automatically expanded by <samp><span class="command">make</span></samp>. Its
shortcoming is that you need to explicitly specify some of the
organization of your project, such as for instance the directory tree
depth, whether some directories are found in a separate tree, <small class="enddots">...</small>
<p>The second method is the most general one. It requires an external
program, called <samp><span class="command">find</span></samp>, which is standard on all Unix systems. All
the directories found under a given root directory will be added to the
list.
<pre class="smallexample"> # The examples below are based on the following directory hierarchy:
# All the directories can contain any number of files
# ROOT_DIRECTORY -> a -> aa -> aaa
# -> ab
# -> ac
# -> b -> ba -> baa
# -> bb
# -> bc
# This Makefile creates a variable called DIRS, that can be reused any time
# you need this list (see the other examples in this section)
# The root of your project's directory hierarchy
ROOT_DIRECTORY=.
####
# First method: specify explicitly the list of directories
# This allows you to specify any subset of all the directories you need.
####
DIRS := a/aa/ a/ab/ b/ba/
####
# Second method: use wildcards
# Note that the argument(s) to wildcard below should end with a '/'.
# Since wildcards also return file names, we have to filter them out
# to avoid duplicate directory names.
# We thus use make's <code>dir</code> and <code>sort</code> functions.
# It sets DIRs to the following value (note that the directories aaa and baa
# are not given, unless you change the arguments to wildcard).
# DIRS= ./a/a/ ./b/ ./a/aa/ ./a/ab/ ./a/ac/ ./b/ba/ ./b/bb/ ./b/bc/
####
DIRS := ${sort ${dir ${wildcard ${ROOT_DIRECTORY}/*/
${ROOT_DIRECTORY}/*/*/}}}
####
# Third method: use an external program
# This command is much faster if run on local disks, avoiding NFS slowdowns.
# This is the most complete command: it sets DIRs to the following value:
# DIRS= ./a ./a/aa ./a/aa/aaa ./a/ab ./a/ac ./b ./b/ba ./b/ba/baa ./b/bb ./b/bc
####
DIRS := ${shell find ${ROOT_DIRECTORY} -type d -print}
</pre>
<div class="node">
<a name="Generating-the-Command-Line-Switches"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Overcoming-Command-Line-Length-Limits">Overcoming Command Line Length Limits</a>,
Previous: <a rel="previous" accesskey="p" href="#Automatically-Creating-a-List-of-Directories">Automatically Creating a List of Directories</a>,
Up: <a rel="up" accesskey="u" href="#Using-the-GNU-make-Utility">Using the GNU make Utility</a>
</div>
<h3 class="section">21.3 Generating the Command Line Switches</h3>
<p class="noindent">Once you have created the list of directories as explained in the
previous section (see <a href="#Automatically-Creating-a-List-of-Directories">Automatically Creating a List of Directories</a>),
you can easily generate the command line arguments to pass to gnatmake.
<p>For the sake of completeness, this example assumes that the source path
is not the same as the object path, and that you have two separate lists
of directories.
<pre class="smallexample"> # see "Automatically creating a list of directories" to create
# these variables
SOURCE_DIRS=
OBJECT_DIRS=
GNATMAKE_SWITCHES := ${patsubst %,-aI%,${SOURCE_DIRS}}
GNATMAKE_SWITCHES += ${patsubst %,-aO%,${OBJECT_DIRS}}
all:
gnatmake ${GNATMAKE_SWITCHES} main_unit
</pre>
<div class="node">
<a name="Overcoming-Command-Line-Length-Limits"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Generating-the-Command-Line-Switches">Generating the Command Line Switches</a>,
Up: <a rel="up" accesskey="u" href="#Using-the-GNU-make-Utility">Using the GNU make Utility</a>
</div>
<h3 class="section">21.4 Overcoming Command Line Length Limits</h3>
<p class="noindent">One problem that might be encountered on big projects is that many
operating systems limit the length of the command line. It is thus hard to give
gnatmake the list of source and object directories.
<p>This example shows how you can set up environment variables, which will
make <samp><span class="command">gnatmake</span></samp> behave exactly as if the directories had been
specified on the command line, but have a much higher length limit (or
even none on most systems).
<p>It assumes that you have created a list of directories in your Makefile,
using one of the methods presented in
<a href="#Automatically-Creating-a-List-of-Directories">Automatically Creating a List of Directories</a>.
For the sake of completeness, we assume that the object
path (where the ALI files are found) is different from the sources patch.
<p>Note a small trick in the Makefile below: for efficiency reasons, we
create two temporary variables (SOURCE_LIST and OBJECT_LIST), that are
expanded immediately by <code>make</code>. This way we overcome the standard
make behavior which is to expand the variables only when they are
actually used.
<p>On Windows, if you are using the standard Windows command shell, you must
replace colons with semicolons in the assignments to these variables.
<pre class="smallexample"> # In this example, we create both ADA_INCLUDE_PATH and ADA_OBJECT_PATH.
# This is the same thing as putting the -I arguments on the command line.
# (the equivalent of using -aI on the command line would be to define
# only ADA_INCLUDE_PATH, the equivalent of -aO is ADA_OBJECT_PATH).
# You can of course have different values for these variables.
#
# Note also that we need to keep the previous values of these variables, since
# they might have been set before running 'make' to specify where the GNAT
# library is installed.
# see "Automatically creating a list of directories" to create these
# variables
SOURCE_DIRS=
OBJECT_DIRS=
empty:=
space:=${empty} ${empty}
SOURCE_LIST := ${subst ${space},:,${SOURCE_DIRS}}
OBJECT_LIST := ${subst ${space},:,${OBJECT_DIRS}}
ADA_INCLUDE_PATH += ${SOURCE_LIST}
ADA_OBJECT_PATH += ${OBJECT_LIST}
export ADA_INCLUDE_PATH
export ADA_OBJECT_PATH
all:
gnatmake main_unit
</pre>
<div class="node">
<a name="Memory-Management-Issues"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Stack-Related-Facilities">Stack Related Facilities</a>,
Previous: <a rel="previous" accesskey="p" href="#Using-the-GNU-make-Utility">Using the GNU make Utility</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">22 Memory Management Issues</h2>
<p class="noindent">This chapter describes some useful memory pools provided in the GNAT library
and in particular the GNAT Debug Pool facility, which can be used to detect
incorrect uses of access values (including “dangling references”).
It also describes the <samp><span class="command">gnatmem</span></samp> tool, which can be used to track down
“memory leaks”.
<ul class="menu">
<li><a accesskey="1" href="#Some-Useful-Memory-Pools">Some Useful Memory Pools</a>
<li><a accesskey="2" href="#The-GNAT-Debug-Pool-Facility">The GNAT Debug Pool Facility</a>
<li><a accesskey="3" href="#The-gnatmem-Tool">The gnatmem Tool</a>
</ul>
<div class="node">
<a name="Some-Useful-Memory-Pools"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#The-GNAT-Debug-Pool-Facility">The GNAT Debug Pool Facility</a>,
Up: <a rel="up" accesskey="u" href="#Memory-Management-Issues">Memory Management Issues</a>
</div>
<h3 class="section">22.1 Some Useful Memory Pools</h3>
<p><a name="index-Memory-Pool-873"></a><a name="index-storage_002c-pool-874"></a>
The <code>System.Pool_Global</code> package offers the Unbounded_No_Reclaim_Pool
storage pool. Allocations use the standard system call <code>malloc</code> while
deallocations use the standard system call <code>free</code>. No reclamation is
performed when the pool goes out of scope. For performance reasons, the
standard default Ada allocators/deallocators do not use any explicit storage
pools but if they did, they could use this storage pool without any change in
behavior. That is why this storage pool is used when the user
manages to make the default implicit allocator explicit as in this example:
<pre class="smallexample"> type T1 is access Something;
-- no Storage pool is defined for T2
type T2 is access Something_Else;
for T2'Storage_Pool use T1'Storage_Pool;
-- the above is equivalent to
for T2'Storage_Pool use System.Pool_Global.Global_Pool_Object;
</pre>
<p class="noindent">The <code>System.Pool_Local</code> package offers the Unbounded_Reclaim_Pool storage
pool. The allocation strategy is similar to <code>Pool_Local</code>'s
except that the all
storage allocated with this pool is reclaimed when the pool object goes out of
scope. This pool provides a explicit mechanism similar to the implicit one
provided by several Ada 83 compilers for allocations performed through a local
access type and whose purpose was to reclaim memory when exiting the
scope of a given local access. As an example, the following program does not
leak memory even though it does not perform explicit deallocation:
<pre class="smallexample"> with System.Pool_Local;
procedure Pooloc1 is
procedure Internal is
type A is access Integer;
X : System.Pool_Local.Unbounded_Reclaim_Pool;
for A'Storage_Pool use X;
v : A;
begin
for I in 1 .. 50 loop
v := new Integer;
end loop;
end Internal;
begin
for I in 1 .. 100 loop
Internal;
end loop;
end Pooloc1;
</pre>
<p class="noindent">The <code>System.Pool_Size</code> package implements the Stack_Bounded_Pool used when
<code>Storage_Size</code> is specified for an access type.
The whole storage for the pool is
allocated at once, usually on the stack at the point where the access type is
elaborated. It is automatically reclaimed when exiting the scope where the
access type is defined. This package is not intended to be used directly by the
user and it is implicitly used for each such declaration:
<pre class="smallexample"> type T1 is access Something;
for T1'Storage_Size use 10_000;
</pre>
<div class="node">
<a name="The-GNAT-Debug-Pool-Facility"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#The-gnatmem-Tool">The gnatmem Tool</a>,
Previous: <a rel="previous" accesskey="p" href="#Some-Useful-Memory-Pools">Some Useful Memory Pools</a>,
Up: <a rel="up" accesskey="u" href="#Memory-Management-Issues">Memory Management Issues</a>
</div>
<h3 class="section">22.2 The GNAT Debug Pool Facility</h3>
<p><a name="index-Debug-Pool-875"></a><a name="index-storage_002c-pool_002c-memory-corruption-876"></a>
The use of unchecked deallocation and unchecked conversion can easily
lead to incorrect memory references. The problems generated by such
references are usually difficult to tackle because the symptoms can be
very remote from the origin of the problem. In such cases, it is
very helpful to detect the problem as early as possible. This is the
purpose of the Storage Pool provided by <code>GNAT.Debug_Pools</code>.
<p>In order to use the GNAT specific debugging pool, the user must
associate a debug pool object with each of the access types that may be
related to suspected memory problems. See Ada Reference Manual 13.11.
<pre class="smallexample"> type Ptr is access Some_Type;
Pool : GNAT.Debug_Pools.Debug_Pool;
for Ptr'Storage_Pool use Pool;
</pre>
<p class="noindent"><code>GNAT.Debug_Pools</code> is derived from a GNAT-specific kind of
pool: the <code>Checked_Pool</code>. Such pools, like standard Ada storage pools,
allow the user to redefine allocation and deallocation strategies. They
also provide a checkpoint for each dereference, through the use of
the primitive operation <code>Dereference</code> which is implicitly called at
each dereference of an access value.
<p>Once an access type has been associated with a debug pool, operations on
values of the type may raise four distinct exceptions,
which correspond to four potential kinds of memory corruption:
<ul>
<li><code>GNAT.Debug_Pools.Accessing_Not_Allocated_Storage</code>
<li><code>GNAT.Debug_Pools.Accessing_Deallocated_Storage</code>
<li><code>GNAT.Debug_Pools.Freeing_Not_Allocated_Storage</code>
<li><code>GNAT.Debug_Pools.Freeing_Deallocated_Storage </code>
</ul>
<p class="noindent">For types associated with a Debug_Pool, dynamic allocation is performed using
the standard GNAT allocation routine. References to all allocated chunks of
memory are kept in an internal dictionary. Several deallocation strategies are
provided, whereupon the user can choose to release the memory to the system,
keep it allocated for further invalid access checks, or fill it with an easily
recognizable pattern for debug sessions. The memory pattern is the old IBM
hexadecimal convention: <code>16#DEADBEEF#</code>.
<p>See the documentation in the file g-debpoo.ads for more information on the
various strategies.
<p>Upon each dereference, a check is made that the access value denotes a
properly allocated memory location. Here is a complete example of use of
<code>Debug_Pools</code>, that includes typical instances of memory corruption:
<pre class="smallexample"> with Gnat.Io; use Gnat.Io;
with Unchecked_Deallocation;
with Unchecked_Conversion;
with GNAT.Debug_Pools;
with System.Storage_Elements;
with Ada.Exceptions; use Ada.Exceptions;
procedure Debug_Pool_Test is
type T is access Integer;
type U is access all T;
P : GNAT.Debug_Pools.Debug_Pool;
for T'Storage_Pool use P;
procedure Free is new Unchecked_Deallocation (Integer, T);
function UC is new Unchecked_Conversion (U, T);
A, B : aliased T;
procedure Info is new GNAT.Debug_Pools.Print_Info(Put_Line);
begin
Info (P);
A := new Integer;
B := new Integer;
B := A;
Info (P);
Free (A);
begin
Put_Line (Integer'Image(B.all));
exception
when E : others => Put_Line ("raised: " & Exception_Name (E));
end;
begin
Free (B);
exception
when E : others => Put_Line ("raised: " & Exception_Name (E));
end;
B := UC(A'Access);
begin
Put_Line (Integer'Image(B.all));
exception
when E : others => Put_Line ("raised: " & Exception_Name (E));
end;
begin
Free (B);
exception
when E : others => Put_Line ("raised: " & Exception_Name (E));
end;
Info (P);
end Debug_Pool_Test;
</pre>
<p class="noindent">The debug pool mechanism provides the following precise diagnostics on the
execution of this erroneous program:
<pre class="smallexample"> Debug Pool info:
Total allocated bytes : 0
Total deallocated bytes : 0
Current Water Mark: 0
High Water Mark: 0
Debug Pool info:
Total allocated bytes : 8
Total deallocated bytes : 0
Current Water Mark: 8
High Water Mark: 8
raised: GNAT.DEBUG_POOLS.ACCESSING_DEALLOCATED_STORAGE
raised: GNAT.DEBUG_POOLS.FREEING_DEALLOCATED_STORAGE
raised: GNAT.DEBUG_POOLS.ACCESSING_NOT_ALLOCATED_STORAGE
raised: GNAT.DEBUG_POOLS.FREEING_NOT_ALLOCATED_STORAGE
Debug Pool info:
Total allocated bytes : 8
Total deallocated bytes : 4
Current Water Mark: 4
High Water Mark: 8
</pre>
<div class="node">
<a name="The-gnatmem-Tool"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#The-GNAT-Debug-Pool-Facility">The GNAT Debug Pool Facility</a>,
Up: <a rel="up" accesskey="u" href="#Memory-Management-Issues">Memory Management Issues</a>
</div>
<h3 class="section">22.3 The <samp><span class="command">gnatmem</span></samp> Tool</h3>
<p><a name="index-gnatmem-877"></a>
The <code>gnatmem</code> utility monitors dynamic allocation and
deallocation activity in a program, and displays information about
incorrect deallocations and possible sources of memory leaks.
It is designed to work in association with a static runtime library
only and in this context provides three types of information:
<ul>
<li>General information concerning memory management, such as the total
number of allocations and deallocations, the amount of allocated
memory and the high water mark, i.e. the largest amount of allocated
memory in the course of program execution.
<li>Backtraces for all incorrect deallocations, that is to say deallocations
which do not correspond to a valid allocation.
<li>Information on each allocation that is potentially the origin of a memory
leak.
</ul>
<ul class="menu">
<li><a accesskey="1" href="#Running-gnatmem">Running gnatmem</a>
<li><a accesskey="2" href="#Switches-for-gnatmem">Switches for gnatmem</a>
<li><a accesskey="3" href="#Example-of-gnatmem-Usage">Example of gnatmem Usage</a>
</ul>
<div class="node">
<a name="Running-gnatmem"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Switches-for-gnatmem">Switches for gnatmem</a>,
Up: <a rel="up" accesskey="u" href="#The-gnatmem-Tool">The gnatmem Tool</a>
</div>
<h4 class="subsection">22.3.1 Running <code>gnatmem</code></h4>
<p class="noindent"><code>gnatmem</code> makes use of the output created by the special version of
allocation and deallocation routines that record call information. This
allows to obtain accurate dynamic memory usage history at a minimal cost to
the execution speed. Note however, that <code>gnatmem</code> is not supported on
all platforms (currently, it is supported on AIX, HP-UX, GNU/Linux,
Solaris and Windows NT/2000/XP (x86).
<p class="noindent">The <code>gnatmem</code> command has the form
<pre class="smallexample"> <!-- $ gnatmem @ovar{switches} user_program -->
<!-- Expanding @ovar macro inline (explanation in macro def comments) -->
$ gnatmem <span class="roman">[</span><var>switches</var><span class="roman">]</span> <var>user_program</var>
</pre>
<p class="noindent">The program must have been linked with the instrumented version of the
allocation and deallocation routines. This is done by linking with the
<samp><span class="file">libgmem.a</span></samp> library. For correct symbolic backtrace information,
the user program should be compiled with debugging options
(see <a href="#Switches-for-gcc">Switches for gcc</a>). For example to build <samp><span class="file">my_program</span></samp>:
<pre class="smallexample"> $ gnatmake -g my_program -largs -lgmem
</pre>
<p class="noindent">As library <samp><span class="file">libgmem.a</span></samp> contains an alternate body for package
<code>System.Memory</code>, <samp><span class="file">s-memory.adb</span></samp> should not be compiled and linked
when an executable is linked with library <samp><span class="file">libgmem.a</span></samp>. It is then not
recommended to use <samp><span class="command">gnatmake</span></samp> with switch <samp><span class="option">-a</span></samp>.
<p class="noindent">When <samp><span class="file">my_program</span></samp> is executed, the file <samp><span class="file">gmem.out</span></samp> is produced.
This file contains information about all allocations and deallocations
performed by the program. It is produced by the instrumented allocations and
deallocations routines and will be used by <code>gnatmem</code>.
<p>In order to produce symbolic backtrace information for allocations and
deallocations performed by the GNAT run-time library, you need to use a
version of that library that has been compiled with the <samp><span class="option">-g</span></samp> switch
(see <a href="#Rebuilding-the-GNAT-Run_002dTime-Library">Rebuilding the GNAT Run-Time Library</a>).
<p>Gnatmem must be supplied with the <samp><span class="file">gmem.out</span></samp> file and the executable to
examine. If the location of <samp><span class="file">gmem.out</span></samp> file was not explicitly supplied by
<samp><span class="option">-i</span></samp> switch, gnatmem will assume that this file can be found in the
current directory. For example, after you have executed <samp><span class="file">my_program</span></samp>,
<samp><span class="file">gmem.out</span></samp> can be analyzed by <code>gnatmem</code> using the command:
<pre class="smallexample"> $ gnatmem my_program
</pre>
<p class="noindent">This will produce the output with the following format:
<p>*************** debut cc
<pre class="smallexample"> $ gnatmem my_program
Global information
------------------
Total number of allocations : 45
Total number of deallocations : 6
Final Water Mark (non freed mem) : 11.29 Kilobytes
High Water Mark : 11.40 Kilobytes
.
.
.
Allocation Root # 2
-------------------
Number of non freed allocations : 11
Final Water Mark (non freed mem) : 1.16 Kilobytes
High Water Mark : 1.27 Kilobytes
Backtrace :
my_program.adb:23 my_program.alloc
.
.
.
</pre>
<p>The first block of output gives general information. In this case, the
Ada construct “<b>new</b>” was executed 45 times, and only 6 calls to an
Unchecked_Deallocation routine occurred.
<p class="noindent">Subsequent paragraphs display information on all allocation roots.
An allocation root is a specific point in the execution of the program
that generates some dynamic allocation, such as a “<b>new</b>”
construct. This root is represented by an execution backtrace (or subprogram
call stack). By default the backtrace depth for allocations roots is 1, so
that a root corresponds exactly to a source location. The backtrace can
be made deeper, to make the root more specific.
<div class="node">
<a name="Switches-for-gnatmem"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Example-of-gnatmem-Usage">Example of gnatmem Usage</a>,
Previous: <a rel="previous" accesskey="p" href="#Running-gnatmem">Running gnatmem</a>,
Up: <a rel="up" accesskey="u" href="#The-gnatmem-Tool">The gnatmem Tool</a>
</div>
<h4 class="subsection">22.3.2 Switches for <code>gnatmem</code></h4>
<p class="noindent"><code>gnatmem</code> recognizes the following switches:
<dl>
<dt><samp><span class="option">-q</span></samp><dd><a name="index-g_t_0040option_007b_002dq_007d-_0028_0040code_007bgnatmem_007d_0029-878"></a>Quiet. Gives the minimum output needed to identify the origin of the
memory leaks. Omits statistical information.
<br><dt><samp><var>N</var></samp><dd><a name="index-g_t_0040var_007bN_007d-_0028_0040code_007bgnatmem_007d_0029-879"></a>N is an integer literal (usually between 1 and 10) which controls the
depth of the backtraces defining allocation root. The default value for
N is 1. The deeper the backtrace, the more precise the localization of
the root. Note that the total number of roots can depend on this
parameter. This parameter must be specified <em>before</em> the name of the
executable to be analyzed, to avoid ambiguity.
<br><dt><samp><span class="option">-b n</span></samp><dd><a name="index-g_t_0040option_007b_002db_007d-_0028_0040code_007bgnatmem_007d_0029-880"></a>This switch has the same effect as just depth parameter.
<br><dt><samp><span class="option">-i </span><var>file</var></samp><dd><a name="index-g_t_0040option_007b_002di_007d-_0028_0040code_007bgnatmem_007d_0029-881"></a>Do the <code>gnatmem</code> processing starting from <samp><span class="file">file</span></samp>, rather than
<samp><span class="file">gmem.out</span></samp> in the current directory.
<br><dt><samp><span class="option">-m n</span></samp><dd><a name="index-g_t_0040option_007b_002dm_007d-_0028_0040code_007bgnatmem_007d_0029-882"></a>This switch causes <code>gnatmem</code> to mask the allocation roots that have less
than n leaks. The default value is 1. Specifying the value of 0 will allow to
examine even the roots that didn't result in leaks.
<br><dt><samp><span class="option">-s order</span></samp><dd><a name="index-g_t_0040option_007b_002ds_007d-_0028_0040code_007bgnatmem_007d_0029-883"></a>This switch causes <code>gnatmem</code> to sort the allocation roots according to the
specified order of sort criteria, each identified by a single letter. The
currently supported criteria are <code>n, h, w</code> standing respectively for
number of unfreed allocations, high watermark, and final watermark
corresponding to a specific root. The default order is <code>nwh</code>.
</dl>
<div class="node">
<a name="Example-of-gnatmem-Usage"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Switches-for-gnatmem">Switches for gnatmem</a>,
Up: <a rel="up" accesskey="u" href="#The-gnatmem-Tool">The gnatmem Tool</a>
</div>
<h4 class="subsection">22.3.3 Example of <code>gnatmem</code> Usage</h4>
<p class="noindent">The following example shows the use of <code>gnatmem</code>
on a simple memory-leaking program.
Suppose that we have the following Ada program:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
with Unchecked_Deallocation;
procedure Test_Gm is
type T is array (1..1000) of Integer;
type Ptr is access T;
procedure Free is new Unchecked_Deallocation (T, Ptr);
A : Ptr;
procedure My_Alloc is
begin
A := new T;
end My_Alloc;
procedure My_DeAlloc is
B : Ptr := A;
begin
Free (B);
end My_DeAlloc;
begin
My_Alloc;
for I in 1 .. 5 loop
for J in I .. 5 loop
My_Alloc;
end loop;
My_Dealloc;
end loop;
end;
</td></tr></table>
</pre>
<p class="noindent">The program needs to be compiled with debugging option and linked with
<code>gmem</code> library:
<pre class="smallexample"> $ gnatmake -g test_gm -largs -lgmem
</pre>
<p class="noindent">Then we execute the program as usual:
<pre class="smallexample"> $ test_gm
</pre>
<p class="noindent">Then <code>gnatmem</code> is invoked simply with
<pre class="smallexample"> $ gnatmem test_gm
</pre>
<p class="noindent">which produces the following output (result may vary on different platforms):
<pre class="smallexample"> Global information
------------------
Total number of allocations : 18
Total number of deallocations : 5
Final Water Mark (non freed mem) : 53.00 Kilobytes
High Water Mark : 56.90 Kilobytes
Allocation Root # 1
-------------------
Number of non freed allocations : 11
Final Water Mark (non freed mem) : 42.97 Kilobytes
High Water Mark : 46.88 Kilobytes
Backtrace :
test_gm.adb:11 test_gm.my_alloc
Allocation Root # 2
-------------------
Number of non freed allocations : 1
Final Water Mark (non freed mem) : 10.02 Kilobytes
High Water Mark : 10.02 Kilobytes
Backtrace :
s-secsta.adb:81 system.secondary_stack.ss_init
Allocation Root # 3
-------------------
Number of non freed allocations : 1
Final Water Mark (non freed mem) : 12 Bytes
High Water Mark : 12 Bytes
Backtrace :
s-secsta.adb:181 system.secondary_stack.ss_init
</pre>
<p class="noindent">Note that the GNAT run time contains itself a certain number of
allocations that have no corresponding deallocation,
as shown here for root #2 and root
#3. This is a normal behavior when the number of non-freed allocations
is one, it allocates dynamic data structures that the run time needs for
the complete lifetime of the program. Note also that there is only one
allocation root in the user program with a single line back trace:
test_gm.adb:11 test_gm.my_alloc, whereas a careful analysis of the
program shows that 'My_Alloc' is called at 2 different points in the
source (line 21 and line 24). If those two allocation roots need to be
distinguished, the backtrace depth parameter can be used:
<pre class="smallexample"> $ gnatmem 3 test_gm
</pre>
<p class="noindent">which will give the following output:
<pre class="smallexample"> Global information
------------------
Total number of allocations : 18
Total number of deallocations : 5
Final Water Mark (non freed mem) : 53.00 Kilobytes
High Water Mark : 56.90 Kilobytes
Allocation Root # 1
-------------------
Number of non freed allocations : 10
Final Water Mark (non freed mem) : 39.06 Kilobytes
High Water Mark : 42.97 Kilobytes
Backtrace :
test_gm.adb:11 test_gm.my_alloc
test_gm.adb:24 test_gm
b_test_gm.c:52 main
Allocation Root # 2
-------------------
Number of non freed allocations : 1
Final Water Mark (non freed mem) : 10.02 Kilobytes
High Water Mark : 10.02 Kilobytes
Backtrace :
s-secsta.adb:81 system.secondary_stack.ss_init
s-secsta.adb:283 <system__secondary_stack___elabb>
b_test_gm.c:33 adainit
Allocation Root # 3
-------------------
Number of non freed allocations : 1
Final Water Mark (non freed mem) : 3.91 Kilobytes
High Water Mark : 3.91 Kilobytes
Backtrace :
test_gm.adb:11 test_gm.my_alloc
test_gm.adb:21 test_gm
b_test_gm.c:52 main
Allocation Root # 4
-------------------
Number of non freed allocations : 1
Final Water Mark (non freed mem) : 12 Bytes
High Water Mark : 12 Bytes
Backtrace :
s-secsta.adb:181 system.secondary_stack.ss_init
s-secsta.adb:283 <system__secondary_stack___elabb>
b_test_gm.c:33 adainit
</pre>
<p class="noindent">The allocation root #1 of the first example has been split in 2 roots #1
and #3 thanks to the more precise associated backtrace.
<div class="node">
<a name="Stack-Related-Facilities"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Verifying-Properties-Using-gnatcheck">Verifying Properties Using gnatcheck</a>,
Previous: <a rel="previous" accesskey="p" href="#Memory-Management-Issues">Memory Management Issues</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">23 Stack Related Facilities</h2>
<p class="noindent">This chapter describes some useful tools associated with stack
checking and analysis. In
particular, it deals with dynamic and static stack usage measurements.
<ul class="menu">
<li><a accesskey="1" href="#Stack-Overflow-Checking">Stack Overflow Checking</a>
<li><a accesskey="2" href="#Static-Stack-Usage-Analysis">Static Stack Usage Analysis</a>
<li><a accesskey="3" href="#Dynamic-Stack-Usage-Analysis">Dynamic Stack Usage Analysis</a>
</ul>
<div class="node">
<a name="Stack-Overflow-Checking"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Static-Stack-Usage-Analysis">Static Stack Usage Analysis</a>,
Up: <a rel="up" accesskey="u" href="#Stack-Related-Facilities">Stack Related Facilities</a>
</div>
<h3 class="section">23.1 Stack Overflow Checking</h3>
<p><a name="index-Stack-Overflow-Checking-884"></a><a name="index-g_t_002dfstack_002dcheck-885"></a>
For most operating systems, <samp><span class="command">gcc</span></samp> does not perform stack overflow
checking by default. This means that if the main environment task or
some other task exceeds the available stack space, then unpredictable
behavior will occur. Most native systems offer some level of protection by
adding a guard page at the end of each task stack. This mechanism is usually
not enough for dealing properly with stack overflow situations because
a large local variable could “jump” above the guard page.
Furthermore, when the
guard page is hit, there may not be any space left on the stack for executing
the exception propagation code. Enabling stack checking avoids
such situations.
<p>To activate stack checking, compile all units with the gcc option
<samp><span class="option">-fstack-check</span></samp>. For example:
<pre class="smallexample"> gcc -c -fstack-check package1.adb
</pre>
<p class="noindent">Units compiled with this option will generate extra instructions to check
that any use of the stack (for procedure calls or for declaring local
variables in declare blocks) does not exceed the available stack space.
If the space is exceeded, then a <code>Storage_Error</code> exception is raised.
<p>For declared tasks, the stack size is controlled by the size
given in an applicable <code>Storage_Size</code> pragma or by the value specified
at bind time with <samp><span class="option">-d</span></samp> (see <a href="#Switches-for-gnatbind">Switches for gnatbind</a>) or is set to
the default size as defined in the GNAT runtime otherwise.
<p>For the environment task, the stack size depends on
system defaults and is unknown to the compiler. Stack checking
may still work correctly if a fixed
size stack is allocated, but this cannot be guaranteed.
To ensure that a clean exception is signalled for stack
overflow, set the environment variable
<samp><span class="env">GNAT_STACK_LIMIT</span></samp> to indicate the maximum
stack area that can be used, as in:
<a name="index-GNAT_005fSTACK_005fLIMIT-886"></a>
<pre class="smallexample"> SET GNAT_STACK_LIMIT 1600
</pre>
<p class="noindent">The limit is given in kilobytes, so the above declaration would
set the stack limit of the environment task to 1.6 megabytes.
Note that the only purpose of this usage is to limit the amount
of stack used by the environment task. If it is necessary to
increase the amount of stack for the environment task, then this
is an operating systems issue, and must be addressed with the
appropriate operating systems commands.
<div class="node">
<a name="Static-Stack-Usage-Analysis"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Dynamic-Stack-Usage-Analysis">Dynamic Stack Usage Analysis</a>,
Previous: <a rel="previous" accesskey="p" href="#Stack-Overflow-Checking">Stack Overflow Checking</a>,
Up: <a rel="up" accesskey="u" href="#Stack-Related-Facilities">Stack Related Facilities</a>
</div>
<h3 class="section">23.2 Static Stack Usage Analysis</h3>
<p><a name="index-Static-Stack-Usage-Analysis-887"></a><a name="index-g_t_002dfstack_002dusage-888"></a>
A unit compiled with <samp><span class="option">-fstack-usage</span></samp> will generate an extra file
that specifies
the maximum amount of stack used, on a per-function basis.
The file has the same
basename as the target object file with a <samp><span class="file">.su</span></samp> extension.
Each line of this file is made up of three fields:
<ul>
<li>The name of the function.
<li>A number of bytes.
<li>One or more qualifiers: <code>static</code>, <code>dynamic</code>, <code>bounded</code>.
</ul>
<p>The second field corresponds to the size of the known part of the function
frame.
<p>The qualifier <code>static</code> means that the function frame size
is purely static.
It usually means that all local variables have a static size.
In this case, the second field is a reliable measure of the function stack
utilization.
<p>The qualifier <code>dynamic</code> means that the function frame size is not static.
It happens mainly when some local variables have a dynamic size. When this
qualifier appears alone, the second field is not a reliable measure
of the function stack analysis. When it is qualified with <code>bounded</code>, it
means that the second field is a reliable maximum of the function stack
utilization.
<div class="node">
<a name="Dynamic-Stack-Usage-Analysis"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Static-Stack-Usage-Analysis">Static Stack Usage Analysis</a>,
Up: <a rel="up" accesskey="u" href="#Stack-Related-Facilities">Stack Related Facilities</a>
</div>
<h3 class="section">23.3 Dynamic Stack Usage Analysis</h3>
<p class="noindent">It is possible to measure the maximum amount of stack used by a task, by
adding a switch to <samp><span class="command">gnatbind</span></samp>, as:
<pre class="smallexample"> $ gnatbind -u0 file
</pre>
<p class="noindent">With this option, at each task termination, its stack usage is output on
<samp><span class="file">stderr</span></samp>.
It is not always convenient to output the stack usage when the program
is still running. Hence, it is possible to delay this output until program
termination. for a given number of tasks specified as the argument of the
<samp><span class="option">-u</span></samp> option. For instance:
<pre class="smallexample"> $ gnatbind -u100 file
</pre>
<p class="noindent">will buffer the stack usage information of the first 100 tasks to terminate and
output this info at program termination. Results are displayed in four
columns:
<p class="noindent">Index | Task Name | Stack Size | Stack Usage [Value +/- Variation]
<p class="noindent">where:
<dl>
<dt><em>Index</em><dd>is a number associated with each task.
<br><dt><em>Task Name</em><dd>is the name of the task analyzed.
<br><dt><em>Stack Size</em><dd>is the maximum size for the stack.
<br><dt><em>Stack Usage</em><dd>is the measure done by the stack analyzer. In order to prevent overflow, the stack
is not entirely analyzed, and it's not possible to know exactly how
much has actually been used. The report thus contains the theoretical stack usage
(Value) and the possible variation (Variation) around this value.
</dl>
<p class="noindent">The environment task stack, e.g., the stack that contains the main unit, is
only processed when the environment variable GNAT_STACK_LIMIT is set.
<!-- ********************************* -->
<!-- * GNATCHECK * -->
<!-- ********************************* -->
<div class="node">
<a name="Verifying-Properties-Using-gnatcheck"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Creating-Sample-Bodies-Using-gnatstub">Creating Sample Bodies Using gnatstub</a>,
Previous: <a rel="previous" accesskey="p" href="#Stack-Related-Facilities">Stack Related Facilities</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">24 Verifying Properties Using <samp><span class="command">gnatcheck</span></samp></h2>
<p><a name="index-gnatcheck-889"></a><a name="index-g_t_0040command_007bgnatcheck_007d-890"></a>
The <samp><span class="command">gnatcheck</span></samp> tool is an ASIS-based utility that checks properties
of Ada source files according to a given set of semantic rules.
<a name="index-ASIS-891"></a>
In order to check compliance with a given rule, <samp><span class="command">gnatcheck</span></samp> has to
semantically analyze the Ada sources.
Therefore, checks can only be performed on
legal Ada units. Moreover, when a unit depends semantically upon units located
outside the current directory, the source search path has to be provided when
calling <samp><span class="command">gnatcheck</span></samp>, either through a specified project file or
through <samp><span class="command">gnatcheck</span></samp> switches.
<p>A number of rules are predefined in <samp><span class="command">gnatcheck</span></samp> and are described
later in this chapter.
<p>For full details, refer to <cite>GNATcheck Reference Manual</cite> document.
<!-- ********************************* -->
<div class="node">
<a name="Creating-Sample-Bodies-Using-gnatstub"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Generating-Ada-Bindings-for-C-and-C_002b_002b-headers">Generating Ada Bindings for C and C++ headers</a>,
Previous: <a rel="previous" accesskey="p" href="#Verifying-Properties-Using-gnatcheck">Verifying Properties Using gnatcheck</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">25 Creating Sample Bodies Using <samp><span class="command">gnatstub</span></samp></h2>
<p><a name="index-gnatstub-892"></a>
<samp><span class="command">gnatstub</span></samp> creates body stubs, that is, empty but compilable bodies
for library unit declarations.
<p>Note: to invoke <code>gnatstub</code> with a project file, use the <code>gnat</code>
driver (see <a href="#The-GNAT-Driver-and-Project-Files">The GNAT Driver and Project Files</a>).
<p>To create a body stub, <samp><span class="command">gnatstub</span></samp> has to compile the library
unit declaration. Therefore, bodies can be created only for legal
library units. Moreover, if a library unit depends semantically upon
units located outside the current directory, you have to provide
the source search path when calling <samp><span class="command">gnatstub</span></samp>, see the description
of <samp><span class="command">gnatstub</span></samp> switches below.
<p>By default, all the program unit body stubs generated by <code>gnatstub</code>
raise the predefined <code>Program_Error</code> exception, which will catch
accidental calls of generated stubs. This behavior can be changed with
option <samp><span class="option">--no-exception</span></samp> (see below).
<ul class="menu">
<li><a accesskey="1" href="#Running-gnatstub">Running gnatstub</a>
<li><a accesskey="2" href="#Switches-for-gnatstub">Switches for gnatstub</a>
</ul>
<div class="node">
<a name="Running-gnatstub"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Switches-for-gnatstub">Switches for gnatstub</a>,
Up: <a rel="up" accesskey="u" href="#Creating-Sample-Bodies-Using-gnatstub">Creating Sample Bodies Using gnatstub</a>
</div>
<h3 class="section">25.1 Running <samp><span class="command">gnatstub</span></samp></h3>
<p class="noindent"><samp><span class="command">gnatstub</span></samp> has the command-line interface of the form
<pre class="smallexample"> <!-- $ gnatstub @ovar{switches} @var{filename} @ovar{directory} -->
<!-- Expanding @ovar macro inline (explanation in macro def comments) -->
$ gnatstub <span class="roman">[</span><var>switches</var><span class="roman">]</span> <var>filename</var> <span class="roman">[</span><var>directory</var><span class="roman">]</span> <span class="roman">[</span>-cargs <var>gcc_switches</var><span class="roman">]</span>
</pre>
<p class="noindent">where
<dl>
<dt><var>filename</var><dd>is the name of the source file that contains a library unit declaration
for which a body must be created. The file name may contain the path
information.
The file name does not have to follow the GNAT file name conventions. If the
name
does not follow GNAT file naming conventions, the name of the body file must
be provided
explicitly as the value of the <samp><span class="option">-o</span><var>body-name</var></samp> option.
If the file name follows the GNAT file naming
conventions and the name of the body file is not provided,
<samp><span class="command">gnatstub</span></samp>
creates the name
of the body file from the argument file name by replacing the <samp><span class="file">.ads</span></samp>
suffix
with the <samp><span class="file">.adb</span></samp> suffix.
<br><dt><var>directory</var><dd>indicates the directory in which the body stub is to be placed (the default
is the
current directory)
<br><dt><var>‘</var><samp><var>gcc_switches</var></samp><var>’ is a list of switches for</var><dd><samp><span class="command">gcc</span></samp>. They will be passed on to all compiler invocations made by
<samp><span class="command">gnatelim</span></samp> to generate the ASIS trees. Here you can provide
<samp><span class="option">-I</span></samp> switches to form the source search path,
use the <samp><span class="option">-gnatec</span></samp> switch to set the configuration file,
use the <samp><span class="option">-gnat05</span></samp> switch if sources should be compiled in
Ada 2005 mode etc.
<br><dt><var>switches</var><dd>is an optional sequence of switches as described in the next section
</dl>
<div class="node">
<a name="Switches-for-gnatstub"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Running-gnatstub">Running gnatstub</a>,
Up: <a rel="up" accesskey="u" href="#Creating-Sample-Bodies-Using-gnatstub">Creating Sample Bodies Using gnatstub</a>
</div>
<h3 class="section">25.2 Switches for <samp><span class="command">gnatstub</span></samp></h3>
<dl>
<!-- !sort! -->
<dt><samp><span class="option">-f</span></samp><dd><a name="index-g_t_0040option_007b_002df_007d-_0028_0040command_007bgnatstub_007d_0029-893"></a>If the destination directory already contains a file with the name of the
body file
for the argument spec file, replace it with the generated body stub.
<br><dt><samp><span class="option">-hs</span></samp><dd><a name="index-g_t_0040option_007b_002dhs_007d-_0028_0040command_007bgnatstub_007d_0029-894"></a>Put the comment header (i.e., all the comments preceding the
compilation unit) from the source of the library unit declaration
into the body stub.
<br><dt><samp><span class="option">-hg</span></samp><dd><a name="index-g_t_0040option_007b_002dhg_007d-_0028_0040command_007bgnatstub_007d_0029-895"></a>Put a sample comment header into the body stub.
<br><dt><samp><span class="option">--header-file=</span><var>filename</var></samp><dd><a name="index-g_t_0040option_007b_002d_002dheader_002dfile_007d-_0028_0040command_007bgnatstub_007d_0029-896"></a>Use the content of the file as the comment header for a generated body stub.
<br><dt><samp><span class="option">-IDIR</span></samp><dd><a name="index-g_t_0040option_007b_002dIDIR_007d-_0028_0040command_007bgnatstub_007d_0029-897"></a><dt><samp><span class="option">-I-</span></samp><dd><a name="index-g_t_0040option_007b_002dI_002d_007d-_0028_0040command_007bgnatstub_007d_0029-898"></a>These switches have the same meaning as in calls to
<samp><span class="command">gcc</span></samp>.
They define the source search path in the call to
<samp><span class="command">gcc</span></samp> issued
by <samp><span class="command">gnatstub</span></samp> to compile an argument source file.
<br><dt><samp><span class="option">-gnatec</span><var>PATH</var></samp><dd><a name="index-g_t_0040option_007b_002dgnatec_007d-_0028_0040command_007bgnatstub_007d_0029-899"></a>This switch has the same meaning as in calls to <samp><span class="command">gcc</span></samp>.
It defines the additional configuration file to be passed to the call to
<samp><span class="command">gcc</span></samp> issued
by <samp><span class="command">gnatstub</span></samp> to compile an argument source file.
<br><dt><samp><span class="option">-gnatyM</span><var>n</var></samp><dd><a name="index-g_t_0040option_007b_002dgnatyM_007d-_0028_0040command_007bgnatstub_007d_0029-900"></a>(<var>n</var> is a non-negative integer). Set the maximum line length in the
body stub to <var>n</var>; the default is 79. The maximum value that can be
specified is 32767. Note that in the special case of configuration
pragma files, the maximum is always 32767 regardless of whether or
not this switch appears.
<br><dt><samp><span class="option">-gnaty</span><var>n</var></samp><dd><a name="index-g_t_0040option_007b_002dgnaty_007d-_0028_0040command_007bgnatstub_007d_0029-901"></a>(<var>n</var> is a non-negative integer from 1 to 9). Set the indentation level in
the generated body sample to <var>n</var>.
The default indentation is 3.
<br><dt><samp><span class="option">-gnatyo</span></samp><dd><a name="index-g_t_0040option_007b_002dgnato_007d-_0028_0040command_007bgnatstub_007d_0029-902"></a>Order local bodies alphabetically. (By default local bodies are ordered
in the same way as the corresponding local specs in the argument spec file.)
<br><dt><samp><span class="option">-i</span><var>n</var></samp><dd><a name="index-g_t_0040option_007b_002di_007d-_0028_0040command_007bgnatstub_007d_0029-903"></a>Same as <samp><span class="option">-gnaty</span><var>n</var></samp>
<br><dt><samp><span class="option">-k</span></samp><dd><a name="index-g_t_0040option_007b_002dk_007d-_0028_0040command_007bgnatstub_007d_0029-904"></a>Do not remove the tree file (i.e., the snapshot of the compiler internal
structures used by <samp><span class="command">gnatstub</span></samp>) after creating the body stub.
<br><dt><samp><span class="option">-l</span><var>n</var></samp><dd><a name="index-g_t_0040option_007b_002dl_007d-_0028_0040command_007bgnatstub_007d_0029-905"></a>Same as <samp><span class="option">-gnatyM</span><var>n</var></samp>
<br><dt><samp><span class="option">--no-exception</span></samp><dd><a name="index-g_t_0040option_007b_002d_002dno_002dexception_007d-_0028_0040command_007bgnatstub_007d_0029-906"></a>void raising PROGRAM_ERROR in the generated bodies of program unit stubs.
This is not always possible for function stubs.
<br><dt><samp><span class="option">--no-local-header</span></samp><dd><a name="index-g_t_0040option_007b_002d_002dno_002dlocal_002dheader_007d-_0028_0040command_007bgnatstub_007d_0029-907"></a>Do not place local comment header with unit name before body stub for a
unit.
<br><dt><samp><span class="option">-o </span><var>body-name</var></samp><dd><a name="index-g_t_0040option_007b_002do_007d-_0028_0040command_007bgnatstub_007d_0029-908"></a>Body file name. This should be set if the argument file name does not
follow
the GNAT file naming
conventions. If this switch is omitted the default name for the body will be
obtained
from the argument file name according to the GNAT file naming conventions.
<br><dt><samp><span class="option">-q</span></samp><dd><a name="index-g_t_0040option_007b_002dq_007d-_0028_0040command_007bgnatstub_007d_0029-909"></a>Quiet mode: do not generate a confirmation when a body is
successfully created, and do not generate a message when a body is not
required for an
argument unit.
<br><dt><samp><span class="option">-r</span></samp><dd><a name="index-g_t_0040option_007b_002dr_007d-_0028_0040command_007bgnatstub_007d_0029-910"></a>Reuse the tree file (if it exists) instead of creating it. Instead of
creating the tree file for the library unit declaration, <samp><span class="command">gnatstub</span></samp>
tries to find it in the current directory and use it for creating
a body. If the tree file is not found, no body is created. This option
also implies <samp><span class="option">-k</span></samp>, whether or not
the latter is set explicitly.
<br><dt><samp><span class="option">-t</span></samp><dd><a name="index-g_t_0040option_007b_002dt_007d-_0028_0040command_007bgnatstub_007d_0029-911"></a>Overwrite the existing tree file. If the current directory already
contains the file which, according to the GNAT file naming rules should
be considered as a tree file for the argument source file,
<samp><span class="command">gnatstub</span></samp>
will refuse to create the tree file needed to create a sample body
unless this option is set.
<br><dt><samp><span class="option">-v</span></samp><dd><a name="index-g_t_0040option_007b_002dv_007d-_0028_0040command_007bgnatstub_007d_0029-912"></a>Verbose mode: generate version information.
</dl>
<!-- ********************************* -->
<div class="node">
<a name="Generating-Ada-Bindings-for-C-and-C++-headers"></a>
<a name="Generating-Ada-Bindings-for-C-and-C_002b_002b-headers"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Other-Utility-Programs">Other Utility Programs</a>,
Previous: <a rel="previous" accesskey="p" href="#Creating-Sample-Bodies-Using-gnatstub">Creating Sample Bodies Using gnatstub</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">26 Generating Ada Bindings for C and C++ headers</h2>
<p><a name="index-binding-913"></a>
GNAT now comes with a binding generator for C and C++ headers which is
intended to do 95% of the tedious work of generating Ada specs from C
or C++ header files.
<p>Note that this capability is not intended to generate 100% correct Ada specs,
and will is some cases require manual adjustments, although it can often
be used out of the box in practice.
<p>Some of the known limitations include:
<ul>
<li>only very simple character constant macros are translated into Ada
constants. Function macros (macros with arguments) are partially translated
as comments, to be completed manually if needed.
<li>some extensions (e.g. vector types) are not supported
<li>pointers to pointers or complex structures are mapped to System.Address
<li>identifiers with identical name (except casing) will generate compilation
errors (e.g. <code>shm_get</code> vs <code>SHM_GET</code>).
</ul>
<p>The code generated is using the Ada 2005 syntax, which makes it
easier to interface with other languages than previous versions of Ada.
<ul class="menu">
<li><a accesskey="1" href="#Running-the-binding-generator">Running the binding generator</a>
<li><a accesskey="2" href="#Generating-bindings-for-C_002b_002b-headers">Generating bindings for C++ headers</a>
<li><a accesskey="3" href="#Switches">Switches</a>
</ul>
<div class="node">
<a name="Running-the-binding-generator"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Generating-bindings-for-C_002b_002b-headers">Generating bindings for C++ headers</a>,
Up: <a rel="up" accesskey="u" href="#Generating-Ada-Bindings-for-C-and-C_002b_002b-headers">Generating Ada Bindings for C and C++ headers</a>
</div>
<h3 class="section">26.1 Running the binding generator</h3>
<p class="noindent">The binding generator is part of the <samp><span class="command">gcc</span></samp> compiler and can be
invoked via the <samp><span class="option">-fdump-ada-spec</span></samp> switch, which will generate Ada
spec files for the header files specified on the command line, and all
header files needed by these files transitively. For example:
<pre class="smallexample"> $ g++ -c -fdump-ada-spec -C /usr/include/time.h
$ gcc -c -gnat05 *.ads
</pre>
<p>will generate, under GNU/Linux, the following files: <samp><span class="file">time_h.ads</span></samp>,
<samp><span class="file">bits_time_h.ads</span></samp>, <samp><span class="file">stddef_h.ads</span></samp>, <samp><span class="file">bits_types_h.ads</span></samp> which
correspond to the files <samp><span class="file">/usr/include/time.h</span></samp>,
<samp><span class="file">/usr/include/bits/time.h</span></samp>, etc<small class="dots">...</small>, and will then compile in Ada 2005
mode these Ada specs.
<p>The <code>-C</code> switch tells <samp><span class="command">gcc</span></samp> to extract comments from headers,
and will attempt to generate corresponding Ada comments.
<p>If you want to generate a single Ada file and not the transitive closure, you
can use instead the <samp><span class="option">-fdump-ada-spec-slim</span></samp> switch.
<p>Note that we recommend when possible to use the <samp><span class="command">g++</span></samp> driver to
generate bindings, even for most C headers, since this will in general
generate better Ada specs. For generating bindings for C++ headers, it is
mandatory to use the <samp><span class="command">g++</span></samp> command, or <samp><span class="command">gcc -x c++</span></samp> which
is equivalent in this case. If <samp><span class="command">g++</span></samp> cannot work on your C headers
because of incompatibilities between C and C++, then you can fallback to
<samp><span class="command">gcc</span></samp> instead.
<p>For an example of better bindings generated from the C++ front-end,
the name of the parameters (when available) are actually ignored by the C
front-end. Consider the following C header:
<pre class="smallexample"> extern void foo (int variable);
</pre>
<p>with the C front-end, <code>variable</code> is ignored, and the above is handled as:
<pre class="smallexample"> extern void foo (int);
</pre>
<p>generating a generic:
<pre class="smallexample"> procedure foo (param1 : int);
</pre>
<p>with the C++ front-end, the name is available, and we generate:
<pre class="smallexample"> procedure foo (variable : int);
</pre>
<p>In some cases, the generated bindings will be more complete or more meaningful
when defining some macros, which you can do via the <samp><span class="option">-D</span></samp> switch. This
is for example the case with <samp><span class="file">Xlib.h</span></samp> under GNU/Linux:
<pre class="smallexample"> g++ -c -fdump-ada-spec -DXLIB_ILLEGAL_ACCESS -C /usr/include/X11/Xlib.h
</pre>
<p>The above will generate more complete bindings than a straight call without
the <samp><span class="option">-DXLIB_ILLEGAL_ACCESS</span></samp> switch.
<p>In other cases, it is not possible to parse a header file in a stand alone
manner, because other include files need to be included first. In this
case, the solution is to create a small header file including the needed
<code>#include</code> and possible <code>#define</code> directives. For example, to
generate Ada bindings for <samp><span class="file">readline/readline.h</span></samp>, you need to first
include <samp><span class="file">stdio.h</span></samp>, so you can create a file with the following two
lines in e.g. <samp><span class="file">readline1.h</span></samp>:
<pre class="smallexample"> #include <stdio.h>
#include <readline/readline.h>
</pre>
<p>and then generate Ada bindings from this file:
<pre class="smallexample"> $ g++ -c -fdump-ada-spec readline1.h
</pre>
<div class="node">
<a name="Generating-bindings-for-C++-headers"></a>
<a name="Generating-bindings-for-C_002b_002b-headers"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Switches">Switches</a>,
Previous: <a rel="previous" accesskey="p" href="#Running-the-binding-generator">Running the binding generator</a>,
Up: <a rel="up" accesskey="u" href="#Generating-Ada-Bindings-for-C-and-C_002b_002b-headers">Generating Ada Bindings for C and C++ headers</a>
</div>
<h3 class="section">26.2 Generating bindings for C++ headers</h3>
<p class="noindent">Generating bindings for C++ headers is done using the same options, always
with the <samp><span class="command">g++</span></samp> compiler.
<p>In this mode, C++ classes will be mapped to Ada tagged types, constructors
will be mapped using the <code>CPP_Constructor</code> pragma, and when possible,
multiple inheritance of abstract classes will be mapped to Ada interfaces
(See <a href="gnat_rm.html#Interfacing-to-C_002b_002b">Interfacing to C++</a>, for additional
information on interfacing to C++).
<p>For example, given the following C++ header file:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
class Carnivore {
public:
virtual int Number_Of_Teeth () = 0;
};
class Domestic {
public:
virtual void Set_Owner (char* Name) = 0;
};
class Animal {
public:
int Age_Count;
virtual void Set_Age (int New_Age);
};
class Dog : Animal, Carnivore, Domestic {
public:
int Tooth_Count;
char *Owner;
virtual int Number_Of_Teeth ();
virtual void Set_Owner (char* Name);
Dog();
};
</td></tr></table>
</pre>
<p>The corresponding Ada code is generated:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
package Class_Carnivore is
type Carnivore is limited interface;
pragma Import (CPP, Carnivore);
function Number_Of_Teeth (this : access Carnivore) return int is abstract;
end;
use Class_Carnivore;
package Class_Domestic is
type Domestic is limited interface;
pragma Import (CPP, Domestic);
procedure Set_Owner
(this : access Domestic;
Name : Interfaces.C.Strings.chars_ptr) is abstract;
end;
use Class_Domestic;
package Class_Animal is
type Animal is tagged limited record
Age_Count : aliased int;
end record;
pragma Import (CPP, Animal);
procedure Set_Age (this : access Animal; New_Age : int);
pragma Import (CPP, Set_Age, "_ZN6Animal7Set_AgeEi");
end;
use Class_Animal;
package Class_Dog is
type Dog is new Animal and Carnivore and Domestic with record
Tooth_Count : aliased int;
Owner : Interfaces.C.Strings.chars_ptr;
end record;
pragma Import (CPP, Dog);
function Number_Of_Teeth (this : access Dog) return int;
pragma Import (CPP, Number_Of_Teeth, "_ZN3Dog15Number_Of_TeethEv");
procedure Set_Owner
(this : access Dog; Name : Interfaces.C.Strings.chars_ptr);
pragma Import (CPP, Set_Owner, "_ZN3Dog9Set_OwnerEPc");
function New_Dog return Dog;
pragma CPP_Constructor (New_Dog);
pragma Import (CPP, New_Dog, "_ZN3DogC1Ev");
end;
use Class_Dog;
</td></tr></table>
</pre>
<div class="node">
<a name="Switches"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Generating-bindings-for-C_002b_002b-headers">Generating bindings for C++ headers</a>,
Up: <a rel="up" accesskey="u" href="#Generating-Ada-Bindings-for-C-and-C_002b_002b-headers">Generating Ada Bindings for C and C++ headers</a>
</div>
<h3 class="section">26.3 Switches</h3>
<dl>
<dt><samp><span class="option">-fdump-ada-spec</span></samp><dd><a name="index-g_t_0040option_007b_002dfdump_002dada_002dspec_007d-_0028_0040command_007bgcc_007d_0029-914"></a>Generate Ada spec files for the given header files transitively (including
all header files that these headers depend upon).
<br><dt><samp><span class="option">-fdump-ada-spec-slim</span></samp><dd><a name="index-g_t_0040option_007b_002dfdump_002dada_002dspec_002dslim_007d-_0028_0040command_007bgcc_007d_0029-915"></a>Generate Ada spec files for the header files specified on the command line
only.
<br><dt><samp><span class="option">-C</span></samp><dd><a name="index-g_t_0040option_007b_002dC_007d-_0028_0040command_007bgcc_007d_0029-916"></a>Extract comments from headers and generate Ada comments in the Ada spec files.
</dl>
<div class="node">
<a name="Other-Utility-Programs"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Running-and-Debugging-Ada-Programs">Running and Debugging Ada Programs</a>,
Previous: <a rel="previous" accesskey="p" href="#Generating-Ada-Bindings-for-C-and-C_002b_002b-headers">Generating Ada Bindings for C and C++ headers</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">27 Other Utility Programs</h2>
<p class="noindent">This chapter discusses some other utility programs available in the Ada
environment.
<ul class="menu">
<li><a accesskey="1" href="#Using-Other-Utility-Programs-with-GNAT">Using Other Utility Programs with GNAT</a>
<li><a accesskey="2" href="#The-External-Symbol-Naming-Scheme-of-GNAT">The External Symbol Naming Scheme of GNAT</a>
<li><a accesskey="3" href="#Converting-Ada-Files-to-html-with-gnathtml">Converting Ada Files to html with gnathtml</a>
<li><a accesskey="4" href="#Installing-gnathtml">Installing gnathtml</a>
</ul>
<div class="node">
<a name="Using-Other-Utility-Programs-with-GNAT"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#The-External-Symbol-Naming-Scheme-of-GNAT">The External Symbol Naming Scheme of GNAT</a>,
Up: <a rel="up" accesskey="u" href="#Other-Utility-Programs">Other Utility Programs</a>
</div>
<h3 class="section">27.1 Using Other Utility Programs with GNAT</h3>
<p class="noindent">The object files generated by GNAT are in standard system format and in
particular the debugging information uses this format. This means
programs generated by GNAT can be used with existing utilities that
depend on these formats.
<p>In general, any utility program that works with C will also often work with
Ada programs generated by GNAT. This includes software utilities such as
gprof (a profiling program), <code>gdb</code> (the FSF debugger), and utilities such
as Purify.
<div class="node">
<a name="The-External-Symbol-Naming-Scheme-of-GNAT"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Converting-Ada-Files-to-html-with-gnathtml">Converting Ada Files to html with gnathtml</a>,
Previous: <a rel="previous" accesskey="p" href="#Using-Other-Utility-Programs-with-GNAT">Using Other Utility Programs with GNAT</a>,
Up: <a rel="up" accesskey="u" href="#Other-Utility-Programs">Other Utility Programs</a>
</div>
<h3 class="section">27.2 The External Symbol Naming Scheme of GNAT</h3>
<p class="noindent">In order to interpret the output from GNAT, when using tools that are
originally intended for use with other languages, it is useful to
understand the conventions used to generate link names from the Ada
entity names.
<p>All link names are in all lowercase letters. With the exception of library
procedure names, the mechanism used is simply to use the full expanded
Ada name with dots replaced by double underscores. For example, suppose
we have the following package spec:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
package QRS is
MN : Integer;
end QRS;
</td></tr></table>
</pre>
<p class="noindent">The variable <code>MN</code> has a full expanded Ada name of <code>QRS.MN</code>, so
the corresponding link name is <code>qrs__mn</code>.
<a name="index-Export-917"></a>Of course if a <code>pragma Export</code> is used this may be overridden:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
package Exports is
Var1 : Integer;
pragma Export (Var1, C, External_Name => "var1_name");
Var2 : Integer;
pragma Export (Var2, C, Link_Name => "var2_link_name");
end Exports;
</td></tr></table>
</pre>
<p class="noindent">In this case, the link name for <var>Var1</var> is whatever link name the
C compiler would assign for the C function <var>var1_name</var>. This typically
would be either <var>var1_name</var> or <var>_var1_name</var>, depending on operating
system conventions, but other possibilities exist. The link name for
<var>Var2</var> is <var>var2_link_name</var>, and this is not operating system
dependent.
<p><a name="index-g_t_005fmain-918"></a>One exception occurs for library level procedures. A potential ambiguity
arises between the required name <code>_main</code> for the C main program,
and the name we would otherwise assign to an Ada library level procedure
called <code>Main</code> (which might well not be the main program).
<p>To avoid this ambiguity, we attach the prefix <code>_ada_</code> to such
names. So if we have a library level procedure such as
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
procedure Hello (S : String);
</td></tr></table>
</pre>
<p class="noindent">the external name of this procedure will be <var>_ada_hello</var>.
<div class="node">
<a name="Converting-Ada-Files-to-html-with-gnathtml"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Installing-gnathtml">Installing gnathtml</a>,
Previous: <a rel="previous" accesskey="p" href="#The-External-Symbol-Naming-Scheme-of-GNAT">The External Symbol Naming Scheme of GNAT</a>,
Up: <a rel="up" accesskey="u" href="#Other-Utility-Programs">Other Utility Programs</a>
</div>
<h3 class="section">27.3 Converting Ada Files to HTML with <code>gnathtml</code></h3>
<p class="noindent">This <code>Perl</code> script allows Ada source files to be browsed using
standard Web browsers. For installation procedure, see the section
See <a href="#Installing-gnathtml">Installing gnathtml</a>.
<p>Ada reserved keywords are highlighted in a bold font and Ada comments in
a blue font. Unless your program was compiled with the gcc <samp><span class="option">-gnatx</span></samp>
switch to suppress the generation of cross-referencing information, user
defined variables and types will appear in a different color; you will
be able to click on any identifier and go to its declaration.
<p>The command line is as follow:
<pre class="smallexample"> <!-- $ perl gnathtml.pl @ovar{switches} @var{ada-files} -->
<!-- Expanding @ovar macro inline (explanation in macro def comments) -->
$ perl gnathtml.pl <span class="roman">[</span><var>switches</var><span class="roman">]</span> <var>ada-files</var>
</pre>
<p class="noindent">You can pass it as many Ada files as you want. <code>gnathtml</code> will generate
an html file for every ada file, and a global file called <samp><span class="file">index.htm</span></samp>.
This file is an index of every identifier defined in the files.
<p>The available switches are the following ones:
<dl>
<dt><samp><span class="option">-83</span></samp><dd><a name="index-g_t_0040option_007b_002d83_007d-_0028_0040code_007bgnathtml_007d_0029-919"></a>Only the Ada 83 subset of keywords will be highlighted.
<br><dt><samp><span class="option">-cc </span><var>color</var></samp><dd><a name="index-g_t_0040option_007b_002dcc_007d-_0028_0040code_007bgnathtml_007d_0029-920"></a>This option allows you to change the color used for comments. The default
value is green. The color argument can be any name accepted by html.
<br><dt><samp><span class="option">-d</span></samp><dd><a name="index-g_t_0040option_007b_002dd_007d-_0028_0040code_007bgnathtml_007d_0029-921"></a>If the Ada files depend on some other files (for instance through
<code>with</code> clauses, the latter files will also be converted to html.
Only the files in the user project will be converted to html, not the files
in the run-time library itself.
<br><dt><samp><span class="option">-D</span></samp><dd><a name="index-g_t_0040option_007b_002dD_007d-_0028_0040code_007bgnathtml_007d_0029-922"></a>This command is the same as <samp><span class="option">-d</span></samp> above, but <samp><span class="command">gnathtml</span></samp> will
also look for files in the run-time library, and generate html files for them.
<br><dt><samp><span class="option">-ext </span><var>extension</var></samp><dd><a name="index-g_t_0040option_007b_002dext_007d-_0028_0040code_007bgnathtml_007d_0029-923"></a>This option allows you to change the extension of the generated HTML files.
If you do not specify an extension, it will default to <samp><span class="file">htm</span></samp>.
<br><dt><samp><span class="option">-f</span></samp><dd><a name="index-g_t_0040option_007b_002df_007d-_0028_0040code_007bgnathtml_007d_0029-924"></a>By default, gnathtml will generate html links only for global entities
('with'ed units, global variables and types,<small class="dots">...</small>). If you specify
<samp><span class="option">-f</span></samp> on the command line, then links will be generated for local
entities too.
<br><dt><samp><span class="option">-l </span><var>number</var></samp><dd><a name="index-g_t_0040option_007b_002dl_007d-_0028_0040code_007bgnathtml_007d_0029-925"></a>If this switch is provided and <var>number</var> is not 0, then
<code>gnathtml</code> will number the html files every <var>number</var> line.
<br><dt><samp><span class="option">-I </span><var>dir</var></samp><dd><a name="index-g_t_0040option_007b_002dI_007d-_0028_0040code_007bgnathtml_007d_0029-926"></a>Specify a directory to search for library files (<samp><span class="file">.ALI</span></samp> files) and
source files. You can provide several -I switches on the command line,
and the directories will be parsed in the order of the command line.
<br><dt><samp><span class="option">-o </span><var>dir</var></samp><dd><a name="index-g_t_0040option_007b_002do_007d-_0028_0040code_007bgnathtml_007d_0029-927"></a>Specify the output directory for html files. By default, gnathtml will
saved the generated html files in a subdirectory named <samp><span class="file">html/</span></samp>.
<br><dt><samp><span class="option">-p </span><var>file</var></samp><dd><a name="index-g_t_0040option_007b_002dp_007d-_0028_0040code_007bgnathtml_007d_0029-928"></a>If you are using Emacs and the most recent Emacs Ada mode, which provides
a full Integrated Development Environment for compiling, checking,
running and debugging applications, you may use <samp><span class="file">.gpr</span></samp> files
to give the directories where Emacs can find sources and object files.
<p>Using this switch, you can tell gnathtml to use these files.
This allows you to get an html version of your application, even if it
is spread over multiple directories.
<br><dt><samp><span class="option">-sc </span><var>color</var></samp><dd><a name="index-g_t_0040option_007b_002dsc_007d-_0028_0040code_007bgnathtml_007d_0029-929"></a>This switch allows you to change the color used for symbol
definitions.
The default value is red. The color argument can be any name accepted by html.
<br><dt><samp><span class="option">-t </span><var>file</var></samp><dd><a name="index-g_t_0040option_007b_002dt_007d-_0028_0040code_007bgnathtml_007d_0029-930"></a>This switch provides the name of a file. This file contains a list of
file names to be converted, and the effect is exactly as though they had
appeared explicitly on the command line. This
is the recommended way to work around the command line length limit on some
systems.
</dl>
<div class="node">
<a name="Installing-gnathtml"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Converting-Ada-Files-to-html-with-gnathtml">Converting Ada Files to html with gnathtml</a>,
Up: <a rel="up" accesskey="u" href="#Other-Utility-Programs">Other Utility Programs</a>
</div>
<h3 class="section">27.4 Installing <code>gnathtml</code></h3>
<p class="noindent"><code>Perl</code> needs to be installed on your machine to run this script.
<code>Perl</code> is freely available for almost every architecture and
Operating System via the Internet.
<p>On Unix systems, you may want to modify the first line of the script
<code>gnathtml</code>, to explicitly tell the Operating system where Perl
is. The syntax of this line is:
<pre class="smallexample"> #!full_path_name_to_perl
</pre>
<p class="noindent">Alternatively, you may run the script using the following command line:
<pre class="smallexample"> <!-- $ perl gnathtml.pl @ovar{switches} @var{files} -->
<!-- Expanding @ovar macro inline (explanation in macro def comments) -->
$ perl gnathtml.pl <span class="roman">[</span><var>switches</var><span class="roman">]</span> <var>files</var>
</pre>
<!-- ****************************** -->
<div class="node">
<a name="Code-Coverage-and-Profiling"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Platform_002dSpecific-Information-for-the-Run_002dTime-Libraries">Platform-Specific Information for the Run-Time Libraries</a>,
Previous: <a rel="previous" accesskey="p" href="#Running-and-Debugging-Ada-Programs">Running and Debugging Ada Programs</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">28 Code Coverage and Profiling</h2>
<p><a name="index-Code-Coverage-931"></a><a name="index-Profiling-932"></a>
This chapter describes how to use <code>gcov</code> - coverage testing tool - and
<code>gprof</code> - profiler tool - on your Ada programs.
<ul class="menu">
<li><a accesskey="1" href="#Code-Coverage-of-Ada-Programs-using-gcov">Code Coverage of Ada Programs using gcov</a>
<li><a accesskey="2" href="#Profiling-an-Ada-Program-using-gprof">Profiling an Ada Program using gprof</a>
</ul>
<div class="node">
<a name="Code-Coverage-of-Ada-Programs-using-gcov"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Profiling-an-Ada-Program-using-gprof">Profiling an Ada Program using gprof</a>,
Up: <a rel="up" accesskey="u" href="#Code-Coverage-and-Profiling">Code Coverage and Profiling</a>
</div>
<h3 class="section">28.1 Code Coverage of Ada Programs using gcov</h3>
<p><a name="index-gcov-933"></a><a name="index-g_t_002dfprofile_002darcs-934"></a><a name="index-g_t_002dftest_002dcoverage-935"></a><a name="index-g_t_002dcoverage-936"></a><a name="index-Code-Coverage-937"></a>
<code>gcov</code> is a test coverage program: it analyzes the execution of a given
program on selected tests, to help you determine the portions of the program
that are still untested.
<p><code>gcov</code> is part of the GCC suite, and is described in detail in the GCC
User's Guide. You can refer to this documentation for a more complete
description.
<p>This chapter provides a quick startup guide, and
details some Gnat-specific features.
<ul class="menu">
<li><a accesskey="1" href="#Quick-startup-guide">Quick startup guide</a>
<li><a accesskey="2" href="#Gnat-specifics">Gnat specifics</a>
</ul>
<div class="node">
<a name="Quick-startup-guide"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Gnat-specifics">Gnat specifics</a>,
Up: <a rel="up" accesskey="u" href="#Code-Coverage-of-Ada-Programs-using-gcov">Code Coverage of Ada Programs using gcov</a>
</div>
<h4 class="subsection">28.1.1 Quick startup guide</h4>
<p>In order to perform coverage analysis of a program using <code>gcov</code>, 3
steps are needed:
<ul>
<li>Code instrumentation during the compilation process
<li>Execution of the instrumented program
<li>Execution of the <code>gcov</code> tool to generate the result.
</ul>
<p>The code instrumentation needed by gcov is created at the object level:
The source code is not modified in any way, because the instrumentation code is
inserted by gcc during the compilation process. To compile your code with code
coverage activated, you need to recompile your whole project using the
switches
<code>-fprofile-arcs</code> and <code>-ftest-coverage</code>, and link it using
<code>-fprofile-arcs</code>.
<pre class="smallexample"> $ gnatmake -P my_project.gpr -f -cargs -fprofile-arcs -ftest-coverage \
-largs -fprofile-arcs
</pre>
<p>This compilation process will create <samp><span class="file">.gcno</span></samp> files together with
the usual object files.
<p>Once the program is compiled with coverage instrumentation, you can
run it as many times as needed - on portions of a test suite for
example. The first execution will produce <samp><span class="file">.gcda</span></samp> files at the
same location as the <samp><span class="file">.gcno</span></samp> files. The following executions
will update those files, so that a cumulative result of the covered
portions of the program is generated.
<p>Finally, you need to call the <code>gcov</code> tool. The different options of
<code>gcov</code> are available in the GCC User's Guide, section 'Invoking gcov'.
<p>This will create annotated source files with a <samp><span class="file">.gcov</span></samp> extension:
<samp><span class="file">my_main.adb</span></samp> file will be analysed in <samp><span class="file">my_main.adb.gcov</span></samp>.
<div class="node">
<a name="Gnat-specifics"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Quick-startup-guide">Quick startup guide</a>,
Up: <a rel="up" accesskey="u" href="#Code-Coverage-of-Ada-Programs-using-gcov">Code Coverage of Ada Programs using gcov</a>
</div>
<h4 class="subsection">28.1.2 Gnat specifics</h4>
<p>Because Ada semantics, portions of the source code may be shared among
several object files. This is the case for example when generics are
involved, when inlining is active or when declarations generate initialisation
calls. In order to take
into account this shared code, you need to call <code>gcov</code> on all
source files of the tested program at once.
<p>The list of source files might exceed the system's maximum command line
length. In order to bypass this limitation, a new mechanism has been
implemented in <code>gcov</code>: you can now list all your project's files into a
text file, and provide this file to gcov as a parameter, preceded by a @
(e.g. ‘<samp><span class="samp">gcov @mysrclist.txt</span></samp>’).
<p>Note that on AIX compiling a static library with <code>-fprofile-arcs</code> is
not supported as there can be unresolved symbols during the final link.
<div class="node">
<a name="Profiling-an-Ada-Program-using-gprof"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Code-Coverage-of-Ada-Programs-using-gcov">Code Coverage of Ada Programs using gcov</a>,
Up: <a rel="up" accesskey="u" href="#Code-Coverage-and-Profiling">Code Coverage and Profiling</a>
</div>
<h3 class="section">28.2 Profiling an Ada Program using gprof</h3>
<p><a name="index-gprof-938"></a><a name="index-g_t_002dpg-939"></a><a name="index-Profiling-940"></a>
This section is not meant to be an exhaustive documentation of <code>gprof</code>.
Full documentation for it can be found in the GNU Profiler User's Guide
documentation that is part of this GNAT distribution.
<p>Profiling a program helps determine the parts of a program that are executed
most often, and are therefore the most time-consuming.
<p><code>gprof</code> is the standard GNU profiling tool; it has been enhanced to
better handle Ada programs and multitasking.
It is currently supported on the following platforms
<ul>
<li>linux x86/x86_64
<li>solaris sparc/sparc64/x86
<li>windows x86
</ul>
<p class="noindent">In order to profile a program using <code>gprof</code>, 3 steps are needed:
<ul>
<li>Code instrumentation, requiring a full recompilation of the project with the
proper switches.
<li>Execution of the program under the analysis conditions, i.e. with the desired
input.
<li>Analysis of the results using the <code>gprof</code> tool.
</ul>
<p class="noindent">The following sections detail the different steps, and indicate how
to interpret the results:
<ul class="menu">
<li><a accesskey="1" href="#Compilation-for-profiling">Compilation for profiling</a>
<li><a accesskey="2" href="#Program-execution">Program execution</a>
<li><a accesskey="3" href="#Running-gprof">Running gprof</a>
<li><a accesskey="4" href="#Interpretation-of-profiling-results">Interpretation of profiling results</a>
</ul>
<div class="node">
<a name="Compilation-for-profiling"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Program-execution">Program execution</a>,
Up: <a rel="up" accesskey="u" href="#Profiling-an-Ada-Program-using-gprof">Profiling an Ada Program using gprof</a>
</div>
<h4 class="subsection">28.2.1 Compilation for profiling</h4>
<p><a name="index-g_t_002dpg-941"></a><a name="index-Profiling-942"></a>
In order to profile a program the first step is to tell the compiler
to generate the necessary profiling information. The compiler switch to be used
is <code>-pg</code>, which must be added to other compilation switches. This
switch needs to be specified both during compilation and link stages, and can
be specified once when using gnatmake:
<pre class="smallexample"> gnatmake -f -pg -P my_project
</pre>
<p class="noindent">Note that only the objects that were compiled with the ‘<samp><span class="samp">-pg</span></samp>’ switch will
be profiled; if you need to profile your whole project, use the ‘<samp><span class="samp">-f</span></samp>’
gnatmake switch to force full recompilation.
<div class="node">
<a name="Program-execution"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Running-gprof">Running gprof</a>,
Previous: <a rel="previous" accesskey="p" href="#Compilation-for-profiling">Compilation for profiling</a>,
Up: <a rel="up" accesskey="u" href="#Profiling-an-Ada-Program-using-gprof">Profiling an Ada Program using gprof</a>
</div>
<h4 class="subsection">28.2.2 Program execution</h4>
<p class="noindent">Once the program has been compiled for profiling, you can run it as usual.
<p>The only constraint imposed by profiling is that the program must terminate
normally. An interrupted program (via a Ctrl-C, kill, etc.) will not be
properly analyzed.
<p>Once the program completes execution, a data file called <samp><span class="file">gmon.out</span></samp> is
generated in the directory where the program was launched from. If this file
already exists, it will be overwritten.
<div class="node">
<a name="Running-gprof"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Interpretation-of-profiling-results">Interpretation of profiling results</a>,
Previous: <a rel="previous" accesskey="p" href="#Program-execution">Program execution</a>,
Up: <a rel="up" accesskey="u" href="#Profiling-an-Ada-Program-using-gprof">Profiling an Ada Program using gprof</a>
</div>
<h4 class="subsection">28.2.3 Running gprof</h4>
<p class="noindent">The <code>gprof</code> tool is called as follow:
<pre class="smallexample"> gprof my_prog gmon.out
</pre>
<p class="noindent">or simpler:
<pre class="smallexample"> gprof my_prog
</pre>
<p class="noindent">The complete form of the gprof command line is the following:
<pre class="smallexample"> gprof [switches] [executable [data-file]]
</pre>
<p class="noindent"><code>gprof</code> supports numerous switch. The order of these
switch does not matter. The full list of options can be found in
the GNU Profiler User's Guide documentation that comes with this documentation.
<p>The following is the subset of those switches that is most relevant:
<dl>
<dt><samp><span class="option">--demangle[=</span><var>style</var><span class="option">]</span></samp><dt><samp><span class="option">--no-demangle</span></samp><dd><a name="index-g_t_0040option_007b_002d_002ddemangle_007d-_0028_0040code_007bgprof_007d_0029-943"></a>These options control whether symbol names should be demangled when
printing output. The default is to demangle C++ symbols. The
<code>--no-demangle</code> option may be used to turn off demangling. Different
compilers have different mangling styles. The optional demangling style
argument can be used to choose an appropriate demangling style for your
compiler, in particular Ada symbols generated by GNAT can be demangled using
<code>--demangle=gnat</code>.
<br><dt><samp><span class="option">-e </span><var>function_name</var></samp><dd><a name="index-g_t_0040option_007b_002de_007d-_0028_0040code_007bgprof_007d_0029-944"></a>The ‘<samp><span class="samp">-e </span><var>function</var></samp>’ option tells <code>gprof</code> not to print
information about the function <var>function_name</var> (and its
children<small class="dots">...</small>) in the call graph. The function will still be listed
as a child of any functions that call it, but its index number will be
shown as ‘<samp><span class="samp">[not printed]</span></samp>’. More than one ‘<samp><span class="samp">-e</span></samp>’ option may be
given; only one <var>function_name</var> may be indicated with each ‘<samp><span class="samp">-e</span></samp>’
option.
<br><dt><samp><span class="option">-E </span><var>function_name</var></samp><dd><a name="index-g_t_0040option_007b_002dE_007d-_0028_0040code_007bgprof_007d_0029-945"></a>The <code>-E </code><var>function</var> option works like the <code>-e</code> option, but
execution time spent in the function (and children who were not called from
anywhere else), will not be used to compute the percentages-of-time for
the call graph. More than one ‘<samp><span class="samp">-E</span></samp>’ option may be given; only one
<var>function_name</var> may be indicated with each ‘<samp><span class="samp">-E</span></samp>’ option.
<br><dt><samp><span class="option">-f </span><var>function_name</var></samp><dd><a name="index-g_t_0040option_007b_002df_007d-_0028_0040code_007bgprof_007d_0029-946"></a>The ‘<samp><span class="samp">-f </span><var>function</var></samp>’ option causes <code>gprof</code> to limit the
call graph to the function <var>function_name</var> and its children (and
their children<small class="dots">...</small>). More than one ‘<samp><span class="samp">-f</span></samp>’ option may be given;
only one <var>function_name</var> may be indicated with each ‘<samp><span class="samp">-f</span></samp>’
option.
<br><dt><samp><span class="option">-F </span><var>function_name</var></samp><dd><a name="index-g_t_0040option_007b_002dF_007d-_0028_0040code_007bgprof_007d_0029-947"></a>The ‘<samp><span class="samp">-F </span><var>function</var></samp>’ option works like the <code>-f</code> option, but
only time spent in the function and its children (and their
children<small class="dots">...</small>) will be used to determine total-time and
percentages-of-time for the call graph. More than one ‘<samp><span class="samp">-F</span></samp>’ option
may be given; only one <var>function_name</var> may be indicated with each
‘<samp><span class="samp">-F</span></samp>’ option. The ‘<samp><span class="samp">-F</span></samp>’ option overrides the ‘<samp><span class="samp">-E</span></samp>’ option.
</dl>
<div class="node">
<a name="Interpretation-of-profiling-results"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Running-gprof">Running gprof</a>,
Up: <a rel="up" accesskey="u" href="#Profiling-an-Ada-Program-using-gprof">Profiling an Ada Program using gprof</a>
</div>
<h4 class="subsection">28.2.4 Interpretation of profiling results</h4>
<p class="noindent">The results of the profiling analysis are represented by two arrays: the
'flat profile' and the 'call graph'. Full documentation of those outputs
can be found in the GNU Profiler User's Guide.
<p>The flat profile shows the time spent in each function of the program, and how
many time it has been called. This allows you to locate easily the most
time-consuming functions.
<p>The call graph shows, for each subprogram, the subprograms that call it,
and the subprograms that it calls. It also provides an estimate of the time
spent in each of those callers/called subprograms.
<!-- ****************************** -->
<div class="node">
<a name="Running-and-Debugging-Ada-Programs"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Code-Coverage-and-Profiling">Code Coverage and Profiling</a>,
Previous: <a rel="previous" accesskey="p" href="#Other-Utility-Programs">Other Utility Programs</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">29 Running and Debugging Ada Programs</h2>
<p><a name="index-Debugging-948"></a>
This chapter discusses how to debug Ada programs.
<p>An incorrect Ada program may be handled in three ways by the GNAT compiler:
<ol type=1 start=1>
<li>The illegality may be a violation of the static semantics of Ada. In
that case GNAT diagnoses the constructs in the program that are illegal.
It is then a straightforward matter for the user to modify those parts of
the program.
<li>The illegality may be a violation of the dynamic semantics of Ada. In
that case the program compiles and executes, but may generate incorrect
results, or may terminate abnormally with some exception.
<li>When presented with a program that contains convoluted errors, GNAT
itself may terminate abnormally without providing full diagnostics on
the incorrect user program.
</ol>
<ul class="menu">
<li><a accesskey="1" href="#The-GNAT-Debugger-GDB">The GNAT Debugger GDB</a>
<li><a accesskey="2" href="#Running-GDB">Running GDB</a>
<li><a accesskey="3" href="#Introduction-to-GDB-Commands">Introduction to GDB Commands</a>
<li><a accesskey="4" href="#Using-Ada-Expressions">Using Ada Expressions</a>
<li><a accesskey="5" href="#Calling-User_002dDefined-Subprograms">Calling User-Defined Subprograms</a>
<li><a accesskey="6" href="#Using-the-Next-Command-in-a-Function">Using the Next Command in a Function</a>
<li><a accesskey="7" href="#Ada-Exceptions">Ada Exceptions</a>
<li><a accesskey="8" href="#Ada-Tasks">Ada Tasks</a>
<li><a accesskey="9" href="#Debugging-Generic-Units">Debugging Generic Units</a>
<li><a href="#Remote-Debugging-using-gdbserver">Remote Debugging using gdbserver</a>
<li><a href="#GNAT-Abnormal-Termination-or-Failure-to-Terminate">GNAT Abnormal Termination or Failure to Terminate</a>
<li><a href="#Naming-Conventions-for-GNAT-Source-Files">Naming Conventions for GNAT Source Files</a>
<li><a href="#Getting-Internal-Debugging-Information">Getting Internal Debugging Information</a>
<li><a href="#Stack-Traceback">Stack Traceback</a>
</ul>
<p><a name="index-Debugger-949"></a><a name="index-gdb-950"></a>
<div class="node">
<a name="The-GNAT-Debugger-GDB"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Running-GDB">Running GDB</a>,
Up: <a rel="up" accesskey="u" href="#Running-and-Debugging-Ada-Programs">Running and Debugging Ada Programs</a>
</div>
<h3 class="section">29.1 The GNAT Debugger GDB</h3>
<p class="noindent"><code>GDB</code> is a general purpose, platform-independent debugger that
can be used to debug mixed-language programs compiled with <samp><span class="command">gcc</span></samp>,
and in particular is capable of debugging Ada programs compiled with
GNAT. The latest versions of <code>GDB</code> are Ada-aware and can handle
complex Ada data structures.
<p>See <a href="gdb.html#Top">Debugging with GDB</a>,
for full details on the usage of <code>GDB</code>, including a section on
its usage on programs. This manual should be consulted for full
details. The section that follows is a brief introduction to the
philosophy and use of <code>GDB</code>.
<p>When GNAT programs are compiled, the compiler optionally writes debugging
information into the generated object file, including information on
line numbers, and on declared types and variables. This information is
separate from the generated code. It makes the object files considerably
larger, but it does not add to the size of the actual executable that
will be loaded into memory, and has no impact on run-time performance. The
generation of debug information is triggered by the use of the
-g switch in the <samp><span class="command">gcc</span></samp> or <samp><span class="command">gnatmake</span></samp> command
used to carry out the compilations. It is important to emphasize that
the use of these options does not change the generated code.
<p>The debugging information is written in standard system formats that
are used by many tools, including debuggers and profilers. The format
of the information is typically designed to describe C types and
semantics, but GNAT implements a translation scheme which allows full
details about Ada types and variables to be encoded into these
standard C formats. Details of this encoding scheme may be found in
the file exp_dbug.ads in the GNAT source distribution. However, the
details of this encoding are, in general, of no interest to a user,
since <code>GDB</code> automatically performs the necessary decoding.
<p>When a program is bound and linked, the debugging information is
collected from the object files, and stored in the executable image of
the program. Again, this process significantly increases the size of
the generated executable file, but it does not increase the size of
the executable program itself. Furthermore, if this program is run in
the normal manner, it runs exactly as if the debug information were
not present, and takes no more actual memory.
<p>However, if the program is run under control of <code>GDB</code>, the
debugger is activated. The image of the program is loaded, at which
point it is ready to run. If a run command is given, then the program
will run exactly as it would have if <code>GDB</code> were not present. This
is a crucial part of the <code>GDB</code> design philosophy. <code>GDB</code> is
entirely non-intrusive until a breakpoint is encountered. If no
breakpoint is ever hit, the program will run exactly as it would if no
debugger were present. When a breakpoint is hit, <code>GDB</code> accesses
the debugging information and can respond to user commands to inspect
variables, and more generally to report on the state of execution.
<!-- ************** -->
<div class="node">
<a name="Running-GDB"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Introduction-to-GDB-Commands">Introduction to GDB Commands</a>,
Previous: <a rel="previous" accesskey="p" href="#The-GNAT-Debugger-GDB">The GNAT Debugger GDB</a>,
Up: <a rel="up" accesskey="u" href="#Running-and-Debugging-Ada-Programs">Running and Debugging Ada Programs</a>
</div>
<h3 class="section">29.2 Running GDB</h3>
<p class="noindent">This section describes how to initiate the debugger.
<!-- The above sentence is really just filler, but it was otherwise -->
<!-- clumsy to get the first paragraph nonindented given the conditional -->
<!-- nature of the description -->
<p>The debugger can be launched from a <code>GPS</code> menu or
directly from the command line. The description below covers the latter use.
All the commands shown can be used in the <code>GPS</code> debug console window,
but there are usually more GUI-based ways to achieve the same effect.
<p>The command to run <code>GDB</code> is
<pre class="smallexample"> $ gdb program
</pre>
<p class="noindent">where <code>program</code> is the name of the executable file. This
activates the debugger and results in a prompt for debugger commands.
The simplest command is simply <code>run</code>, which causes the program to run
exactly as if the debugger were not present. The following section
describes some of the additional commands that can be given to <code>GDB</code>.
<!-- ******************************* -->
<div class="node">
<a name="Introduction-to-GDB-Commands"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Using-Ada-Expressions">Using Ada Expressions</a>,
Previous: <a rel="previous" accesskey="p" href="#Running-GDB">Running GDB</a>,
Up: <a rel="up" accesskey="u" href="#Running-and-Debugging-Ada-Programs">Running and Debugging Ada Programs</a>
</div>
<h3 class="section">29.3 Introduction to GDB Commands</h3>
<p class="noindent"><code>GDB</code> contains a large repertoire of commands. See <a href="gdb.html#Top">Debugging with GDB</a>,
for extensive documentation on the use
of these commands, together with examples of their use. Furthermore,
the command <samp><span class="command">help</span></samp> invoked from within GDB activates a simple help
facility which summarizes the available commands and their options.
In this section we summarize a few of the most commonly
used commands to give an idea of what <code>GDB</code> is about. You should create
a simple program with debugging information and experiment with the use of
these <code>GDB</code> commands on the program as you read through the
following section.
<dl>
<dt><code>set args </code><var>arguments</var><dd>The <var>arguments</var> list above is a list of arguments to be passed to
the program on a subsequent run command, just as though the arguments
had been entered on a normal invocation of the program. The <code>set args</code>
command is not needed if the program does not require arguments.
<br><dt><code>run</code><dd>The <code>run</code> command causes execution of the program to start from
the beginning. If the program is already running, that is to say if
you are currently positioned at a breakpoint, then a prompt will ask
for confirmation that you want to abandon the current execution and
restart.
<br><dt><code>breakpoint </code><var>location</var><dd>The breakpoint command sets a breakpoint, that is to say a point at which
execution will halt and <code>GDB</code> will await further
commands. <var>location</var> is
either a line number within a file, given in the format <code>file:linenumber</code>,
or it is the name of a subprogram. If you request that a breakpoint be set on
a subprogram that is overloaded, a prompt will ask you to specify on which of
those subprograms you want to breakpoint. You can also
specify that all of them should be breakpointed. If the program is run
and execution encounters the breakpoint, then the program
stops and <code>GDB</code> signals that the breakpoint was encountered by
printing the line of code before which the program is halted.
<br><dt><code>catch exception </code><var>name</var><dd>This command causes the program execution to stop whenever exception
<var>name</var> is raised. If <var>name</var> is omitted, then the execution is
suspended when any exception is raised.
<br><dt><code>print </code><var>expression</var><dd>This will print the value of the given expression. Most simple
Ada expression formats are properly handled by <code>GDB</code>, so the expression
can contain function calls, variables, operators, and attribute references.
<br><dt><code>continue</code><dd>Continues execution following a breakpoint, until the next breakpoint or the
termination of the program.
<br><dt><code>step</code><dd>Executes a single line after a breakpoint. If the next statement
is a subprogram call, execution continues into (the first statement of)
the called subprogram.
<br><dt><code>next</code><dd>Executes a single line. If this line is a subprogram call, executes and
returns from the call.
<br><dt><code>list</code><dd>Lists a few lines around the current source location. In practice, it
is usually more convenient to have a separate edit window open with the
relevant source file displayed. Successive applications of this command
print subsequent lines. The command can be given an argument which is a
line number, in which case it displays a few lines around the specified one.
<br><dt><code>backtrace</code><dd>Displays a backtrace of the call chain. This command is typically
used after a breakpoint has occurred, to examine the sequence of calls that
leads to the current breakpoint. The display includes one line for each
activation record (frame) corresponding to an active subprogram.
<br><dt><code>up</code><dd>At a breakpoint, <code>GDB</code> can display the values of variables local
to the current frame. The command <code>up</code> can be used to
examine the contents of other active frames, by moving the focus up
the stack, that is to say from callee to caller, one frame at a time.
<br><dt><code>down</code><dd>Moves the focus of <code>GDB</code> down from the frame currently being
examined to the frame of its callee (the reverse of the previous command),
<br><dt><code>frame </code><var>n</var><dd>Inspect the frame with the given number. The value 0 denotes the frame
of the current breakpoint, that is to say the top of the call stack.
</dl>
<p class="noindent">The above list is a very short introduction to the commands that
<code>GDB</code> provides. Important additional capabilities, including conditional
breakpoints, the ability to execute command sequences on a breakpoint,
the ability to debug at the machine instruction level and many other
features are described in detail in <a href="gdb.html#Top">Debugging with GDB</a>. Note that most commands can be abbreviated
(for example, c for continue, bt for backtrace).
<div class="node">
<a name="Using-Ada-Expressions"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Calling-User_002dDefined-Subprograms">Calling User-Defined Subprograms</a>,
Previous: <a rel="previous" accesskey="p" href="#Introduction-to-GDB-Commands">Introduction to GDB Commands</a>,
Up: <a rel="up" accesskey="u" href="#Running-and-Debugging-Ada-Programs">Running and Debugging Ada Programs</a>
</div>
<h3 class="section">29.4 Using Ada Expressions</h3>
<p><a name="index-Ada-expressions-951"></a>
<code>GDB</code> supports a fairly large subset of Ada expression syntax, with some
extensions. The philosophy behind the design of this subset is
<ul>
<li>That <code>GDB</code> should provide basic literals and access to operations for
arithmetic, dereferencing, field selection, indexing, and subprogram calls,
leaving more sophisticated computations to subprograms written into the
program (which therefore may be called from <code>GDB</code>).
<li>That type safety and strict adherence to Ada language restrictions
are not particularly important to the <code>GDB</code> user.
<li>That brevity is important to the <code>GDB</code> user.
</ul>
<p class="noindent">Thus, for brevity, the debugger acts as if there were
implicit <code>with</code> and <code>use</code> clauses in effect for all user-written
packages, thus making it unnecessary to fully qualify most names with
their packages, regardless of context. Where this causes ambiguity,
<code>GDB</code> asks the user's intent.
<p>For details on the supported Ada syntax, see <a href="gdb.html#Top">Debugging with GDB</a>.
<div class="node">
<a name="Calling-User-Defined-Subprograms"></a>
<a name="Calling-User_002dDefined-Subprograms"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Using-the-Next-Command-in-a-Function">Using the Next Command in a Function</a>,
Previous: <a rel="previous" accesskey="p" href="#Using-Ada-Expressions">Using Ada Expressions</a>,
Up: <a rel="up" accesskey="u" href="#Running-and-Debugging-Ada-Programs">Running and Debugging Ada Programs</a>
</div>
<h3 class="section">29.5 Calling User-Defined Subprograms</h3>
<p class="noindent">An important capability of <code>GDB</code> is the ability to call user-defined
subprograms while debugging. This is achieved simply by entering
a subprogram call statement in the form:
<pre class="smallexample"> call subprogram-name (parameters)
</pre>
<p class="noindent">The keyword <code>call</code> can be omitted in the normal case where the
<code>subprogram-name</code> does not coincide with any of the predefined
<code>GDB</code> commands.
<p>The effect is to invoke the given subprogram, passing it the
list of parameters that is supplied. The parameters can be expressions and
can include variables from the program being debugged. The
subprogram must be defined
at the library level within your program, and <code>GDB</code> will call the
subprogram within the environment of your program execution (which
means that the subprogram is free to access or even modify variables
within your program).
<p>The most important use of this facility is in allowing the inclusion of
debugging routines that are tailored to particular data structures
in your program. Such debugging routines can be written to provide a suitably
high-level description of an abstract type, rather than a low-level dump
of its physical layout. After all, the standard
<code>GDB print</code> command only knows the physical layout of your
types, not their abstract meaning. Debugging routines can provide information
at the desired semantic level and are thus enormously useful.
<p>For example, when debugging GNAT itself, it is crucial to have access to
the contents of the tree nodes used to represent the program internally.
But tree nodes are represented simply by an integer value (which in turn
is an index into a table of nodes).
Using the <code>print</code> command on a tree node would simply print this integer
value, which is not very useful. But the PN routine (defined in file
treepr.adb in the GNAT sources) takes a tree node as input, and displays
a useful high level representation of the tree node, which includes the
syntactic category of the node, its position in the source, the integers
that denote descendant nodes and parent node, as well as varied
semantic information. To study this example in more detail, you might want to
look at the body of the PN procedure in the stated file.
<div class="node">
<a name="Using-the-Next-Command-in-a-Function"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Ada-Exceptions">Ada Exceptions</a>,
Previous: <a rel="previous" accesskey="p" href="#Calling-User_002dDefined-Subprograms">Calling User-Defined Subprograms</a>,
Up: <a rel="up" accesskey="u" href="#Running-and-Debugging-Ada-Programs">Running and Debugging Ada Programs</a>
</div>
<h3 class="section">29.6 Using the Next Command in a Function</h3>
<p class="noindent">When you use the <code>next</code> command in a function, the current source
location will advance to the next statement as usual. A special case
arises in the case of a <code>return</code> statement.
<p>Part of the code for a return statement is the “epilog” of the function.
This is the code that returns to the caller. There is only one copy of
this epilog code, and it is typically associated with the last return
statement in the function if there is more than one return. In some
implementations, this epilog is associated with the first statement
of the function.
<p>The result is that if you use the <code>next</code> command from a return
statement that is not the last return statement of the function you
may see a strange apparent jump to the last return statement or to
the start of the function. You should simply ignore this odd jump.
The value returned is always that from the first return statement
that was stepped through.
<div class="node">
<a name="Ada-Exceptions"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Ada-Tasks">Ada Tasks</a>,
Previous: <a rel="previous" accesskey="p" href="#Using-the-Next-Command-in-a-Function">Using the Next Command in a Function</a>,
Up: <a rel="up" accesskey="u" href="#Running-and-Debugging-Ada-Programs">Running and Debugging Ada Programs</a>
</div>
<h3 class="section">29.7 Stopping when Ada Exceptions are Raised</h3>
<p><a name="index-Exceptions-952"></a>
You can set catchpoints that stop the program execution when your program
raises selected exceptions.
<dl>
<dt><code>catch exception</code><dd>Set a catchpoint that stops execution whenever (any task in the) program
raises any exception.
<br><dt><code>catch exception </code><var>name</var><dd>Set a catchpoint that stops execution whenever (any task in the) program
raises the exception <var>name</var>.
<br><dt><code>catch exception unhandled</code><dd>Set a catchpoint that stops executing whenever (any task in the) program
raises an exception for which there is no handler.
<br><dt><code>info exceptions</code><dt><code>info exceptions </code><var>regexp</var><dd>The <code>info exceptions</code> command permits the user to examine all defined
exceptions within Ada programs. With a regular expression, <var>regexp</var>, as
argument, prints out only those exceptions whose name matches <var>regexp</var>.
</dl>
<div class="node">
<a name="Ada-Tasks"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Debugging-Generic-Units">Debugging Generic Units</a>,
Previous: <a rel="previous" accesskey="p" href="#Ada-Exceptions">Ada Exceptions</a>,
Up: <a rel="up" accesskey="u" href="#Running-and-Debugging-Ada-Programs">Running and Debugging Ada Programs</a>
</div>
<h3 class="section">29.8 Ada Tasks</h3>
<p><a name="index-Tasks-953"></a>
<code>GDB</code> allows the following task-related commands:
<dl>
<dt><code>info tasks</code><dd>This command shows a list of current Ada tasks, as in the following example:
<pre class="smallexample"> (gdb) info tasks
ID TID P-ID Thread Pri State Name
1 8088000 0 807e000 15 Child Activation Wait main_task
2 80a4000 1 80ae000 15 Accept/Select Wait b
3 809a800 1 80a4800 15 Child Activation Wait a
* 4 80ae800 3 80b8000 15 Running c
</pre>
<p class="noindent">In this listing, the asterisk before the first task indicates it to be the
currently running task. The first column lists the task ID that is used
to refer to tasks in the following commands.
<br><dt><code>break </code><var>linespec</var><code> task </code><var>taskid</var><dt><code>break </code><var>linespec</var><code> task </code><var>taskid</var><code> if ...</code><dd><a name="index-Breakpoints-and-tasks-954"></a>These commands are like the <code>break ... thread ...</code>.
<var>linespec</var> specifies source lines.
<p>Use the qualifier ‘<samp><span class="samp">task </span><var>taskid</var></samp>’ with a breakpoint command
to specify that you only want <code>GDB</code> to stop the program when a
particular Ada task reaches this breakpoint. <var>taskid</var> is one of the
numeric task identifiers assigned by <code>GDB</code>, shown in the first
column of the ‘<samp><span class="samp">info tasks</span></samp>’ display.
<p>If you do not specify ‘<samp><span class="samp">task </span><var>taskid</var></samp>’ when you set a
breakpoint, the breakpoint applies to <em>all</em> tasks of your
program.
<p>You can use the <code>task</code> qualifier on conditional breakpoints as
well; in this case, place ‘<samp><span class="samp">task </span><var>taskid</var></samp>’ before the
breakpoint condition (before the <code>if</code>).
<br><dt><code>task </code><var>taskno</var><dd><a name="index-Task-switching-955"></a>
This command allows to switch to the task referred by <var>taskno</var>. In
particular, This allows to browse the backtrace of the specified
task. It is advised to switch back to the original task before
continuing execution otherwise the scheduling of the program may be
perturbed.
</dl>
<p class="noindent">For more detailed information on the tasking support,
see <a href="gdb.html#Top">Debugging with GDB</a>.
<div class="node">
<a name="Debugging-Generic-Units"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Remote-Debugging-using-gdbserver">Remote Debugging using gdbserver</a>,
Previous: <a rel="previous" accesskey="p" href="#Ada-Tasks">Ada Tasks</a>,
Up: <a rel="up" accesskey="u" href="#Running-and-Debugging-Ada-Programs">Running and Debugging Ada Programs</a>
</div>
<h3 class="section">29.9 Debugging Generic Units</h3>
<p><a name="index-Debugging-Generic-Units-956"></a><a name="index-Generics-957"></a>
GNAT always uses code expansion for generic instantiation. This means that
each time an instantiation occurs, a complete copy of the original code is
made, with appropriate substitutions of formals by actuals.
<p>It is not possible to refer to the original generic entities in
<code>GDB</code>, but it is always possible to debug a particular instance of
a generic, by using the appropriate expanded names. For example, if we have
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
procedure g is
generic package k is
procedure kp (v1 : in out integer);
end k;
package body k is
procedure kp (v1 : in out integer) is
begin
v1 := v1 + 1;
end kp;
end k;
package k1 is new k;
package k2 is new k;
var : integer := 1;
begin
k1.kp (var);
k2.kp (var);
k1.kp (var);
k2.kp (var);
end;
</td></tr></table>
</pre>
<p class="noindent">Then to break on a call to procedure kp in the k2 instance, simply
use the command:
<pre class="smallexample"> (gdb) break g.k2.kp
</pre>
<p class="noindent">When the breakpoint occurs, you can step through the code of the
instance in the normal manner and examine the values of local variables, as for
other units.
<div class="node">
<a name="Remote-Debugging-using-gdbserver"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#GNAT-Abnormal-Termination-or-Failure-to-Terminate">GNAT Abnormal Termination or Failure to Terminate</a>,
Previous: <a rel="previous" accesskey="p" href="#Debugging-Generic-Units">Debugging Generic Units</a>,
Up: <a rel="up" accesskey="u" href="#Running-and-Debugging-Ada-Programs">Running and Debugging Ada Programs</a>
</div>
<h3 class="section">29.10 Remote Debugging using gdbserver</h3>
<p><a name="index-Remote-Debugging-using-gdbserver-958"></a>
On platforms where gdbserver is supported, it is possible to use this tool
to debug your application remotely. This can be useful in situations
where the program needs to be run on a target host that is different
from the host used for development, particularly when the target has
a limited amount of resources (either CPU and/or memory).
<p>To do so, start your program using gdbserver on the target machine.
gdbserver then automatically suspends the execution of your program
at its entry point, waiting for a debugger to connect to it. The
following commands starts an application and tells gdbserver to
wait for a connection with the debugger on localhost port 4444.
<pre class="smallexample"> $ gdbserver localhost:4444 program
Process program created; pid = 5685
Listening on port 4444
</pre>
<p>Once gdbserver has started listening, we can tell the debugger to establish
a connection with this gdbserver, and then start the same debugging session
as if the program was being debugged on the same host, directly under
the control of GDB.
<pre class="smallexample"> $ gdb program
(gdb) target remote targethost:4444
Remote debugging using targethost:4444
0x00007f29936d0af0 in ?? () from /lib64/ld-linux-x86-64.so.
(gdb) b foo.adb:3
Breakpoint 1 at 0x401f0c: file foo.adb, line 3.
(gdb) continue
Continuing.
Breakpoint 1, foo () at foo.adb:4
4 end foo;
</pre>
<p>It is also possible to use gdbserver to attach to an already running
program, in which case the execution of that program is simply suspended
until the connection between the debugger and gdbserver is established.
<p>For more information on how to use gdbserver, <a href="gdb.html#Top">Server</a>. GNAT Pro provides support
for gdbserver on x86-linux, x86-windows and x86_64-linux.
<div class="node">
<a name="GNAT-Abnormal-Termination-or-Failure-to-Terminate"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Naming-Conventions-for-GNAT-Source-Files">Naming Conventions for GNAT Source Files</a>,
Previous: <a rel="previous" accesskey="p" href="#Remote-Debugging-using-gdbserver">Remote Debugging using gdbserver</a>,
Up: <a rel="up" accesskey="u" href="#Running-and-Debugging-Ada-Programs">Running and Debugging Ada Programs</a>
</div>
<h3 class="section">29.11 GNAT Abnormal Termination or Failure to Terminate</h3>
<p><a name="index-GNAT-Abnormal-Termination-or-Failure-to-Terminate-959"></a>
When presented with programs that contain serious errors in syntax
or semantics,
GNAT may on rare occasions experience problems in operation, such
as aborting with a
segmentation fault or illegal memory access, raising an internal
exception, terminating abnormally, or failing to terminate at all.
In such cases, you can activate
various features of GNAT that can help you pinpoint the construct in your
program that is the likely source of the problem.
<p>The following strategies are presented in increasing order of
difficulty, corresponding to your experience in using GNAT and your
familiarity with compiler internals.
<ol type=1 start=1>
<li>Run <samp><span class="command">gcc</span></samp> with the <samp><span class="option">-gnatf</span></samp>. This first
switch causes all errors on a given line to be reported. In its absence,
only the first error on a line is displayed.
<p>The <samp><span class="option">-gnatdO</span></samp> switch causes errors to be displayed as soon as they
are encountered, rather than after compilation is terminated. If GNAT
terminates prematurely or goes into an infinite loop, the last error
message displayed may help to pinpoint the culprit.
<li>Run <samp><span class="command">gcc</span></samp> with the <samp><span class="option">-v (verbose)</span></samp> switch. In this
mode, <samp><span class="command">gcc</span></samp> produces ongoing information about the progress of the
compilation and provides the name of each procedure as code is
generated. This switch allows you to find which Ada procedure was being
compiled when it encountered a code generation problem.
<li><a name="index-g_t_0040option_007b_002dgnatdc_007d-switch-960"></a>Run <samp><span class="command">gcc</span></samp> with the <samp><span class="option">-gnatdc</span></samp> switch. This is a GNAT specific
switch that does for the front-end what <samp><span class="option">-v</span></samp> does
for the back end. The system prints the name of each unit,
either a compilation unit or nested unit, as it is being analyzed.
<li>Finally, you can start
<code>gdb</code> directly on the <code>gnat1</code> executable. <code>gnat1</code> is the
front-end of GNAT, and can be run independently (normally it is just
called from <samp><span class="command">gcc</span></samp>). You can use <code>gdb</code> on <code>gnat1</code> as you
would on a C program (but see <a href="#The-GNAT-Debugger-GDB">The GNAT Debugger GDB</a> for caveats). The
<code>where</code> command is the first line of attack; the variable
<code>lineno</code> (seen by <code>print lineno</code>), used by the second phase of
<code>gnat1</code> and by the <samp><span class="command">gcc</span></samp> backend, indicates the source line at
which the execution stopped, and <code>input_file name</code> indicates the name of
the source file.
</ol>
<div class="node">
<a name="Naming-Conventions-for-GNAT-Source-Files"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Getting-Internal-Debugging-Information">Getting Internal Debugging Information</a>,
Previous: <a rel="previous" accesskey="p" href="#GNAT-Abnormal-Termination-or-Failure-to-Terminate">GNAT Abnormal Termination or Failure to Terminate</a>,
Up: <a rel="up" accesskey="u" href="#Running-and-Debugging-Ada-Programs">Running and Debugging Ada Programs</a>
</div>
<h3 class="section">29.12 Naming Conventions for GNAT Source Files</h3>
<p class="noindent">In order to examine the workings of the GNAT system, the following
brief description of its organization may be helpful:
<ul>
<li>Files with prefix <samp><span class="file">sc</span></samp> contain the lexical scanner.
<li>All files prefixed with <samp><span class="file">par</span></samp> are components of the parser. The
numbers correspond to chapters of the Ada Reference Manual. For example,
parsing of select statements can be found in <samp><span class="file">par-ch9.adb</span></samp>.
<li>All files prefixed with <samp><span class="file">sem</span></samp> perform semantic analysis. The
numbers correspond to chapters of the Ada standard. For example, all
issues involving context clauses can be found in <samp><span class="file">sem_ch10.adb</span></samp>. In
addition, some features of the language require sufficient special processing
to justify their own semantic files: sem_aggr for aggregates, sem_disp for
dynamic dispatching, etc.
<li>All files prefixed with <samp><span class="file">exp</span></samp> perform normalization and
expansion of the intermediate representation (abstract syntax tree, or AST).
these files use the same numbering scheme as the parser and semantics files.
For example, the construction of record initialization procedures is done in
<samp><span class="file">exp_ch3.adb</span></samp>.
<li>The files prefixed with <samp><span class="file">bind</span></samp> implement the binder, which
verifies the consistency of the compilation, determines an order of
elaboration, and generates the bind file.
<li>The files <samp><span class="file">atree.ads</span></samp> and <samp><span class="file">atree.adb</span></samp> detail the low-level
data structures used by the front-end.
<li>The files <samp><span class="file">sinfo.ads</span></samp> and <samp><span class="file">sinfo.adb</span></samp> detail the structure of
the abstract syntax tree as produced by the parser.
<li>The files <samp><span class="file">einfo.ads</span></samp> and <samp><span class="file">einfo.adb</span></samp> detail the attributes of
all entities, computed during semantic analysis.
<li>Library management issues are dealt with in files with prefix
<samp><span class="file">lib</span></samp>.
<li><a name="index-Ada-961"></a><a name="index-Annex-A-962"></a>Ada files with the prefix <samp><span class="file">a-</span></samp> are children of <code>Ada</code>, as
defined in Annex A.
<li><a name="index-Interfaces-963"></a><a name="index-Annex-B-964"></a>Files with prefix <samp><span class="file">i-</span></samp> are children of <code>Interfaces</code>, as
defined in Annex B.
<li><a name="index-System-965"></a>Files with prefix <samp><span class="file">s-</span></samp> are children of <code>System</code>. This includes
both language-defined children and GNAT run-time routines.
<li><a name="index-GNAT-966"></a>Files with prefix <samp><span class="file">g-</span></samp> are children of <code>GNAT</code>. These are useful
general-purpose packages, fully documented in their specs. All
the other <samp><span class="file">.c</span></samp> files are modifications of common <samp><span class="command">gcc</span></samp> files.
</ul>
<div class="node">
<a name="Getting-Internal-Debugging-Information"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Stack-Traceback">Stack Traceback</a>,
Previous: <a rel="previous" accesskey="p" href="#Naming-Conventions-for-GNAT-Source-Files">Naming Conventions for GNAT Source Files</a>,
Up: <a rel="up" accesskey="u" href="#Running-and-Debugging-Ada-Programs">Running and Debugging Ada Programs</a>
</div>
<h3 class="section">29.13 Getting Internal Debugging Information</h3>
<p class="noindent">Most compilers have internal debugging switches and modes. GNAT
does also, except GNAT internal debugging switches and modes are not
secret. A summary and full description of all the compiler and binder
debug flags are in the file <samp><span class="file">debug.adb</span></samp>. You must obtain the
sources of the compiler to see the full detailed effects of these flags.
<p>The switches that print the source of the program (reconstructed from
the internal tree) are of general interest for user programs, as are the
options to print
the full internal tree, and the entity table (the symbol table
information). The reconstructed source provides a readable version of the
program after the front-end has completed analysis and expansion,
and is useful when studying the performance of specific constructs.
For example, constraint checks are indicated, complex aggregates
are replaced with loops and assignments, and tasking primitives
are replaced with run-time calls.
<div class="node">
<a name="Stack-Traceback"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Getting-Internal-Debugging-Information">Getting Internal Debugging Information</a>,
Up: <a rel="up" accesskey="u" href="#Running-and-Debugging-Ada-Programs">Running and Debugging Ada Programs</a>
</div>
<h3 class="section">29.14 Stack Traceback</h3>
<p><a name="index-traceback-967"></a><a name="index-stack-traceback-968"></a><a name="index-stack-unwinding-969"></a>
Traceback is a mechanism to display the sequence of subprogram calls that
leads to a specified execution point in a program. Often (but not always)
the execution point is an instruction at which an exception has been raised.
This mechanism is also known as <i>stack unwinding</i> because it obtains
its information by scanning the run-time stack and recovering the activation
records of all active subprograms. Stack unwinding is one of the most
important tools for program debugging.
<p>The first entry stored in traceback corresponds to the deepest calling level,
that is to say the subprogram currently executing the instruction
from which we want to obtain the traceback.
<p>Note that there is no runtime performance penalty when stack traceback
is enabled, and no exception is raised during program execution.
<ul class="menu">
<li><a accesskey="1" href="#Non_002dSymbolic-Traceback">Non-Symbolic Traceback</a>
<li><a accesskey="2" href="#Symbolic-Traceback">Symbolic Traceback</a>
</ul>
<div class="node">
<a name="Non-Symbolic-Traceback"></a>
<a name="Non_002dSymbolic-Traceback"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Symbolic-Traceback">Symbolic Traceback</a>,
Up: <a rel="up" accesskey="u" href="#Stack-Traceback">Stack Traceback</a>
</div>
<h4 class="subsection">29.14.1 Non-Symbolic Traceback</h4>
<p><a name="index-traceback_002c-non_002dsymbolic-970"></a>
Note: this feature is not supported on all platforms. See
<samp><span class="file">GNAT.Traceback spec in g-traceb.ads</span></samp> for a complete list of supported
platforms.
<ul class="menu">
<li><a accesskey="1" href="#Tracebacks-From-an-Unhandled-Exception">Tracebacks From an Unhandled Exception</a>
<li><a accesskey="2" href="#Tracebacks-From-Exception-Occurrences-_0028non_002dsymbolic_0029">Tracebacks From Exception Occurrences (non-symbolic)</a>
<li><a accesskey="3" href="#Tracebacks-From-Anywhere-in-a-Program-_0028non_002dsymbolic_0029">Tracebacks From Anywhere in a Program (non-symbolic)</a>
</ul>
<div class="node">
<a name="Tracebacks-From-an-Unhandled-Exception"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Tracebacks-From-Exception-Occurrences-_0028non_002dsymbolic_0029">Tracebacks From Exception Occurrences (non-symbolic)</a>,
Up: <a rel="up" accesskey="u" href="#Non_002dSymbolic-Traceback">Non-Symbolic Traceback</a>
</div>
<h5 class="subsubsection">29.14.1.1 Tracebacks From an Unhandled Exception</h5>
<p class="noindent">A runtime non-symbolic traceback is a list of addresses of call instructions.
To enable this feature you must use the <samp><span class="option">-E</span></samp>
<code>gnatbind</code>'s option. With this option a stack traceback is stored as part
of exception information. You can retrieve this information using the
<code>addr2line</code> tool.
<p>Here is a simple example:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
procedure STB is
procedure P1 is
begin
raise Constraint_Error;
end P1;
procedure P2 is
begin
P1;
end P2;
begin
P2;
end STB;
</td></tr></table>
</pre>
<pre class="smallexample"> $ gnatmake stb -bargs -E
$ stb
Execution terminated by unhandled exception
Exception name: CONSTRAINT_ERROR
Message: stb.adb:5
Call stack traceback locations:
0x401373 0x40138b 0x40139c 0x401335 0x4011c4 0x4011f1 0x77e892a4
</pre>
<p class="noindent">As we see the traceback lists a sequence of addresses for the unhandled
exception <code>CONSTRAINT_ERROR</code> raised in procedure P1. It is easy to
guess that this exception come from procedure P1. To translate these
addresses into the source lines where the calls appear, the
<code>addr2line</code> tool, described below, is invaluable. The use of this tool
requires the program to be compiled with debug information.
<pre class="smallexample"> $ gnatmake -g stb -bargs -E
$ stb
Execution terminated by unhandled exception
Exception name: CONSTRAINT_ERROR
Message: stb.adb:5
Call stack traceback locations:
0x401373 0x40138b 0x40139c 0x401335 0x4011c4 0x4011f1 0x77e892a4
$ addr2line --exe=stb 0x401373 0x40138b 0x40139c 0x401335 0x4011c4
0x4011f1 0x77e892a4
00401373 at d:/stb/stb.adb:5
0040138B at d:/stb/stb.adb:10
0040139C at d:/stb/stb.adb:14
00401335 at d:/stb/b~stb.adb:104
004011C4 at /build/.../crt1.c:200
004011F1 at /build/.../crt1.c:222
77E892A4 in ?? at ??:0
</pre>
<p class="noindent">The <code>addr2line</code> tool has several other useful options:
<dl>
<dt><code>--functions</code><dd>to get the function name corresponding to any location
<br><dt><code>--demangle=gnat</code><dd>to use the gnat decoding mode for the function names. Note that
for binutils version 2.9.x the option is simply <samp><span class="option">--demangle</span></samp>.
</dl>
<pre class="smallexample"> $ addr2line --exe=stb --functions --demangle=gnat 0x401373 0x40138b
0x40139c 0x401335 0x4011c4 0x4011f1
00401373 in stb.p1 at d:/stb/stb.adb:5
0040138B in stb.p2 at d:/stb/stb.adb:10
0040139C in stb at d:/stb/stb.adb:14
00401335 in main at d:/stb/b~stb.adb:104
004011C4 in <__mingw_CRTStartup> at /build/.../crt1.c:200
004011F1 in <mainCRTStartup> at /build/.../crt1.c:222
</pre>
<p class="noindent">From this traceback we can see that the exception was raised in
<samp><span class="file">stb.adb</span></samp> at line 5, which was reached from a procedure call in
<samp><span class="file">stb.adb</span></samp> at line 10, and so on. The <samp><span class="file">b~std.adb</span></samp> is the binder file,
which contains the call to the main program.
See <a href="#Running-gnatbind">Running gnatbind</a>. The remaining entries are assorted runtime routines,
and the output will vary from platform to platform.
<p>It is also possible to use <code>GDB</code> with these traceback addresses to debug
the program. For example, we can break at a given code location, as reported
in the stack traceback:
<pre class="smallexample"> $ gdb -nw stb
Furthermore, this feature is not implemented inside Windows DLL. Only
the non-symbolic traceback is reported in this case.
(gdb) break *0x401373
Breakpoint 1 at 0x401373: file stb.adb, line 5.
</pre>
<p class="noindent">It is important to note that the stack traceback addresses
do not change when debug information is included. This is particularly useful
because it makes it possible to release software without debug information (to
minimize object size), get a field report that includes a stack traceback
whenever an internal bug occurs, and then be able to retrieve the sequence
of calls with the same program compiled with debug information.
<div class="node">
<a name="Tracebacks-From-Exception-Occurrences-(non-symbolic)"></a>
<a name="Tracebacks-From-Exception-Occurrences-_0028non_002dsymbolic_0029"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Tracebacks-From-Anywhere-in-a-Program-_0028non_002dsymbolic_0029">Tracebacks From Anywhere in a Program (non-symbolic)</a>,
Previous: <a rel="previous" accesskey="p" href="#Tracebacks-From-an-Unhandled-Exception">Tracebacks From an Unhandled Exception</a>,
Up: <a rel="up" accesskey="u" href="#Non_002dSymbolic-Traceback">Non-Symbolic Traceback</a>
</div>
<h5 class="subsubsection">29.14.1.2 Tracebacks From Exception Occurrences</h5>
<p class="noindent">Non-symbolic tracebacks are obtained by using the <samp><span class="option">-E</span></samp> binder argument.
The stack traceback is attached to the exception information string, and can
be retrieved in an exception handler within the Ada program, by means of the
Ada facilities defined in <code>Ada.Exceptions</code>. Here is a simple example:
<pre class="smallexample"> with Ada.Text_IO;
with Ada.Exceptions;
procedure STB is
use Ada;
use Ada.Exceptions;
procedure P1 is
K : Positive := 1;
begin
K := K - 1;
exception
when E : others =>
Text_IO.Put_Line (Exception_Information (E));
end P1;
procedure P2 is
begin
P1;
end P2;
begin
P2;
end STB;
</pre>
<p class="noindent">This program will output:
<pre class="smallexample"> $ stb
Exception name: CONSTRAINT_ERROR
Message: stb.adb:12
Call stack traceback locations:
0x4015e4 0x401633 0x401644 0x401461 0x4011c4 0x4011f1 0x77e892a4
</pre>
<div class="node">
<a name="Tracebacks-From-Anywhere-in-a-Program-(non-symbolic)"></a>
<a name="Tracebacks-From-Anywhere-in-a-Program-_0028non_002dsymbolic_0029"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Tracebacks-From-Exception-Occurrences-_0028non_002dsymbolic_0029">Tracebacks From Exception Occurrences (non-symbolic)</a>,
Up: <a rel="up" accesskey="u" href="#Non_002dSymbolic-Traceback">Non-Symbolic Traceback</a>
</div>
<h5 class="subsubsection">29.14.1.3 Tracebacks From Anywhere in a Program</h5>
<p class="noindent">It is also possible to retrieve a stack traceback from anywhere in a
program. For this you need to
use the <code>GNAT.Traceback</code> API. This package includes a procedure called
<code>Call_Chain</code> that computes a complete stack traceback, as well as useful
display procedures described below. It is not necessary to use the
<samp><span class="option">-E gnatbind</span></samp> option in this case, because the stack traceback mechanism
is invoked explicitly.
<p class="noindent">In the following example we compute a traceback at a specific location in
the program, and we display it using <code>GNAT.Debug_Utilities.Image</code> to
convert addresses to strings:
<pre class="smallexample"> with Ada.Text_IO;
with GNAT.Traceback;
with GNAT.Debug_Utilities;
procedure STB is
use Ada;
use GNAT;
use GNAT.Traceback;
procedure P1 is
TB : Tracebacks_Array (1 .. 10);
-- We are asking for a maximum of 10 stack frames.
Len : Natural;
-- Len will receive the actual number of stack frames returned.
begin
Call_Chain (TB, Len);
Text_IO.Put ("In STB.P1 : ");
for K in 1 .. Len loop
Text_IO.Put (Debug_Utilities.Image (TB (K)));
Text_IO.Put (' ');
end loop;
Text_IO.New_Line;
end P1;
procedure P2 is
begin
P1;
end P2;
begin
P2;
end STB;
</pre>
<pre class="smallexample"> $ gnatmake -g stb
$ stb
In STB.P1 : 16#0040_F1E4# 16#0040_14F2# 16#0040_170B# 16#0040_171C#
16#0040_1461# 16#0040_11C4# 16#0040_11F1# 16#77E8_92A4#
</pre>
<p class="noindent">You can then get further information by invoking the <code>addr2line</code>
tool as described earlier (note that the hexadecimal addresses
need to be specified in C format, with a leading “0x”).
<div class="node">
<a name="Symbolic-Traceback"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Non_002dSymbolic-Traceback">Non-Symbolic Traceback</a>,
Up: <a rel="up" accesskey="u" href="#Stack-Traceback">Stack Traceback</a>
</div>
<h4 class="subsection">29.14.2 Symbolic Traceback</h4>
<p><a name="index-traceback_002c-symbolic-971"></a>
A symbolic traceback is a stack traceback in which procedure names are
associated with each code location.
<p class="noindent">Note that this feature is not supported on all platforms. See
<samp><span class="file">GNAT.Traceback.Symbolic spec in g-trasym.ads</span></samp> for a complete
list of currently supported platforms.
<p class="noindent">Note that the symbolic traceback requires that the program be compiled
with debug information. If it is not compiled with debug information
only the non-symbolic information will be valid.
<ul class="menu">
<li><a accesskey="1" href="#Tracebacks-From-Exception-Occurrences-_0028symbolic_0029">Tracebacks From Exception Occurrences (symbolic)</a>
<li><a accesskey="2" href="#Tracebacks-From-Anywhere-in-a-Program-_0028symbolic_0029">Tracebacks From Anywhere in a Program (symbolic)</a>
</ul>
<div class="node">
<a name="Tracebacks-From-Exception-Occurrences-(symbolic)"></a>
<a name="Tracebacks-From-Exception-Occurrences-_0028symbolic_0029"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Tracebacks-From-Anywhere-in-a-Program-_0028symbolic_0029">Tracebacks From Anywhere in a Program (symbolic)</a>,
Up: <a rel="up" accesskey="u" href="#Symbolic-Traceback">Symbolic Traceback</a>
</div>
<h5 class="subsubsection">29.14.2.1 Tracebacks From Exception Occurrences</h5>
<pre class="smallexample"> with Ada.Text_IO;
with GNAT.Traceback.Symbolic;
procedure STB is
procedure P1 is
begin
raise Constraint_Error;
end P1;
procedure P2 is
begin
P1;
end P2;
procedure P3 is
begin
P2;
end P3;
begin
P3;
exception
when E : others =>
Ada.Text_IO.Put_Line (GNAT.Traceback.Symbolic.Symbolic_Traceback (E));
end STB;
</pre>
<pre class="smallexample"> $ gnatmake -g .\stb -bargs -E -largs -lgnat -laddr2line -lintl
$ stb
0040149F in stb.p1 at stb.adb:8
004014B7 in stb.p2 at stb.adb:13
004014CF in stb.p3 at stb.adb:18
004015DD in ada.stb at stb.adb:22
00401461 in main at b~stb.adb:168
004011C4 in __mingw_CRTStartup at crt1.c:200
004011F1 in mainCRTStartup at crt1.c:222
77E892A4 in ?? at ??:0
</pre>
<p class="noindent">In the above example the “.\” syntax in the <samp><span class="command">gnatmake</span></samp> command
is currently required by <samp><span class="command">addr2line</span></samp> for files that are in
the current working directory.
Moreover, the exact sequence of linker options may vary from platform
to platform.
The above <samp><span class="option">-largs</span></samp> section is for Windows platforms. By contrast,
under Unix there is no need for the <samp><span class="option">-largs</span></samp> section.
Differences across platforms are due to details of linker implementation.
<div class="node">
<a name="Tracebacks-From-Anywhere-in-a-Program-(symbolic)"></a>
<a name="Tracebacks-From-Anywhere-in-a-Program-_0028symbolic_0029"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Tracebacks-From-Exception-Occurrences-_0028symbolic_0029">Tracebacks From Exception Occurrences (symbolic)</a>,
Up: <a rel="up" accesskey="u" href="#Symbolic-Traceback">Symbolic Traceback</a>
</div>
<h5 class="subsubsection">29.14.2.2 Tracebacks From Anywhere in a Program</h5>
<p class="noindent">It is possible to get a symbolic stack traceback
from anywhere in a program, just as for non-symbolic tracebacks.
The first step is to obtain a non-symbolic
traceback, and then call <code>Symbolic_Traceback</code> to compute the symbolic
information. Here is an example:
<pre class="smallexample"> with Ada.Text_IO;
with GNAT.Traceback;
with GNAT.Traceback.Symbolic;
procedure STB is
use Ada;
use GNAT.Traceback;
use GNAT.Traceback.Symbolic;
procedure P1 is
TB : Tracebacks_Array (1 .. 10);
-- We are asking for a maximum of 10 stack frames.
Len : Natural;
-- Len will receive the actual number of stack frames returned.
begin
Call_Chain (TB, Len);
Text_IO.Put_Line (Symbolic_Traceback (TB (1 .. Len)));
end P1;
procedure P2 is
begin
P1;
end P2;
begin
P2;
end STB;
</pre>
<!-- ****************************** -->
<!-- ************************************** -->
<div class="node">
<a name="Platform-Specific-Information-for-the-Run-Time-Libraries"></a>
<a name="Platform_002dSpecific-Information-for-the-Run_002dTime-Libraries"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Example-of-Binder-Output-File">Example of Binder Output File</a>,
Previous: <a rel="previous" accesskey="p" href="#Code-Coverage-and-Profiling">Code Coverage and Profiling</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="appendix">Appendix A Platform-Specific Information for the Run-Time Libraries</h2>
<p><a name="index-Tasking-and-threads-libraries-972"></a><a name="index-Threads-libraries-and-tasking-973"></a><a name="index-Run_002dtime-libraries-_0028platform_002dspecific-information_0029-974"></a>
The GNAT run-time implementation may vary with respect to both the
underlying threads library and the exception handling scheme.
For threads support, one or more of the following are supplied:
<ul>
<li><b>native threads library</b>, a binding to the thread package from
the underlying operating system
<li><b>pthreads library</b> (Sparc Solaris only), a binding to the Solaris
POSIX thread package
</ul>
<p class="noindent">For exception handling, either or both of two models are supplied:
<ul>
<li><b>Zero-Cost Exceptions</b> (“ZCX”),<a rel="footnote" href="#fn-1" name="fnd-1"><sup>1</sup></a>
<a name="index-Zero_002dCost-Exceptions-975"></a><a name="index-ZCX-_0028Zero_002dCost-Exceptions_0029-976"></a>which uses binder-generated tables that
are interrogated at run time to locate a handler
<li><b>setjmp / longjmp</b> (“SJLJ”),
<a name="index-setjmp_002flongjmp-Exception-Model-977"></a><a name="index-SJLJ-_0028setjmp_002flongjmp-Exception-Model_0029-978"></a>which uses dynamically-set data to establish
the set of handlers
</ul>
<p class="noindent">This appendix summarizes which combinations of threads and exception support
are supplied on various GNAT platforms.
It then shows how to select a particular library either
permanently or temporarily,
explains the properties of (and tradeoffs among) the various threads
libraries, and provides some additional
information about several specific platforms.
<ul class="menu">
<li><a accesskey="1" href="#Summary-of-Run_002dTime-Configurations">Summary of Run-Time Configurations</a>
<li><a accesskey="2" href="#Specifying-a-Run_002dTime-Library">Specifying a Run-Time Library</a>
<li><a accesskey="3" href="#Choosing-the-Scheduling-Policy">Choosing the Scheduling Policy</a>
<li><a accesskey="4" href="#Solaris_002dSpecific-Considerations">Solaris-Specific Considerations</a>
<li><a accesskey="5" href="#Linux_002dSpecific-Considerations">Linux-Specific Considerations</a>
<li><a accesskey="6" href="#AIX_002dSpecific-Considerations">AIX-Specific Considerations</a>
<li><a accesskey="7" href="#Irix_002dSpecific-Considerations">Irix-Specific Considerations</a>
<li><a accesskey="8" href="#RTX_002dSpecific-Considerations">RTX-Specific Considerations</a>
<li><a accesskey="9" href="#HP_002dUX_002dSpecific-Considerations">HP-UX-Specific Considerations</a>
</ul>
<div class="node">
<a name="Summary-of-Run-Time-Configurations"></a>
<a name="Summary-of-Run_002dTime-Configurations"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Specifying-a-Run_002dTime-Library">Specifying a Run-Time Library</a>,
Up: <a rel="up" accesskey="u" href="#Platform_002dSpecific-Information-for-the-Run_002dTime-Libraries">Platform-Specific Information for the Run-Time Libraries</a>
</div>
<h3 class="section">A.1 Summary of Run-Time Configurations</h3>
<p><table summary=""><tr align="left"><td valign="top" width="30%"><b>alpha-openvms</b>
<br></td></tr><tr align="left"><td valign="top" width="30%"> <i>rts-native (default)</i>
<br></td></tr><tr align="left"><td valign="top" width="30%"> Tasking </td><td valign="top" width="70%">native VMS threads
<br></td></tr><tr align="left"><td valign="top" width="30%"> Exceptions </td><td valign="top" width="70%">ZCX
<br>
<br></td></tr><tr align="left"><td valign="top" width="30%"><b>alpha-tru64</b>
<br></td></tr><tr align="left"><td valign="top" width="30%"> <i>rts-native (default)</i>
<br></td></tr><tr align="left"><td valign="top" width="30%"> Tasking </td><td valign="top" width="70%">native TRU64 threads
<br></td></tr><tr align="left"><td valign="top" width="30%"> Exceptions </td><td valign="top" width="70%">ZCX
<br>
<br></td></tr><tr align="left"><td valign="top" width="30%"> <i>rts-sjlj</i>
<br></td></tr><tr align="left"><td valign="top" width="30%"> Tasking </td><td valign="top" width="70%">native TRU64 threads
<br></td></tr><tr align="left"><td valign="top" width="30%"> Exceptions </td><td valign="top" width="70%">SJLJ
<br>
<br></td></tr><tr align="left"><td valign="top" width="30%"><b>ia64-hp_linux</b>
<br></td></tr><tr align="left"><td valign="top" width="30%"> <i>rts-native (default)</i>
<br></td></tr><tr align="left"><td valign="top" width="30%"> Tasking </td><td valign="top" width="70%">pthread library
<br></td></tr><tr align="left"><td valign="top" width="30%"> Exceptions </td><td valign="top" width="70%">ZCX
<br>
<br></td></tr><tr align="left"><td valign="top" width="30%"><b>ia64-hpux</b>
<br></td></tr><tr align="left"><td valign="top" width="30%"> <i>rts-native (default)</i>
<br></td></tr><tr align="left"><td valign="top" width="30%"> Tasking </td><td valign="top" width="70%">native HP-UX threads
<br></td></tr><tr align="left"><td valign="top" width="30%"> Exceptions </td><td valign="top" width="70%">SJLJ
<br>
<br></td></tr><tr align="left"><td valign="top" width="30%"><b>ia64-openvms</b>
<br></td></tr><tr align="left"><td valign="top" width="30%"> <i>rts-native (default)</i>
<br></td></tr><tr align="left"><td valign="top" width="30%"> Tasking </td><td valign="top" width="70%">native VMS threads
<br></td></tr><tr align="left"><td valign="top" width="30%"> Exceptions </td><td valign="top" width="70%">ZCX
<br>
<br></td></tr><tr align="left"><td valign="top" width="30%"><b>ia64-sgi_linux</b>
<br></td></tr><tr align="left"><td valign="top" width="30%"> <i>rts-native (default)</i>
<br></td></tr><tr align="left"><td valign="top" width="30%"> Tasking </td><td valign="top" width="70%">pthread library
<br></td></tr><tr align="left"><td valign="top" width="30%"> Exceptions </td><td valign="top" width="70%">ZCX
<br>
<br></td></tr><tr align="left"><td valign="top" width="30%"><b>mips-irix</b>
<br></td></tr><tr align="left"><td valign="top" width="30%"> <i>rts-native (default)</i>
<br></td></tr><tr align="left"><td valign="top" width="30%"> Tasking </td><td valign="top" width="70%">native IRIX threads
<br></td></tr><tr align="left"><td valign="top" width="30%"> Exceptions </td><td valign="top" width="70%">ZCX
<br>
<br></td></tr><tr align="left"><td valign="top" width="30%"><b>pa-hpux</b>
<br></td></tr><tr align="left"><td valign="top" width="30%"> <i>rts-native (default)</i>
<br></td></tr><tr align="left"><td valign="top" width="30%"> Tasking </td><td valign="top" width="70%">native HP-UX threads
<br></td></tr><tr align="left"><td valign="top" width="30%"> Exceptions </td><td valign="top" width="70%">ZCX
<br>
<br></td></tr><tr align="left"><td valign="top" width="30%"> <i>rts-sjlj</i>
<br></td></tr><tr align="left"><td valign="top" width="30%"> Tasking </td><td valign="top" width="70%">native HP-UX threads
<br></td></tr><tr align="left"><td valign="top" width="30%"> Exceptions </td><td valign="top" width="70%">SJLJ
<br>
<br></td></tr><tr align="left"><td valign="top" width="30%"><b>ppc-aix</b>
<br></td></tr><tr align="left"><td valign="top" width="30%"> <i>rts-native (default)</i>
<br></td></tr><tr align="left"><td valign="top" width="30%"> Tasking </td><td valign="top" width="70%">native AIX threads
<br></td></tr><tr align="left"><td valign="top" width="30%"> Exceptions </td><td valign="top" width="70%">SJLJ
<br>
<br></td></tr><tr align="left"><td valign="top" width="30%"><b>ppc-darwin</b>
<br></td></tr><tr align="left"><td valign="top" width="30%"> <i>rts-native (default)</i>
<br></td></tr><tr align="left"><td valign="top" width="30%"> Tasking </td><td valign="top" width="70%">native MacOS threads
<br></td></tr><tr align="left"><td valign="top" width="30%"> Exceptions </td><td valign="top" width="70%">ZCX
<br>
<br></td></tr><tr align="left"><td valign="top" width="30%"><b>sparc-solaris</b> </td><td valign="top" width="70%">
<br></td></tr><tr align="left"><td valign="top" width="30%"> <i>rts-native (default)</i>
<br></td></tr><tr align="left"><td valign="top" width="30%"> Tasking </td><td valign="top" width="70%">native Solaris threads library
<br></td></tr><tr align="left"><td valign="top" width="30%"> Exceptions </td><td valign="top" width="70%">ZCX
<br>
<br></td></tr><tr align="left"><td valign="top" width="30%"> <i>rts-pthread</i>
<br></td></tr><tr align="left"><td valign="top" width="30%"> Tasking </td><td valign="top" width="70%">pthread library
<br></td></tr><tr align="left"><td valign="top" width="30%"> Exceptions </td><td valign="top" width="70%">ZCX
<br>
<br></td></tr><tr align="left"><td valign="top" width="30%"> <i>rts-sjlj</i>
<br></td></tr><tr align="left"><td valign="top" width="30%"> Tasking </td><td valign="top" width="70%">native Solaris threads library
<br></td></tr><tr align="left"><td valign="top" width="30%"> Exceptions </td><td valign="top" width="70%">SJLJ
<br>
<br></td></tr><tr align="left"><td valign="top" width="30%"><b>sparc64-solaris</b> </td><td valign="top" width="70%">
<br></td></tr><tr align="left"><td valign="top" width="30%"> <i>rts-native (default)</i>
<br></td></tr><tr align="left"><td valign="top" width="30%"> Tasking </td><td valign="top" width="70%">native Solaris threads library
<br></td></tr><tr align="left"><td valign="top" width="30%"> Exceptions </td><td valign="top" width="70%">ZCX
<br>
<br></td></tr><tr align="left"><td valign="top" width="30%"><b>x86-linux</b>
<br></td></tr><tr align="left"><td valign="top" width="30%"> <i>rts-native (default)</i>
<br></td></tr><tr align="left"><td valign="top" width="30%"> Tasking </td><td valign="top" width="70%">pthread library
<br></td></tr><tr align="left"><td valign="top" width="30%"> Exceptions </td><td valign="top" width="70%">ZCX
<br>
<br></td></tr><tr align="left"><td valign="top" width="30%"> <i>rts-sjlj</i>
<br></td></tr><tr align="left"><td valign="top" width="30%"> Tasking </td><td valign="top" width="70%">pthread library
<br></td></tr><tr align="left"><td valign="top" width="30%"> Exceptions </td><td valign="top" width="70%">SJLJ
<br>
<br></td></tr><tr align="left"><td valign="top" width="30%"><b>x86-lynx</b>
<br></td></tr><tr align="left"><td valign="top" width="30%"> <i>rts-native (default)</i>
<br></td></tr><tr align="left"><td valign="top" width="30%"> Tasking </td><td valign="top" width="70%">native LynxOS threads
<br></td></tr><tr align="left"><td valign="top" width="30%"> Exceptions </td><td valign="top" width="70%">SJLJ
<br>
<br></td></tr><tr align="left"><td valign="top" width="30%"><b>x86-solaris</b>
<br></td></tr><tr align="left"><td valign="top" width="30%"> <i>rts-native (default)</i>
<br></td></tr><tr align="left"><td valign="top" width="30%"> Tasking </td><td valign="top" width="70%">native Solaris threads
<br></td></tr><tr align="left"><td valign="top" width="30%"> Exceptions </td><td valign="top" width="70%">SJLJ
<br>
<br></td></tr><tr align="left"><td valign="top" width="30%"><b>x86-windows</b>
<br></td></tr><tr align="left"><td valign="top" width="30%"> <i>rts-native (default)</i>
<br></td></tr><tr align="left"><td valign="top" width="30%"> Tasking </td><td valign="top" width="70%">native Win32 threads
<br></td></tr><tr align="left"><td valign="top" width="30%"> Exceptions </td><td valign="top" width="70%">ZCX
<br>
<br></td></tr><tr align="left"><td valign="top" width="30%"> <i>rts-sjlj (default)</i>
<br></td></tr><tr align="left"><td valign="top" width="30%"> Tasking </td><td valign="top" width="70%">native Win32 threads
<br></td></tr><tr align="left"><td valign="top" width="30%"> Exceptions </td><td valign="top" width="70%">SJLJ
<br>
<br></td></tr><tr align="left"><td valign="top" width="30%"><b>x86-windows-rtx</b>
<br></td></tr><tr align="left"><td valign="top" width="30%"> <i>rts-rtx-rtss (default)</i>
<br></td></tr><tr align="left"><td valign="top" width="30%"> Tasking </td><td valign="top" width="70%">RTX real-time subsystem RTSS threads (kernel mode)
<br></td></tr><tr align="left"><td valign="top" width="30%"> Exceptions </td><td valign="top" width="70%">SJLJ
<br>
<br></td></tr><tr align="left"><td valign="top" width="30%"> <i>rts-rtx-w32</i>
<br></td></tr><tr align="left"><td valign="top" width="30%"> Tasking </td><td valign="top" width="70%">RTX Win32 threads (user mode)
<br></td></tr><tr align="left"><td valign="top" width="30%"> Exceptions </td><td valign="top" width="70%">ZCX
<br>
<br></td></tr><tr align="left"><td valign="top" width="30%"><b>x86_64-linux</b>
<br></td></tr><tr align="left"><td valign="top" width="30%"> <i>rts-native (default)</i>
<br></td></tr><tr align="left"><td valign="top" width="30%"> Tasking </td><td valign="top" width="70%">pthread library
<br></td></tr><tr align="left"><td valign="top" width="30%"> Exceptions </td><td valign="top" width="70%">ZCX
<br>
<br></td></tr><tr align="left"><td valign="top" width="30%"> <i>rts-sjlj</i>
<br></td></tr><tr align="left"><td valign="top" width="30%"> Tasking </td><td valign="top" width="70%">pthread library
<br></td></tr><tr align="left"><td valign="top" width="30%"> Exceptions </td><td valign="top" width="70%">SJLJ
<br>
<br></td></tr></table>
<div class="node">
<a name="Specifying-a-Run-Time-Library"></a>
<a name="Specifying-a-Run_002dTime-Library"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Choosing-the-Scheduling-Policy">Choosing the Scheduling Policy</a>,
Previous: <a rel="previous" accesskey="p" href="#Summary-of-Run_002dTime-Configurations">Summary of Run-Time Configurations</a>,
Up: <a rel="up" accesskey="u" href="#Platform_002dSpecific-Information-for-the-Run_002dTime-Libraries">Platform-Specific Information for the Run-Time Libraries</a>
</div>
<h3 class="section">A.2 Specifying a Run-Time Library</h3>
<p class="noindent">The <samp><span class="file">adainclude</span></samp> subdirectory containing the sources of the GNAT
run-time library, and the <samp><span class="file">adalib</span></samp> subdirectory containing the
<samp><span class="file">ALI</span></samp> files and the static and/or shared GNAT library, are located
in the gcc target-dependent area:
<pre class="smallexample"> target=$prefix/lib/gcc/gcc-<i>dumpmachine</i>/gcc-<i>dumpversion</i>/
</pre>
<p class="noindent">As indicated above, on some platforms several run-time libraries are supplied.
These libraries are installed in the target dependent area and
contain a complete source and binary subdirectory. The detailed description
below explains the differences between the different libraries in terms of
their thread support.
<p>The default run-time library (when GNAT is installed) is <em>rts-native</em>.
This default run time is selected by the means of soft links.
For example on x86-linux:
<pre class="smallexample"> $(target-dir)
|
+--- adainclude----------+
| |
+--- adalib-----------+ |
| | |
+--- rts-native | |
| | | |
| +--- adainclude <---+
| | |
| +--- adalib <----+
|
+--- rts-sjlj
|
+--- adainclude
|
+--- adalib
</pre>
<p class="noindent">If the <i>rts-sjlj</i> library is to be selected on a permanent basis,
these soft links can be modified with the following commands:
<pre class="smallexample"> $ cd $target
$ rm -f adainclude adalib
$ ln -s rts-sjlj/adainclude adainclude
$ ln -s rts-sjlj/adalib adalib
</pre>
<p class="noindent">Alternatively, you can specify <samp><span class="file">rts-sjlj/adainclude</span></samp> in the file
<samp><span class="file">$target/ada_source_path</span></samp> and <samp><span class="file">rts-sjlj/adalib</span></samp> in
<samp><span class="file">$target/ada_object_path</span></samp>.
<p>Selecting another run-time library temporarily can be
achieved by using the <samp><span class="option">--RTS</span></samp> switch, e.g., <samp><span class="option">--RTS=sjlj</span></samp>
<a name="index-g_t_0040option_007b_002d_002dRTS_007d-option-979"></a>
<div class="node">
<a name="Choosing-the-Scheduling-Policy"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Solaris_002dSpecific-Considerations">Solaris-Specific Considerations</a>,
Previous: <a rel="previous" accesskey="p" href="#Specifying-a-Run_002dTime-Library">Specifying a Run-Time Library</a>,
Up: <a rel="up" accesskey="u" href="#Platform_002dSpecific-Information-for-the-Run_002dTime-Libraries">Platform-Specific Information for the Run-Time Libraries</a>
</div>
<h3 class="section">A.3 Choosing the Scheduling Policy</h3>
<p class="noindent">When using a POSIX threads implementation, you have a choice of several
scheduling policies: <code>SCHED_FIFO</code>,
<a name="index-g_t_0040code_007bSCHED_005fFIFO_007d-scheduling-policy-980"></a><code>SCHED_RR</code>
<a name="index-g_t_0040code_007bSCHED_005fRR_007d-scheduling-policy-981"></a>and <code>SCHED_OTHER</code>.
<a name="index-g_t_0040code_007bSCHED_005fOTHER_007d-scheduling-policy-982"></a>Typically, the default is <code>SCHED_OTHER</code>, while using <code>SCHED_FIFO</code>
or <code>SCHED_RR</code> requires special (e.g., root) privileges.
<p>By default, GNAT uses the <code>SCHED_OTHER</code> policy. To specify
<code>SCHED_FIFO</code>,
<a name="index-g_t_0040code_007bSCHED_005fFIFO_007d-scheduling-policy-983"></a>you can use one of the following:
<ul>
<li><code>pragma Time_Slice (0.0)</code>
<a name="index-pragma-Time_005fSlice-984"></a><li>the corresponding binder option <samp><span class="option">-T0</span></samp>
<a name="index-g_t_0040option_007b_002dT0_007d-option-985"></a><li><code>pragma Task_Dispatching_Policy (FIFO_Within_Priorities)</code>
<a name="index-pragma-Task_005fDispatching_005fPolicy-986"></a></ul>
<p class="noindent">To specify <code>SCHED_RR</code>,
<a name="index-g_t_0040code_007bSCHED_005fRR_007d-scheduling-policy-987"></a>you should use <code>pragma Time_Slice</code> with a
value greater than <code>0.0</code>, or else use the corresponding <samp><span class="option">-T</span></samp>
binder option.
<div class="node">
<a name="Solaris-Specific-Considerations"></a>
<a name="Solaris_002dSpecific-Considerations"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Linux_002dSpecific-Considerations">Linux-Specific Considerations</a>,
Previous: <a rel="previous" accesskey="p" href="#Choosing-the-Scheduling-Policy">Choosing the Scheduling Policy</a>,
Up: <a rel="up" accesskey="u" href="#Platform_002dSpecific-Information-for-the-Run_002dTime-Libraries">Platform-Specific Information for the Run-Time Libraries</a>
</div>
<h3 class="section">A.4 Solaris-Specific Considerations</h3>
<p><a name="index-Solaris-Sparc-threads-libraries-988"></a>
This section addresses some topics related to the various threads libraries
on Sparc Solaris.
<ul class="menu">
<li><a accesskey="1" href="#Solaris-Threads-Issues">Solaris Threads Issues</a>
</ul>
<div class="node">
<a name="Solaris-Threads-Issues"></a>
<p><hr>
Up: <a rel="up" accesskey="u" href="#Solaris_002dSpecific-Considerations">Solaris-Specific Considerations</a>
</div>
<h4 class="subsection">A.4.1 Solaris Threads Issues</h4>
<p class="noindent">GNAT under Solaris/Sparc 32 bits comes with an alternate tasking run-time
library based on POSIX threads — <em>rts-pthread</em>.
<a name="index-rts_002dpthread-threads-library-989"></a>This run-time library has the advantage of being mostly shared across all
POSIX-compliant thread implementations, and it also provides under
Solaris 8<!-- /@w --> the <code>PTHREAD_PRIO_INHERIT</code>
<a name="index-g_t_0040code_007bPTHREAD_005fPRIO_005fINHERIT_007d-policy-_0028under-rts_002dpthread_0029-990"></a>and <code>PTHREAD_PRIO_PROTECT</code>
<a name="index-g_t_0040code_007bPTHREAD_005fPRIO_005fPROTECT_007d-policy-_0028under-rts_002dpthread_0029-991"></a>semantics that can be selected using the predefined pragma
<code>Locking_Policy</code>
<a name="index-pragma-Locking_005fPolicy-_0028under-rts_002dpthread_0029-992"></a>with respectively
<code>Inheritance_Locking</code> and <code>Ceiling_Locking</code> as the policy.
<a name="index-g_t_0040code_007bInheritance_005fLocking_007d-_0028under-rts_002dpthread_0029-993"></a><a name="index-g_t_0040code_007bCeiling_005fLocking_007d-_0028under-rts_002dpthread_0029-994"></a>
As explained above, the native run-time library is based on the Solaris thread
library (<code>libthread</code>) and is the default library.
<p>When the Solaris threads library is used (this is the default), programs
compiled with GNAT can automatically take advantage of
and can thus execute on multiple processors.
The user can alternatively specify a processor on which the program should run
to emulate a single-processor system. The multiprocessor / uniprocessor choice
is made by
setting the environment variable <samp><span class="env">GNAT_PROCESSOR</span></samp>
<a name="index-g_t_0040env_007bGNAT_005fPROCESSOR_007d-environment-variable-_0028on-Sparc-Solaris_0029-995"></a>to one of the following:
<dl>
<dt><code>-2</code><dd>Use the default configuration (run the program on all
available processors) - this is the same as having <code>GNAT_PROCESSOR</code>
unset
<br><dt><code>-1</code><dd>Let the run-time implementation choose one processor and run the program on
that processor
<br><dt><code>0 .. Last_Proc</code><dd>Run the program on the specified processor.
<code>Last_Proc</code> is equal to <code>_SC_NPROCESSORS_CONF - 1</code>
(where <code>_SC_NPROCESSORS_CONF</code> is a system variable).
</dl>
<div class="node">
<a name="Linux-Specific-Considerations"></a>
<a name="Linux_002dSpecific-Considerations"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#AIX_002dSpecific-Considerations">AIX-Specific Considerations</a>,
Previous: <a rel="previous" accesskey="p" href="#Solaris_002dSpecific-Considerations">Solaris-Specific Considerations</a>,
Up: <a rel="up" accesskey="u" href="#Platform_002dSpecific-Information-for-the-Run_002dTime-Libraries">Platform-Specific Information for the Run-Time Libraries</a>
</div>
<h3 class="section">A.5 Linux-Specific Considerations</h3>
<p><a name="index-Linux-threads-libraries-996"></a>
On GNU/Linux without NPTL support (usually system with GNU C Library
older than 2.3), the signal model is not POSIX compliant, which means
that to send a signal to the process, you need to send the signal to all
threads, e.g. by using <code>killpg()</code>.
<div class="node">
<a name="AIX-Specific-Considerations"></a>
<a name="AIX_002dSpecific-Considerations"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Irix_002dSpecific-Considerations">Irix-Specific Considerations</a>,
Previous: <a rel="previous" accesskey="p" href="#Linux_002dSpecific-Considerations">Linux-Specific Considerations</a>,
Up: <a rel="up" accesskey="u" href="#Platform_002dSpecific-Information-for-the-Run_002dTime-Libraries">Platform-Specific Information for the Run-Time Libraries</a>
</div>
<h3 class="section">A.6 AIX-Specific Considerations</h3>
<p><a name="index-AIX-resolver-library-997"></a>
On AIX, the resolver library initializes some internal structure on
the first call to <code>get*by*</code> functions, which are used to implement
<code>GNAT.Sockets.Get_Host_By_Name</code> and
<code>GNAT.Sockets.Get_Host_By_Address</code>.
If such initialization occurs within an Ada task, and the stack size for
the task is the default size, a stack overflow may occur.
<p>To avoid this overflow, the user should either ensure that the first call
to <code>GNAT.Sockets.Get_Host_By_Name</code> or
<code>GNAT.Sockets.Get_Host_By_Addrss</code>
occurs in the environment task, or use <code>pragma Storage_Size</code> to
specify a sufficiently large size for the stack of the task that contains
this call.
<div class="node">
<a name="Irix-Specific-Considerations"></a>
<a name="Irix_002dSpecific-Considerations"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#RTX_002dSpecific-Considerations">RTX-Specific Considerations</a>,
Previous: <a rel="previous" accesskey="p" href="#AIX_002dSpecific-Considerations">AIX-Specific Considerations</a>,
Up: <a rel="up" accesskey="u" href="#Platform_002dSpecific-Information-for-the-Run_002dTime-Libraries">Platform-Specific Information for the Run-Time Libraries</a>
</div>
<h3 class="section">A.7 Irix-Specific Considerations</h3>
<p><a name="index-Irix-libraries-998"></a>
The GCC support libraries coming with the Irix compiler have moved to
their canonical place with respect to the general Irix ABI related
conventions. Running applications built with the default shared GNAT
run-time now requires the LD_LIBRARY_PATH environment variable to
include this location. A possible way to achieve this is to issue the
following command line on a bash prompt:
<pre class="smallexample"> $ LD_LIBRARY_PATH=$LD_LIBRARY_PATH:`dirname \`gcc --print-file-name=libgcc_s.so\``
</pre>
<div class="node">
<a name="RTX-Specific-Considerations"></a>
<a name="RTX_002dSpecific-Considerations"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#HP_002dUX_002dSpecific-Considerations">HP-UX-Specific Considerations</a>,
Previous: <a rel="previous" accesskey="p" href="#Irix_002dSpecific-Considerations">Irix-Specific Considerations</a>,
Up: <a rel="up" accesskey="u" href="#Platform_002dSpecific-Information-for-the-Run_002dTime-Libraries">Platform-Specific Information for the Run-Time Libraries</a>
</div>
<h3 class="section">A.8 RTX-Specific Considerations</h3>
<p><a name="index-RTX-libraries-999"></a>
The Real-time Extension (RTX) to Windows is based on the Windows Win32
API. Applications can be built to work in two different modes:
<ul>
<li>Windows executables that run in Ring 3 to utilize memory protection
(<em>rts-rtx-w32</em>).
<li>Real-time subsystem (RTSS) executables that run in Ring 0, where
performance can be optimized with RTSS applications taking precedent
over all Windows applications (<em>rts-rtx-rtss</em>). This mode requires
the Microsoft linker to handle RTSS libraries.
</ul>
<div class="node">
<a name="HP-UX-Specific-Considerations"></a>
<a name="HP_002dUX_002dSpecific-Considerations"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#RTX_002dSpecific-Considerations">RTX-Specific Considerations</a>,
Up: <a rel="up" accesskey="u" href="#Platform_002dSpecific-Information-for-the-Run_002dTime-Libraries">Platform-Specific Information for the Run-Time Libraries</a>
</div>
<h3 class="section">A.9 HP-UX-Specific Considerations</h3>
<p><a name="index-HP_002dUX-Scheduling-1000"></a>
On HP-UX, appropriate privileges are required to change the scheduling
parameters of a task. The calling process must have appropriate
privileges or be a member of a group having <code>PRIV_RTSCHED</code> access to
successfully change the scheduling parameters.
<p>By default, GNAT uses the <code>SCHED_HPUX</code> policy. To have access to the
priority range 0-31 either the <code>FIFO_Within_Priorities</code> or the
<code>Round_Robin_Within_Priorities</code> scheduling policies need to be set.
<p>To specify the <code>FIFO_Within_Priorities</code> scheduling policy you can use
one of the following:
<ul>
<li><code>pragma Time_Slice (0.0)</code>
<a name="index-pragma-Time_005fSlice-1001"></a><li>the corresponding binder option <samp><span class="option">-T0</span></samp>
<a name="index-g_t_0040option_007b_002dT0_007d-option-1002"></a><li><code>pragma Task_Dispatching_Policy (FIFO_Within_Priorities)</code>
<a name="index-pragma-Task_005fDispatching_005fPolicy-1003"></a></ul>
<p class="noindent">To specify the <code>Round_Robin_Within_Priorities</code>, scheduling policy
you should use <code>pragma Time_Slice</code> with a
value greater than <code>0.0</code>, or use the corresponding <samp><span class="option">-T</span></samp>
binder option, or set the <code>pragma Task_Dispatching_Policy
(Round_Robin_Within_Priorities)</code>.
<!-- ******************************* -->
<div class="node">
<a name="Example-of-Binder-Output-File"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Elaboration-Order-Handling-in-GNAT">Elaboration Order Handling in GNAT</a>,
Previous: <a rel="previous" accesskey="p" href="#Platform_002dSpecific-Information-for-the-Run_002dTime-Libraries">Platform-Specific Information for the Run-Time Libraries</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="appendix">Appendix B Example of Binder Output File</h2>
<p class="noindent">This Appendix displays the source code for <samp><span class="command">gnatbind</span></samp>'s output
file generated for a simple “Hello World” program.
Comments have been added for clarification purposes.
<pre class="smallexample"> -- The package is called Ada_Main unless this name is actually used
-- as a unit name in the partition, in which case some other unique
-- name is used.
with System;
package ada_main is
Elab_Final_Code : Integer;
pragma Import (C, Elab_Final_Code, "__gnat_inside_elab_final_code");
-- The main program saves the parameters (argument count,
-- argument values, environment pointer) in global variables
-- for later access by other units including
-- Ada.Command_Line.
gnat_argc : Integer;
gnat_argv : System.Address;
gnat_envp : System.Address;
-- The actual variables are stored in a library routine. This
-- is useful for some shared library situations, where there
-- are problems if variables are not in the library.
pragma Import (C, gnat_argc);
pragma Import (C, gnat_argv);
pragma Import (C, gnat_envp);
-- The exit status is similarly an external location
gnat_exit_status : Integer;
pragma Import (C, gnat_exit_status);
GNAT_Version : constant String :=
"GNAT Version: 6.0.0w (20061115)";
pragma Export (C, GNAT_Version, "__gnat_version");
-- This is the generated adafinal routine that performs
-- finalization at the end of execution. In the case where
-- Ada is the main program, this main program makes a call
-- to adafinal at program termination.
procedure adafinal;
pragma Export (C, adafinal, "adafinal");
-- This is the generated adainit routine that performs
-- initialization at the start of execution. In the case
-- where Ada is the main program, this main program makes
-- a call to adainit at program startup.
procedure adainit;
pragma Export (C, adainit, "adainit");
-- This routine is called at the start of execution. It is
-- a dummy routine that is used by the debugger to breakpoint
-- at the start of execution.
procedure Break_Start;
pragma Import (C, Break_Start, "__gnat_break_start");
-- This is the actual generated main program (it would be
-- suppressed if the no main program switch were used). As
-- required by standard system conventions, this program has
-- the external name main.
function main
(argc : Integer;
argv : System.Address;
envp : System.Address)
return Integer;
pragma Export (C, main, "main");
-- The following set of constants give the version
-- identification values for every unit in the bound
-- partition. This identification is computed from all
-- dependent semantic units, and corresponds to the
-- string that would be returned by use of the
-- Body_Version or Version attributes.
type Version_32 is mod 2 ** 32;
u00001 : constant Version_32 := 16#7880BEB3#;
u00002 : constant Version_32 := 16#0D24CBD0#;
u00003 : constant Version_32 := 16#3283DBEB#;
u00004 : constant Version_32 := 16#2359F9ED#;
u00005 : constant Version_32 := 16#664FB847#;
u00006 : constant Version_32 := 16#68E803DF#;
u00007 : constant Version_32 := 16#5572E604#;
u00008 : constant Version_32 := 16#46B173D8#;
u00009 : constant Version_32 := 16#156A40CF#;
u00010 : constant Version_32 := 16#033DABE0#;
u00011 : constant Version_32 := 16#6AB38FEA#;
u00012 : constant Version_32 := 16#22B6217D#;
u00013 : constant Version_32 := 16#68A22947#;
u00014 : constant Version_32 := 16#18CC4A56#;
u00015 : constant Version_32 := 16#08258E1B#;
u00016 : constant Version_32 := 16#367D5222#;
u00017 : constant Version_32 := 16#20C9ECA4#;
u00018 : constant Version_32 := 16#50D32CB6#;
u00019 : constant Version_32 := 16#39A8BB77#;
u00020 : constant Version_32 := 16#5CF8FA2B#;
u00021 : constant Version_32 := 16#2F1EB794#;
u00022 : constant Version_32 := 16#31AB6444#;
u00023 : constant Version_32 := 16#1574B6E9#;
u00024 : constant Version_32 := 16#5109C189#;
u00025 : constant Version_32 := 16#56D770CD#;
u00026 : constant Version_32 := 16#02F9DE3D#;
u00027 : constant Version_32 := 16#08AB6B2C#;
u00028 : constant Version_32 := 16#3FA37670#;
u00029 : constant Version_32 := 16#476457A0#;
u00030 : constant Version_32 := 16#731E1B6E#;
u00031 : constant Version_32 := 16#23C2E789#;
u00032 : constant Version_32 := 16#0F1BD6A1#;
u00033 : constant Version_32 := 16#7C25DE96#;
u00034 : constant Version_32 := 16#39ADFFA2#;
u00035 : constant Version_32 := 16#571DE3E7#;
u00036 : constant Version_32 := 16#5EB646AB#;
u00037 : constant Version_32 := 16#4249379B#;
u00038 : constant Version_32 := 16#0357E00A#;
u00039 : constant Version_32 := 16#3784FB72#;
u00040 : constant Version_32 := 16#2E723019#;
u00041 : constant Version_32 := 16#623358EA#;
u00042 : constant Version_32 := 16#107F9465#;
u00043 : constant Version_32 := 16#6843F68A#;
u00044 : constant Version_32 := 16#63305874#;
u00045 : constant Version_32 := 16#31E56CE1#;
u00046 : constant Version_32 := 16#02917970#;
u00047 : constant Version_32 := 16#6CCBA70E#;
u00048 : constant Version_32 := 16#41CD4204#;
u00049 : constant Version_32 := 16#572E3F58#;
u00050 : constant Version_32 := 16#20729FF5#;
u00051 : constant Version_32 := 16#1D4F93E8#;
u00052 : constant Version_32 := 16#30B2EC3D#;
u00053 : constant Version_32 := 16#34054F96#;
u00054 : constant Version_32 := 16#5A199860#;
u00055 : constant Version_32 := 16#0E7F912B#;
u00056 : constant Version_32 := 16#5760634A#;
u00057 : constant Version_32 := 16#5D851835#;
-- The following Export pragmas export the version numbers
-- with symbolic names ending in B (for body) or S
-- (for spec) so that they can be located in a link. The
-- information provided here is sufficient to track down
-- the exact versions of units used in a given build.
pragma Export (C, u00001, "helloB");
pragma Export (C, u00002, "system__standard_libraryB");
pragma Export (C, u00003, "system__standard_libraryS");
pragma Export (C, u00004, "adaS");
pragma Export (C, u00005, "ada__text_ioB");
pragma Export (C, u00006, "ada__text_ioS");
pragma Export (C, u00007, "ada__exceptionsB");
pragma Export (C, u00008, "ada__exceptionsS");
pragma Export (C, u00009, "gnatS");
pragma Export (C, u00010, "gnat__heap_sort_aB");
pragma Export (C, u00011, "gnat__heap_sort_aS");
pragma Export (C, u00012, "systemS");
pragma Export (C, u00013, "system__exception_tableB");
pragma Export (C, u00014, "system__exception_tableS");
pragma Export (C, u00015, "gnat__htableB");
pragma Export (C, u00016, "gnat__htableS");
pragma Export (C, u00017, "system__exceptionsS");
pragma Export (C, u00018, "system__machine_state_operationsB");
pragma Export (C, u00019, "system__machine_state_operationsS");
pragma Export (C, u00020, "system__machine_codeS");
pragma Export (C, u00021, "system__storage_elementsB");
pragma Export (C, u00022, "system__storage_elementsS");
pragma Export (C, u00023, "system__secondary_stackB");
pragma Export (C, u00024, "system__secondary_stackS");
pragma Export (C, u00025, "system__parametersB");
pragma Export (C, u00026, "system__parametersS");
pragma Export (C, u00027, "system__soft_linksB");
pragma Export (C, u00028, "system__soft_linksS");
pragma Export (C, u00029, "system__stack_checkingB");
pragma Export (C, u00030, "system__stack_checkingS");
pragma Export (C, u00031, "system__tracebackB");
pragma Export (C, u00032, "system__tracebackS");
pragma Export (C, u00033, "ada__streamsS");
pragma Export (C, u00034, "ada__tagsB");
pragma Export (C, u00035, "ada__tagsS");
pragma Export (C, u00036, "system__string_opsB");
pragma Export (C, u00037, "system__string_opsS");
pragma Export (C, u00038, "interfacesS");
pragma Export (C, u00039, "interfaces__c_streamsB");
pragma Export (C, u00040, "interfaces__c_streamsS");
pragma Export (C, u00041, "system__file_ioB");
pragma Export (C, u00042, "system__file_ioS");
pragma Export (C, u00043, "ada__finalizationB");
pragma Export (C, u00044, "ada__finalizationS");
pragma Export (C, u00045, "system__finalization_rootB");
pragma Export (C, u00046, "system__finalization_rootS");
pragma Export (C, u00047, "system__finalization_implementationB");
pragma Export (C, u00048, "system__finalization_implementationS");
pragma Export (C, u00049, "system__string_ops_concat_3B");
pragma Export (C, u00050, "system__string_ops_concat_3S");
pragma Export (C, u00051, "system__stream_attributesB");
pragma Export (C, u00052, "system__stream_attributesS");
pragma Export (C, u00053, "ada__io_exceptionsS");
pragma Export (C, u00054, "system__unsigned_typesS");
pragma Export (C, u00055, "system__file_control_blockS");
pragma Export (C, u00056, "ada__finalization__list_controllerB");
pragma Export (C, u00057, "ada__finalization__list_controllerS");
-- BEGIN ELABORATION ORDER
-- ada (spec)
-- gnat (spec)
-- gnat.heap_sort_a (spec)
-- gnat.heap_sort_a (body)
-- gnat.htable (spec)
-- gnat.htable (body)
-- interfaces (spec)
-- system (spec)
-- system.machine_code (spec)
-- system.parameters (spec)
-- system.parameters (body)
-- interfaces.c_streams (spec)
-- interfaces.c_streams (body)
-- system.standard_library (spec)
-- ada.exceptions (spec)
-- system.exception_table (spec)
-- system.exception_table (body)
-- ada.io_exceptions (spec)
-- system.exceptions (spec)
-- system.storage_elements (spec)
-- system.storage_elements (body)
-- system.machine_state_operations (spec)
-- system.machine_state_operations (body)
-- system.secondary_stack (spec)
-- system.stack_checking (spec)
-- system.soft_links (spec)
-- system.soft_links (body)
-- system.stack_checking (body)
-- system.secondary_stack (body)
-- system.standard_library (body)
-- system.string_ops (spec)
-- system.string_ops (body)
-- ada.tags (spec)
-- ada.tags (body)
-- ada.streams (spec)
-- system.finalization_root (spec)
-- system.finalization_root (body)
-- system.string_ops_concat_3 (spec)
-- system.string_ops_concat_3 (body)
-- system.traceback (spec)
-- system.traceback (body)
-- ada.exceptions (body)
-- system.unsigned_types (spec)
-- system.stream_attributes (spec)
-- system.stream_attributes (body)
-- system.finalization_implementation (spec)
-- system.finalization_implementation (body)
-- ada.finalization (spec)
-- ada.finalization (body)
-- ada.finalization.list_controller (spec)
-- ada.finalization.list_controller (body)
-- system.file_control_block (spec)
-- system.file_io (spec)
-- system.file_io (body)
-- ada.text_io (spec)
-- ada.text_io (body)
-- hello (body)
-- END ELABORATION ORDER
end ada_main;
-- The following source file name pragmas allow the generated file
-- names to be unique for different main programs. They are needed
-- since the package name will always be Ada_Main.
pragma Source_File_Name (ada_main, Spec_File_Name => "b~hello.ads");
pragma Source_File_Name (ada_main, Body_File_Name => "b~hello.adb");
-- Generated package body for Ada_Main starts here
package body ada_main is
-- The actual finalization is performed by calling the
-- library routine in System.Standard_Library.Adafinal
procedure Do_Finalize;
pragma Import (C, Do_Finalize, "system__standard_library__adafinal");
-------------
-- adainit --
-------------
<a name="index-adainit-1004"></a> procedure adainit is
-- These booleans are set to True once the associated unit has
-- been elaborated. It is also used to avoid elaborating the
-- same unit twice.
E040 : Boolean;
pragma Import (Ada, E040, "interfaces__c_streams_E");
E008 : Boolean;
pragma Import (Ada, E008, "ada__exceptions_E");
E014 : Boolean;
pragma Import (Ada, E014, "system__exception_table_E");
E053 : Boolean;
pragma Import (Ada, E053, "ada__io_exceptions_E");
E017 : Boolean;
pragma Import (Ada, E017, "system__exceptions_E");
E024 : Boolean;
pragma Import (Ada, E024, "system__secondary_stack_E");
E030 : Boolean;
pragma Import (Ada, E030, "system__stack_checking_E");
E028 : Boolean;
pragma Import (Ada, E028, "system__soft_links_E");
E035 : Boolean;
pragma Import (Ada, E035, "ada__tags_E");
E033 : Boolean;
pragma Import (Ada, E033, "ada__streams_E");
E046 : Boolean;
pragma Import (Ada, E046, "system__finalization_root_E");
E048 : Boolean;
pragma Import (Ada, E048, "system__finalization_implementation_E");
E044 : Boolean;
pragma Import (Ada, E044, "ada__finalization_E");
E057 : Boolean;
pragma Import (Ada, E057, "ada__finalization__list_controller_E");
E055 : Boolean;
pragma Import (Ada, E055, "system__file_control_block_E");
E042 : Boolean;
pragma Import (Ada, E042, "system__file_io_E");
E006 : Boolean;
pragma Import (Ada, E006, "ada__text_io_E");
-- Set_Globals is a library routine that stores away the
-- value of the indicated set of global values in global
-- variables within the library.
procedure Set_Globals
(Main_Priority : Integer;
Time_Slice_Value : Integer;
WC_Encoding : Character;
Locking_Policy : Character;
Queuing_Policy : Character;
Task_Dispatching_Policy : Character;
Adafinal : System.Address;
Unreserve_All_Interrupts : Integer;
Exception_Tracebacks : Integer);
<a name="index-g_t_005f_005fgnat_005fset_005fglobals-1005"></a> pragma Import (C, Set_Globals, "__gnat_set_globals");
-- SDP_Table_Build is a library routine used to build the
-- exception tables. See unit Ada.Exceptions in files
-- a-except.ads/adb for full details of how zero cost
-- exception handling works. This procedure, the call to
-- it, and the two following tables are all omitted if the
-- build is in longjmp/setjmp exception mode.
<a name="index-SDP_005fTable_005fBuild-1006"></a><a name="index-Zero-Cost-Exceptions-1007"></a> procedure SDP_Table_Build
(SDP_Addresses : System.Address;
SDP_Count : Natural;
Elab_Addresses : System.Address;
Elab_Addr_Count : Natural);
pragma Import (C, SDP_Table_Build, "__gnat_SDP_Table_Build");
-- Table of Unit_Exception_Table addresses. Used for zero
-- cost exception handling to build the top level table.
ST : aliased constant array (1 .. 23) of System.Address := (
Hello'UET_Address,
Ada.Text_Io'UET_Address,
Ada.Exceptions'UET_Address,
Gnat.Heap_Sort_A'UET_Address,
System.Exception_Table'UET_Address,
System.Machine_State_Operations'UET_Address,
System.Secondary_Stack'UET_Address,
System.Parameters'UET_Address,
System.Soft_Links'UET_Address,
System.Stack_Checking'UET_Address,
System.Traceback'UET_Address,
Ada.Streams'UET_Address,
Ada.Tags'UET_Address,
System.String_Ops'UET_Address,
Interfaces.C_Streams'UET_Address,
System.File_Io'UET_Address,
Ada.Finalization'UET_Address,
System.Finalization_Root'UET_Address,
System.Finalization_Implementation'UET_Address,
System.String_Ops_Concat_3'UET_Address,
System.Stream_Attributes'UET_Address,
System.File_Control_Block'UET_Address,
Ada.Finalization.List_Controller'UET_Address);
-- Table of addresses of elaboration routines. Used for
-- zero cost exception handling to make sure these
-- addresses are included in the top level procedure
-- address table.
EA : aliased constant array (1 .. 23) of System.Address := (
adainit'Code_Address,
Do_Finalize'Code_Address,
Ada.Exceptions'Elab_Spec'Address,
System.Exceptions'Elab_Spec'Address,
Interfaces.C_Streams'Elab_Spec'Address,
System.Exception_Table'Elab_Body'Address,
Ada.Io_Exceptions'Elab_Spec'Address,
System.Stack_Checking'Elab_Spec'Address,
System.Soft_Links'Elab_Body'Address,
System.Secondary_Stack'Elab_Body'Address,
Ada.Tags'Elab_Spec'Address,
Ada.Tags'Elab_Body'Address,
Ada.Streams'Elab_Spec'Address,
System.Finalization_Root'Elab_Spec'Address,
Ada.Exceptions'Elab_Body'Address,
System.Finalization_Implementation'Elab_Spec'Address,
System.Finalization_Implementation'Elab_Body'Address,
Ada.Finalization'Elab_Spec'Address,
Ada.Finalization.List_Controller'Elab_Spec'Address,
System.File_Control_Block'Elab_Spec'Address,
System.File_Io'Elab_Body'Address,
Ada.Text_Io'Elab_Spec'Address,
Ada.Text_Io'Elab_Body'Address);
-- Start of processing for adainit
begin
-- Call SDP_Table_Build to build the top level procedure
-- table for zero cost exception handling (omitted in
-- longjmp/setjmp mode).
SDP_Table_Build (ST'Address, 23, EA'Address, 23);
-- Call Set_Globals to record various information for
-- this partition. The values are derived by the binder
-- from information stored in the ali files by the compiler.
<a name="index-g_t_005f_005fgnat_005fset_005fglobals-1008"></a> Set_Globals
(Main_Priority => -1,
-- Priority of main program, -1 if no pragma Priority used
Time_Slice_Value => -1,
-- Time slice from Time_Slice pragma, -1 if none used
WC_Encoding => 'b',
-- Wide_Character encoding used, default is brackets
Locking_Policy => ' ',
-- Locking_Policy used, default of space means not
-- specified, otherwise it is the first character of
-- the policy name.
Queuing_Policy => ' ',
-- Queuing_Policy used, default of space means not
-- specified, otherwise it is the first character of
-- the policy name.
Task_Dispatching_Policy => ' ',
-- Task_Dispatching_Policy used, default of space means
-- not specified, otherwise first character of the
-- policy name.
Adafinal => System.Null_Address,
-- Address of Adafinal routine, not used anymore
Unreserve_All_Interrupts => 0,
-- Set true if pragma Unreserve_All_Interrupts was used
Exception_Tracebacks => 0);
-- Indicates if exception tracebacks are enabled
Elab_Final_Code := 1;
-- Now we have the elaboration calls for all units in the partition.
-- The Elab_Spec and Elab_Body attributes generate references to the
-- implicit elaboration procedures generated by the compiler for
-- each unit that requires elaboration.
if not E040 then
Interfaces.C_Streams'Elab_Spec;
end if;
E040 := True;
if not E008 then
Ada.Exceptions'Elab_Spec;
end if;
if not E014 then
System.Exception_Table'Elab_Body;
E014 := True;
end if;
if not E053 then
Ada.Io_Exceptions'Elab_Spec;
E053 := True;
end if;
if not E017 then
System.Exceptions'Elab_Spec;
E017 := True;
end if;
if not E030 then
System.Stack_Checking'Elab_Spec;
end if;
if not E028 then
System.Soft_Links'Elab_Body;
E028 := True;
end if;
E030 := True;
if not E024 then
System.Secondary_Stack'Elab_Body;
E024 := True;
end if;
if not E035 then
Ada.Tags'Elab_Spec;
end if;
if not E035 then
Ada.Tags'Elab_Body;
E035 := True;
end if;
if not E033 then
Ada.Streams'Elab_Spec;
E033 := True;
end if;
if not E046 then
System.Finalization_Root'Elab_Spec;
end if;
E046 := True;
if not E008 then
Ada.Exceptions'Elab_Body;
E008 := True;
end if;
if not E048 then
System.Finalization_Implementation'Elab_Spec;
end if;
if not E048 then
System.Finalization_Implementation'Elab_Body;
E048 := True;
end if;
if not E044 then
Ada.Finalization'Elab_Spec;
end if;
E044 := True;
if not E057 then
Ada.Finalization.List_Controller'Elab_Spec;
end if;
E057 := True;
if not E055 then
System.File_Control_Block'Elab_Spec;
E055 := True;
end if;
if not E042 then
System.File_Io'Elab_Body;
E042 := True;
end if;
if not E006 then
Ada.Text_Io'Elab_Spec;
end if;
if not E006 then
Ada.Text_Io'Elab_Body;
E006 := True;
end if;
Elab_Final_Code := 0;
end adainit;
--------------
-- adafinal --
--------------
<a name="index-adafinal-1009"></a> procedure adafinal is
begin
Do_Finalize;
end adafinal;
----------
-- main --
----------
-- main is actually a function, as in the ANSI C standard,
-- defined to return the exit status. The three parameters
-- are the argument count, argument values and environment
-- pointer.
<a name="index-Main-Program-1010"></a> function main
(argc : Integer;
argv : System.Address;
envp : System.Address)
return Integer
is
-- The initialize routine performs low level system
-- initialization using a standard library routine which
-- sets up signal handling and performs any other
-- required setup. The routine can be found in file
-- a-init.c.
<a name="index-g_t_005f_005fgnat_005finitialize-1011"></a> procedure initialize;
pragma Import (C, initialize, "__gnat_initialize");
-- The finalize routine performs low level system
-- finalization using a standard library routine. The
-- routine is found in file a-final.c and in the standard
-- distribution is a dummy routine that does nothing, so
-- really this is a hook for special user finalization.
<a name="index-g_t_005f_005fgnat_005ffinalize-1012"></a> procedure finalize;
pragma Import (C, finalize, "__gnat_finalize");
-- We get to the main program of the partition by using
-- pragma Import because if we try to with the unit and
-- call it Ada style, then not only do we waste time
-- recompiling it, but also, we don't really know the right
-- switches (e.g. identifier character set) to be used
-- to compile it.
procedure Ada_Main_Program;
pragma Import (Ada, Ada_Main_Program, "_ada_hello");
-- Start of processing for main
begin
-- Save global variables
gnat_argc := argc;
gnat_argv := argv;
gnat_envp := envp;
-- Call low level system initialization
Initialize;
-- Call our generated Ada initialization routine
adainit;
-- This is the point at which we want the debugger to get
-- control
Break_Start;
-- Now we call the main program of the partition
Ada_Main_Program;
-- Perform Ada finalization
adafinal;
-- Perform low level system finalization
Finalize;
-- Return the proper exit status
return (gnat_exit_status);
end;
-- This section is entirely comments, so it has no effect on the
-- compilation of the Ada_Main package. It provides the list of
-- object files and linker options, as well as some standard
-- libraries needed for the link. The gnatlink utility parses
-- this b~hello.adb file to read these comment lines to generate
-- the appropriate command line arguments for the call to the
-- system linker. The BEGIN/END lines are used for sentinels for
-- this parsing operation.
-- The exact file names will of course depend on the environment,
-- host/target and location of files on the host system.
<a name="index-Object-file-list-1013"></a>-- BEGIN Object file/option list
-- ./hello.o
-- -L./
-- -L/usr/local/gnat/lib/gcc-lib/i686-pc-linux-gnu/2.8.1/adalib/
-- /usr/local/gnat/lib/gcc-lib/i686-pc-linux-gnu/2.8.1/adalib/libgnat.a
-- END Object file/option list
end ada_main;
</pre>
<p class="noindent">The Ada code in the above example is exactly what is generated by the
binder. We have added comments to more clearly indicate the function
of each part of the generated <code>Ada_Main</code> package.
<p>The code is standard Ada in all respects, and can be processed by any
tools that handle Ada. In particular, it is possible to use the debugger
in Ada mode to debug the generated <code>Ada_Main</code> package. For example,
suppose that for reasons that you do not understand, your program is crashing
during elaboration of the body of <code>Ada.Text_IO</code>. To locate this bug,
you can place a breakpoint on the call:
<pre class="smallexample"> Ada.Text_Io'Elab_Body;
</pre>
<p class="noindent">and trace the elaboration routine for this package to find out where
the problem might be (more usually of course you would be debugging
elaboration code in your own application).
<div class="node">
<a name="Elaboration-Order-Handling-in-GNAT"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Conditional-Compilation">Conditional Compilation</a>,
Previous: <a rel="previous" accesskey="p" href="#Example-of-Binder-Output-File">Example of Binder Output File</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="appendix">Appendix C Elaboration Order Handling in GNAT</h2>
<p><a name="index-Order-of-elaboration-1014"></a><a name="index-Elaboration-control-1015"></a>
<ul class="menu">
<li><a accesskey="1" href="#Elaboration-Code">Elaboration Code</a>
<li><a accesskey="2" href="#Checking-the-Elaboration-Order">Checking the Elaboration Order</a>
<li><a accesskey="3" href="#Controlling-the-Elaboration-Order">Controlling the Elaboration Order</a>
<li><a accesskey="4" href="#Controlling-Elaboration-in-GNAT-_002d-Internal-Calls">Controlling Elaboration in GNAT - Internal Calls</a>
<li><a accesskey="5" href="#Controlling-Elaboration-in-GNAT-_002d-External-Calls">Controlling Elaboration in GNAT - External Calls</a>
<li><a accesskey="6" href="#Default-Behavior-in-GNAT-_002d-Ensuring-Safety">Default Behavior in GNAT - Ensuring Safety</a>
<li><a accesskey="7" href="#Treatment-of-Pragma-Elaborate">Treatment of Pragma Elaborate</a>
<li><a accesskey="8" href="#Elaboration-Issues-for-Library-Tasks">Elaboration Issues for Library Tasks</a>
<li><a accesskey="9" href="#Mixing-Elaboration-Models">Mixing Elaboration Models</a>
<li><a href="#What-to-Do-If-the-Default-Elaboration-Behavior-Fails">What to Do If the Default Elaboration Behavior Fails</a>
<li><a href="#Elaboration-for-Access_002dto_002dSubprogram-Values">Elaboration for Access-to-Subprogram Values</a>
<li><a href="#Summary-of-Procedures-for-Elaboration-Control">Summary of Procedures for Elaboration Control</a>
<li><a href="#Other-Elaboration-Order-Considerations">Other Elaboration Order Considerations</a>
</ul>
<p class="noindent">This chapter describes the handling of elaboration code in Ada and
in GNAT, and discusses how the order of elaboration of program units can
be controlled in GNAT, either automatically or with explicit programming
features.
<div class="node">
<a name="Elaboration-Code"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Checking-the-Elaboration-Order">Checking the Elaboration Order</a>,
Up: <a rel="up" accesskey="u" href="#Elaboration-Order-Handling-in-GNAT">Elaboration Order Handling in GNAT</a>
</div>
<h3 class="section">C.1 Elaboration Code</h3>
<p class="noindent">Ada provides rather general mechanisms for executing code at elaboration
time, that is to say before the main program starts executing. Such code arises
in three contexts:
<dl>
<dt>Initializers for variables.<dd>Variables declared at the library level, in package specs or bodies, can
require initialization that is performed at elaboration time, as in:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
Sqrt_Half : Float := Sqrt (0.5);
</td></tr></table>
</pre>
<br><dt>Package initialization code<dd>Code in a <code>BEGIN-END</code> section at the outer level of a package body is
executed as part of the package body elaboration code.
<br><dt>Library level task allocators<dd>Tasks that are declared using task allocators at the library level
start executing immediately and hence can execute at elaboration time.
</dl>
<p class="noindent">Subprogram calls are possible in any of these contexts, which means that
any arbitrary part of the program may be executed as part of the elaboration
code. It is even possible to write a program which does all its work at
elaboration time, with a null main program, although stylistically this
would usually be considered an inappropriate way to structure
a program.
<p>An important concern arises in the context of elaboration code:
we have to be sure that it is executed in an appropriate order. What we
have is a series of elaboration code sections, potentially one section
for each unit in the program. It is important that these execute
in the correct order. Correctness here means that, taking the above
example of the declaration of <code>Sqrt_Half</code>,
if some other piece of
elaboration code references <code>Sqrt_Half</code>,
then it must run after the
section of elaboration code that contains the declaration of
<code>Sqrt_Half</code>.
<p>There would never be any order of elaboration problem if we made a rule
that whenever you <code>with</code> a unit, you must elaborate both the spec and body
of that unit before elaborating the unit doing the <code>with</code>'ing:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
with Unit_1;
package Unit_2 is ...
</td></tr></table>
</pre>
<p class="noindent">would require that both the body and spec of <code>Unit_1</code> be elaborated
before the spec of <code>Unit_2</code>. However, a rule like that would be far too
restrictive. In particular, it would make it impossible to have routines
in separate packages that were mutually recursive.
<p>You might think that a clever enough compiler could look at the actual
elaboration code and determine an appropriate correct order of elaboration,
but in the general case, this is not possible. Consider the following
example.
<p>In the body of <code>Unit_1</code>, we have a procedure <code>Func_1</code>
that references
the variable <code>Sqrt_1</code>, which is declared in the elaboration code
of the body of <code>Unit_1</code>:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
Sqrt_1 : Float := Sqrt (0.1);
</td></tr></table>
</pre>
<p class="noindent">The elaboration code of the body of <code>Unit_1</code> also contains:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
if expression_1 = 1 then
Q := Unit_2.Func_2;
end if;
</td></tr></table>
</pre>
<p class="noindent"><code>Unit_2</code> is exactly parallel,
it has a procedure <code>Func_2</code> that references
the variable <code>Sqrt_2</code>, which is declared in the elaboration code of
the body <code>Unit_2</code>:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
Sqrt_2 : Float := Sqrt (0.1);
</td></tr></table>
</pre>
<p class="noindent">The elaboration code of the body of <code>Unit_2</code> also contains:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
if expression_2 = 2 then
Q := Unit_1.Func_1;
end if;
</td></tr></table>
</pre>
<p class="noindent">Now the question is, which of the following orders of elaboration is
acceptable:
<pre class="smallexample"> Spec of Unit_1
Spec of Unit_2
Body of Unit_1
Body of Unit_2
</pre>
<p class="noindent">or
<pre class="smallexample"> Spec of Unit_2
Spec of Unit_1
Body of Unit_2
Body of Unit_1
</pre>
<p class="noindent">If you carefully analyze the flow here, you will see that you cannot tell
at compile time the answer to this question.
If <code>expression_1</code> is not equal to 1,
and <code>expression_2</code> is not equal to 2,
then either order is acceptable, because neither of the function calls is
executed. If both tests evaluate to true, then neither order is acceptable
and in fact there is no correct order.
<p>If one of the two expressions is true, and the other is false, then one
of the above orders is correct, and the other is incorrect. For example,
if <code>expression_1</code> /= 1 and <code>expression_2</code> = 2,
then the call to <code>Func_1</code>
will occur, but not the call to <code>Func_2.</code>
This means that it is essential
to elaborate the body of <code>Unit_1</code> before
the body of <code>Unit_2</code>, so the first
order of elaboration is correct and the second is wrong.
<p>By making <code>expression_1</code> and <code>expression_2</code>
depend on input data, or perhaps
the time of day, we can make it impossible for the compiler or binder
to figure out which of these expressions will be true, and hence it
is impossible to guarantee a safe order of elaboration at run time.
<div class="node">
<a name="Checking-the-Elaboration-Order"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Controlling-the-Elaboration-Order">Controlling the Elaboration Order</a>,
Previous: <a rel="previous" accesskey="p" href="#Elaboration-Code">Elaboration Code</a>,
Up: <a rel="up" accesskey="u" href="#Elaboration-Order-Handling-in-GNAT">Elaboration Order Handling in GNAT</a>
</div>
<h3 class="section">C.2 Checking the Elaboration Order</h3>
<p class="noindent">In some languages that involve the same kind of elaboration problems,
e.g. Java and C++, the programmer is expected to worry about these
ordering problems himself, and it is common to
write a program in which an incorrect elaboration order gives
surprising results, because it references variables before they
are initialized.
Ada is designed to be a safe language, and a programmer-beware approach is
clearly not sufficient. Consequently, the language provides three lines
of defense:
<dl>
<dt>Standard rules<dd>Some standard rules restrict the possible choice of elaboration
order. In particular, if you <code>with</code> a unit, then its spec is always
elaborated before the unit doing the <code>with</code>. Similarly, a parent
spec is always elaborated before the child spec, and finally
a spec is always elaborated before its corresponding body.
<br><dt>Dynamic elaboration checks<dd><a name="index-Elaboration-checks-1016"></a><a name="index-Checks_002c-elaboration-1017"></a>Dynamic checks are made at run time, so that if some entity is accessed
before it is elaborated (typically by means of a subprogram call)
then the exception (<code>Program_Error</code>) is raised.
<br><dt>Elaboration control<dd>Facilities are provided for the programmer to specify the desired order
of elaboration.
</dl>
<p>Let's look at these facilities in more detail. First, the rules for
dynamic checking. One possible rule would be simply to say that the
exception is raised if you access a variable which has not yet been
elaborated. The trouble with this approach is that it could require
expensive checks on every variable reference. Instead Ada has two
rules which are a little more restrictive, but easier to check, and
easier to state:
<dl>
<dt>Restrictions on calls<dd>A subprogram can only be called at elaboration time if its body
has been elaborated. The rules for elaboration given above guarantee
that the spec of the subprogram has been elaborated before the
call, but not the body. If this rule is violated, then the
exception <code>Program_Error</code> is raised.
<br><dt>Restrictions on instantiations<dd>A generic unit can only be instantiated if the body of the generic
unit has been elaborated. Again, the rules for elaboration given above
guarantee that the spec of the generic unit has been elaborated
before the instantiation, but not the body. If this rule is
violated, then the exception <code>Program_Error</code> is raised.
</dl>
<p class="noindent">The idea is that if the body has been elaborated, then any variables
it references must have been elaborated; by checking for the body being
elaborated we guarantee that none of its references causes any
trouble. As we noted above, this is a little too restrictive, because a
subprogram that has no non-local references in its body may in fact be safe
to call. However, it really would be unsafe to rely on this, because
it would mean that the caller was aware of details of the implementation
in the body. This goes against the basic tenets of Ada.
<p>A plausible implementation can be described as follows.
A Boolean variable is associated with each subprogram
and each generic unit. This variable is initialized to False, and is set to
True at the point body is elaborated. Every call or instantiation checks the
variable, and raises <code>Program_Error</code> if the variable is False.
<p>Note that one might think that it would be good enough to have one Boolean
variable for each package, but that would not deal with cases of trying
to call a body in the same package as the call
that has not been elaborated yet.
Of course a compiler may be able to do enough analysis to optimize away
some of the Boolean variables as unnecessary, and <code>GNAT</code> indeed
does such optimizations, but still the easiest conceptual model is to
think of there being one variable per subprogram.
<div class="node">
<a name="Controlling-the-Elaboration-Order"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Controlling-Elaboration-in-GNAT-_002d-Internal-Calls">Controlling Elaboration in GNAT - Internal Calls</a>,
Previous: <a rel="previous" accesskey="p" href="#Checking-the-Elaboration-Order">Checking the Elaboration Order</a>,
Up: <a rel="up" accesskey="u" href="#Elaboration-Order-Handling-in-GNAT">Elaboration Order Handling in GNAT</a>
</div>
<h3 class="section">C.3 Controlling the Elaboration Order</h3>
<p class="noindent">In the previous section we discussed the rules in Ada which ensure
that <code>Program_Error</code> is raised if an incorrect elaboration order is
chosen. This prevents erroneous executions, but we need mechanisms to
specify a correct execution and avoid the exception altogether.
To achieve this, Ada provides a number of features for controlling
the order of elaboration. We discuss these features in this section.
<p>First, there are several ways of indicating to the compiler that a given
unit has no elaboration problems:
<dl>
<dt>packages that do not require a body<dd>A library package that does not require a body does not permit
a body (this rule was introduced in Ada 95).
Thus if we have a such a package, as in:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
package Definitions is
generic
type m is new integer;
package Subp is
type a is array (1 .. 10) of m;
type b is array (1 .. 20) of m;
end Subp;
end Definitions;
</td></tr></table>
</pre>
<p class="noindent">A package that <code>with</code>'s <code>Definitions</code> may safely instantiate
<code>Definitions.Subp</code> because the compiler can determine that there
definitely is no package body to worry about in this case
<br><dt>pragma Pure<dd><a name="index-pragma-Pure-1018"></a><a name="index-Pure-1019"></a>Places sufficient restrictions on a unit to guarantee that
no call to any subprogram in the unit can result in an
elaboration problem. This means that the compiler does not need
to worry about the point of elaboration of such units, and in
particular, does not need to check any calls to any subprograms
in this unit.
<br><dt>pragma Preelaborate<dd><a name="index-Preelaborate-1020"></a><a name="index-pragma-Preelaborate-1021"></a>This pragma places slightly less stringent restrictions on a unit than
does pragma Pure,
but these restrictions are still sufficient to ensure that there
are no elaboration problems with any calls to the unit.
<br><dt>pragma Elaborate_Body<dd><a name="index-Elaborate_005fBody-1022"></a><a name="index-pragma-Elaborate_005fBody-1023"></a>This pragma requires that the body of a unit be elaborated immediately
after its spec. Suppose a unit <code>A</code> has such a pragma,
and unit <code>B</code> does
a <code>with</code> of unit <code>A</code>. Recall that the standard rules require
the spec of unit <code>A</code>
to be elaborated before the <code>with</code>'ing unit; given the pragma in
<code>A</code>, we also know that the body of <code>A</code>
will be elaborated before <code>B</code>, so
that calls to <code>A</code> are safe and do not need a check.
</dl>
<p class="noindent">Note that,
unlike pragma <code>Pure</code> and pragma <code>Preelaborate</code>,
the use of
<code>Elaborate_Body</code> does not guarantee that the program is
free of elaboration problems, because it may not be possible
to satisfy the requested elaboration order.
Let's go back to the example with <code>Unit_1</code> and <code>Unit_2</code>.
If a programmer
marks <code>Unit_1</code> as <code>Elaborate_Body</code>,
and not <code>Unit_2,</code> then the order of
elaboration will be:
<pre class="smallexample"> Spec of Unit_2
Spec of Unit_1
Body of Unit_1
Body of Unit_2
</pre>
<p class="noindent">Now that means that the call to <code>Func_1</code> in <code>Unit_2</code>
need not be checked,
it must be safe. But the call to <code>Func_2</code> in
<code>Unit_1</code> may still fail if
<code>Expression_1</code> is equal to 1,
and the programmer must still take
responsibility for this not being the case.
<p>If all units carry a pragma <code>Elaborate_Body</code>, then all problems are
eliminated, except for calls entirely within a body, which are
in any case fully under programmer control. However, using the pragma
everywhere is not always possible.
In particular, for our <code>Unit_1</code>/<code>Unit_2</code> example, if
we marked both of them as having pragma <code>Elaborate_Body</code>, then
clearly there would be no possible elaboration order.
<p>The above pragmas allow a server to guarantee safe use by clients, and
clearly this is the preferable approach. Consequently a good rule
is to mark units as <code>Pure</code> or <code>Preelaborate</code> if possible,
and if this is not possible,
mark them as <code>Elaborate_Body</code> if possible.
As we have seen, there are situations where neither of these
three pragmas can be used.
So we also provide methods for clients to control the
order of elaboration of the servers on which they depend:
<dl>
<dt>pragma Elaborate (unit)<dd><a name="index-Elaborate-1024"></a><a name="index-pragma-Elaborate-1025"></a>This pragma is placed in the context clause, after a <code>with</code> clause,
and it requires that the body of the named unit be elaborated before
the unit in which the pragma occurs. The idea is to use this pragma
if the current unit calls at elaboration time, directly or indirectly,
some subprogram in the named unit.
<br><dt>pragma Elaborate_All (unit)<dd><a name="index-Elaborate_005fAll-1026"></a><a name="index-pragma-Elaborate_005fAll-1027"></a>This is a stronger version of the Elaborate pragma. Consider the
following example:
<pre class="smallexample"> Unit A <code>with</code>'s unit B and calls B.Func in elab code
Unit B <code>with</code>'s unit C, and B.Func calls C.Func
</pre>
<p class="noindent">Now if we put a pragma <code>Elaborate (B)</code>
in unit <code>A</code>, this ensures that the
body of <code>B</code> is elaborated before the call, but not the
body of <code>C</code>, so
the call to <code>C.Func</code> could still cause <code>Program_Error</code> to
be raised.
<p>The effect of a pragma <code>Elaborate_All</code> is stronger, it requires
not only that the body of the named unit be elaborated before the
unit doing the <code>with</code>, but also the bodies of all units that the
named unit uses, following <code>with</code> links transitively. For example,
if we put a pragma <code>Elaborate_All (B)</code> in unit <code>A</code>,
then it requires
not only that the body of <code>B</code> be elaborated before <code>A</code>,
but also the
body of <code>C</code>, because <code>B</code> <code>with</code>'s <code>C</code>.
</dl>
<p class="noindent">We are now in a position to give a usage rule in Ada for avoiding
elaboration problems, at least if dynamic dispatching and access to
subprogram values are not used. We will handle these cases separately
later.
<p>The rule is simple. If a unit has elaboration code that can directly or
indirectly make a call to a subprogram in a <code>with</code>'ed unit, or instantiate
a generic package in a <code>with</code>'ed unit,
then if the <code>with</code>'ed unit does not have
pragma <code>Pure</code> or <code>Preelaborate</code>, then the client should have
a pragma <code>Elaborate_All</code>
for the <code>with</code>'ed unit. By following this rule a client is
assured that calls can be made without risk of an exception.
<p>For generic subprogram instantiations, the rule can be relaxed to
require only a pragma <code>Elaborate</code> since elaborating the body
of a subprogram cannot cause any transitive elaboration (we are
not calling the subprogram in this case, just elaborating its
declaration).
<p>If this rule is not followed, then a program may be in one of four
states:
<dl>
<dt>No order exists<dd>No order of elaboration exists which follows the rules, taking into
account any <code>Elaborate</code>, <code>Elaborate_All</code>,
or <code>Elaborate_Body</code> pragmas. In
this case, an Ada compiler must diagnose the situation at bind
time, and refuse to build an executable program.
<br><dt>One or more orders exist, all incorrect<dd>One or more acceptable elaboration orders exist, and all of them
generate an elaboration order problem. In this case, the binder
can build an executable program, but <code>Program_Error</code> will be raised
when the program is run.
<br><dt>Several orders exist, some right, some incorrect<dd>One or more acceptable elaboration orders exists, and some of them
work, and some do not. The programmer has not controlled
the order of elaboration, so the binder may or may not pick one of
the correct orders, and the program may or may not raise an
exception when it is run. This is the worst case, because it means
that the program may fail when moved to another compiler, or even
another version of the same compiler.
<br><dt>One or more orders exists, all correct<dd>One ore more acceptable elaboration orders exist, and all of them
work. In this case the program runs successfully. This state of
affairs can be guaranteed by following the rule we gave above, but
may be true even if the rule is not followed.
</dl>
<p class="noindent">Note that one additional advantage of following our rules on the use
of <code>Elaborate</code> and <code>Elaborate_All</code>
is that the program continues to stay in the ideal (all orders OK) state
even if maintenance
changes some bodies of some units. Conversely, if a program that does
not follow this rule happens to be safe at some point, this state of affairs
may deteriorate silently as a result of maintenance changes.
<p>You may have noticed that the above discussion did not mention
the use of <code>Elaborate_Body</code>. This was a deliberate omission. If you
<code>with</code> an <code>Elaborate_Body</code> unit, it still may be the case that
code in the body makes calls to some other unit, so it is still necessary
to use <code>Elaborate_All</code> on such units.
<div class="node">
<a name="Controlling-Elaboration-in-GNAT---Internal-Calls"></a>
<a name="Controlling-Elaboration-in-GNAT-_002d-Internal-Calls"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Controlling-Elaboration-in-GNAT-_002d-External-Calls">Controlling Elaboration in GNAT - External Calls</a>,
Previous: <a rel="previous" accesskey="p" href="#Controlling-the-Elaboration-Order">Controlling the Elaboration Order</a>,
Up: <a rel="up" accesskey="u" href="#Elaboration-Order-Handling-in-GNAT">Elaboration Order Handling in GNAT</a>
</div>
<h3 class="section">C.4 Controlling Elaboration in GNAT - Internal Calls</h3>
<p class="noindent">In the case of internal calls, i.e., calls within a single package, the
programmer has full control over the order of elaboration, and it is up
to the programmer to elaborate declarations in an appropriate order. For
example writing:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
function One return Float;
Q : Float := One;
function One return Float is
begin
return 1.0;
end One;
</td></tr></table>
</pre>
<p class="noindent">will obviously raise <code>Program_Error</code> at run time, because function
One will be called before its body is elaborated. In this case GNAT will
generate a warning that the call will raise <code>Program_Error</code>:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
1. procedure y is
2. function One return Float;
3.
4. Q : Float := One;
|
>>> warning: cannot call "One" before body is elaborated
>>> warning: Program_Error will be raised at run time
5.
6. function One return Float is
7. begin
8. return 1.0;
9. end One;
10.
11. begin
12. null;
13. end;
</td></tr></table>
</pre>
<p class="noindent">Note that in this particular case, it is likely that the call is safe, because
the function <code>One</code> does not access any global variables.
Nevertheless in Ada, we do not want the validity of the check to depend on
the contents of the body (think about the separate compilation case), so this
is still wrong, as we discussed in the previous sections.
<p>The error is easily corrected by rearranging the declarations so that the
body of <code>One</code> appears before the declaration containing the call
(note that in Ada 95 and Ada 2005,
declarations can appear in any order, so there is no restriction that
would prevent this reordering, and if we write:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
function One return Float;
function One return Float is
begin
return 1.0;
end One;
Q : Float := One;
</td></tr></table>
</pre>
<p class="noindent">then all is well, no warning is generated, and no
<code>Program_Error</code> exception
will be raised.
Things are more complicated when a chain of subprograms is executed:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
function A return Integer;
function B return Integer;
function C return Integer;
function B return Integer is begin return A; end;
function C return Integer is begin return B; end;
X : Integer := C;
function A return Integer is begin return 1; end;
</td></tr></table>
</pre>
<p class="noindent">Now the call to <code>C</code>
at elaboration time in the declaration of <code>X</code> is correct, because
the body of <code>C</code> is already elaborated,
and the call to <code>B</code> within the body of
<code>C</code> is correct, but the call
to <code>A</code> within the body of <code>B</code> is incorrect, because the body
of <code>A</code> has not been elaborated, so <code>Program_Error</code>
will be raised on the call to <code>A</code>.
In this case GNAT will generate a
warning that <code>Program_Error</code> may be
raised at the point of the call. Let's look at the warning:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
1. procedure x is
2. function A return Integer;
3. function B return Integer;
4. function C return Integer;
5.
6. function B return Integer is begin return A; end;
|
>>> warning: call to "A" before body is elaborated may
raise Program_Error
>>> warning: "B" called at line 7
>>> warning: "C" called at line 9
7. function C return Integer is begin return B; end;
8.
9. X : Integer := C;
10.
11. function A return Integer is begin return 1; end;
12.
13. begin
14. null;
15. end;
</td></tr></table>
</pre>
<p class="noindent">Note that the message here says “may raise”, instead of the direct case,
where the message says “will be raised”. That's because whether
<code>A</code> is
actually called depends in general on run-time flow of control.
For example, if the body of <code>B</code> said
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
function B return Integer is
begin
if some-condition-depending-on-input-data then
return A;
else
return 1;
end if;
end B;
</td></tr></table>
</pre>
<p class="noindent">then we could not know until run time whether the incorrect call to A would
actually occur, so <code>Program_Error</code> might
or might not be raised. It is possible for a compiler to
do a better job of analyzing bodies, to
determine whether or not <code>Program_Error</code>
might be raised, but it certainly
couldn't do a perfect job (that would require solving the halting problem
and is provably impossible), and because this is a warning anyway, it does
not seem worth the effort to do the analysis. Cases in which it
would be relevant are rare.
<p>In practice, warnings of either of the forms given
above will usually correspond to
real errors, and should be examined carefully and eliminated.
In the rare case where a warning is bogus, it can be suppressed by any of
the following methods:
<ul>
<li>Compile with the <samp><span class="option">-gnatws</span></samp> switch set
<li>Suppress <code>Elaboration_Check</code> for the called subprogram
<li>Use pragma <code>Warnings_Off</code> to turn warnings off for the call
</ul>
<p class="noindent">For the internal elaboration check case,
GNAT by default generates the
necessary run-time checks to ensure
that <code>Program_Error</code> is raised if any
call fails an elaboration check. Of course this can only happen if a
warning has been issued as described above. The use of pragma
<code>Suppress (Elaboration_Check)</code> may (but is not guaranteed to) suppress
some of these checks, meaning that it may be possible (but is not
guaranteed) for a program to be able to call a subprogram whose body
is not yet elaborated, without raising a <code>Program_Error</code> exception.
<div class="node">
<a name="Controlling-Elaboration-in-GNAT---External-Calls"></a>
<a name="Controlling-Elaboration-in-GNAT-_002d-External-Calls"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Default-Behavior-in-GNAT-_002d-Ensuring-Safety">Default Behavior in GNAT - Ensuring Safety</a>,
Previous: <a rel="previous" accesskey="p" href="#Controlling-Elaboration-in-GNAT-_002d-Internal-Calls">Controlling Elaboration in GNAT - Internal Calls</a>,
Up: <a rel="up" accesskey="u" href="#Elaboration-Order-Handling-in-GNAT">Elaboration Order Handling in GNAT</a>
</div>
<h3 class="section">C.5 Controlling Elaboration in GNAT - External Calls</h3>
<p class="noindent">The previous section discussed the case in which the execution of a
particular thread of elaboration code occurred entirely within a
single unit. This is the easy case to handle, because a programmer
has direct and total control over the order of elaboration, and
furthermore, checks need only be generated in cases which are rare
and which the compiler can easily detect.
The situation is more complex when separate compilation is taken into account.
Consider the following:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
<p>package Math is
function Sqrt (Arg : Float) return Float;
end Math;
package body Math is
function Sqrt (Arg : Float) return Float is
begin
...
end Sqrt;
end Math;
<p>with Math;
package Stuff is
X : Float := Math.Sqrt (0.5);
end Stuff;
with Stuff;
procedure Main is
begin
...
end Main;
</td></tr></table>
</pre>
<p class="noindent">where <code>Main</code> is the main program. When this program is executed, the
elaboration code must first be executed, and one of the jobs of the
binder is to determine the order in which the units of a program are
to be elaborated. In this case we have four units: the spec and body
of <code>Math</code>,
the spec of <code>Stuff</code> and the body of <code>Main</code>).
In what order should the four separate sections of elaboration code
be executed?
<p>There are some restrictions in the order of elaboration that the binder
can choose. In particular, if unit U has a <code>with</code>
for a package <code>X</code>, then you
are assured that the spec of <code>X</code>
is elaborated before U , but you are
not assured that the body of <code>X</code>
is elaborated before U.
This means that in the above case, the binder is allowed to choose the
order:
<pre class="smallexample"> spec of Math
spec of Stuff
body of Math
body of Main
</pre>
<p class="noindent">but that's not good, because now the call to <code>Math.Sqrt</code>
that happens during
the elaboration of the <code>Stuff</code>
spec happens before the body of <code>Math.Sqrt</code> is
elaborated, and hence causes <code>Program_Error</code> exception to be raised.
At first glance, one might say that the binder is misbehaving, because
obviously you want to elaborate the body of something you <code>with</code>
first, but
that is not a general rule that can be followed in all cases. Consider
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
package X is ...
package Y is ...
with X;
package body Y is ...
with Y;
package body X is ...
</td></tr></table>
</pre>
<p class="noindent">This is a common arrangement, and, apart from the order of elaboration
problems that might arise in connection with elaboration code, this works fine.
A rule that says that you must first elaborate the body of anything you
<code>with</code> cannot work in this case:
the body of <code>X</code> <code>with</code>'s <code>Y</code>,
which means you would have to
elaborate the body of <code>Y</code> first, but that <code>with</code>'s <code>X</code>,
which means
you have to elaborate the body of <code>X</code> first, but <small class="dots">...</small> and we have a
loop that cannot be broken.
<p>It is true that the binder can in many cases guess an order of elaboration
that is unlikely to cause a <code>Program_Error</code>
exception to be raised, and it tries to do so (in the
above example of <code>Math/Stuff/Spec</code>, the GNAT binder will
by default
elaborate the body of <code>Math</code> right after its spec, so all will be well).
<p>However, a program that blindly relies on the binder to be helpful can
get into trouble, as we discussed in the previous sections, so
GNAT
provides a number of facilities for assisting the programmer in
developing programs that are robust with respect to elaboration order.
<div class="node">
<a name="Default-Behavior-in-GNAT---Ensuring-Safety"></a>
<a name="Default-Behavior-in-GNAT-_002d-Ensuring-Safety"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Treatment-of-Pragma-Elaborate">Treatment of Pragma Elaborate</a>,
Previous: <a rel="previous" accesskey="p" href="#Controlling-Elaboration-in-GNAT-_002d-External-Calls">Controlling Elaboration in GNAT - External Calls</a>,
Up: <a rel="up" accesskey="u" href="#Elaboration-Order-Handling-in-GNAT">Elaboration Order Handling in GNAT</a>
</div>
<h3 class="section">C.6 Default Behavior in GNAT - Ensuring Safety</h3>
<p class="noindent">The default behavior in GNAT ensures elaboration safety. In its
default mode GNAT implements the
rule we previously described as the right approach. Let's restate it:
<ul>
<li><em>If a unit has elaboration code that can directly or indirectly make a
call to a subprogram in a </em><code>with</code><em>'ed unit, or instantiate a generic
package in a </em><code>with</code><em>'ed unit, then if the </em><code>with</code><em>'ed unit
does not have pragma </em><code>Pure</code><em> or
</em><code>Preelaborate</code><em>, then the client should have an
</em><code>Elaborate_All</code><em> pragma for the </em><code>with</code><em>'ed unit.</em>
<p><em>In the case of instantiating a generic subprogram, it is always
sufficient to have only an </em><code>Elaborate</code><em> pragma for the
</em><code>with</code><em>'ed unit.</em>
</ul>
<p class="noindent">By following this rule a client is assured that calls and instantiations
can be made without risk of an exception.
<p>In this mode GNAT traces all calls that are potentially made from
elaboration code, and puts in any missing implicit <code>Elaborate</code>
and <code>Elaborate_All</code> pragmas.
The advantage of this approach is that no elaboration problems
are possible if the binder can find an elaboration order that is
consistent with these implicit <code>Elaborate</code> and
<code>Elaborate_All</code> pragmas. The
disadvantage of this approach is that no such order may exist.
<p>If the binder does not generate any diagnostics, then it means that it has
found an elaboration order that is guaranteed to be safe. However, the binder
may still be relying on implicitly generated <code>Elaborate</code> and
<code>Elaborate_All</code> pragmas so portability to other compilers than GNAT is not
guaranteed.
<p>If it is important to guarantee portability, then the compilations should
use the
<samp><span class="option">-gnatwl</span></samp>
(warn on elaboration problems) switch. This will cause warning messages
to be generated indicating the missing <code>Elaborate</code> and
<code>Elaborate_All</code> pragmas.
Consider the following source program:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
with k;
package j is
m : integer := k.r;
end;
</td></tr></table>
</pre>
<p class="noindent">where it is clear that there
should be a pragma <code>Elaborate_All</code>
for unit <code>k</code>. An implicit pragma will be generated, and it is
likely that the binder will be able to honor it. However, if you want
to port this program to some other Ada compiler than GNAT.
it is safer to include the pragma explicitly in the source. If this
unit is compiled with the
<samp><span class="option">-gnatwl</span></samp>
switch, then the compiler outputs a warning:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
1. with k;
2. package j is
3. m : integer := k.r;
|
>>> warning: call to "r" may raise Program_Error
>>> warning: missing pragma Elaborate_All for "k"
4. end;
</td></tr></table>
</pre>
<p class="noindent">and these warnings can be used as a guide for supplying manually
the missing pragmas. It is usually a bad idea to use this warning
option during development. That's because it will warn you when
you need to put in a pragma, but cannot warn you when it is time
to take it out. So the use of pragma <code>Elaborate_All</code> may lead to
unnecessary dependencies and even false circularities.
<p>This default mode is more restrictive than the Ada Reference
Manual, and it is possible to construct programs which will compile
using the dynamic model described there, but will run into a
circularity using the safer static model we have described.
<p>Of course any Ada compiler must be able to operate in a mode
consistent with the requirements of the Ada Reference Manual,
and in particular must have the capability of implementing the
standard dynamic model of elaboration with run-time checks.
<p>In GNAT, this standard mode can be achieved either by the use of
the <samp><span class="option">-gnatE</span></samp> switch on the compiler (<samp><span class="command">gcc</span></samp> or
<samp><span class="command">gnatmake</span></samp>) command, or by the use of the configuration pragma:
<pre class="smallexample"> pragma Elaboration_Checks (DYNAMIC);
</pre>
<p class="noindent">Either approach will cause the unit affected to be compiled using the
standard dynamic run-time elaboration checks described in the Ada
Reference Manual. The static model is generally preferable, since it
is clearly safer to rely on compile and link time checks rather than
run-time checks. However, in the case of legacy code, it may be
difficult to meet the requirements of the static model. This
issue is further discussed in
<a href="#What-to-Do-If-the-Default-Elaboration-Behavior-Fails">What to Do If the Default Elaboration Behavior Fails</a>.
<p>Note that the static model provides a strict subset of the allowed
behavior and programs of the Ada Reference Manual, so if you do
adhere to the static model and no circularities exist,
then you are assured that your program will
work using the dynamic model, providing that you remove any
pragma Elaborate statements from the source.
<div class="node">
<a name="Treatment-of-Pragma-Elaborate"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Elaboration-Issues-for-Library-Tasks">Elaboration Issues for Library Tasks</a>,
Previous: <a rel="previous" accesskey="p" href="#Default-Behavior-in-GNAT-_002d-Ensuring-Safety">Default Behavior in GNAT - Ensuring Safety</a>,
Up: <a rel="up" accesskey="u" href="#Elaboration-Order-Handling-in-GNAT">Elaboration Order Handling in GNAT</a>
</div>
<h3 class="section">C.7 Treatment of Pragma Elaborate</h3>
<p><a name="index-Pragma-Elaborate-1028"></a>
The use of <code>pragma Elaborate</code>
should generally be avoided in Ada 95 and Ada 2005 programs,
since there is no guarantee that transitive calls
will be properly handled. Indeed at one point, this pragma was placed
in Annex J (Obsolescent Features), on the grounds that it is never useful.
<p>Now that's a bit restrictive. In practice, the case in which
<code>pragma Elaborate</code> is useful is when the caller knows that there
are no transitive calls, or that the called unit contains all necessary
transitive <code>pragma Elaborate</code> statements, and legacy code often
contains such uses.
<p>Strictly speaking the static mode in GNAT should ignore such pragmas,
since there is no assurance at compile time that the necessary safety
conditions are met. In practice, this would cause GNAT to be incompatible
with correctly written Ada 83 code that had all necessary
<code>pragma Elaborate</code> statements in place. Consequently, we made the
decision that GNAT in its default mode will believe that if it encounters
a <code>pragma Elaborate</code> then the programmer knows what they are doing,
and it will trust that no elaboration errors can occur.
<p>The result of this decision is two-fold. First to be safe using the
static mode, you should remove all <code>pragma Elaborate</code> statements.
Second, when fixing circularities in existing code, you can selectively
use <code>pragma Elaborate</code> statements to convince the static mode of
GNAT that it need not generate an implicit <code>pragma Elaborate_All</code>
statement.
<p>When using the static mode with <samp><span class="option">-gnatwl</span></samp>, any use of
<code>pragma Elaborate</code> will generate a warning about possible
problems.
<div class="node">
<a name="Elaboration-Issues-for-Library-Tasks"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Mixing-Elaboration-Models">Mixing Elaboration Models</a>,
Previous: <a rel="previous" accesskey="p" href="#Treatment-of-Pragma-Elaborate">Treatment of Pragma Elaborate</a>,
Up: <a rel="up" accesskey="u" href="#Elaboration-Order-Handling-in-GNAT">Elaboration Order Handling in GNAT</a>
</div>
<h3 class="section">C.8 Elaboration Issues for Library Tasks</h3>
<p><a name="index-Library-tasks_002c-elaboration-issues-1029"></a><a name="index-Elaboration-of-library-tasks-1030"></a>
In this section we examine special elaboration issues that arise for
programs that declare library level tasks.
<p>Generally the model of execution of an Ada program is that all units are
elaborated, and then execution of the program starts. However, the
declaration of library tasks definitely does not fit this model. The
reason for this is that library tasks start as soon as they are declared
(more precisely, as soon as the statement part of the enclosing package
body is reached), that is to say before elaboration
of the program is complete. This means that if such a task calls a
subprogram, or an entry in another task, the callee may or may not be
elaborated yet, and in the standard
Reference Manual model of dynamic elaboration checks, you can even
get timing dependent Program_Error exceptions, since there can be
a race between the elaboration code and the task code.
<p>The static model of elaboration in GNAT seeks to avoid all such
dynamic behavior, by being conservative, and the conservative
approach in this particular case is to assume that all the code
in a task body is potentially executed at elaboration time if
a task is declared at the library level.
<p>This can definitely result in unexpected circularities. Consider
the following example
<pre class="smallexample"> package Decls is
task Lib_Task is
entry Start;
end Lib_Task;
type My_Int is new Integer;
function Ident (M : My_Int) return My_Int;
end Decls;
with Utils;
package body Decls is
task body Lib_Task is
begin
accept Start;
Utils.Put_Val (2);
end Lib_Task;
function Ident (M : My_Int) return My_Int is
begin
return M;
end Ident;
end Decls;
with Decls;
package Utils is
procedure Put_Val (Arg : Decls.My_Int);
end Utils;
with Text_IO;
package body Utils is
procedure Put_Val (Arg : Decls.My_Int) is
begin
Text_IO.Put_Line (Decls.My_Int'Image (Decls.Ident (Arg)));
end Put_Val;
end Utils;
with Decls;
procedure Main is
begin
Decls.Lib_Task.Start;
end;
</pre>
<p class="noindent">If the above example is compiled in the default static elaboration
mode, then a circularity occurs. The circularity comes from the call
<code>Utils.Put_Val</code> in the task body of <code>Decls.Lib_Task</code>. Since
this call occurs in elaboration code, we need an implicit pragma
<code>Elaborate_All</code> for <code>Utils</code>. This means that not only must
the spec and body of <code>Utils</code> be elaborated before the body
of <code>Decls</code>, but also the spec and body of any unit that is
<code>with'ed</code> by the body of <code>Utils</code> must also be elaborated before
the body of <code>Decls</code>. This is the transitive implication of
pragma <code>Elaborate_All</code> and it makes sense, because in general
the body of <code>Put_Val</code> might have a call to something in a
<code>with'ed</code> unit.
<p>In this case, the body of Utils (actually its spec) <code>with's</code>
<code>Decls</code>. Unfortunately this means that the body of <code>Decls</code>
must be elaborated before itself, in case there is a call from the
body of <code>Utils</code>.
<p>Here is the exact chain of events we are worrying about:
<ol type=1 start=1>
<li>In the body of <code>Decls</code> a call is made from within the body of a library
task to a subprogram in the package <code>Utils</code>. Since this call may
occur at elaboration time (given that the task is activated at elaboration
time), we have to assume the worst, i.e., that the
call does happen at elaboration time.
<li>This means that the body and spec of <code>Util</code> must be elaborated before
the body of <code>Decls</code> so that this call does not cause an access before
elaboration.
<li>Within the body of <code>Util</code>, specifically within the body of
<code>Util.Put_Val</code> there may be calls to any unit <code>with</code>'ed
by this package.
<li>One such <code>with</code>'ed package is package <code>Decls</code>, so there
might be a call to a subprogram in <code>Decls</code> in <code>Put_Val</code>.
In fact there is such a call in this example, but we would have to
assume that there was such a call even if it were not there, since
we are not supposed to write the body of <code>Decls</code> knowing what
is in the body of <code>Utils</code>; certainly in the case of the
static elaboration model, the compiler does not know what is in
other bodies and must assume the worst.
<li>This means that the spec and body of <code>Decls</code> must also be
elaborated before we elaborate the unit containing the call, but
that unit is <code>Decls</code>! This means that the body of <code>Decls</code>
must be elaborated before itself, and that's a circularity.
</ol>
<p class="noindent">Indeed, if you add an explicit pragma <code>Elaborate_All</code> for <code>Utils</code> in
the body of <code>Decls</code> you will get a true Ada Reference Manual
circularity that makes the program illegal.
<p>In practice, we have found that problems with the static model of
elaboration in existing code often arise from library tasks, so
we must address this particular situation.
<p>Note that if we compile and run the program above, using the dynamic model of
elaboration (that is to say use the <samp><span class="option">-gnatE</span></samp> switch),
then it compiles, binds,
links, and runs, printing the expected result of 2. Therefore in some sense
the circularity here is only apparent, and we need to capture
the properties of this program that distinguish it from other library-level
tasks that have real elaboration problems.
<p>We have four possible answers to this question:
<ul>
<li>Use the dynamic model of elaboration.
<p>If we use the <samp><span class="option">-gnatE</span></samp> switch, then as noted above, the program works.
Why is this? If we examine the task body, it is apparent that the task cannot
proceed past the
<code>accept</code> statement until after elaboration has been completed, because
the corresponding entry call comes from the main program, not earlier.
This is why the dynamic model works here. But that's really giving
up on a precise analysis, and we prefer to take this approach only if we cannot
solve the
problem in any other manner. So let us examine two ways to reorganize
the program to avoid the potential elaboration problem.
<li>Split library tasks into separate packages.
<p>Write separate packages, so that library tasks are isolated from
other declarations as much as possible. Let us look at a variation on
the above program.
<pre class="smallexample"> package Decls1 is
task Lib_Task is
entry Start;
end Lib_Task;
end Decls1;
with Utils;
package body Decls1 is
task body Lib_Task is
begin
accept Start;
Utils.Put_Val (2);
end Lib_Task;
end Decls1;
package Decls2 is
type My_Int is new Integer;
function Ident (M : My_Int) return My_Int;
end Decls2;
with Utils;
package body Decls2 is
function Ident (M : My_Int) return My_Int is
begin
return M;
end Ident;
end Decls2;
with Decls2;
package Utils is
procedure Put_Val (Arg : Decls2.My_Int);
end Utils;
with Text_IO;
package body Utils is
procedure Put_Val (Arg : Decls2.My_Int) is
begin
Text_IO.Put_Line (Decls2.My_Int'Image (Decls2.Ident (Arg)));
end Put_Val;
end Utils;
with Decls1;
procedure Main is
begin
Decls1.Lib_Task.Start;
end;
</pre>
<p class="noindent">All we have done is to split <code>Decls</code> into two packages, one
containing the library task, and one containing everything else. Now
there is no cycle, and the program compiles, binds, links and executes
using the default static model of elaboration.
<li>Declare separate task types.
<p>A significant part of the problem arises because of the use of the
single task declaration form. This means that the elaboration of
the task type, and the elaboration of the task itself (i.e. the
creation of the task) happen at the same time. A good rule
of style in Ada is to always create explicit task types. By
following the additional step of placing task objects in separate
packages from the task type declaration, many elaboration problems
are avoided. Here is another modified example of the example program:
<pre class="smallexample"> package Decls is
task type Lib_Task_Type is
entry Start;
end Lib_Task_Type;
type My_Int is new Integer;
function Ident (M : My_Int) return My_Int;
end Decls;
with Utils;
package body Decls is
task body Lib_Task_Type is
begin
accept Start;
Utils.Put_Val (2);
end Lib_Task_Type;
function Ident (M : My_Int) return My_Int is
begin
return M;
end Ident;
end Decls;
with Decls;
package Utils is
procedure Put_Val (Arg : Decls.My_Int);
end Utils;
with Text_IO;
package body Utils is
procedure Put_Val (Arg : Decls.My_Int) is
begin
Text_IO.Put_Line (Decls.My_Int'Image (Decls.Ident (Arg)));
end Put_Val;
end Utils;
with Decls;
package Declst is
Lib_Task : Decls.Lib_Task_Type;
end Declst;
with Declst;
procedure Main is
begin
Declst.Lib_Task.Start;
end;
</pre>
<p class="noindent">What we have done here is to replace the <code>task</code> declaration in
package <code>Decls</code> with a <code>task type</code> declaration. Then we
introduce a separate package <code>Declst</code> to contain the actual
task object. This separates the elaboration issues for
the <code>task type</code>
declaration, which causes no trouble, from the elaboration issues
of the task object, which is also unproblematic, since it is now independent
of the elaboration of <code>Utils</code>.
This separation of concerns also corresponds to
a generally sound engineering principle of separating declarations
from instances. This version of the program also compiles, binds, links,
and executes, generating the expected output.
<li>Use No_Entry_Calls_In_Elaboration_Code restriction.
<a name="index-No_005fEntry_005fCalls_005fIn_005fElaboration_005fCode-1031"></a>
The previous two approaches described how a program can be restructured
to avoid the special problems caused by library task bodies. in practice,
however, such restructuring may be difficult to apply to existing legacy code,
so we must consider solutions that do not require massive rewriting.
<p>Let us consider more carefully why our original sample program works
under the dynamic model of elaboration. The reason is that the code
in the task body blocks immediately on the <code>accept</code>
statement. Now of course there is nothing to prohibit elaboration
code from making entry calls (for example from another library level task),
so we cannot tell in isolation that
the task will not execute the accept statement during elaboration.
<p>However, in practice it is very unusual to see elaboration code
make any entry calls, and the pattern of tasks starting
at elaboration time and then immediately blocking on <code>accept</code> or
<code>select</code> statements is very common. What this means is that
the compiler is being too pessimistic when it analyzes the
whole package body as though it might be executed at elaboration
time.
<p>If we know that the elaboration code contains no entry calls, (a very safe
assumption most of the time, that could almost be made the default
behavior), then we can compile all units of the program under control
of the following configuration pragma:
<pre class="smallexample"> pragma Restrictions (No_Entry_Calls_In_Elaboration_Code);
</pre>
<p class="noindent">This pragma can be placed in the <samp><span class="file">gnat.adc</span></samp> file in the usual
manner. If we take our original unmodified program and compile it
in the presence of a <samp><span class="file">gnat.adc</span></samp> containing the above pragma,
then once again, we can compile, bind, link, and execute, obtaining
the expected result. In the presence of this pragma, the compiler does
not trace calls in a task body, that appear after the first <code>accept</code>
or <code>select</code> statement, and therefore does not report a potential
circularity in the original program.
<p>The compiler will check to the extent it can that the above
restriction is not violated, but it is not always possible to do a
complete check at compile time, so it is important to use this
pragma only if the stated restriction is in fact met, that is to say
no task receives an entry call before elaboration of all units is completed.
</ul>
<div class="node">
<a name="Mixing-Elaboration-Models"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#What-to-Do-If-the-Default-Elaboration-Behavior-Fails">What to Do If the Default Elaboration Behavior Fails</a>,
Previous: <a rel="previous" accesskey="p" href="#Elaboration-Issues-for-Library-Tasks">Elaboration Issues for Library Tasks</a>,
Up: <a rel="up" accesskey="u" href="#Elaboration-Order-Handling-in-GNAT">Elaboration Order Handling in GNAT</a>
</div>
<h3 class="section">C.9 Mixing Elaboration Models</h3>
<p class="noindent">So far, we have assumed that the entire program is either compiled
using the dynamic model or static model, ensuring consistency. It
is possible to mix the two models, but rules have to be followed
if this mixing is done to ensure that elaboration checks are not
omitted.
<p>The basic rule is that <em>a unit compiled with the static model cannot
be </em><code>with'ed</code><em> by a unit compiled with the dynamic model</em>. The
reason for this is that in the static model, a unit assumes that
its clients guarantee to use (the equivalent of) pragma
<code>Elaborate_All</code> so that no elaboration checks are required
in inner subprograms, and this assumption is violated if the
client is compiled with dynamic checks.
<p>The precise rule is as follows. A unit that is compiled with dynamic
checks can only <code>with</code> a unit that meets at least one of the
following criteria:
<ul>
<li>The <code>with'ed</code> unit is itself compiled with dynamic elaboration
checks (that is with the <samp><span class="option">-gnatE</span></samp> switch.
<li>The <code>with'ed</code> unit is an internal GNAT implementation unit from
the System, Interfaces, Ada, or GNAT hierarchies.
<li>The <code>with'ed</code> unit has pragma Preelaborate or pragma Pure.
<li>The <code>with'ing</code> unit (that is the client) has an explicit pragma
<code>Elaborate_All</code> for the <code>with'ed</code> unit.
</ul>
<p class="noindent">If this rule is violated, that is if a unit with dynamic elaboration
checks <code>with's</code> a unit that does not meet one of the above four
criteria, then the binder (<code>gnatbind</code>) will issue a warning
similar to that in the following example:
<pre class="smallexample"> warning: "x.ads" has dynamic elaboration checks and with's
warning: "y.ads" which has static elaboration checks
</pre>
<p class="noindent">These warnings indicate that the rule has been violated, and that as a result
elaboration checks may be missed in the resulting executable file.
This warning may be suppressed using the <samp><span class="option">-ws</span></samp> binder switch
in the usual manner.
<p>One useful application of this mixing rule is in the case of a subsystem
which does not itself <code>with</code> units from the remainder of the
application. In this case, the entire subsystem can be compiled with
dynamic checks to resolve a circularity in the subsystem, while
allowing the main application that uses this subsystem to be compiled
using the more reliable default static model.
<div class="node">
<a name="What-to-Do-If-the-Default-Elaboration-Behavior-Fails"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Elaboration-for-Access_002dto_002dSubprogram-Values">Elaboration for Access-to-Subprogram Values</a>,
Previous: <a rel="previous" accesskey="p" href="#Mixing-Elaboration-Models">Mixing Elaboration Models</a>,
Up: <a rel="up" accesskey="u" href="#Elaboration-Order-Handling-in-GNAT">Elaboration Order Handling in GNAT</a>
</div>
<h3 class="section">C.10 What to Do If the Default Elaboration Behavior Fails</h3>
<p class="noindent">If the binder cannot find an acceptable order, it outputs detailed
diagnostics. For example:
<pre class="smallexample"> error: elaboration circularity detected
info: "proc (body)" must be elaborated before "pack (body)"
info: reason: Elaborate_All probably needed in unit "pack (body)"
info: recompile "pack (body)" with -gnatwl
info: for full details
info: "proc (body)"
info: is needed by its spec:
info: "proc (spec)"
info: which is withed by:
info: "pack (body)"
info: "pack (body)" must be elaborated before "proc (body)"
info: reason: pragma Elaborate in unit "proc (body)"
</pre>
<p class="noindent">In this case we have a cycle that the binder cannot break. On the one
hand, there is an explicit pragma Elaborate in <code>proc</code> for
<code>pack</code>. This means that the body of <code>pack</code> must be elaborated
before the body of <code>proc</code>. On the other hand, there is elaboration
code in <code>pack</code> that calls a subprogram in <code>proc</code>. This means
that for maximum safety, there should really be a pragma
Elaborate_All in <code>pack</code> for <code>proc</code> which would require that
the body of <code>proc</code> be elaborated before the body of
<code>pack</code>. Clearly both requirements cannot be satisfied.
Faced with a circularity of this kind, you have three different options.
<dl>
<dt>Fix the program<dd>The most desirable option from the point of view of long-term maintenance
is to rearrange the program so that the elaboration problems are avoided.
One useful technique is to place the elaboration code into separate
child packages. Another is to move some of the initialization code to
explicitly called subprograms, where the program controls the order
of initialization explicitly. Although this is the most desirable option,
it may be impractical and involve too much modification, especially in
the case of complex legacy code.
<br><dt>Perform dynamic checks<dd>If the compilations are done using the
<samp><span class="option">-gnatE</span></samp>
(dynamic elaboration check) switch, then GNAT behaves in a quite different
manner. Dynamic checks are generated for all calls that could possibly result
in raising an exception. With this switch, the compiler does not generate
implicit <code>Elaborate</code> or <code>Elaborate_All</code> pragmas. The behavior then is
exactly as specified in the <cite>Ada Reference Manual</cite>.
The binder will generate
an executable program that may or may not raise <code>Program_Error</code>, and then
it is the programmer's job to ensure that it does not raise an exception. Note
that it is important to compile all units with the switch, it cannot be used
selectively.
<br><dt>Suppress checks<dd>The drawback of dynamic checks is that they generate a
significant overhead at run time, both in space and time. If you
are absolutely sure that your program cannot raise any elaboration
exceptions, and you still want to use the dynamic elaboration model,
then you can use the configuration pragma
<code>Suppress (Elaboration_Check)</code> to suppress all such checks. For
example this pragma could be placed in the <samp><span class="file">gnat.adc</span></samp> file.
<br><dt>Suppress checks selectively<dd>When you know that certain calls or instantiations in elaboration code cannot
possibly lead to an elaboration error, and the binder nevertheless complains
about implicit <code>Elaborate</code> and <code>Elaborate_All</code> pragmas that lead to
elaboration circularities, it is possible to remove those warnings locally and
obtain a program that will bind. Clearly this can be unsafe, and it is the
responsibility of the programmer to make sure that the resulting program has no
elaboration anomalies. The pragma <code>Suppress (Elaboration_Check)</code> can be
used with different granularity to suppress warnings and break elaboration
circularities:
<ul>
<li>Place the pragma that names the called subprogram in the declarative part
that contains the call.
<li>Place the pragma in the declarative part, without naming an entity. This
disables warnings on all calls in the corresponding declarative region.
<li>Place the pragma in the package spec that declares the called subprogram,
and name the subprogram. This disables warnings on all elaboration calls to
that subprogram.
<li>Place the pragma in the package spec that declares the called subprogram,
without naming any entity. This disables warnings on all elaboration calls to
all subprograms declared in this spec.
<li>Use Pragma Elaborate
As previously described in section See <a href="#Treatment-of-Pragma-Elaborate">Treatment of Pragma Elaborate</a>,
GNAT in static mode assumes that a <code>pragma</code> Elaborate indicates correctly
that no elaboration checks are required on calls to the designated unit.
There may be cases in which the caller knows that no transitive calls
can occur, so that a <code>pragma Elaborate</code> will be sufficient in a
case where <code>pragma Elaborate_All</code> would cause a circularity.
</ul>
<p class="noindent">These five cases are listed in order of decreasing safety, and therefore
require increasing programmer care in their application. Consider the
following program:
<pre class="smallexample"> package Pack1 is
function F1 return Integer;
X1 : Integer;
end Pack1;
package Pack2 is
function F2 return Integer;
function Pure (x : integer) return integer;
-- pragma Suppress (Elaboration_Check, On => Pure); -- (3)
-- pragma Suppress (Elaboration_Check); -- (4)
end Pack2;
with Pack2;
package body Pack1 is
function F1 return Integer is
begin
return 100;
end F1;
Val : integer := Pack2.Pure (11); -- Elab. call (1)
begin
declare
-- pragma Suppress(Elaboration_Check, Pack2.F2); -- (1)
-- pragma Suppress(Elaboration_Check); -- (2)
begin
X1 := Pack2.F2 + 1; -- Elab. call (2)
end;
end Pack1;
with Pack1;
package body Pack2 is
function F2 return Integer is
begin
return Pack1.F1;
end F2;
function Pure (x : integer) return integer is
begin
return x ** 3 - 3 * x;
end;
end Pack2;
with Pack1, Ada.Text_IO;
procedure Proc3 is
begin
Ada.Text_IO.Put_Line(Pack1.X1'Img); -- 101
end Proc3;
</pre>
<p>In the absence of any pragmas, an attempt to bind this program produces
the following diagnostics:
<pre class="smallexample"> error: elaboration circularity detected
info: "pack1 (body)" must be elaborated before "pack1 (body)"
info: reason: Elaborate_All probably needed in unit "pack1 (body)"
info: recompile "pack1 (body)" with -gnatwl for full details
info: "pack1 (body)"
info: must be elaborated along with its spec:
info: "pack1 (spec)"
info: which is withed by:
info: "pack2 (body)"
info: which must be elaborated along with its spec:
info: "pack2 (spec)"
info: which is withed by:
info: "pack1 (body)"
</pre>
<p>The sources of the circularity are the two calls to <code>Pack2.Pure</code> and
<code>Pack2.F2</code> in the body of <code>Pack1</code>. We can see that the call to
F2 is safe, even though F2 calls F1, because the call appears after the
elaboration of the body of F1. Therefore the pragma (1) is safe, and will
remove the warning on the call. It is also possible to use pragma (2)
because there are no other potentially unsafe calls in the block.
<p class="noindent">The call to <code>Pure</code> is safe because this function does not depend on the
state of <code>Pack2</code>. Therefore any call to this function is safe, and it
is correct to place pragma (3) in the corresponding package spec.
<p class="noindent">Finally, we could place pragma (4) in the spec of <code>Pack2</code> to disable
warnings on all calls to functions declared therein. Note that this is not
necessarily safe, and requires more detailed examination of the subprogram
bodies involved. In particular, a call to <code>F2</code> requires that <code>F1</code>
be already elaborated.
</dl>
<p class="noindent">It is hard to generalize on which of these four approaches should be
taken. Obviously if it is possible to fix the program so that the default
treatment works, this is preferable, but this may not always be practical.
It is certainly simple enough to use
<samp><span class="option">-gnatE</span></samp>
but the danger in this case is that, even if the GNAT binder
finds a correct elaboration order, it may not always do so,
and certainly a binder from another Ada compiler might not. A
combination of testing and analysis (for which the warnings generated
with the
<samp><span class="option">-gnatwl</span></samp>
switch can be useful) must be used to ensure that the program is free
of errors. One switch that is useful in this testing is the
<samp><span class="option">-p (pessimistic elaboration order)</span></samp>
switch for
<code>gnatbind</code>.
Normally the binder tries to find an order that has the best chance
of avoiding elaboration problems. However, if this switch is used, the binder
plays a devil's advocate role, and tries to choose the order that
has the best chance of failing. If your program works even with this
switch, then it has a better chance of being error free, but this is still
not a guarantee.
<p>For an example of this approach in action, consider the C-tests (executable
tests) from the ACVC suite. If these are compiled and run with the default
treatment, then all but one of them succeed without generating any error
diagnostics from the binder. However, there is one test that fails, and
this is not surprising, because the whole point of this test is to ensure
that the compiler can handle cases where it is impossible to determine
a correct order statically, and it checks that an exception is indeed
raised at run time.
<p>This one test must be compiled and run using the
<samp><span class="option">-gnatE</span></samp>
switch, and then it passes. Alternatively, the entire suite can
be run using this switch. It is never wrong to run with the dynamic
elaboration switch if your code is correct, and we assume that the
C-tests are indeed correct (it is less efficient, but efficiency is
not a factor in running the ACVC tests.)
<div class="node">
<a name="Elaboration-for-Access-to-Subprogram-Values"></a>
<a name="Elaboration-for-Access_002dto_002dSubprogram-Values"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Summary-of-Procedures-for-Elaboration-Control">Summary of Procedures for Elaboration Control</a>,
Previous: <a rel="previous" accesskey="p" href="#What-to-Do-If-the-Default-Elaboration-Behavior-Fails">What to Do If the Default Elaboration Behavior Fails</a>,
Up: <a rel="up" accesskey="u" href="#Elaboration-Order-Handling-in-GNAT">Elaboration Order Handling in GNAT</a>
</div>
<h3 class="section">C.11 Elaboration for Access-to-Subprogram Values</h3>
<p><a name="index-Access_002dto_002dsubprogram-1032"></a>
Access-to-subprogram types (introduced in Ada 95) complicate
the handling of elaboration. The trouble is that it becomes
impossible to tell at compile time which procedure
is being called. This means that it is not possible for the binder
to analyze the elaboration requirements in this case.
<p>If at the point at which the access value is created
(i.e., the evaluation of <code>P'Access</code> for a subprogram <code>P</code>),
the body of the subprogram is
known to have been elaborated, then the access value is safe, and its use
does not require a check. This may be achieved by appropriate arrangement
of the order of declarations if the subprogram is in the current unit,
or, if the subprogram is in another unit, by using pragma
<code>Pure</code>, <code>Preelaborate</code>, or <code>Elaborate_Body</code>
on the referenced unit.
<p>If the referenced body is not known to have been elaborated at the point
the access value is created, then any use of the access value must do a
dynamic check, and this dynamic check will fail and raise a
<code>Program_Error</code> exception if the body has not been elaborated yet.
GNAT will generate the necessary checks, and in addition, if the
<samp><span class="option">-gnatwl</span></samp>
switch is set, will generate warnings that such checks are required.
<p>The use of dynamic dispatching for tagged types similarly generates
a requirement for dynamic checks, and premature calls to any primitive
operation of a tagged type before the body of the operation has been
elaborated, will result in the raising of <code>Program_Error</code>.
<div class="node">
<a name="Summary-of-Procedures-for-Elaboration-Control"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Other-Elaboration-Order-Considerations">Other Elaboration Order Considerations</a>,
Previous: <a rel="previous" accesskey="p" href="#Elaboration-for-Access_002dto_002dSubprogram-Values">Elaboration for Access-to-Subprogram Values</a>,
Up: <a rel="up" accesskey="u" href="#Elaboration-Order-Handling-in-GNAT">Elaboration Order Handling in GNAT</a>
</div>
<h3 class="section">C.12 Summary of Procedures for Elaboration Control</h3>
<p><a name="index-Elaboration-control-1033"></a>
First, compile your program with the default options, using none of
the special elaboration control switches. If the binder successfully
binds your program, then you can be confident that, apart from issues
raised by the use of access-to-subprogram types and dynamic dispatching,
the program is free of elaboration errors. If it is important that the
program be portable, then use the
<samp><span class="option">-gnatwl</span></samp>
switch to generate warnings about missing <code>Elaborate</code> or
<code>Elaborate_All</code> pragmas, and supply the missing pragmas.
<p>If the program fails to bind using the default static elaboration
handling, then you can fix the program to eliminate the binder
message, or recompile the entire program with the
<samp><span class="option">-gnatE</span></samp> switch to generate dynamic elaboration checks,
and, if you are sure there really are no elaboration problems,
use a global pragma <code>Suppress (Elaboration_Check)</code>.
<div class="node">
<a name="Other-Elaboration-Order-Considerations"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Summary-of-Procedures-for-Elaboration-Control">Summary of Procedures for Elaboration Control</a>,
Up: <a rel="up" accesskey="u" href="#Elaboration-Order-Handling-in-GNAT">Elaboration Order Handling in GNAT</a>
</div>
<h3 class="section">C.13 Other Elaboration Order Considerations</h3>
<p class="noindent">This section has been entirely concerned with the issue of finding a valid
elaboration order, as defined by the Ada Reference Manual. In a case
where several elaboration orders are valid, the task is to find one
of the possible valid elaboration orders (and the static model in GNAT
will ensure that this is achieved).
<p>The purpose of the elaboration rules in the Ada Reference Manual is to
make sure that no entity is accessed before it has been elaborated. For
a subprogram, this means that the spec and body must have been elaborated
before the subprogram is called. For an object, this means that the object
must have been elaborated before its value is read or written. A violation
of either of these two requirements is an access before elaboration order,
and this section has been all about avoiding such errors.
<p>In the case where more than one order of elaboration is possible, in the
sense that access before elaboration errors are avoided, then any one of
the orders is “correct” in the sense that it meets the requirements of
the Ada Reference Manual, and no such error occurs.
<p>However, it may be the case for a given program, that there are
constraints on the order of elaboration that come not from consideration
of avoiding elaboration errors, but rather from extra-lingual logic
requirements. Consider this example:
<pre class="smallexample"> with Init_Constants;
package Constants is
X : Integer := 0;
Y : Integer := 0;
end Constants;
package Init_Constants is
procedure P; -- require a body
end Init_Constants;
with Constants;
package body Init_Constants is
procedure P is begin null; end;
begin
Constants.X := 3;
Constants.Y := 4;
end Init_Constants;
with Constants;
package Calc is
Z : Integer := Constants.X + Constants.Y;
end Calc;
with Calc;
with Text_IO; use Text_IO;
procedure Main is
begin
Put_Line (Calc.Z'Img);
end Main;
</pre>
<p class="noindent">In this example, there is more than one valid order of elaboration. For
example both the following are correct orders:
<pre class="smallexample"> Init_Constants spec
Constants spec
Calc spec
Init_Constants body
Main body
and
Init_Constants spec
Init_Constants body
Constants spec
Calc spec
Main body
</pre>
<p class="noindent">There is no language rule to prefer one or the other, both are correct
from an order of elaboration point of view. But the programmatic effects
of the two orders are very different. In the first, the elaboration routine
of <code>Calc</code> initializes <code>Z</code> to zero, and then the main program
runs with this value of zero. But in the second order, the elaboration
routine of <code>Calc</code> runs after the body of Init_Constants has set
<code>X</code> and <code>Y</code> and thus <code>Z</code> is set to 7 before <code>Main</code>
runs.
<p>One could perhaps by applying pretty clever non-artificial intelligence
to the situation guess that it is more likely that the second order of
elaboration is the one desired, but there is no formal linguistic reason
to prefer one over the other. In fact in this particular case, GNAT will
prefer the second order, because of the rule that bodies are elaborated
as soon as possible, but it's just luck that this is what was wanted
(if indeed the second order was preferred).
<p>If the program cares about the order of elaboration routines in a case like
this, it is important to specify the order required. In this particular
case, that could have been achieved by adding to the spec of Calc:
<pre class="smallexample"> pragma Elaborate_All (Constants);
</pre>
<p class="noindent">which requires that the body (if any) and spec of <code>Constants</code>,
as well as the body and spec of any unit <code>with</code>'ed by
<code>Constants</code> be elaborated before <code>Calc</code> is elaborated.
<p>Clearly no automatic method can always guess which alternative you require,
and if you are working with legacy code that had constraints of this kind
which were not properly specified by adding <code>Elaborate</code> or
<code>Elaborate_All</code> pragmas, then indeed it is possible that two different
compilers can choose different orders.
<p>However, GNAT does attempt to diagnose the common situation where there
are uninitialized variables in the visible part of a package spec, and the
corresponding package body has an elaboration block that directly or
indirectly initialized one or more of these variables. This is the situation
in which a pragma Elaborate_Body is usually desirable, and GNAT will generate
a warning that suggests this addition if it detects this situation.
<p>The <code>gnatbind</code>
<samp><span class="option">-p</span></samp> switch may be useful in smoking
out problems. This switch causes bodies to be elaborated as late as possible
instead of as early as possible. In the example above, it would have forced
the choice of the first elaboration order. If you get different results
when using this switch, and particularly if one set of results is right,
and one is wrong as far as you are concerned, it shows that you have some
missing <code>Elaborate</code> pragmas. For the example above, we have the
following output:
<pre class="smallexample"> gnatmake -f -q main
main
7
gnatmake -f -q main -bargs -p
main
0
</pre>
<p class="noindent">It is of course quite unlikely that both these results are correct, so
it is up to you in a case like this to investigate the source of the
difference, by looking at the two elaboration orders that are chosen,
and figuring out which is correct, and then adding the necessary
<code>Elaborate</code> or <code>Elaborate_All</code> pragmas to ensure the desired order.
<!-- ******************************* -->
<div class="node">
<a name="Conditional-Compilation"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Inline-Assembler">Inline Assembler</a>,
Previous: <a rel="previous" accesskey="p" href="#Elaboration-Order-Handling-in-GNAT">Elaboration Order Handling in GNAT</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="appendix">Appendix D Conditional Compilation</h2>
<!-- ******************************* -->
<p><a name="index-Conditional-compilation-1034"></a>
It is often necessary to arrange for a single source program
to serve multiple purposes, where it is compiled in different
ways to achieve these different goals. Some examples of the
need for this feature are
<ul>
<li>Adapting a program to a different hardware environment
<li>Adapting a program to a different target architecture
<li>Turning debugging features on and off
<li>Arranging for a program to compile with different compilers
</ul>
<p class="noindent">In C, or C++, the typical approach would be to use the preprocessor
that is defined as part of the language. The Ada language does not
contain such a feature. This is not an oversight, but rather a very
deliberate design decision, based on the experience that overuse of
the preprocessing features in C and C++ can result in programs that
are extremely difficult to maintain. For example, if we have ten
switches that can be on or off, this means that there are a thousand
separate programs, any one of which might not even be syntactically
correct, and even if syntactically correct, the resulting program
might not work correctly. Testing all combinations can quickly become
impossible.
<p>Nevertheless, the need to tailor programs certainly exists, and in
this Appendix we will discuss how this can
be achieved using Ada in general, and GNAT in particular.
<ul class="menu">
<li><a accesskey="1" href="#Use-of-Boolean-Constants">Use of Boolean Constants</a>
<li><a accesskey="2" href="#Debugging-_002d-A-Special-Case">Debugging - A Special Case</a>
<li><a accesskey="3" href="#Conditionalizing-Declarations">Conditionalizing Declarations</a>
<li><a accesskey="4" href="#Use-of-Alternative-Implementations">Use of Alternative Implementations</a>
<li><a accesskey="5" href="#Preprocessing">Preprocessing</a>
</ul>
<div class="node">
<a name="Use-of-Boolean-Constants"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Debugging-_002d-A-Special-Case">Debugging - A Special Case</a>,
Up: <a rel="up" accesskey="u" href="#Conditional-Compilation">Conditional Compilation</a>
</div>
<h3 class="section">D.1 Use of Boolean Constants</h3>
<p class="noindent">In the case where the difference is simply which code
sequence is executed, the cleanest solution is to use Boolean
constants to control which code is executed.
<pre class="smallexample"> FP_Initialize_Required : constant Boolean := True;
...
if FP_Initialize_Required then
...
end if;
</pre>
<p class="noindent">Not only will the code inside the <code>if</code> statement not be executed if
the constant Boolean is <code>False</code>, but it will also be completely
deleted from the program.
However, the code is only deleted after the <code>if</code> statement
has been checked for syntactic and semantic correctness.
(In contrast, with preprocessors the code is deleted before the
compiler ever gets to see it, so it is not checked until the switch
is turned on.)
<a name="index-Preprocessors-_0028contrasted-with-conditional-compilation_0029-1035"></a>
Typically the Boolean constants will be in a separate package,
something like:
<pre class="smallexample"> package Config is
FP_Initialize_Required : constant Boolean := True;
Reset_Available : constant Boolean := False;
...
end Config;
</pre>
<p class="noindent">The <code>Config</code> package exists in multiple forms for the various targets,
with an appropriate script selecting the version of <code>Config</code> needed.
Then any other unit requiring conditional compilation can do a <code>with</code>
of <code>Config</code> to make the constants visible.
<div class="node">
<a name="Debugging---A-Special-Case"></a>
<a name="Debugging-_002d-A-Special-Case"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Conditionalizing-Declarations">Conditionalizing Declarations</a>,
Previous: <a rel="previous" accesskey="p" href="#Use-of-Boolean-Constants">Use of Boolean Constants</a>,
Up: <a rel="up" accesskey="u" href="#Conditional-Compilation">Conditional Compilation</a>
</div>
<h3 class="section">D.2 Debugging - A Special Case</h3>
<p class="noindent">A common use of conditional code is to execute statements (for example
dynamic checks, or output of intermediate results) under control of a
debug switch, so that the debugging behavior can be turned on and off.
This can be done using a Boolean constant to control whether the code
is active:
<pre class="smallexample"> if Debugging then
Put_Line ("got to the first stage!");
end if;
</pre>
<p class="noindent">or
<pre class="smallexample"> if Debugging and then Temperature > 999.0 then
raise Temperature_Crazy;
end if;
</pre>
<p class="noindent">Since this is a common case, there are special features to deal with
this in a convenient manner. For the case of tests, Ada 2005 has added
a pragma <code>Assert</code> that can be used for such tests. This pragma is modeled
<a name="index-pragma-_0040code_007bAssert_007d-1036"></a>on the <code>Assert</code> pragma that has always been available in GNAT, so this
feature may be used with GNAT even if you are not using Ada 2005 features.
The use of pragma <code>Assert</code> is described in
<a href="gnat_rm.html#Pragma-Assert">Pragma Assert</a>, but as an
example, the last test could be written:
<pre class="smallexample"> pragma Assert (Temperature <= 999.0, "Temperature Crazy");
</pre>
<p class="noindent">or simply
<pre class="smallexample"> pragma Assert (Temperature <= 999.0);
</pre>
<p class="noindent">In both cases, if assertions are active and the temperature is excessive,
the exception <code>Assert_Failure</code> will be raised, with the given string in
the first case or a string indicating the location of the pragma in the second
case used as the exception message.
<p>You can turn assertions on and off by using the <code>Assertion_Policy</code>
pragma.
<a name="index-pragma-_0040code_007bAssertion_005fPolicy_007d-1037"></a>This is an Ada 2005 pragma which is implemented in all modes by
GNAT, but only in the latest versions of GNAT which include Ada 2005
capability. Alternatively, you can use the <samp><span class="option">-gnata</span></samp> switch
<a name="index-g_t_0040option_007b_002dgnata_007d-switch-1038"></a>to enable assertions from the command line (this is recognized by all versions
of GNAT).
<p>For the example above with the <code>Put_Line</code>, the GNAT-specific pragma
<code>Debug</code> can be used:
<a name="index-pragma-_0040code_007bDebug_007d-1039"></a>
<pre class="smallexample"> pragma Debug (Put_Line ("got to the first stage!"));
</pre>
<p class="noindent">If debug pragmas are enabled, the argument, which must be of the form of
a procedure call, is executed (in this case, <code>Put_Line</code> will be called).
Only one call can be present, but of course a special debugging procedure
containing any code you like can be included in the program and then
called in a pragma <code>Debug</code> argument as needed.
<p>One advantage of pragma <code>Debug</code> over the <code>if Debugging then</code>
construct is that pragma <code>Debug</code> can appear in declarative contexts,
such as at the very beginning of a procedure, before local declarations have
been elaborated.
<p>Debug pragmas are enabled using either the <samp><span class="option">-gnata</span></samp> switch that also
controls assertions, or with a separate Debug_Policy pragma.
<a name="index-pragma-_0040code_007bDebug_005fPolicy_007d-1040"></a>The latter pragma is new in the Ada 2005 versions of GNAT (but it can be used
in Ada 95 and Ada 83 programs as well), and is analogous to
pragma <code>Assertion_Policy</code> to control assertions.
<p><code>Assertion_Policy</code> and <code>Debug_Policy</code> are configuration pragmas,
and thus they can appear in <samp><span class="file">gnat.adc</span></samp> if you are not using a
project file, or in the file designated to contain configuration pragmas
in a project file.
They then apply to all subsequent compilations. In practice the use of
the <samp><span class="option">-gnata</span></samp> switch is often the most convenient method of controlling
the status of these pragmas.
<p>Note that a pragma is not a statement, so in contexts where a statement
sequence is required, you can't just write a pragma on its own. You have
to add a <code>null</code> statement.
<pre class="smallexample"> if ... then
... -- some statements
else
pragma Assert (Num_Cases < 10);
null;
end if;
</pre>
<div class="node">
<a name="Conditionalizing-Declarations"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Use-of-Alternative-Implementations">Use of Alternative Implementations</a>,
Previous: <a rel="previous" accesskey="p" href="#Debugging-_002d-A-Special-Case">Debugging - A Special Case</a>,
Up: <a rel="up" accesskey="u" href="#Conditional-Compilation">Conditional Compilation</a>
</div>
<h3 class="section">D.3 Conditionalizing Declarations</h3>
<p class="noindent">In some cases, it may be necessary to conditionalize declarations to meet
different requirements. For example we might want a bit string whose length
is set to meet some hardware message requirement.
<p>In some cases, it may be possible to do this using declare blocks controlled
by conditional constants:
<pre class="smallexample"> if Small_Machine then
declare
X : Bit_String (1 .. 10);
begin
...
end;
else
declare
X : Large_Bit_String (1 .. 1000);
begin
...
end;
end if;
</pre>
<p class="noindent">Note that in this approach, both declarations are analyzed by the
compiler so this can only be used where both declarations are legal,
even though one of them will not be used.
<p>Another approach is to define integer constants, e.g. <code>Bits_Per_Word</code>,
or Boolean constants, e.g. <code>Little_Endian</code>, and then write declarations
that are parameterized by these constants. For example
<pre class="smallexample"> for Rec use
Field1 at 0 range Boolean'Pos (Little_Endian) * 10 .. Bits_Per_Word;
end record;
</pre>
<p class="noindent">If <code>Bits_Per_Word</code> is set to 32, this generates either
<pre class="smallexample"> for Rec use
Field1 at 0 range 0 .. 32;
end record;
</pre>
<p class="noindent">for the big endian case, or
<pre class="smallexample"> for Rec use record
Field1 at 0 range 10 .. 32;
end record;
</pre>
<p class="noindent">for the little endian case. Since a powerful subset of Ada expression
notation is usable for creating static constants, clever use of this
feature can often solve quite difficult problems in conditionalizing
compilation (note incidentally that in Ada 95, the little endian
constant was introduced as <code>System.Default_Bit_Order</code>, so you do not
need to define this one yourself).
<div class="node">
<a name="Use-of-Alternative-Implementations"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Preprocessing">Preprocessing</a>,
Previous: <a rel="previous" accesskey="p" href="#Conditionalizing-Declarations">Conditionalizing Declarations</a>,
Up: <a rel="up" accesskey="u" href="#Conditional-Compilation">Conditional Compilation</a>
</div>
<h3 class="section">D.4 Use of Alternative Implementations</h3>
<p class="noindent">In some cases, none of the approaches described above are adequate. This
can occur for example if the set of declarations required is radically
different for two different configurations.
<p>In this situation, the official Ada way of dealing with conditionalizing
such code is to write separate units for the different cases. As long as
this does not result in excessive duplication of code, this can be done
without creating maintenance problems. The approach is to share common
code as far as possible, and then isolate the code and declarations
that are different. Subunits are often a convenient method for breaking
out a piece of a unit that is to be conditionalized, with separate files
for different versions of the subunit for different targets, where the
build script selects the right one to give to the compiler.
<a name="index-Subunits-_0028and-conditional-compilation_0029-1041"></a>
As an example, consider a situation where a new feature in Ada 2005
allows something to be done in a really nice way. But your code must be able
to compile with an Ada 95 compiler. Conceptually you want to say:
<pre class="smallexample"> if Ada_2005 then
... neat Ada 2005 code
else
... not quite as neat Ada 95 code
end if;
</pre>
<p class="noindent">where <code>Ada_2005</code> is a Boolean constant.
<p>But this won't work when <code>Ada_2005</code> is set to <code>False</code>,
since the <code>then</code> clause will be illegal for an Ada 95 compiler.
(Recall that although such unreachable code would eventually be deleted
by the compiler, it still needs to be legal. If it uses features
introduced in Ada 2005, it will be illegal in Ada 95.)
<p>So instead we write
<pre class="smallexample"> procedure Insert is separate;
</pre>
<p class="noindent">Then we have two files for the subunit <code>Insert</code>, with the two sets of
code.
If the package containing this is called <code>File_Queries</code>, then we might
have two files
<ul>
<li><samp><span class="file">file_queries-insert-2005.adb</span></samp>
<li><samp><span class="file">file_queries-insert-95.adb</span></samp>
</ul>
<p class="noindent">and the build script renames the appropriate file to
<pre class="smallexample"> file_queries-insert.adb
</pre>
<p class="noindent">and then carries out the compilation.
<p>This can also be done with project files' naming schemes. For example:
<pre class="smallexample"> For Body ("File_Queries.Insert") use "file_queries-insert-2005.ada";
</pre>
<p class="noindent">Note also that with project files it is desirable to use a different extension
than <samp><span class="file">ads</span></samp> / <samp><span class="file">adb</span></samp> for alternative versions. Otherwise a naming
conflict may arise through another commonly used feature: to declare as part
of the project a set of directories containing all the sources obeying the
default naming scheme.
<p>The use of alternative units is certainly feasible in all situations,
and for example the Ada part of the GNAT run-time is conditionalized
based on the target architecture using this approach. As a specific example,
consider the implementation of the AST feature in VMS. There is one
spec:
<pre class="smallexample"> s-asthan.ads
</pre>
<p class="noindent">which is the same for all architectures, and three bodies:
<dl>
<dt><samp><span class="file">s-asthan.adb</span></samp><dd>used for all non-VMS operating systems
<br><dt><samp><span class="file">s-asthan-vms-alpha.adb</span></samp><dd>used for VMS on the Alpha
<br><dt><samp><span class="file">s-asthan-vms-ia64.adb</span></samp><dd>used for VMS on the ia64
</dl>
<p class="noindent">The dummy version <samp><span class="file">s-asthan.adb</span></samp> simply raises exceptions noting that
this operating system feature is not available, and the two remaining
versions interface with the corresponding versions of VMS to provide
VMS-compatible AST handling. The GNAT build script knows the architecture
and operating system, and automatically selects the right version,
renaming it if necessary to <samp><span class="file">s-asthan.adb</span></samp> before the run-time build.
<p>Another style for arranging alternative implementations is through Ada's
access-to-subprogram facility.
In case some functionality is to be conditionally included,
you can declare an access-to-procedure variable <code>Ref</code> that is initialized
to designate a “do nothing” procedure, and then invoke <code>Ref.all</code>
when appropriate.
In some library package, set <code>Ref</code> to <code>Proc'Access</code> for some
procedure <code>Proc</code> that performs the relevant processing.
The initialization only occurs if the library package is included in the
program.
The same idea can also be implemented using tagged types and dispatching
calls.
<div class="node">
<a name="Preprocessing"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Use-of-Alternative-Implementations">Use of Alternative Implementations</a>,
Up: <a rel="up" accesskey="u" href="#Conditional-Compilation">Conditional Compilation</a>
</div>
<h3 class="section">D.5 Preprocessing</h3>
<p><a name="index-Preprocessing-1042"></a>
Although it is quite possible to conditionalize code without the use of
C-style preprocessing, as described earlier in this section, it is
nevertheless convenient in some cases to use the C approach. Moreover,
older Ada compilers have often provided some preprocessing capability,
so legacy code may depend on this approach, even though it is not
standard.
<p>To accommodate such use, GNAT provides a preprocessor (modeled to a large
extent on the various preprocessors that have been used
with legacy code on other compilers, to enable easier transition).
<p>The preprocessor may be used in two separate modes. It can be used quite
separately from the compiler, to generate a separate output source file
that is then fed to the compiler as a separate step. This is the
<code>gnatprep</code> utility, whose use is fully described in
<a href="#Preprocessing-Using-gnatprep">Preprocessing Using gnatprep</a>.
<a name="index-g_t_0040code_007bgnatprep_007d-1043"></a>
The preprocessing language allows such constructs as
<pre class="smallexample"> #if DEBUG or PRIORITY > 4 then
bunch of declarations
#else
completely different bunch of declarations
#end if;
</pre>
<p class="noindent">The values of the symbols <code>DEBUG</code> and <code>PRIORITY</code> can be
defined either on the command line or in a separate file.
<p>The other way of running the preprocessor is even closer to the C style and
often more convenient. In this approach the preprocessing is integrated into
the compilation process. The compiler is fed the preprocessor input which
includes <code>#if</code> lines etc, and then the compiler carries out the
preprocessing internally and processes the resulting output.
For more details on this approach, see <a href="#Integrated-Preprocessing">Integrated Preprocessing</a>.
<!-- ******************************* -->
<div class="node">
<a name="Inline-Assembler"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Compatibility-and-Porting-Guide">Compatibility and Porting Guide</a>,
Previous: <a rel="previous" accesskey="p" href="#Conditional-Compilation">Conditional Compilation</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="appendix">Appendix E Inline Assembler</h2>
<!-- ******************************* -->
<p class="noindent">If you need to write low-level software that interacts directly
with the hardware, Ada provides two ways to incorporate assembly
language code into your program. First, you can import and invoke
external routines written in assembly language, an Ada feature fully
supported by GNAT. However, for small sections of code it may be simpler
or more efficient to include assembly language statements directly
in your Ada source program, using the facilities of the implementation-defined
package <code>System.Machine_Code</code>, which incorporates the gcc
Inline Assembler. The Inline Assembler approach offers a number of advantages,
including the following:
<ul>
<li>No need to use non-Ada tools
<li>Consistent interface over different targets
<li>Automatic usage of the proper calling conventions
<li>Access to Ada constants and variables
<li>Definition of intrinsic routines
<li>Possibility of inlining a subprogram comprising assembler code
<li>Code optimizer can take Inline Assembler code into account
</ul>
<p>This chapter presents a series of examples to show you how to use
the Inline Assembler. Although it focuses on the Intel x86,
the general approach applies also to other processors.
It is assumed that you are familiar with Ada
and with assembly language programming.
<ul class="menu">
<li><a accesskey="1" href="#Basic-Assembler-Syntax">Basic Assembler Syntax</a>
<li><a accesskey="2" href="#A-Simple-Example-of-Inline-Assembler">A Simple Example of Inline Assembler</a>
<li><a accesskey="3" href="#Output-Variables-in-Inline-Assembler">Output Variables in Inline Assembler</a>
<li><a accesskey="4" href="#Input-Variables-in-Inline-Assembler">Input Variables in Inline Assembler</a>
<li><a accesskey="5" href="#Inlining-Inline-Assembler-Code">Inlining Inline Assembler Code</a>
<li><a accesskey="6" href="#Other-Asm-Functionality">Other Asm Functionality</a>
</ul>
<!-- -->
<div class="node">
<a name="Basic-Assembler-Syntax"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#A-Simple-Example-of-Inline-Assembler">A Simple Example of Inline Assembler</a>,
Up: <a rel="up" accesskey="u" href="#Inline-Assembler">Inline Assembler</a>
</div>
<h3 class="section">E.1 Basic Assembler Syntax</h3>
<p class="noindent">The assembler used by GNAT and gcc is based not on the Intel assembly
language, but rather on a language that descends from the AT&T Unix
assembler <em>as</em> (and which is often referred to as “AT&T syntax”).
The following table summarizes the main features of <em>as</em> syntax
and points out the differences from the Intel conventions.
See the gcc <em>as</em> and <em>gas</em> (an <em>as</em> macro
pre-processor) documentation for further information.
<dl>
<dt>Register names<dd>gcc / <em>as</em>: Prefix with “%”; for example <code>%eax</code>
<br>
Intel: No extra punctuation; for example <code>eax</code>
<br><dt>Immediate operand<dd>gcc / <em>as</em>: Prefix with “$”; for example <code>$4</code>
<br>
Intel: No extra punctuation; for example <code>4</code>
<br><dt>Address<dd>gcc / <em>as</em>: Prefix with “$”; for example <code>$loc</code>
<br>
Intel: No extra punctuation; for example <code>loc</code>
<br><dt>Memory contents<dd>gcc / <em>as</em>: No extra punctuation; for example <code>loc</code>
<br>
Intel: Square brackets; for example <code>[loc]</code>
<br><dt>Register contents<dd>gcc / <em>as</em>: Parentheses; for example <code>(%eax)</code>
<br>
Intel: Square brackets; for example <code>[eax]</code>
<br><dt>Hexadecimal numbers<dd>gcc / <em>as</em>: Leading “0x” (C language syntax); for example <code>0xA0</code>
<br>
Intel: Trailing “h”; for example <code>A0h</code>
<br><dt>Operand size<dd>gcc / <em>as</em>: Explicit in op code; for example <code>movw</code> to move
a 16-bit word
<br>
Intel: Implicit, deduced by assembler; for example <code>mov</code>
<br><dt>Instruction repetition<dd>gcc / <em>as</em>: Split into two lines; for example
<br>
<code>rep</code>
<br>
<code>stosl</code>
<br>
Intel: Keep on one line; for example <code>rep stosl</code>
<br><dt>Order of operands<dd>gcc / <em>as</em>: Source first; for example <code>movw $4, %eax</code>
<br>
Intel: Destination first; for example <code>mov eax, 4</code>
</dl>
<!-- -->
<div class="node">
<a name="A-Simple-Example-of-Inline-Assembler"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Output-Variables-in-Inline-Assembler">Output Variables in Inline Assembler</a>,
Previous: <a rel="previous" accesskey="p" href="#Basic-Assembler-Syntax">Basic Assembler Syntax</a>,
Up: <a rel="up" accesskey="u" href="#Inline-Assembler">Inline Assembler</a>
</div>
<h3 class="section">E.2 A Simple Example of Inline Assembler</h3>
<p class="noindent">The following example will generate a single assembly language statement,
<code>nop</code>, which does nothing. Despite its lack of run-time effect,
the example will be useful in illustrating the basics of
the Inline Assembler facility.
<pre class="smallexample"> with System.Machine_Code; use System.Machine_Code;
procedure Nothing is
begin
Asm ("nop");
end Nothing;
</pre>
<p><code>Asm</code> is a procedure declared in package <code>System.Machine_Code</code>;
here it takes one parameter, a <em>template string</em> that must be a static
expression and that will form the generated instruction.
<code>Asm</code> may be regarded as a compile-time procedure that parses
the template string and additional parameters (none here),
from which it generates a sequence of assembly language instructions.
<p>The examples in this chapter will illustrate several of the forms
for invoking <code>Asm</code>; a complete specification of the syntax
is found in <a href="gnat_rm.html#Machine-Code-Insertions">Machine Code Insertions</a>.
<p>Under the standard GNAT conventions, the <code>Nothing</code> procedure
should be in a file named <samp><span class="file">nothing.adb</span></samp>.
You can build the executable in the usual way:
<pre class="smallexample"> gnatmake nothing
</pre>
<p>However, the interesting aspect of this example is not its run-time behavior
but rather the generated assembly code.
To see this output, invoke the compiler as follows:
<pre class="smallexample"> gcc -c -S -fomit-frame-pointer -gnatp <samp><span class="file">nothing.adb</span></samp>
</pre>
<p>where the options are:
<dl>
<dt><code>-c</code><dd>compile only (no bind or link)
<br><dt><code>-S</code><dd>generate assembler listing
<br><dt><code>-fomit-frame-pointer</code><dd>do not set up separate stack frames
<br><dt><code>-gnatp</code><dd>do not add runtime checks
</dl>
<p>This gives a human-readable assembler version of the code. The resulting
file will have the same name as the Ada source file, but with a <code>.s</code>
extension. In our example, the file <samp><span class="file">nothing.s</span></samp> has the following
contents:
<pre class="smallexample"> .file "nothing.adb"
gcc2_compiled.:
___gnu_compiled_ada:
.text
.align 4
.globl __ada_nothing
__ada_nothing:
#APP
nop
#NO_APP
jmp L1
.align 2,0x90
L1:
ret
</pre>
<p>The assembly code you included is clearly indicated by
the compiler, between the <code>#APP</code> and <code>#NO_APP</code>
delimiters. The character before the 'APP' and 'NOAPP'
can differ on different targets. For example, GNU/Linux uses '#APP' while
on NT you will see '/APP'.
<p>If you make a mistake in your assembler code (such as using the
wrong size modifier, or using a wrong operand for the instruction) GNAT
will report this error in a temporary file, which will be deleted when
the compilation is finished. Generating an assembler file will help
in such cases, since you can assemble this file separately using the
<em>as</em> assembler that comes with gcc.
<p>Assembling the file using the command
<pre class="smallexample"> as <samp><span class="file">nothing.s</span></samp>
</pre>
<p class="noindent">will give you error messages whose lines correspond to the assembler
input file, so you can easily find and correct any mistakes you made.
If there are no errors, <em>as</em> will generate an object file
<samp><span class="file">nothing.out</span></samp>.
<!-- -->
<div class="node">
<a name="Output-Variables-in-Inline-Assembler"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Input-Variables-in-Inline-Assembler">Input Variables in Inline Assembler</a>,
Previous: <a rel="previous" accesskey="p" href="#A-Simple-Example-of-Inline-Assembler">A Simple Example of Inline Assembler</a>,
Up: <a rel="up" accesskey="u" href="#Inline-Assembler">Inline Assembler</a>
</div>
<h3 class="section">E.3 Output Variables in Inline Assembler</h3>
<p class="noindent">The examples in this section, showing how to access the processor flags,
illustrate how to specify the destination operands for assembly language
statements.
<pre class="smallexample"> with Interfaces; use Interfaces;
with Ada.Text_IO; use Ada.Text_IO;
with System.Machine_Code; use System.Machine_Code;
procedure Get_Flags is
Flags : Unsigned_32;
use ASCII;
begin
Asm ("pushfl" & LF & HT & -- push flags on stack
"popl %%eax" & LF & HT & -- load eax with flags
"movl %%eax, %0", -- store flags in variable
Outputs => Unsigned_32'Asm_Output ("=g", Flags));
Put_Line ("Flags register:" & Flags'Img);
end Get_Flags;
</pre>
<p>In order to have a nicely aligned assembly listing, we have separated
multiple assembler statements in the Asm template string with linefeed
(ASCII.LF) and horizontal tab (ASCII.HT) characters.
The resulting section of the assembly output file is:
<pre class="smallexample"> #APP
pushfl
popl %eax
movl %eax, -40(%ebp)
#NO_APP
</pre>
<p>It would have been legal to write the Asm invocation as:
<pre class="smallexample"> Asm ("pushfl popl %%eax movl %%eax, %0")
</pre>
<p>but in the generated assembler file, this would come out as:
<pre class="smallexample"> #APP
pushfl popl %eax movl %eax, -40(%ebp)
#NO_APP
</pre>
<p>which is not so convenient for the human reader.
<p>We use Ada comments
at the end of each line to explain what the assembler instructions
actually do. This is a useful convention.
<p>When writing Inline Assembler instructions, you need to precede each register
and variable name with a percent sign. Since the assembler already requires
a percent sign at the beginning of a register name, you need two consecutive
percent signs for such names in the Asm template string, thus <code>%%eax</code>.
In the generated assembly code, one of the percent signs will be stripped off.
<p>Names such as <code>%0</code>, <code>%1</code>, <code>%2</code>, etc., denote input or output
variables: operands you later define using <code>Input</code> or <code>Output</code>
parameters to <code>Asm</code>.
An output variable is illustrated in
the third statement in the Asm template string:
<pre class="smallexample"> movl %%eax, %0
</pre>
<p>The intent is to store the contents of the eax register in a variable that can
be accessed in Ada. Simply writing <code>movl %%eax, Flags</code> would not
necessarily work, since the compiler might optimize by using a register
to hold Flags, and the expansion of the <code>movl</code> instruction would not be
aware of this optimization. The solution is not to store the result directly
but rather to advise the compiler to choose the correct operand form;
that is the purpose of the <code>%0</code> output variable.
<p>Information about the output variable is supplied in the <code>Outputs</code>
parameter to <code>Asm</code>:
<pre class="smallexample"> Outputs => Unsigned_32'Asm_Output ("=g", Flags));
</pre>
<p>The output is defined by the <code>Asm_Output</code> attribute of the target type;
the general format is
<pre class="smallexample"> Type'Asm_Output (constraint_string, variable_name)
</pre>
<p>The constraint string directs the compiler how
to store/access the associated variable. In the example
<pre class="smallexample"> Unsigned_32'Asm_Output ("=m", Flags);
</pre>
<p>the <code>"m"</code> (memory) constraint tells the compiler that the variable
<code>Flags</code> should be stored in a memory variable, thus preventing
the optimizer from keeping it in a register. In contrast,
<pre class="smallexample"> Unsigned_32'Asm_Output ("=r", Flags);
</pre>
<p>uses the <code>"r"</code> (register) constraint, telling the compiler to
store the variable in a register.
<p>If the constraint is preceded by the equal character (<strong>=</strong>), it tells
the compiler that the variable will be used to store data into it.
<p>In the <code>Get_Flags</code> example, we used the <code>"g"</code> (global) constraint,
allowing the optimizer to choose whatever it deems best.
<p>There are a fairly large number of constraints, but the ones that are
most useful (for the Intel x86 processor) are the following:
<dl>
<dt><code>=</code><dd>output constraint
<br><dt><code>g</code><dd>global (i.e. can be stored anywhere)
<br><dt><code>m</code><dd>in memory
<br><dt><code>I</code><dd>a constant
<br><dt><code>a</code><dd>use eax
<br><dt><code>b</code><dd>use ebx
<br><dt><code>c</code><dd>use ecx
<br><dt><code>d</code><dd>use edx
<br><dt><code>S</code><dd>use esi
<br><dt><code>D</code><dd>use edi
<br><dt><code>r</code><dd>use one of eax, ebx, ecx or edx
<br><dt><code>q</code><dd>use one of eax, ebx, ecx, edx, esi or edi
</dl>
<p>The full set of constraints is described in the gcc and <em>as</em>
documentation; note that it is possible to combine certain constraints
in one constraint string.
<p>You specify the association of an output variable with an assembler operand
through the <code>%</code><em>n</em> notation, where <em>n</em> is a non-negative
integer. Thus in
<pre class="smallexample"> Asm ("pushfl" & LF & HT & -- push flags on stack
"popl %%eax" & LF & HT & -- load eax with flags
"movl %%eax, %0", -- store flags in variable
Outputs => Unsigned_32'Asm_Output ("=g", Flags));
</pre>
<p class="noindent"><code>%0</code> will be replaced in the expanded code by the appropriate operand,
whatever
the compiler decided for the <code>Flags</code> variable.
<p>In general, you may have any number of output variables:
<ul>
<li>Count the operands starting at 0; thus <code>%0</code>, <code>%1</code>, etc.
<li>Specify the <code>Outputs</code> parameter as a parenthesized comma-separated list
of <code>Asm_Output</code> attributes
</ul>
<p>For example:
<pre class="smallexample"> Asm ("movl %%eax, %0" & LF & HT &
"movl %%ebx, %1" & LF & HT &
"movl %%ecx, %2",
Outputs => (Unsigned_32'Asm_Output ("=g", Var_A), -- %0 = Var_A
Unsigned_32'Asm_Output ("=g", Var_B), -- %1 = Var_B
Unsigned_32'Asm_Output ("=g", Var_C))); -- %2 = Var_C
</pre>
<p class="noindent">where <code>Var_A</code>, <code>Var_B</code>, and <code>Var_C</code> are variables
in the Ada program.
<p>As a variation on the <code>Get_Flags</code> example, we can use the constraints
string to direct the compiler to store the eax register into the <code>Flags</code>
variable, instead of including the store instruction explicitly in the
<code>Asm</code> template string:
<pre class="smallexample"> with Interfaces; use Interfaces;
with Ada.Text_IO; use Ada.Text_IO;
with System.Machine_Code; use System.Machine_Code;
procedure Get_Flags_2 is
Flags : Unsigned_32;
use ASCII;
begin
Asm ("pushfl" & LF & HT & -- push flags on stack
"popl %%eax", -- save flags in eax
Outputs => Unsigned_32'Asm_Output ("=a", Flags));
Put_Line ("Flags register:" & Flags'Img);
end Get_Flags_2;
</pre>
<p class="noindent">The <code>"a"</code> constraint tells the compiler that the <code>Flags</code>
variable will come from the eax register. Here is the resulting code:
<pre class="smallexample"> #APP
pushfl
popl %eax
#NO_APP
movl %eax,-40(%ebp)
</pre>
<p class="noindent">The compiler generated the store of eax into Flags after
expanding the assembler code.
<p>Actually, there was no need to pop the flags into the eax register;
more simply, we could just pop the flags directly into the program variable:
<pre class="smallexample"> with Interfaces; use Interfaces;
with Ada.Text_IO; use Ada.Text_IO;
with System.Machine_Code; use System.Machine_Code;
procedure Get_Flags_3 is
Flags : Unsigned_32;
use ASCII;
begin
Asm ("pushfl" & LF & HT & -- push flags on stack
"pop %0", -- save flags in Flags
Outputs => Unsigned_32'Asm_Output ("=g", Flags));
Put_Line ("Flags register:" & Flags'Img);
end Get_Flags_3;
</pre>
<!-- -->
<div class="node">
<a name="Input-Variables-in-Inline-Assembler"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Inlining-Inline-Assembler-Code">Inlining Inline Assembler Code</a>,
Previous: <a rel="previous" accesskey="p" href="#Output-Variables-in-Inline-Assembler">Output Variables in Inline Assembler</a>,
Up: <a rel="up" accesskey="u" href="#Inline-Assembler">Inline Assembler</a>
</div>
<h3 class="section">E.4 Input Variables in Inline Assembler</h3>
<p class="noindent">The example in this section illustrates how to specify the source operands
for assembly language statements.
The program simply increments its input value by 1:
<pre class="smallexample"> with Interfaces; use Interfaces;
with Ada.Text_IO; use Ada.Text_IO;
with System.Machine_Code; use System.Machine_Code;
procedure Increment is
function Incr (Value : Unsigned_32) return Unsigned_32 is
Result : Unsigned_32;
begin
Asm ("incl %0",
Inputs => Unsigned_32'Asm_Input ("a", Value),
Outputs => Unsigned_32'Asm_Output ("=a", Result));
return Result;
end Incr;
Value : Unsigned_32;
begin
Value := 5;
Put_Line ("Value before is" & Value'Img);
Value := Incr (Value);
Put_Line ("Value after is" & Value'Img);
end Increment;
</pre>
<p>The <code>Outputs</code> parameter to <code>Asm</code> specifies
that the result will be in the eax register and that it is to be stored
in the <code>Result</code> variable.
<p>The <code>Inputs</code> parameter looks much like the <code>Outputs</code> parameter,
but with an <code>Asm_Input</code> attribute.
The <code>"="</code> constraint, indicating an output value, is not present.
<p>You can have multiple input variables, in the same way that you can have more
than one output variable.
<p>The parameter count (%0, %1) etc, now starts at the first input
statement, and continues with the output statements.
When both parameters use the same variable, the
compiler will treat them as the same %n operand, which is the case here.
<p>Just as the <code>Outputs</code> parameter causes the register to be stored into the
target variable after execution of the assembler statements, so does the
<code>Inputs</code> parameter cause its variable to be loaded into the register
before execution of the assembler statements.
<p>Thus the effect of the <code>Asm</code> invocation is:
<ol type=1 start=1>
<li>load the 32-bit value of <code>Value</code> into eax
<li>execute the <code>incl %eax</code> instruction
<li>store the contents of eax into the <code>Result</code> variable
</ol>
<p>The resulting assembler file (with <samp><span class="option">-O2</span></samp> optimization) contains:
<pre class="smallexample"> _increment__incr.1:
subl $4,%esp
movl 8(%esp),%eax
#APP
incl %eax
#NO_APP
movl %eax,%edx
movl %ecx,(%esp)
addl $4,%esp
ret
</pre>
<!-- -->
<div class="node">
<a name="Inlining-Inline-Assembler-Code"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Other-Asm-Functionality">Other Asm Functionality</a>,
Previous: <a rel="previous" accesskey="p" href="#Input-Variables-in-Inline-Assembler">Input Variables in Inline Assembler</a>,
Up: <a rel="up" accesskey="u" href="#Inline-Assembler">Inline Assembler</a>
</div>
<h3 class="section">E.5 Inlining Inline Assembler Code</h3>
<p class="noindent">For a short subprogram such as the <code>Incr</code> function in the previous
section, the overhead of the call and return (creating / deleting the stack
frame) can be significant, compared to the amount of code in the subprogram
body. A solution is to apply Ada's <code>Inline</code> pragma to the subprogram,
which directs the compiler to expand invocations of the subprogram at the
point(s) of call, instead of setting up a stack frame for out-of-line calls.
Here is the resulting program:
<pre class="smallexample"> with Interfaces; use Interfaces;
with Ada.Text_IO; use Ada.Text_IO;
with System.Machine_Code; use System.Machine_Code;
procedure Increment_2 is
function Incr (Value : Unsigned_32) return Unsigned_32 is
Result : Unsigned_32;
begin
Asm ("incl %0",
Inputs => Unsigned_32'Asm_Input ("a", Value),
Outputs => Unsigned_32'Asm_Output ("=a", Result));
return Result;
end Incr;
pragma Inline (Increment);
Value : Unsigned_32;
begin
Value := 5;
Put_Line ("Value before is" & Value'Img);
Value := Increment (Value);
Put_Line ("Value after is" & Value'Img);
end Increment_2;
</pre>
<p>Compile the program with both optimization (<samp><span class="option">-O2</span></samp>) and inlining
(<samp><span class="option">-gnatn</span></samp>) enabled.
<p>The <code>Incr</code> function is still compiled as usual, but at the
point in <code>Increment</code> where our function used to be called:
<pre class="smallexample"> pushl %edi
call _increment__incr.1
</pre>
<p class="noindent">the code for the function body directly appears:
<pre class="smallexample"> movl %esi,%eax
#APP
incl %eax
#NO_APP
movl %eax,%edx
</pre>
<p class="noindent">thus saving the overhead of stack frame setup and an out-of-line call.
<!-- -->
<div class="node">
<a name="Other-Asm-Functionality"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Inlining-Inline-Assembler-Code">Inlining Inline Assembler Code</a>,
Up: <a rel="up" accesskey="u" href="#Inline-Assembler">Inline Assembler</a>
</div>
<h3 class="section">E.6 Other <code>Asm</code> Functionality</h3>
<p class="noindent">This section describes two important parameters to the <code>Asm</code>
procedure: <code>Clobber</code>, which identifies register usage;
and <code>Volatile</code>, which inhibits unwanted optimizations.
<ul class="menu">
<li><a accesskey="1" href="#The-Clobber-Parameter">The Clobber Parameter</a>
<li><a accesskey="2" href="#The-Volatile-Parameter">The Volatile Parameter</a>
</ul>
<!-- -->
<div class="node">
<a name="The-Clobber-Parameter"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#The-Volatile-Parameter">The Volatile Parameter</a>,
Up: <a rel="up" accesskey="u" href="#Other-Asm-Functionality">Other Asm Functionality</a>
</div>
<h4 class="subsection">E.6.1 The <code>Clobber</code> Parameter</h4>
<p class="noindent">One of the dangers of intermixing assembly language and a compiled language
such as Ada is that the compiler needs to be aware of which registers are
being used by the assembly code. In some cases, such as the earlier examples,
the constraint string is sufficient to indicate register usage (e.g.,
<code>"a"</code> for
the eax register). But more generally, the compiler needs an explicit
identification of the registers that are used by the Inline Assembly
statements.
<p>Using a register that the compiler doesn't know about
could be a side effect of an instruction (like <code>mull</code>
storing its result in both eax and edx).
It can also arise from explicit register usage in your
assembly code; for example:
<pre class="smallexample"> Asm ("movl %0, %%ebx" & LF & HT &
"movl %%ebx, %1",
Inputs => Unsigned_32'Asm_Input ("g", Var_In),
Outputs => Unsigned_32'Asm_Output ("=g", Var_Out));
</pre>
<p class="noindent">where the compiler (since it does not analyze the <code>Asm</code> template string)
does not know you are using the ebx register.
<p>In such cases you need to supply the <code>Clobber</code> parameter to <code>Asm</code>,
to identify the registers that will be used by your assembly code:
<pre class="smallexample"> Asm ("movl %0, %%ebx" & LF & HT &
"movl %%ebx, %1",
Inputs => Unsigned_32'Asm_Input ("g", Var_In),
Outputs => Unsigned_32'Asm_Output ("=g", Var_Out),
Clobber => "ebx");
</pre>
<p>The Clobber parameter is a static string expression specifying the
register(s) you are using. Note that register names are <em>not</em> prefixed
by a percent sign. Also, if more than one register is used then their names
are separated by commas; e.g., <code>"eax, ebx"</code>
<p>The <code>Clobber</code> parameter has several additional uses:
<ol type=1 start=1>
<li>Use “register” name <code>cc</code> to indicate that flags might have changed
<li>Use “register” name <code>memory</code> if you changed a memory location
</ol>
<!-- -->
<div class="node">
<a name="The-Volatile-Parameter"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#The-Clobber-Parameter">The Clobber Parameter</a>,
Up: <a rel="up" accesskey="u" href="#Other-Asm-Functionality">Other Asm Functionality</a>
</div>
<h4 class="subsection">E.6.2 The <code>Volatile</code> Parameter</h4>
<p><a name="index-Volatile-parameter-1044"></a>
Compiler optimizations in the presence of Inline Assembler may sometimes have
unwanted effects. For example, when an <code>Asm</code> invocation with an input
variable is inside a loop, the compiler might move the loading of the input
variable outside the loop, regarding it as a one-time initialization.
<p>If this effect is not desired, you can disable such optimizations by setting
the <code>Volatile</code> parameter to <code>True</code>; for example:
<pre class="smallexample"> Asm ("movl %0, %%ebx" & LF & HT &
"movl %%ebx, %1",
Inputs => Unsigned_32'Asm_Input ("g", Var_In),
Outputs => Unsigned_32'Asm_Output ("=g", Var_Out),
Clobber => "ebx",
Volatile => True);
</pre>
<p>By default, <code>Volatile</code> is set to <code>False</code> unless there is no
<code>Outputs</code> parameter.
<p>Although setting <code>Volatile</code> to <code>True</code> prevents unwanted
optimizations, it will also disable other optimizations that might be
important for efficiency. In general, you should set <code>Volatile</code>
to <code>True</code> only if the compiler's optimizations have created
problems.
<!-- END OF INLINE ASSEMBLER CHAPTER -->
<!-- =============================== -->
<!-- *********************************** -->
<!-- * Compatibility and Porting Guide * -->
<!-- *********************************** -->
<div class="node">
<a name="Compatibility-and-Porting-Guide"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Microsoft-Windows-Topics">Microsoft Windows Topics</a>,
Previous: <a rel="previous" accesskey="p" href="#Inline-Assembler">Inline Assembler</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="appendix">Appendix F Compatibility and Porting Guide</h2>
<p class="noindent">This chapter describes the compatibility issues that may arise between
GNAT and other Ada compilation systems (including those for Ada 83),
and shows how GNAT can expedite porting
applications developed in other Ada environments.
<ul class="menu">
<li><a accesskey="1" href="#Compatibility-with-Ada-83">Compatibility with Ada 83</a>
<li><a accesskey="2" href="#Compatibility-between-Ada-95-and-Ada-2005">Compatibility between Ada 95 and Ada 2005</a>
<li><a accesskey="3" href="#Implementation_002ddependent-characteristics">Implementation-dependent characteristics</a>
<li><a accesskey="4" href="#Compatibility-with-Other-Ada-Systems">Compatibility with Other Ada Systems</a>
<li><a accesskey="5" href="#Representation-Clauses">Representation Clauses</a>
<!-- Brief section is only in non-VMS version -->
<!-- Full chapter is in VMS version -->
<li><a accesskey="6" href="#Compatibility-with-HP-Ada-83">Compatibility with HP Ada 83</a>
</ul>
<div class="node">
<a name="Compatibility-with-Ada-83"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Compatibility-between-Ada-95-and-Ada-2005">Compatibility between Ada 95 and Ada 2005</a>,
Up: <a rel="up" accesskey="u" href="#Compatibility-and-Porting-Guide">Compatibility and Porting Guide</a>
</div>
<h3 class="section">F.1 Compatibility with Ada 83</h3>
<p><a name="index-Compatibility-_0028between-Ada-83-and-Ada-95-_002f-Ada-2005_0029-1045"></a>
Ada 95 and Ada 2005 are highly upwards compatible with Ada 83. In
particular, the design intention was that the difficulties associated
with moving from Ada 83 to Ada 95 or Ada 2005 should be no greater than those
that occur when moving from one Ada 83 system to another.
<p>However, there are a number of points at which there are minor
incompatibilities. The <cite>Ada 95 Annotated Reference Manual</cite> contains
full details of these issues,
and should be consulted for a complete treatment.
In practice the
following subsections treat the most likely issues to be encountered.
<ul class="menu">
<li><a accesskey="1" href="#Legal-Ada-83-programs-that-are-illegal-in-Ada-95">Legal Ada 83 programs that are illegal in Ada 95</a>
<li><a accesskey="2" href="#More-deterministic-semantics">More deterministic semantics</a>
<li><a accesskey="3" href="#Changed-semantics">Changed semantics</a>
<li><a accesskey="4" href="#Other-language-compatibility-issues">Other language compatibility issues</a>
</ul>
<div class="node">
<a name="Legal-Ada-83-programs-that-are-illegal-in-Ada-95"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#More-deterministic-semantics">More deterministic semantics</a>,
Up: <a rel="up" accesskey="u" href="#Compatibility-with-Ada-83">Compatibility with Ada 83</a>
</div>
<h4 class="subsection">F.1.1 Legal Ada 83 programs that are illegal in Ada 95</h4>
<p>Some legal Ada 83 programs are illegal (i.e., they will fail to compile) in
Ada 95 and thus also in Ada 2005:
<dl>
<dt><em>Character literals</em><dd>Some uses of character literals are ambiguous. Since Ada 95 has introduced
<code>Wide_Character</code> as a new predefined character type, some uses of
character literals that were legal in Ada 83 are illegal in Ada 95.
For example:
<pre class="smallexample"> for Char in 'A' .. 'Z' loop ... end loop;
</pre>
<p class="noindent">The problem is that <code>'A'</code> and <code>'Z'</code> could be from either
<code>Character</code> or <code>Wide_Character</code>. The simplest correction
is to make the type explicit; e.g.:
<pre class="smallexample"> for Char in Character range 'A' .. 'Z' loop ... end loop;
</pre>
<br><dt><em>New reserved words</em><dd>The identifiers <code>abstract</code>, <code>aliased</code>, <code>protected</code>,
<code>requeue</code>, <code>tagged</code>, and <code>until</code> are reserved in Ada 95.
Existing Ada 83 code using any of these identifiers must be edited to
use some alternative name.
<br><dt><em>Freezing rules</em><dd>The rules in Ada 95 are slightly different with regard to the point at
which entities are frozen, and representation pragmas and clauses are
not permitted past the freeze point. This shows up most typically in
the form of an error message complaining that a representation item
appears too late, and the appropriate corrective action is to move
the item nearer to the declaration of the entity to which it refers.
<p>A particular case is that representation pragmas
cannot be applied to a subprogram body. If necessary, a separate subprogram
declaration must be introduced to which the pragma can be applied.
<br><dt><em>Optional bodies for library packages</em><dd>In Ada 83, a package that did not require a package body was nevertheless
allowed to have one. This lead to certain surprises in compiling large
systems (situations in which the body could be unexpectedly ignored by the
binder). In Ada 95, if a package does not require a body then it is not
permitted to have a body. To fix this problem, simply remove a redundant
body if it is empty, or, if it is non-empty, introduce a dummy declaration
into the spec that makes the body required. One approach is to add a private
part to the package declaration (if necessary), and define a parameterless
procedure called <code>Requires_Body</code>, which must then be given a dummy
procedure body in the package body, which then becomes required.
Another approach (assuming that this does not introduce elaboration
circularities) is to add an <code>Elaborate_Body</code> pragma to the package spec,
since one effect of this pragma is to require the presence of a package body.
<br><dt><code>Numeric_Error</code><em> is now the same as </em><code>Constraint_Error</code><dd>In Ada 95, the exception <code>Numeric_Error</code> is a renaming of
<code>Constraint_Error</code>.
This means that it is illegal to have separate exception handlers for
the two exceptions. The fix is simply to remove the handler for the
<code>Numeric_Error</code> case (since even in Ada 83, a compiler was free to raise
<code>Constraint_Error</code> in place of <code>Numeric_Error</code> in all cases).
<br><dt><em>Indefinite subtypes in generics</em><dd>In Ada 83, it was permissible to pass an indefinite type (e.g. <code>String</code>)
as the actual for a generic formal private type, but then the instantiation
would be illegal if there were any instances of declarations of variables
of this type in the generic body. In Ada 95, to avoid this clear violation
of the methodological principle known as the “contract model”,
the generic declaration explicitly indicates whether
or not such instantiations are permitted. If a generic formal parameter
has explicit unknown discriminants, indicated by using <code>(<>)</code> after the
type name, then it can be instantiated with indefinite types, but no
stand-alone variables can be declared of this type. Any attempt to declare
such a variable will result in an illegality at the time the generic is
declared. If the <code>(<>)</code> notation is not used, then it is illegal
to instantiate the generic with an indefinite type.
This is the potential incompatibility issue when porting Ada 83 code to Ada 95.
It will show up as a compile time error, and
the fix is usually simply to add the <code>(<>)</code> to the generic declaration.
</dl>
<div class="node">
<a name="More-deterministic-semantics"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Changed-semantics">Changed semantics</a>,
Previous: <a rel="previous" accesskey="p" href="#Legal-Ada-83-programs-that-are-illegal-in-Ada-95">Legal Ada 83 programs that are illegal in Ada 95</a>,
Up: <a rel="up" accesskey="u" href="#Compatibility-with-Ada-83">Compatibility with Ada 83</a>
</div>
<h4 class="subsection">F.1.2 More deterministic semantics</h4>
<dl>
<dt><em>Conversions</em><dd>Conversions from real types to integer types round away from 0. In Ada 83
the conversion Integer(2.5) could deliver either 2 or 3 as its value. This
implementation freedom was intended to support unbiased rounding in
statistical applications, but in practice it interfered with portability.
In Ada 95 the conversion semantics are unambiguous, and rounding away from 0
is required. Numeric code may be affected by this change in semantics.
Note, though, that this issue is no worse than already existed in Ada 83
when porting code from one vendor to another.
<br><dt><em>Tasking</em><dd>The Real-Time Annex introduces a set of policies that define the behavior of
features that were implementation dependent in Ada 83, such as the order in
which open select branches are executed.
</dl>
<div class="node">
<a name="Changed-semantics"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Other-language-compatibility-issues">Other language compatibility issues</a>,
Previous: <a rel="previous" accesskey="p" href="#More-deterministic-semantics">More deterministic semantics</a>,
Up: <a rel="up" accesskey="u" href="#Compatibility-with-Ada-83">Compatibility with Ada 83</a>
</div>
<h4 class="subsection">F.1.3 Changed semantics</h4>
<p class="noindent">The worst kind of incompatibility is one where a program that is legal in
Ada 83 is also legal in Ada 95 but can have an effect in Ada 95 that was not
possible in Ada 83. Fortunately this is extremely rare, but the one
situation that you should be alert to is the change in the predefined type
<code>Character</code> from 7-bit ASCII to 8-bit Latin-1.
<dl>
<dt><em>Range of type </em><code>Character</code><dd>The range of <code>Standard.Character</code> is now the full 256 characters
of Latin-1, whereas in most Ada 83 implementations it was restricted
to 128 characters. Although some of the effects of
this change will be manifest in compile-time rejection of legal
Ada 83 programs it is possible for a working Ada 83 program to have
a different effect in Ada 95, one that was not permitted in Ada 83.
As an example, the expression
<code>Character'Pos(Character'Last)</code> returned <code>127</code> in Ada 83 and now
delivers <code>255</code> as its value.
In general, you should look at the logic of any
character-processing Ada 83 program and see whether it needs to be adapted
to work correctly with Latin-1. Note that the predefined Ada 95 API has a
character handling package that may be relevant if code needs to be adapted
to account for the additional Latin-1 elements.
The desirable fix is to
modify the program to accommodate the full character set, but in some cases
it may be convenient to define a subtype or derived type of Character that
covers only the restricted range.
<a name="index-Latin_002d1-1046"></a></dl>
<div class="node">
<a name="Other-language-compatibility-issues"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Changed-semantics">Changed semantics</a>,
Up: <a rel="up" accesskey="u" href="#Compatibility-with-Ada-83">Compatibility with Ada 83</a>
</div>
<h4 class="subsection">F.1.4 Other language compatibility issues</h4>
<dl>
<dt><samp><span class="option">-gnat83</span></samp><em> switch</em><dd>All implementations of GNAT provide a switch that causes GNAT to operate
in Ada 83 mode. In this mode, some but not all compatibility problems
of the type described above are handled automatically. For example, the
new reserved words introduced in Ada 95 and Ada 2005 are treated simply
as identifiers as in Ada 83.
However,
in practice, it is usually advisable to make the necessary modifications
to the program to remove the need for using this switch.
See <a href="#Compiling-Different-Versions-of-Ada">Compiling Different Versions of Ada</a>.
<br><dt><em>Support for removed Ada 83 pragmas and attributes</em><dd>A number of pragmas and attributes from Ada 83 were removed from Ada 95,
generally because they were replaced by other mechanisms. Ada 95 and Ada 2005
compilers are allowed, but not required, to implement these missing
elements. In contrast with some other compilers, GNAT implements all
such pragmas and attributes, eliminating this compatibility concern. These
include <code>pragma Interface</code> and the floating point type attributes
(<code>Emax</code>, <code>Mantissa</code>, etc.), among other items.
</dl>
<div class="node">
<a name="Compatibility-between-Ada-95-and-Ada-2005"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Implementation_002ddependent-characteristics">Implementation-dependent characteristics</a>,
Previous: <a rel="previous" accesskey="p" href="#Compatibility-with-Ada-83">Compatibility with Ada 83</a>,
Up: <a rel="up" accesskey="u" href="#Compatibility-and-Porting-Guide">Compatibility and Porting Guide</a>
</div>
<h3 class="section">F.2 Compatibility between Ada 95 and Ada 2005</h3>
<p><a name="index-Compatibility-between-Ada-95-and-Ada-2005-1047"></a>
Although Ada 2005 was designed to be upwards compatible with Ada 95, there are
a number of incompatibilities. Several are enumerated below;
for a complete description please see the
Annotated Ada 2005 Reference Manual, or section 9.1.1 in
<cite>Rationale for Ada 2005</cite>.
<dl>
<dt><em>New reserved words.</em><dd>The words <code>interface</code>, <code>overriding</code> and <code>synchronized</code> are
reserved in Ada 2005.
A pre-Ada 2005 program that uses any of these as an identifier will be
illegal.
<br><dt><em>New declarations in predefined packages.</em><dd>A number of packages in the predefined environment contain new declarations:
<code>Ada.Exceptions</code>, <code>Ada.Real_Time</code>, <code>Ada.Strings</code>,
<code>Ada.Strings.Fixed</code>, <code>Ada.Strings.Bounded</code>,
<code>Ada.Strings.Unbounded</code>, <code>Ada.Strings.Wide_Fixed</code>,
<code>Ada.Strings.Wide_Bounded</code>, <code>Ada.Strings.Wide_Unbounded</code>,
<code>Ada.Tags</code>, <code>Ada.Text_IO</code>, and <code>Interfaces.C</code>.
If an Ada 95 program does a <code>with</code> and <code>use</code> of any of these
packages, the new declarations may cause name clashes.
<br><dt><em>Access parameters.</em><dd>A nondispatching subprogram with an access parameter cannot be renamed
as a dispatching operation. This was permitted in Ada 95.
<br><dt><em>Access types, discriminants, and constraints.</em><dd>Rule changes in this area have led to some incompatibilities; for example,
constrained subtypes of some access types are not permitted in Ada 2005.
<br><dt><em>Aggregates for limited types.</em><dd>The allowance of aggregates for limited types in Ada 2005 raises the
possibility of ambiguities in legal Ada 95 programs, since additional types
now need to be considered in expression resolution.
<br><dt><em>Fixed-point multiplication and division.</em><dd>Certain expressions involving “*” or “/” for a fixed-point type, which
were legal in Ada 95 and invoked the predefined versions of these operations,
are now ambiguous.
The ambiguity may be resolved either by applying a type conversion to the
expression, or by explicitly invoking the operation from package
<code>Standard</code>.
<br><dt><em>Return-by-reference types.</em><dd>The Ada 95 return-by-reference mechanism has been removed. Instead, the user
can declare a function returning a value from an anonymous access type.
</dl>
<div class="node">
<a name="Implementation-dependent-characteristics"></a>
<a name="Implementation_002ddependent-characteristics"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Compatibility-with-Other-Ada-Systems">Compatibility with Other Ada Systems</a>,
Previous: <a rel="previous" accesskey="p" href="#Compatibility-between-Ada-95-and-Ada-2005">Compatibility between Ada 95 and Ada 2005</a>,
Up: <a rel="up" accesskey="u" href="#Compatibility-and-Porting-Guide">Compatibility and Porting Guide</a>
</div>
<h3 class="section">F.3 Implementation-dependent characteristics</h3>
<p class="noindent">Although the Ada language defines the semantics of each construct as
precisely as practical, in some situations (for example for reasons of
efficiency, or where the effect is heavily dependent on the host or target
platform) the implementation is allowed some freedom. In porting Ada 83
code to GNAT, you need to be aware of whether / how the existing code
exercised such implementation dependencies. Such characteristics fall into
several categories, and GNAT offers specific support in assisting the
transition from certain Ada 83 compilers.
<ul class="menu">
<li><a accesskey="1" href="#Implementation_002ddefined-pragmas">Implementation-defined pragmas</a>
<li><a accesskey="2" href="#Implementation_002ddefined-attributes">Implementation-defined attributes</a>
<li><a accesskey="3" href="#Libraries">Libraries</a>
<li><a accesskey="4" href="#Elaboration-order">Elaboration order</a>
<li><a accesskey="5" href="#Target_002dspecific-aspects">Target-specific aspects</a>
</ul>
<div class="node">
<a name="Implementation-defined-pragmas"></a>
<a name="Implementation_002ddefined-pragmas"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Implementation_002ddefined-attributes">Implementation-defined attributes</a>,
Up: <a rel="up" accesskey="u" href="#Implementation_002ddependent-characteristics">Implementation-dependent characteristics</a>
</div>
<h4 class="subsection">F.3.1 Implementation-defined pragmas</h4>
<p class="noindent">Ada compilers are allowed to supplement the language-defined pragmas, and
these are a potential source of non-portability. All GNAT-defined pragmas
are described in <a href="gnat_rm.html#Implementation-Defined-Pragmas">Implementation Defined Pragmas</a>, and these include several that are specifically
intended to correspond to other vendors' Ada 83 pragmas.
For migrating from VADS, the pragma <code>Use_VADS_Size</code> may be useful.
For compatibility with HP Ada 83, GNAT supplies the pragmas
<code>Extend_System</code>, <code>Ident</code>, <code>Inline_Generic</code>,
<code>Interface_Name</code>, <code>Passive</code>, <code>Suppress_All</code>,
and <code>Volatile</code>.
Other relevant pragmas include <code>External</code> and <code>Link_With</code>.
Some vendor-specific
Ada 83 pragmas (<code>Share_Generic</code>, <code>Subtitle</code>, and <code>Title</code>) are
recognized, thus
avoiding compiler rejection of units that contain such pragmas; they are not
relevant in a GNAT context and hence are not otherwise implemented.
<div class="node">
<a name="Implementation-defined-attributes"></a>
<a name="Implementation_002ddefined-attributes"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Libraries">Libraries</a>,
Previous: <a rel="previous" accesskey="p" href="#Implementation_002ddefined-pragmas">Implementation-defined pragmas</a>,
Up: <a rel="up" accesskey="u" href="#Implementation_002ddependent-characteristics">Implementation-dependent characteristics</a>
</div>
<h4 class="subsection">F.3.2 Implementation-defined attributes</h4>
<p>Analogous to pragmas, the set of attributes may be extended by an
implementation. All GNAT-defined attributes are described in
<a href="gnat_rm.html#Implementation-Defined-Attributes">Implementation Defined Attributes</a>, and these include several that are specifically intended
to correspond to other vendors' Ada 83 attributes. For migrating from VADS,
the attribute <code>VADS_Size</code> may be useful. For compatibility with HP
Ada 83, GNAT supplies the attributes <code>Bit</code>, <code>Machine_Size</code> and
<code>Type_Class</code>.
<div class="node">
<a name="Libraries"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Elaboration-order">Elaboration order</a>,
Previous: <a rel="previous" accesskey="p" href="#Implementation_002ddefined-attributes">Implementation-defined attributes</a>,
Up: <a rel="up" accesskey="u" href="#Implementation_002ddependent-characteristics">Implementation-dependent characteristics</a>
</div>
<h4 class="subsection">F.3.3 Libraries</h4>
<p class="noindent">Vendors may supply libraries to supplement the standard Ada API. If Ada 83
code uses vendor-specific libraries then there are several ways to manage
this in Ada 95 or Ada 2005:
<ol type=1 start=1>
<li>If the source code for the libraries (specs and bodies) are
available, then the libraries can be migrated in the same way as the
application.
<li>If the source code for the specs but not the bodies are
available, then you can reimplement the bodies.
<li>Some features introduced by Ada 95 obviate the need for library support. For
example most Ada 83 vendors supplied a package for unsigned integers. The
Ada 95 modular type feature is the preferred way to handle this need, so
instead of migrating or reimplementing the unsigned integer package it may
be preferable to retrofit the application using modular types.
</ol>
<div class="node">
<a name="Elaboration-order"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Target_002dspecific-aspects">Target-specific aspects</a>,
Previous: <a rel="previous" accesskey="p" href="#Libraries">Libraries</a>,
Up: <a rel="up" accesskey="u" href="#Implementation_002ddependent-characteristics">Implementation-dependent characteristics</a>
</div>
<h4 class="subsection">F.3.4 Elaboration order</h4>
<p class="noindent">The implementation can choose any elaboration order consistent with the unit
dependency relationship. This freedom means that some orders can result in
Program_Error being raised due to an “Access Before Elaboration”: an attempt
to invoke a subprogram its body has been elaborated, or to instantiate a
generic before the generic body has been elaborated. By default GNAT
attempts to choose a safe order (one that will not encounter access before
elaboration problems) by implicitly inserting <code>Elaborate</code> or
<code>Elaborate_All</code> pragmas where
needed. However, this can lead to the creation of elaboration circularities
and a resulting rejection of the program by gnatbind. This issue is
thoroughly described in <a href="#Elaboration-Order-Handling-in-GNAT">Elaboration Order Handling in GNAT</a>.
In brief, there are several
ways to deal with this situation:
<ul>
<li>Modify the program to eliminate the circularities, e.g. by moving
elaboration-time code into explicitly-invoked procedures
<li>Constrain the elaboration order by including explicit <code>Elaborate_Body</code> or
<code>Elaborate</code> pragmas, and then inhibit the generation of implicit
<code>Elaborate_All</code>
pragmas either globally (as an effect of the <samp><span class="option">-gnatE</span></samp> switch) or locally
(by selectively suppressing elaboration checks via pragma
<code>Suppress(Elaboration_Check)</code> when it is safe to do so).
</ul>
<div class="node">
<a name="Target-specific-aspects"></a>
<a name="Target_002dspecific-aspects"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Elaboration-order">Elaboration order</a>,
Up: <a rel="up" accesskey="u" href="#Implementation_002ddependent-characteristics">Implementation-dependent characteristics</a>
</div>
<h4 class="subsection">F.3.5 Target-specific aspects</h4>
<p class="noindent">Low-level applications need to deal with machine addresses, data
representations, interfacing with assembler code, and similar issues. If
such an Ada 83 application is being ported to different target hardware (for
example where the byte endianness has changed) then you will need to
carefully examine the program logic; the porting effort will heavily depend
on the robustness of the original design. Moreover, Ada 95 (and thus
Ada 2005) are sometimes
incompatible with typical Ada 83 compiler practices regarding implicit
packing, the meaning of the Size attribute, and the size of access values.
GNAT's approach to these issues is described in <a href="#Representation-Clauses">Representation Clauses</a>.
<div class="node">
<a name="Compatibility-with-Other-Ada-Systems"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Representation-Clauses">Representation Clauses</a>,
Previous: <a rel="previous" accesskey="p" href="#Implementation_002ddependent-characteristics">Implementation-dependent characteristics</a>,
Up: <a rel="up" accesskey="u" href="#Compatibility-and-Porting-Guide">Compatibility and Porting Guide</a>
</div>
<h3 class="section">F.4 Compatibility with Other Ada Systems</h3>
<p class="noindent">If programs avoid the use of implementation dependent and
implementation defined features, as documented in the <cite>Ada
Reference Manual</cite>, there should be a high degree of portability between
GNAT and other Ada systems. The following are specific items which
have proved troublesome in moving Ada 95 programs from GNAT to other Ada 95
compilers, but do not affect porting code to GNAT.
(As of January 2007, GNAT is the only compiler available for Ada 2005;
the following issues may or may not arise for Ada 2005 programs
when other compilers appear.)
<dl>
<dt><em>Ada 83 Pragmas and Attributes</em><dd>Ada 95 compilers are allowed, but not required, to implement the missing
Ada 83 pragmas and attributes that are no longer defined in Ada 95.
GNAT implements all such pragmas and attributes, eliminating this as
a compatibility concern, but some other Ada 95 compilers reject these
pragmas and attributes.
<br><dt><em>Specialized Needs Annexes</em><dd>GNAT implements the full set of special needs annexes. At the
current time, it is the only Ada 95 compiler to do so. This means that
programs making use of these features may not be portable to other Ada
95 compilation systems.
<br><dt><em>Representation Clauses</em><dd>Some other Ada 95 compilers implement only the minimal set of
representation clauses required by the Ada 95 reference manual. GNAT goes
far beyond this minimal set, as described in the next section.
</dl>
<div class="node">
<a name="Representation-Clauses"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Compatibility-with-HP-Ada-83">Compatibility with HP Ada 83</a>,
Previous: <a rel="previous" accesskey="p" href="#Compatibility-with-Other-Ada-Systems">Compatibility with Other Ada Systems</a>,
Up: <a rel="up" accesskey="u" href="#Compatibility-and-Porting-Guide">Compatibility and Porting Guide</a>
</div>
<h3 class="section">F.5 Representation Clauses</h3>
<p class="noindent">The Ada 83 reference manual was quite vague in describing both the minimal
required implementation of representation clauses, and also their precise
effects. Ada 95 (and thus also Ada 2005) are much more explicit, but the
minimal set of capabilities required is still quite limited.
<p>GNAT implements the full required set of capabilities in
Ada 95 and Ada 2005, but also goes much further, and in particular
an effort has been made to be compatible with existing Ada 83 usage to the
greatest extent possible.
<p>A few cases exist in which Ada 83 compiler behavior is incompatible with
the requirements in Ada 95 (and thus also Ada 2005). These are instances of
intentional or accidental dependence on specific implementation dependent
characteristics of these Ada 83 compilers. The following is a list of
the cases most likely to arise in existing Ada 83 code.
<dl>
<dt><em>Implicit Packing</em><dd>Some Ada 83 compilers allowed a Size specification to cause implicit
packing of an array or record. This could cause expensive implicit
conversions for change of representation in the presence of derived
types, and the Ada design intends to avoid this possibility.
Subsequent AI's were issued to make it clear that such implicit
change of representation in response to a Size clause is inadvisable,
and this recommendation is represented explicitly in the Ada 95 (and Ada 2005)
Reference Manuals as implementation advice that is followed by GNAT.
The problem will show up as an error
message rejecting the size clause. The fix is simply to provide
the explicit pragma <code>Pack</code>, or for more fine tuned control, provide
a Component_Size clause.
<br><dt><em>Meaning of Size Attribute</em><dd>The Size attribute in Ada 95 (and Ada 2005) for discrete types is defined as
the minimal number of bits required to hold values of the type. For example,
on a 32-bit machine, the size of <code>Natural</code> will typically be 31 and not
32 (since no sign bit is required). Some Ada 83 compilers gave 31, and
some 32 in this situation. This problem will usually show up as a compile
time error, but not always. It is a good idea to check all uses of the
'Size attribute when porting Ada 83 code. The GNAT specific attribute
Object_Size can provide a useful way of duplicating the behavior of
some Ada 83 compiler systems.
<br><dt><em>Size of Access Types</em><dd>A common assumption in Ada 83 code is that an access type is in fact a pointer,
and that therefore it will be the same size as a System.Address value. This
assumption is true for GNAT in most cases with one exception. For the case of
a pointer to an unconstrained array type (where the bounds may vary from one
value of the access type to another), the default is to use a “fat pointer”,
which is represented as two separate pointers, one to the bounds, and one to
the array. This representation has a number of advantages, including improved
efficiency. However, it may cause some difficulties in porting existing Ada 83
code which makes the assumption that, for example, pointers fit in 32 bits on
a machine with 32-bit addressing.
<p>To get around this problem, GNAT also permits the use of “thin pointers” for
access types in this case (where the designated type is an unconstrained array
type). These thin pointers are indeed the same size as a System.Address value.
To specify a thin pointer, use a size clause for the type, for example:
<pre class="smallexample"> type X is access all String;
for X'Size use Standard'Address_Size;
</pre>
<p class="noindent">which will cause the type X to be represented using a single pointer.
When using this representation, the bounds are right behind the array.
This representation is slightly less efficient, and does not allow quite
such flexibility in the use of foreign pointers or in using the
Unrestricted_Access attribute to create pointers to non-aliased objects.
But for any standard portable use of the access type it will work in
a functionally correct manner and allow porting of existing code.
Note that another way of forcing a thin pointer representation
is to use a component size clause for the element size in an array,
or a record representation clause for an access field in a record.
</dl>
<!-- This brief section is only in the non-VMS version -->
<!-- The complete chapter on HP Ada is in the VMS version -->
<div class="node">
<a name="Compatibility-with-HP-Ada-83"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Representation-Clauses">Representation Clauses</a>,
Up: <a rel="up" accesskey="u" href="#Compatibility-and-Porting-Guide">Compatibility and Porting Guide</a>
</div>
<h3 class="section">F.6 Compatibility with HP Ada 83</h3>
<p class="noindent">The VMS version of GNAT fully implements all the pragmas and attributes
provided by HP Ada 83, as well as providing the standard HP Ada 83
libraries, including Starlet. In addition, data layouts and parameter
passing conventions are highly compatible. This means that porting
existing HP Ada 83 code to GNAT in VMS systems should be easier than
most other porting efforts. The following are some of the most
significant differences between GNAT and HP Ada 83.
<dl>
<dt><em>Default floating-point representation</em><dd>In GNAT, the default floating-point format is IEEE, whereas in HP Ada 83,
it is VMS format. GNAT does implement the necessary pragmas
(Long_Float, Float_Representation) for changing this default.
<br><dt><em>System</em><dd>The package System in GNAT exactly corresponds to the definition in the
Ada 95 reference manual, which means that it excludes many of the
HP Ada 83 extensions. However, a separate package Aux_DEC is provided
that contains the additional definitions, and a special pragma,
Extend_System allows this package to be treated transparently as an
extension of package System.
<br><dt><em>To_Address</em><dd>The definitions provided by Aux_DEC are exactly compatible with those
in the HP Ada 83 version of System, with one exception.
HP Ada provides the following declarations:
<pre class="smallexample"> TO_ADDRESS (INTEGER)
TO_ADDRESS (UNSIGNED_LONGWORD)
TO_ADDRESS (<i>universal_integer</i>)
</pre>
<p class="noindent">The version of TO_ADDRESS taking a <i>universal integer</i> argument is in fact
an extension to Ada 83 not strictly compatible with the reference manual.
In GNAT, we are constrained to be exactly compatible with the standard,
and this means we cannot provide this capability. In HP Ada 83, the
point of this definition is to deal with a call like:
<pre class="smallexample"> TO_ADDRESS (16#12777#);
</pre>
<p class="noindent">Normally, according to the Ada 83 standard, one would expect this to be
ambiguous, since it matches both the INTEGER and UNSIGNED_LONGWORD forms
of TO_ADDRESS. However, in HP Ada 83, there is no ambiguity, since the
definition using <i>universal_integer</i> takes precedence.
<p>In GNAT, since the version with <i>universal_integer</i> cannot be supplied, it
is not possible to be 100% compatible. Since there are many programs using
numeric constants for the argument to TO_ADDRESS, the decision in GNAT was
to change the name of the function in the UNSIGNED_LONGWORD case, so the
declarations provided in the GNAT version of AUX_Dec are:
<pre class="smallexample"> function To_Address (X : Integer) return Address;
pragma Pure_Function (To_Address);
function To_Address_Long (X : Unsigned_Longword)
return Address;
pragma Pure_Function (To_Address_Long);
</pre>
<p class="noindent">This means that programs using TO_ADDRESS for UNSIGNED_LONGWORD must
change the name to TO_ADDRESS_LONG.
<br><dt><em>Task_Id values</em><dd>The Task_Id values assigned will be different in the two systems, and GNAT
does not provide a specified value for the Task_Id of the environment task,
which in GNAT is treated like any other declared task.
</dl>
<p class="noindent">For full details on these and other less significant compatibility issues,
see appendix E of the HP publication entitled <cite>HP Ada, Technical
Overview and Comparison on HP Platforms</cite>.
<p>For GNAT running on other than VMS systems, all the HP Ada 83 pragmas and
attributes are recognized, although only a subset of them can sensibly
be implemented. The description of pragmas in <a href="gnat_rm.html#Implementation-Defined-Pragmas">Implementation Defined Pragmas</a>
indicates whether or not they are applicable to non-VMS systems.
<!-- ************************************************ -->
<div class="node">
<a name="Microsoft-Windows-Topics"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#GNU-Free-Documentation-License">GNU Free Documentation License</a>,
Previous: <a rel="previous" accesskey="p" href="#Compatibility-and-Porting-Guide">Compatibility and Porting Guide</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="appendix">Appendix G Microsoft Windows Topics</h2>
<p><a name="index-Windows-NT-1048"></a><a name="index-Windows-95-1049"></a><a name="index-Windows-98-1050"></a>
This chapter describes topics that are specific to the Microsoft Windows
platforms (NT, 2000, and XP Professional).
<ul class="menu">
<li><a accesskey="1" href="#Using-GNAT-on-Windows">Using GNAT on Windows</a>
<li><a accesskey="2" href="#Using-a-network-installation-of-GNAT">Using a network installation of GNAT</a>
<li><a accesskey="3" href="#CONSOLE-and-WINDOWS-subsystems">CONSOLE and WINDOWS subsystems</a>
<li><a accesskey="4" href="#Temporary-Files">Temporary Files</a>
<li><a accesskey="5" href="#Mixed_002dLanguage-Programming-on-Windows">Mixed-Language Programming on Windows</a>
<li><a accesskey="6" href="#Windows-Calling-Conventions">Windows Calling Conventions</a>
<li><a accesskey="7" href="#Introduction-to-Dynamic-Link-Libraries-_0028DLLs_0029">Introduction to Dynamic Link Libraries (DLLs)</a>
<li><a accesskey="8" href="#Using-DLLs-with-GNAT">Using DLLs with GNAT</a>
<li><a accesskey="9" href="#Building-DLLs-with-GNAT-Project-files">Building DLLs with GNAT Project files</a>
<li><a href="#Building-DLLs-with-GNAT">Building DLLs with GNAT</a>
<li><a href="#Building-DLLs-with-gnatdll">Building DLLs with gnatdll</a>
<li><a href="#GNAT-and-Windows-Resources">GNAT and Windows Resources</a>
<li><a href="#Debugging-a-DLL">Debugging a DLL</a>
<li><a href="#Setting-Stack-Size-from-gnatlink">Setting Stack Size from gnatlink</a>
<li><a href="#Setting-Heap-Size-from-gnatlink">Setting Heap Size from gnatlink</a>
</ul>
<div class="node">
<a name="Using-GNAT-on-Windows"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Using-a-network-installation-of-GNAT">Using a network installation of GNAT</a>,
Up: <a rel="up" accesskey="u" href="#Microsoft-Windows-Topics">Microsoft Windows Topics</a>
</div>
<h3 class="section">G.1 Using GNAT on Windows</h3>
<p class="noindent">One of the strengths of the GNAT technology is that its tool set
(<samp><span class="command">gcc</span></samp>, <samp><span class="command">gnatbind</span></samp>, <samp><span class="command">gnatlink</span></samp>, <samp><span class="command">gnatmake</span></samp>, the
<code>gdb</code> debugger, etc.) is used in the same way regardless of the
platform.
<p>On Windows this tool set is complemented by a number of Microsoft-specific
tools that have been provided to facilitate interoperability with Windows
when this is required. With these tools:
<ul>
<li>You can build applications using the <code>CONSOLE</code> or <code>WINDOWS</code>
subsystems.
<li>You can use any Dynamically Linked Library (DLL) in your Ada code (both
relocatable and non-relocatable DLLs are supported).
<li>You can build Ada DLLs for use in other applications. These applications
can be written in a language other than Ada (e.g., C, C++, etc). Again both
relocatable and non-relocatable Ada DLLs are supported.
<li>You can include Windows resources in your Ada application.
<li>You can use or create COM/DCOM objects.
</ul>
<p class="noindent">Immediately below are listed all known general GNAT-for-Windows restrictions.
Other restrictions about specific features like Windows Resources and DLLs
are listed in separate sections below.
<ul>
<li>It is not possible to use <code>GetLastError</code> and <code>SetLastError</code>
when tasking, protected records, or exceptions are used. In these
cases, in order to implement Ada semantics, the GNAT run-time system
calls certain Win32 routines that set the last error variable to 0 upon
success. It should be possible to use <code>GetLastError</code> and
<code>SetLastError</code> when tasking, protected record, and exception
features are not used, but it is not guaranteed to work.
<li>It is not possible to link against Microsoft libraries except for
import libraries. Interfacing must be done by the mean of DLLs.
<li>When the compilation environment is located on FAT32 drives, users may
experience recompilations of the source files that have not changed if
Daylight Saving Time (DST) state has changed since the last time files
were compiled. NTFS drives do not have this problem.
<li>No components of the GNAT toolset use any entries in the Windows
registry. The only entries that can be created are file associations and
PATH settings, provided the user has chosen to create them at installation
time, as well as some minimal book-keeping information needed to correctly
uninstall or integrate different GNAT products.
</ul>
<div class="node">
<a name="Using-a-network-installation-of-GNAT"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#CONSOLE-and-WINDOWS-subsystems">CONSOLE and WINDOWS subsystems</a>,
Previous: <a rel="previous" accesskey="p" href="#Using-GNAT-on-Windows">Using GNAT on Windows</a>,
Up: <a rel="up" accesskey="u" href="#Microsoft-Windows-Topics">Microsoft Windows Topics</a>
</div>
<h3 class="section">G.2 Using a network installation of GNAT</h3>
<p class="noindent">Make sure the system on which GNAT is installed is accessible from the
current machine, i.e., the install location is shared over the network.
Shared resources are accessed on Windows by means of UNC paths, which
have the format <code>\\server\sharename\path</code>
<p>In order to use such a network installation, simply add the UNC path of the
<samp><span class="file">bin</span></samp> directory of your GNAT installation in front of your PATH. For
example, if GNAT is installed in <samp><span class="file">\GNAT</span></samp> directory of a share location
called <samp><span class="file">c-drive</span></samp> on a machine <samp><span class="file">LOKI</span></samp>, the following command will
make it available:
<p><code> path \\loki\c-drive\gnat\bin;%path%</code>
<p>Be aware that every compilation using the network installation results in the
transfer of large amounts of data across the network and will likely cause
serious performance penalty.
<div class="node">
<a name="CONSOLE-and-WINDOWS-subsystems"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Temporary-Files">Temporary Files</a>,
Previous: <a rel="previous" accesskey="p" href="#Using-a-network-installation-of-GNAT">Using a network installation of GNAT</a>,
Up: <a rel="up" accesskey="u" href="#Microsoft-Windows-Topics">Microsoft Windows Topics</a>
</div>
<h3 class="section">G.3 CONSOLE and WINDOWS subsystems</h3>
<p><a name="index-CONSOLE-Subsystem-1051"></a><a name="index-WINDOWS-Subsystem-1052"></a><a name="index-g_t_002dmwindows-1053"></a>
There are two main subsystems under Windows. The <code>CONSOLE</code> subsystem
(which is the default subsystem) will always create a console when
launching the application. This is not something desirable when the
application has a Windows GUI. To get rid of this console the
application must be using the <code>WINDOWS</code> subsystem. To do so
the <samp><span class="option">-mwindows</span></samp> linker option must be specified.
<pre class="smallexample"> $ gnatmake winprog -largs -mwindows
</pre>
<div class="node">
<a name="Temporary-Files"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Mixed_002dLanguage-Programming-on-Windows">Mixed-Language Programming on Windows</a>,
Previous: <a rel="previous" accesskey="p" href="#CONSOLE-and-WINDOWS-subsystems">CONSOLE and WINDOWS subsystems</a>,
Up: <a rel="up" accesskey="u" href="#Microsoft-Windows-Topics">Microsoft Windows Topics</a>
</div>
<h3 class="section">G.4 Temporary Files</h3>
<p><a name="index-Temporary-files-1054"></a>
It is possible to control where temporary files gets created by setting
the <samp><span class="env">TMP</span></samp> environment variable. The file will be created:
<ul>
<li>Under the directory pointed to by the <samp><span class="env">TMP</span></samp> environment variable if
this directory exists.
<li>Under <samp><span class="file">c:\temp</span></samp>, if the <samp><span class="env">TMP</span></samp> environment variable is not
set (or not pointing to a directory) and if this directory exists.
<li>Under the current working directory otherwise.
</ul>
<p class="noindent">This allows you to determine exactly where the temporary
file will be created. This is particularly useful in networked
environments where you may not have write access to some
directories.
<div class="node">
<a name="Mixed-Language-Programming-on-Windows"></a>
<a name="Mixed_002dLanguage-Programming-on-Windows"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Windows-Calling-Conventions">Windows Calling Conventions</a>,
Previous: <a rel="previous" accesskey="p" href="#Temporary-Files">Temporary Files</a>,
Up: <a rel="up" accesskey="u" href="#Microsoft-Windows-Topics">Microsoft Windows Topics</a>
</div>
<h3 class="section">G.5 Mixed-Language Programming on Windows</h3>
<p class="noindent">Developing pure Ada applications on Windows is no different than on
other GNAT-supported platforms. However, when developing or porting an
application that contains a mix of Ada and C/C++, the choice of your
Windows C/C++ development environment conditions your overall
interoperability strategy.
<p>If you use <samp><span class="command">gcc</span></samp> to compile the non-Ada part of your application,
there are no Windows-specific restrictions that affect the overall
interoperability with your Ada code. If you do want to use the
Microsoft tools for your non-Ada code, you have two choices:
<ol type=1 start=1>
<li>Encapsulate your non-Ada code in a DLL to be linked with your Ada
application. In this case, use the Microsoft or whatever environment to
build the DLL and use GNAT to build your executable
(see <a href="#Using-DLLs-with-GNAT">Using DLLs with GNAT</a>).
<li>Or you can encapsulate your Ada code in a DLL to be linked with the
other part of your application. In this case, use GNAT to build the DLL
(see <a href="#Building-DLLs-with-GNAT-Project-files">Building DLLs with GNAT Project files</a>) and use the Microsoft
or whatever environment to build your executable.
</ol>
<div class="node">
<a name="Windows-Calling-Conventions"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Introduction-to-Dynamic-Link-Libraries-_0028DLLs_0029">Introduction to Dynamic Link Libraries (DLLs)</a>,
Previous: <a rel="previous" accesskey="p" href="#Mixed_002dLanguage-Programming-on-Windows">Mixed-Language Programming on Windows</a>,
Up: <a rel="up" accesskey="u" href="#Microsoft-Windows-Topics">Microsoft Windows Topics</a>
</div>
<h3 class="section">G.6 Windows Calling Conventions</h3>
<p><a name="index-Stdcall-1055"></a><a name="index-APIENTRY-1056"></a>
This section pertain only to Win32. On Win64 there is a single native
calling convention. All convention specifiers are ignored on this
platform.
<ul class="menu">
<li><a accesskey="1" href="#C-Calling-Convention">C Calling Convention</a>
<li><a accesskey="2" href="#Stdcall-Calling-Convention">Stdcall Calling Convention</a>
<li><a accesskey="3" href="#Win32-Calling-Convention">Win32 Calling Convention</a>
<li><a accesskey="4" href="#DLL-Calling-Convention">DLL Calling Convention</a>
</ul>
<p class="noindent">When a subprogram <code>F</code> (caller) calls a subprogram <code>G</code>
(callee), there are several ways to push <code>G</code>'s parameters on the
stack and there are several possible scenarios to clean up the stack
upon <code>G</code>'s return. A calling convention is an agreed upon software
protocol whereby the responsibilities between the caller (<code>F</code>) and
the callee (<code>G</code>) are clearly defined. Several calling conventions
are available for Windows:
<ul>
<li><code>C</code> (Microsoft defined)
<li><code>Stdcall</code> (Microsoft defined)
<li><code>Win32</code> (GNAT specific)
<li><code>DLL</code> (GNAT specific)
</ul>
<div class="node">
<a name="C-Calling-Convention"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Stdcall-Calling-Convention">Stdcall Calling Convention</a>,
Up: <a rel="up" accesskey="u" href="#Windows-Calling-Conventions">Windows Calling Conventions</a>
</div>
<h4 class="subsection">G.6.1 <code>C</code> Calling Convention</h4>
<p class="noindent">This is the default calling convention used when interfacing to C/C++
routines compiled with either <samp><span class="command">gcc</span></samp> or Microsoft Visual C++.
<p>In the <code>C</code> calling convention subprogram parameters are pushed on the
stack by the caller from right to left. The caller itself is in charge of
cleaning up the stack after the call. In addition, the name of a routine
with <code>C</code> calling convention is mangled by adding a leading underscore.
<p>The name to use on the Ada side when importing (or exporting) a routine
with <code>C</code> calling convention is the name of the routine. For
instance the C function:
<pre class="smallexample"> int get_val (long);
</pre>
<p class="noindent">should be imported from Ada as follows:
<pre class="smallexample"> function Get_Val (V : Interfaces.C.long) return Interfaces.C.int;
pragma Import (C, Get_Val, External_Name => "get_val");
</pre>
<p class="noindent">Note that in this particular case the <code>External_Name</code> parameter could
have been omitted since, when missing, this parameter is taken to be the
name of the Ada entity in lower case. When the <code>Link_Name</code> parameter
is missing, as in the above example, this parameter is set to be the
<code>External_Name</code> with a leading underscore.
<p>When importing a variable defined in C, you should always use the <code>C</code>
calling convention unless the object containing the variable is part of a
DLL (in which case you should use the <code>Stdcall</code> calling
convention, see <a href="#Stdcall-Calling-Convention">Stdcall Calling Convention</a>).
<div class="node">
<a name="Stdcall-Calling-Convention"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Win32-Calling-Convention">Win32 Calling Convention</a>,
Previous: <a rel="previous" accesskey="p" href="#C-Calling-Convention">C Calling Convention</a>,
Up: <a rel="up" accesskey="u" href="#Windows-Calling-Conventions">Windows Calling Conventions</a>
</div>
<h4 class="subsection">G.6.2 <code>Stdcall</code> Calling Convention</h4>
<p class="noindent">This convention, which was the calling convention used for Pascal
programs, is used by Microsoft for all the routines in the Win32 API for
efficiency reasons. It must be used to import any routine for which this
convention was specified.
<p>In the <code>Stdcall</code> calling convention subprogram parameters are pushed
on the stack by the caller from right to left. The callee (and not the
caller) is in charge of cleaning the stack on routine exit. In addition,
the name of a routine with <code>Stdcall</code> calling convention is mangled by
adding a leading underscore (as for the <code>C</code> calling convention) and a
trailing <code>@</code><var>nn</var>, where <var>nn</var> is the overall size (in
bytes) of the parameters passed to the routine.
<p>The name to use on the Ada side when importing a C routine with a
<code>Stdcall</code> calling convention is the name of the C routine. The leading
underscore and trailing <code>@</code><var>nn</var> are added automatically by
the compiler. For instance the Win32 function:
<pre class="smallexample"> <b>APIENTRY</b> int get_val (long);
</pre>
<p class="noindent">should be imported from Ada as follows:
<pre class="smallexample"> function Get_Val (V : Interfaces.C.long) return Interfaces.C.int;
pragma Import (Stdcall, Get_Val);
-- On the x86 a long is 4 bytes, so the Link_Name is "_get_val@4"
</pre>
<p class="noindent">As for the <code>C</code> calling convention, when the <code>External_Name</code>
parameter is missing, it is taken to be the name of the Ada entity in lower
case. If instead of writing the above import pragma you write:
<pre class="smallexample"> function Get_Val (V : Interfaces.C.long) return Interfaces.C.int;
pragma Import (Stdcall, Get_Val, External_Name => "retrieve_val");
</pre>
<p class="noindent">then the imported routine is <code>_retrieve_val@4</code>. However, if instead
of specifying the <code>External_Name</code> parameter you specify the
<code>Link_Name</code> as in the following example:
<pre class="smallexample"> function Get_Val (V : Interfaces.C.long) return Interfaces.C.int;
pragma Import (Stdcall, Get_Val, Link_Name => "retrieve_val");
</pre>
<p class="noindent">then the imported routine is <code>retrieve_val</code>, that is, there is no
decoration at all. No leading underscore and no Stdcall suffix
<code>@</code><var>nn</var>.
<p class="noindent">This is especially important as in some special cases a DLL's entry
point name lacks a trailing <code>@</code><var>nn</var> while the exported
name generated for a call has it.
<p class="noindent">It is also possible to import variables defined in a DLL by using an
import pragma for a variable. As an example, if a DLL contains a
variable defined as:
<pre class="smallexample"> int my_var;
</pre>
<p class="noindent">then, to access this variable from Ada you should write:
<pre class="smallexample"> My_Var : Interfaces.C.int;
pragma Import (Stdcall, My_Var);
</pre>
<p class="noindent">Note that to ease building cross-platform bindings this convention
will be handled as a <code>C</code> calling convention on non-Windows platforms.
<div class="node">
<a name="Win32-Calling-Convention"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#DLL-Calling-Convention">DLL Calling Convention</a>,
Previous: <a rel="previous" accesskey="p" href="#Stdcall-Calling-Convention">Stdcall Calling Convention</a>,
Up: <a rel="up" accesskey="u" href="#Windows-Calling-Conventions">Windows Calling Conventions</a>
</div>
<h4 class="subsection">G.6.3 <code>Win32</code> Calling Convention</h4>
<p class="noindent">This convention, which is GNAT-specific is fully equivalent to the
<code>Stdcall</code> calling convention described above.
<div class="node">
<a name="DLL-Calling-Convention"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Win32-Calling-Convention">Win32 Calling Convention</a>,
Up: <a rel="up" accesskey="u" href="#Windows-Calling-Conventions">Windows Calling Conventions</a>
</div>
<h4 class="subsection">G.6.4 <code>DLL</code> Calling Convention</h4>
<p class="noindent">This convention, which is GNAT-specific is fully equivalent to the
<code>Stdcall</code> calling convention described above.
<div class="node">
<a name="Introduction-to-Dynamic-Link-Libraries-(DLLs)"></a>
<a name="Introduction-to-Dynamic-Link-Libraries-_0028DLLs_0029"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Using-DLLs-with-GNAT">Using DLLs with GNAT</a>,
Previous: <a rel="previous" accesskey="p" href="#Windows-Calling-Conventions">Windows Calling Conventions</a>,
Up: <a rel="up" accesskey="u" href="#Microsoft-Windows-Topics">Microsoft Windows Topics</a>
</div>
<h3 class="section">G.7 Introduction to Dynamic Link Libraries (DLLs)</h3>
<p><a name="index-DLL-1057"></a>
A Dynamically Linked Library (DLL) is a library that can be shared by
several applications running under Windows. A DLL can contain any number of
routines and variables.
<p>One advantage of DLLs is that you can change and enhance them without
forcing all the applications that depend on them to be relinked or
recompiled. However, you should be aware than all calls to DLL routines are
slower since, as you will understand below, such calls are indirect.
<p>To illustrate the remainder of this section, suppose that an application
wants to use the services of a DLL <samp><span class="file">API.dll</span></samp>. To use the services
provided by <samp><span class="file">API.dll</span></samp> you must statically link against the DLL or
an import library which contains a jump table with an entry for each
routine and variable exported by the DLL. In the Microsoft world this
import library is called <samp><span class="file">API.lib</span></samp>. When using GNAT this import
library is called either <samp><span class="file">libAPI.dll.a</span></samp>, <samp><span class="file">libapi.dll.a</span></samp>,
<samp><span class="file">libAPI.a</span></samp> or <samp><span class="file">libapi.a</span></samp> (names are case insensitive).
<p>After you have linked your application with the DLL or the import library
and you run your application, here is what happens:
<ol type=1 start=1>
<li>Your application is loaded into memory.
<li>The DLL <samp><span class="file">API.dll</span></samp> is mapped into the address space of your
application. This means that:
<ul>
<li>The DLL will use the stack of the calling thread.
<li>The DLL will use the virtual address space of the calling process.
<li>The DLL will allocate memory from the virtual address space of the calling
process.
<li>Handles (pointers) can be safely exchanged between routines in the DLL
routines and routines in the application using the DLL.
</ul>
<li>The entries in the jump table (from the import library <samp><span class="file">libAPI.dll.a</span></samp>
or <samp><span class="file">API.lib</span></samp> or automatically created when linking against a DLL)
which is part of your application are initialized with the addresses
of the routines and variables in <samp><span class="file">API.dll</span></samp>.
<li>If present in <samp><span class="file">API.dll</span></samp>, routines <code>DllMain</code> or
<code>DllMainCRTStartup</code> are invoked. These routines typically contain
the initialization code needed for the well-being of the routines and
variables exported by the DLL.
</ol>
<p class="noindent">There is an additional point which is worth mentioning. In the Windows
world there are two kind of DLLs: relocatable and non-relocatable
DLLs. Non-relocatable DLLs can only be loaded at a very specific address
in the target application address space. If the addresses of two
non-relocatable DLLs overlap and these happen to be used by the same
application, a conflict will occur and the application will run
incorrectly. Hence, when possible, it is always preferable to use and
build relocatable DLLs. Both relocatable and non-relocatable DLLs are
supported by GNAT. Note that the <samp><span class="option">-s</span></samp> linker option (see GNU Linker
User's Guide) removes the debugging symbols from the DLL but the DLL can
still be relocated.
<p>As a side note, an interesting difference between Microsoft DLLs and
Unix shared libraries, is the fact that on most Unix systems all public
routines are exported by default in a Unix shared library, while under
Windows it is possible (but not required) to list exported routines in
a definition file (see <a href="#The-Definition-File">The Definition File</a>).
<div class="node">
<a name="Using-DLLs-with-GNAT"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Building-DLLs-with-GNAT-Project-files">Building DLLs with GNAT Project files</a>,
Previous: <a rel="previous" accesskey="p" href="#Introduction-to-Dynamic-Link-Libraries-_0028DLLs_0029">Introduction to Dynamic Link Libraries (DLLs)</a>,
Up: <a rel="up" accesskey="u" href="#Microsoft-Windows-Topics">Microsoft Windows Topics</a>
</div>
<h3 class="section">G.8 Using DLLs with GNAT</h3>
<ul class="menu">
<li><a accesskey="1" href="#Creating-an-Ada-Spec-for-the-DLL-Services">Creating an Ada Spec for the DLL Services</a>
<li><a accesskey="2" href="#Creating-an-Import-Library">Creating an Import Library</a>
</ul>
<p class="noindent">To use the services of a DLL, say <samp><span class="file">API.dll</span></samp>, in your Ada application
you must have:
<ol type=1 start=1>
<li>The Ada spec for the routines and/or variables you want to access in
<samp><span class="file">API.dll</span></samp>. If not available this Ada spec must be built from the C/C++
header files provided with the DLL.
<li>The import library (<samp><span class="file">libAPI.dll.a</span></samp> or <samp><span class="file">API.lib</span></samp>). As previously
mentioned an import library is a statically linked library containing the
import table which will be filled at load time to point to the actual
<samp><span class="file">API.dll</span></samp> routines. Sometimes you don't have an import library for the
DLL you want to use. The following sections will explain how to build
one. Note that this is optional.
<li>The actual DLL, <samp><span class="file">API.dll</span></samp>.
</ol>
<p class="noindent">Once you have all the above, to compile an Ada application that uses the
services of <samp><span class="file">API.dll</span></samp> and whose main subprogram is <code>My_Ada_App</code>,
you simply issue the command
<pre class="smallexample"> $ gnatmake my_ada_app -largs -lAPI
</pre>
<p class="noindent">The argument <samp><span class="option">-largs -lAPI</span></samp> at the end of the <samp><span class="command">gnatmake</span></samp> command
tells the GNAT linker to look for an import library. The linker will
look for a library name in this specific order:
<ol type=1 start=1>
<li><samp><span class="file">libAPI.dll.a</span></samp>
<li><samp><span class="file">API.dll.a</span></samp>
<li><samp><span class="file">libAPI.a</span></samp>
<li><samp><span class="file">API.lib</span></samp>
<li><samp><span class="file">libAPI.dll</span></samp>
<li><samp><span class="file">API.dll</span></samp>
</ol>
<p>The first three are the GNU style import libraries. The third is the
Microsoft style import libraries. The last two are the actual DLL names.
<p>Note that if the Ada package spec for <samp><span class="file">API.dll</span></samp> contains the
following pragma
<pre class="smallexample"> pragma Linker_Options ("-lAPI");
</pre>
<p class="noindent">you do not have to add <samp><span class="option">-largs -lAPI</span></samp> at the end of the
<samp><span class="command">gnatmake</span></samp> command.
<p>If any one of the items above is missing you will have to create it
yourself. The following sections explain how to do so using as an
example a fictitious DLL called <samp><span class="file">API.dll</span></samp>.
<div class="node">
<a name="Creating-an-Ada-Spec-for-the-DLL-Services"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Creating-an-Import-Library">Creating an Import Library</a>,
Up: <a rel="up" accesskey="u" href="#Using-DLLs-with-GNAT">Using DLLs with GNAT</a>
</div>
<h4 class="subsection">G.8.1 Creating an Ada Spec for the DLL Services</h4>
<p class="noindent">A DLL typically comes with a C/C++ header file which provides the
definitions of the routines and variables exported by the DLL. The Ada
equivalent of this header file is a package spec that contains definitions
for the imported entities. If the DLL you intend to use does not come with
an Ada spec you have to generate one such spec yourself. For example if
the header file of <samp><span class="file">API.dll</span></samp> is a file <samp><span class="file">api.h</span></samp> containing the
following two definitions:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
int some_var;
int get (char *);
</td></tr></table>
</pre>
<p class="noindent">then the equivalent Ada spec could be:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
with Interfaces.C.Strings;
package API is
use Interfaces;
Some_Var : C.int;
function Get (Str : C.Strings.Chars_Ptr) return C.int;
private
pragma Import (C, Get);
pragma Import (DLL, Some_Var);
end API;
</td></tr></table>
</pre>
<p class="noindent">Note that a variable is
<strong>always imported with a DLL convention</strong>. A function
can have <code>C</code> or <code>Stdcall</code> convention.
(see <a href="#Windows-Calling-Conventions">Windows Calling Conventions</a>).
<div class="node">
<a name="Creating-an-Import-Library"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Creating-an-Ada-Spec-for-the-DLL-Services">Creating an Ada Spec for the DLL Services</a>,
Up: <a rel="up" accesskey="u" href="#Using-DLLs-with-GNAT">Using DLLs with GNAT</a>
</div>
<h4 class="subsection">G.8.2 Creating an Import Library</h4>
<p><a name="index-Import-library-1058"></a>
<ul class="menu">
<li><a accesskey="1" href="#The-Definition-File">The Definition File</a>
<li><a accesskey="2" href="#GNAT_002dStyle-Import-Library">GNAT-Style Import Library</a>
<li><a accesskey="3" href="#Microsoft_002dStyle-Import-Library">Microsoft-Style Import Library</a>
</ul>
<p class="noindent">If a Microsoft-style import library <samp><span class="file">API.lib</span></samp> or a GNAT-style
import library <samp><span class="file">libAPI.dll.a</span></samp> or <samp><span class="file">libAPI.a</span></samp> is available
with <samp><span class="file">API.dll</span></samp> you can skip this section. You can also skip this
section if <samp><span class="file">API.dll</span></samp> or <samp><span class="file">libAPI.dll</span></samp> is built with GNU tools
as in this case it is possible to link directly against the
DLL. Otherwise read on.
<div class="node">
<a name="The-Definition-File"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#GNAT_002dStyle-Import-Library">GNAT-Style Import Library</a>,
Up: <a rel="up" accesskey="u" href="#Creating-an-Import-Library">Creating an Import Library</a>
</div>
<h5 class="subsubsection">G.8.2.1 The Definition File</h5>
<p><a name="index-Definition-file-1059"></a><a name="index-g_t_002edef-1060"></a>
As previously mentioned, and unlike Unix systems, the list of symbols
that are exported from a DLL must be provided explicitly in Windows.
The main goal of a definition file is precisely that: list the symbols
exported by a DLL. A definition file (usually a file with a <code>.def</code>
suffix) has the following structure:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
<span class="roman">[</span>LIBRARY <var>name</var><span class="roman">]</span>
<span class="roman">[</span>DESCRIPTION <var>string</var><span class="roman">]</span>
EXPORTS
<var>symbol1</var>
<var>symbol2</var>
...
</td></tr></table>
</pre>
<dl>
<dt><code>LIBRARY </code><var>name</var><dd>This section, which is optional, gives the name of the DLL.
<br><dt><code>DESCRIPTION </code><var>string</var><dd>This section, which is optional, gives a description string that will be
embedded in the import library.
<br><dt><code>EXPORTS</code><dd>This section gives the list of exported symbols (procedures, functions or
variables). For instance in the case of <samp><span class="file">API.dll</span></samp> the <code>EXPORTS</code>
section of <samp><span class="file">API.def</span></samp> looks like:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
EXPORTS
some_var
get
</td></tr></table>
</pre>
</dl>
<p class="noindent">Note that you must specify the correct suffix (<code>@</code><var>nn</var>)
(see <a href="#Windows-Calling-Conventions">Windows Calling Conventions</a>) for a Stdcall
calling convention function in the exported symbols list.
<p class="noindent">There can actually be other sections in a definition file, but these
sections are not relevant to the discussion at hand.
<div class="node">
<a name="GNAT-Style-Import-Library"></a>
<a name="GNAT_002dStyle-Import-Library"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Microsoft_002dStyle-Import-Library">Microsoft-Style Import Library</a>,
Previous: <a rel="previous" accesskey="p" href="#The-Definition-File">The Definition File</a>,
Up: <a rel="up" accesskey="u" href="#Creating-an-Import-Library">Creating an Import Library</a>
</div>
<h5 class="subsubsection">G.8.2.2 GNAT-Style Import Library</h5>
<p class="noindent">To create a static import library from <samp><span class="file">API.dll</span></samp> with the GNAT tools
you should proceed as follows:
<ol type=1 start=1>
<li>Create the definition file <samp><span class="file">API.def</span></samp> (see <a href="#The-Definition-File">The Definition File</a>).
For that use the <code>dll2def</code> tool as follows:
<pre class="smallexample"> $ dll2def API.dll > API.def
</pre>
<p class="noindent"><code>dll2def</code> is a very simple tool: it takes as input a DLL and prints
to standard output the list of entry points in the DLL. Note that if
some routines in the DLL have the <code>Stdcall</code> convention
(see <a href="#Windows-Calling-Conventions">Windows Calling Conventions</a>) with stripped <code>@</code><var>nn</var>
suffix then you'll have to edit <samp><span class="file">api.def</span></samp> to add it, and specify
<samp><span class="option">-k</span></samp> to <samp><span class="command">gnatdll</span></samp> when creating the import library.
<p class="noindent">Here are some hints to find the right <code>@</code><var>nn</var> suffix.
<ol type=1 start=1>
<li>If you have the Microsoft import library (.lib), it is possible to get
the right symbols by using Microsoft <code>dumpbin</code> tool (see the
corresponding Microsoft documentation for further details).
<pre class="smallexample"> $ dumpbin /exports api.lib
</pre>
<li>If you have a message about a missing symbol at link time the compiler
tells you what symbol is expected. You just have to go back to the
definition file and add the right suffix.
</ol>
<li>Build the import library <code>libAPI.dll.a</code>, using <code>gnatdll</code>
(see <a href="#Using-gnatdll">Using gnatdll</a>) as follows:
<pre class="smallexample"> $ gnatdll -e API.def -d API.dll
</pre>
<p class="noindent"><code>gnatdll</code> takes as input a definition file <samp><span class="file">API.def</span></samp> and the
name of the DLL containing the services listed in the definition file
<samp><span class="file">API.dll</span></samp>. The name of the static import library generated is
computed from the name of the definition file as follows: if the
definition file name is <var>xyz</var><code>.def</code>, the import library name will
be <code>lib</code><var>xyz</var><code>.a</code>. Note that in the previous example option
<samp><span class="option">-e</span></samp> could have been removed because the name of the definition
file (before the “<code>.def</code>” suffix) is the same as the name of the
DLL (see <a href="#Using-gnatdll">Using gnatdll</a> for more information about <code>gnatdll</code>).
</ol>
<div class="node">
<a name="Microsoft-Style-Import-Library"></a>
<a name="Microsoft_002dStyle-Import-Library"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#GNAT_002dStyle-Import-Library">GNAT-Style Import Library</a>,
Up: <a rel="up" accesskey="u" href="#Creating-an-Import-Library">Creating an Import Library</a>
</div>
<h5 class="subsubsection">G.8.2.3 Microsoft-Style Import Library</h5>
<p class="noindent">With GNAT you can either use a GNAT-style or Microsoft-style import
library. A Microsoft import library is needed only if you plan to make an
Ada DLL available to applications developed with Microsoft
tools (see <a href="#Mixed_002dLanguage-Programming-on-Windows">Mixed-Language Programming on Windows</a>).
<p>To create a Microsoft-style import library for <samp><span class="file">API.dll</span></samp> you
should proceed as follows:
<ol type=1 start=1>
<li>Create the definition file <samp><span class="file">API.def</span></samp> from the DLL. For this use either
the <code>dll2def</code> tool as described above or the Microsoft <code>dumpbin</code>
tool (see the corresponding Microsoft documentation for further details).
<li>Build the actual import library using Microsoft's <code>lib</code> utility:
<pre class="smallexample"> $ lib -machine:IX86 -def:API.def -out:API.lib
</pre>
<p class="noindent">If you use the above command the definition file <samp><span class="file">API.def</span></samp> must
contain a line giving the name of the DLL:
<pre class="smallexample"> LIBRARY "API"
</pre>
<p class="noindent">See the Microsoft documentation for further details about the usage of
<code>lib</code>.
</ol>
<div class="node">
<a name="Building-DLLs-with-GNAT-Project-files"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Building-DLLs-with-GNAT">Building DLLs with GNAT</a>,
Previous: <a rel="previous" accesskey="p" href="#Using-DLLs-with-GNAT">Using DLLs with GNAT</a>,
Up: <a rel="up" accesskey="u" href="#Microsoft-Windows-Topics">Microsoft Windows Topics</a>
</div>
<h3 class="section">G.9 Building DLLs with GNAT Project files</h3>
<p><a name="index-DLLs_002c-building-1061"></a>
There is nothing specific to Windows in the build process.
see <a href="#Library-Projects">Library Projects</a>.
<p class="noindent">Due to a system limitation, it is not possible under Windows to create threads
when inside the <code>DllMain</code> routine which is used for auto-initialization
of shared libraries, so it is not possible to have library level tasks in SALs.
<div class="node">
<a name="Building-DLLs-with-GNAT"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Building-DLLs-with-gnatdll">Building DLLs with gnatdll</a>,
Previous: <a rel="previous" accesskey="p" href="#Building-DLLs-with-GNAT-Project-files">Building DLLs with GNAT Project files</a>,
Up: <a rel="up" accesskey="u" href="#Microsoft-Windows-Topics">Microsoft Windows Topics</a>
</div>
<h3 class="section">G.10 Building DLLs with GNAT</h3>
<p><a name="index-DLLs_002c-building-1062"></a>
This section explain how to build DLLs using the GNAT built-in DLL
support. With the following procedure it is straight forward to build
and use DLLs with GNAT.
<ol type=1 start=1>
<li>building object files
<p>The first step is to build all objects files that are to be included
into the DLL. This is done by using the standard <samp><span class="command">gnatmake</span></samp> tool.
<li>building the DLL
<p>To build the DLL you must use <samp><span class="command">gcc</span></samp>'s <samp><span class="option">-shared</span></samp> and
<samp><span class="option">-shared-libgcc</span></samp> options. It is quite simple to use this method:
<pre class="smallexample"> $ gcc -shared -shared-libgcc -o api.dll obj1.o obj2.o ...
</pre>
<p>It is important to note that in this case all symbols found in the
object files are automatically exported. It is possible to restrict
the set of symbols to export by passing to <samp><span class="command">gcc</span></samp> a definition
file, see <a href="#The-Definition-File">The Definition File</a>. For example:
<pre class="smallexample"> $ gcc -shared -shared-libgcc -o api.dll api.def obj1.o obj2.o ...
</pre>
<p>If you use a definition file you must export the elaboration procedures
for every package that required one. Elaboration procedures are named
using the package name followed by "_E".
<li>preparing DLL to be used
<p>For the DLL to be used by client programs the bodies must be hidden
from it and the .ali set with read-only attribute. This is very important
otherwise GNAT will recompile all packages and will not actually use
the code in the DLL. For example:
<pre class="smallexample"> $ mkdir apilib
$ copy *.ads *.ali api.dll apilib
$ attrib +R apilib\*.ali
</pre>
</ol>
<p>At this point it is possible to use the DLL by directly linking
against it. Note that you must use the GNAT shared runtime when using
GNAT shared libraries. This is achieved by using <samp><span class="option">-shared</span></samp> binder's
option.
<pre class="smallexample"> $ gnatmake main -Iapilib -bargs -shared -largs -Lapilib -lAPI
</pre>
<div class="node">
<a name="Building-DLLs-with-gnatdll"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#GNAT-and-Windows-Resources">GNAT and Windows Resources</a>,
Previous: <a rel="previous" accesskey="p" href="#Building-DLLs-with-GNAT">Building DLLs with GNAT</a>,
Up: <a rel="up" accesskey="u" href="#Microsoft-Windows-Topics">Microsoft Windows Topics</a>
</div>
<h3 class="section">G.11 Building DLLs with gnatdll</h3>
<p><a name="index-DLLs_002c-building-1063"></a>
<ul class="menu">
<li><a accesskey="1" href="#Limitations-When-Using-Ada-DLLs-from-Ada">Limitations When Using Ada DLLs from Ada</a>
<li><a accesskey="2" href="#Exporting-Ada-Entities">Exporting Ada Entities</a>
<li><a accesskey="3" href="#Ada-DLLs-and-Elaboration">Ada DLLs and Elaboration</a>
<li><a accesskey="4" href="#Ada-DLLs-and-Finalization">Ada DLLs and Finalization</a>
<li><a accesskey="5" href="#Creating-a-Spec-for-Ada-DLLs">Creating a Spec for Ada DLLs</a>
<li><a accesskey="6" href="#Creating-the-Definition-File">Creating the Definition File</a>
<li><a accesskey="7" href="#Using-gnatdll">Using gnatdll</a>
</ul>
<p class="noindent">Note that it is preferred to use GNAT Project files
(see <a href="#Building-DLLs-with-GNAT-Project-files">Building DLLs with GNAT Project files</a>) or the built-in GNAT
DLL support (see <a href="#Building-DLLs-with-GNAT">Building DLLs with GNAT</a>) or to build DLLs.
<p>This section explains how to build DLLs containing Ada code using
<code>gnatdll</code>. These DLLs will be referred to as Ada DLLs in the
remainder of this section.
<p>The steps required to build an Ada DLL that is to be used by Ada as well as
non-Ada applications are as follows:
<ol type=1 start=1>
<li>You need to mark each Ada <i>entity</i> exported by the DLL with a <code>C</code> or
<code>Stdcall</code> calling convention to avoid any Ada name mangling for the
entities exported by the DLL (see <a href="#Exporting-Ada-Entities">Exporting Ada Entities</a>). You can
skip this step if you plan to use the Ada DLL only from Ada applications.
<li>Your Ada code must export an initialization routine which calls the routine
<code>adainit</code> generated by <samp><span class="command">gnatbind</span></samp> to perform the elaboration of
the Ada code in the DLL (see <a href="#Ada-DLLs-and-Elaboration">Ada DLLs and Elaboration</a>). The initialization
routine exported by the Ada DLL must be invoked by the clients of the DLL
to initialize the DLL.
<li>When useful, the DLL should also export a finalization routine which calls
routine <code>adafinal</code> generated by <samp><span class="command">gnatbind</span></samp> to perform the
finalization of the Ada code in the DLL (see <a href="#Ada-DLLs-and-Finalization">Ada DLLs and Finalization</a>).
The finalization routine exported by the Ada DLL must be invoked by the
clients of the DLL when the DLL services are no further needed.
<li>You must provide a spec for the services exported by the Ada DLL in each
of the programming languages to which you plan to make the DLL available.
<li>You must provide a definition file listing the exported entities
(see <a href="#The-Definition-File">The Definition File</a>).
<li>Finally you must use <code>gnatdll</code> to produce the DLL and the import
library (see <a href="#Using-gnatdll">Using gnatdll</a>).
</ol>
<p class="noindent">Note that a relocatable DLL stripped using the <code>strip</code>
binutils tool will not be relocatable anymore. To build a DLL without
debug information pass <code>-largs -s</code> to <code>gnatdll</code>. This
restriction does not apply to a DLL built using a Library Project.
see <a href="#Library-Projects">Library Projects</a>.
<div class="node">
<a name="Limitations-When-Using-Ada-DLLs-from-Ada"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Exporting-Ada-Entities">Exporting Ada Entities</a>,
Up: <a rel="up" accesskey="u" href="#Building-DLLs-with-gnatdll">Building DLLs with gnatdll</a>
</div>
<h4 class="subsection">G.11.1 Limitations When Using Ada DLLs from Ada</h4>
<p class="noindent">When using Ada DLLs from Ada applications there is a limitation users
should be aware of. Because on Windows the GNAT run time is not in a DLL of
its own, each Ada DLL includes a part of the GNAT run time. Specifically,
each Ada DLL includes the services of the GNAT run time that are necessary
to the Ada code inside the DLL. As a result, when an Ada program uses an
Ada DLL there are two independent GNAT run times: one in the Ada DLL and
one in the main program.
<p>It is therefore not possible to exchange GNAT run-time objects between the
Ada DLL and the main Ada program. Example of GNAT run-time objects are file
handles (e.g. <code>Text_IO.File_Type</code>), tasks types, protected objects
types, etc.
<p>It is completely safe to exchange plain elementary, array or record types,
Windows object handles, etc.
<div class="node">
<a name="Exporting-Ada-Entities"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Ada-DLLs-and-Elaboration">Ada DLLs and Elaboration</a>,
Previous: <a rel="previous" accesskey="p" href="#Limitations-When-Using-Ada-DLLs-from-Ada">Limitations When Using Ada DLLs from Ada</a>,
Up: <a rel="up" accesskey="u" href="#Building-DLLs-with-gnatdll">Building DLLs with gnatdll</a>
</div>
<h4 class="subsection">G.11.2 Exporting Ada Entities</h4>
<p><a name="index-Export-table-1064"></a>
Building a DLL is a way to encapsulate a set of services usable from any
application. As a result, the Ada entities exported by a DLL should be
exported with the <code>C</code> or <code>Stdcall</code> calling conventions to avoid
any Ada name mangling. As an example here is an Ada package
<code>API</code>, spec and body, exporting two procedures, a function, and a
variable:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
with Interfaces.C; use Interfaces;
package API is
Count : C.int := 0;
function Factorial (Val : C.int) return C.int;
procedure Initialize_API;
procedure Finalize_API;
-- Initialization & Finalization routines. More in the next section.
private
pragma Export (C, Initialize_API);
pragma Export (C, Finalize_API);
pragma Export (C, Count);
pragma Export (C, Factorial);
end API;
</td></tr></table>
</pre>
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
package body API is
function Factorial (Val : C.int) return C.int is
Fact : C.int := 1;
begin
Count := Count + 1;
for K in 1 .. Val loop
Fact := Fact * K;
end loop;
return Fact;
end Factorial;
procedure Initialize_API is
procedure Adainit;
pragma Import (C, Adainit);
begin
Adainit;
end Initialize_API;
procedure Finalize_API is
procedure Adafinal;
pragma Import (C, Adafinal);
begin
Adafinal;
end Finalize_API;
end API;
</td></tr></table>
</pre>
<p class="noindent">If the Ada DLL you are building will only be used by Ada applications
you do not have to export Ada entities with a <code>C</code> or <code>Stdcall</code>
convention. As an example, the previous package could be written as
follows:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
package API is
Count : Integer := 0;
function Factorial (Val : Integer) return Integer;
procedure Initialize_API;
procedure Finalize_API;
-- Initialization and Finalization routines.
end API;
</td></tr></table>
</pre>
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
package body API is
function Factorial (Val : Integer) return Integer is
Fact : Integer := 1;
begin
Count := Count + 1;
for K in 1 .. Val loop
Fact := Fact * K;
end loop;
return Fact;
end Factorial;
...
-- The remainder of this package body is unchanged.
end API;
</td></tr></table>
</pre>
<p class="noindent">Note that if you do not export the Ada entities with a <code>C</code> or
<code>Stdcall</code> convention you will have to provide the mangled Ada names
in the definition file of the Ada DLL
(see <a href="#Creating-the-Definition-File">Creating the Definition File</a>).
<div class="node">
<a name="Ada-DLLs-and-Elaboration"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Ada-DLLs-and-Finalization">Ada DLLs and Finalization</a>,
Previous: <a rel="previous" accesskey="p" href="#Exporting-Ada-Entities">Exporting Ada Entities</a>,
Up: <a rel="up" accesskey="u" href="#Building-DLLs-with-gnatdll">Building DLLs with gnatdll</a>
</div>
<h4 class="subsection">G.11.3 Ada DLLs and Elaboration</h4>
<p><a name="index-DLLs-and-elaboration-1065"></a>
The DLL that you are building contains your Ada code as well as all the
routines in the Ada library that are needed by it. The first thing a
user of your DLL must do is elaborate the Ada code
(see <a href="#Elaboration-Order-Handling-in-GNAT">Elaboration Order Handling in GNAT</a>).
<p>To achieve this you must export an initialization routine
(<code>Initialize_API</code> in the previous example), which must be invoked
before using any of the DLL services. This elaboration routine must call
the Ada elaboration routine <code>adainit</code> generated by the GNAT binder
(see <a href="#Binding-with-Non_002dAda-Main-Programs">Binding with Non-Ada Main Programs</a>). See the body of
<code>Initialize_Api</code> for an example. Note that the GNAT binder is
automatically invoked during the DLL build process by the <code>gnatdll</code>
tool (see <a href="#Using-gnatdll">Using gnatdll</a>).
<p>When a DLL is loaded, Windows systematically invokes a routine called
<code>DllMain</code>. It would therefore be possible to call <code>adainit</code>
directly from <code>DllMain</code> without having to provide an explicit
initialization routine. Unfortunately, it is not possible to call
<code>adainit</code> from the <code>DllMain</code> if your program has library level
tasks because access to the <code>DllMain</code> entry point is serialized by
the system (that is, only a single thread can execute “through” it at a
time), which means that the GNAT run time will deadlock waiting for the
newly created task to complete its initialization.
<div class="node">
<a name="Ada-DLLs-and-Finalization"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Creating-a-Spec-for-Ada-DLLs">Creating a Spec for Ada DLLs</a>,
Previous: <a rel="previous" accesskey="p" href="#Ada-DLLs-and-Elaboration">Ada DLLs and Elaboration</a>,
Up: <a rel="up" accesskey="u" href="#Building-DLLs-with-gnatdll">Building DLLs with gnatdll</a>
</div>
<h4 class="subsection">G.11.4 Ada DLLs and Finalization</h4>
<p><a name="index-DLLs-and-finalization-1066"></a>
When the services of an Ada DLL are no longer needed, the client code should
invoke the DLL finalization routine, if available. The DLL finalization
routine is in charge of releasing all resources acquired by the DLL. In the
case of the Ada code contained in the DLL, this is achieved by calling
routine <code>adafinal</code> generated by the GNAT binder
(see <a href="#Binding-with-Non_002dAda-Main-Programs">Binding with Non-Ada Main Programs</a>).
See the body of <code>Finalize_Api</code> for an
example. As already pointed out the GNAT binder is automatically invoked
during the DLL build process by the <code>gnatdll</code> tool
(see <a href="#Using-gnatdll">Using gnatdll</a>).
<div class="node">
<a name="Creating-a-Spec-for-Ada-DLLs"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Creating-the-Definition-File">Creating the Definition File</a>,
Previous: <a rel="previous" accesskey="p" href="#Ada-DLLs-and-Finalization">Ada DLLs and Finalization</a>,
Up: <a rel="up" accesskey="u" href="#Building-DLLs-with-gnatdll">Building DLLs with gnatdll</a>
</div>
<h4 class="subsection">G.11.5 Creating a Spec for Ada DLLs</h4>
<p class="noindent">To use the services exported by the Ada DLL from another programming
language (e.g. C), you have to translate the specs of the exported Ada
entities in that language. For instance in the case of <code>API.dll</code>,
the corresponding C header file could look like:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
extern int *_imp__count;
#define count (*_imp__count)
int factorial (int);
</td></tr></table>
</pre>
<p class="noindent">It is important to understand that when building an Ada DLL to be used by
other Ada applications, you need two different specs for the packages
contained in the DLL: one for building the DLL and the other for using
the DLL. This is because the <code>DLL</code> calling convention is needed to
use a variable defined in a DLL, but when building the DLL, the variable
must have either the <code>Ada</code> or <code>C</code> calling convention. As an
example consider a DLL comprising the following package <code>API</code>:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
package API is
Count : Integer := 0;
...
-- Remainder of the package omitted.
end API;
</td></tr></table>
</pre>
<p class="noindent">After producing a DLL containing package <code>API</code>, the spec that
must be used to import <code>API.Count</code> from Ada code outside of the
DLL is:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
package API is
Count : Integer;
pragma Import (DLL, Count);
end API;
</td></tr></table>
</pre>
<div class="node">
<a name="Creating-the-Definition-File"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Using-gnatdll">Using gnatdll</a>,
Previous: <a rel="previous" accesskey="p" href="#Creating-a-Spec-for-Ada-DLLs">Creating a Spec for Ada DLLs</a>,
Up: <a rel="up" accesskey="u" href="#Building-DLLs-with-gnatdll">Building DLLs with gnatdll</a>
</div>
<h4 class="subsection">G.11.6 Creating the Definition File</h4>
<p class="noindent">The definition file is the last file needed to build the DLL. It lists
the exported symbols. As an example, the definition file for a DLL
containing only package <code>API</code> (where all the entities are exported
with a <code>C</code> calling convention) is:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
EXPORTS
count
factorial
finalize_api
initialize_api
</td></tr></table>
</pre>
<p class="noindent">If the <code>C</code> calling convention is missing from package <code>API</code>,
then the definition file contains the mangled Ada names of the above
entities, which in this case are:
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
EXPORTS
api__count
api__factorial
api__finalize_api
api__initialize_api
</td></tr></table>
</pre>
<div class="node">
<a name="Using-gnatdll"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Creating-the-Definition-File">Creating the Definition File</a>,
Up: <a rel="up" accesskey="u" href="#Building-DLLs-with-gnatdll">Building DLLs with gnatdll</a>
</div>
<h4 class="subsection">G.11.7 Using <code>gnatdll</code></h4>
<p><a name="index-gnatdll-1067"></a>
<ul class="menu">
<li><a accesskey="1" href="#gnatdll-Example">gnatdll Example</a>
<li><a accesskey="2" href="#gnatdll-behind-the-Scenes">gnatdll behind the Scenes</a>
<li><a accesskey="3" href="#Using-dlltool">Using dlltool</a>
</ul>
<p class="noindent"><code>gnatdll</code> is a tool to automate the DLL build process once all the Ada
and non-Ada sources that make up your DLL have been compiled.
<code>gnatdll</code> is actually in charge of two distinct tasks: build the
static import library for the DLL and the actual DLL. The form of the
<code>gnatdll</code> command is
<pre class="smallexample"> <p><table class="cartouche" summary="cartouche" border="1"><tr><td>
<!-- $ gnatdll @ovar{switches} @var{list-of-files} @r{[}-largs @var{opts}@r{]} -->
<!-- Expanding @ovar macro inline (explanation in macro def comments) -->
$ gnatdll <span class="roman">[</span><var>switches</var><span class="roman">]</span> <var>list-of-files</var> <span class="roman">[</span>-largs <var>opts</var><span class="roman">]</span>
</td></tr></table>
</pre>
<p class="noindent">where <var>list-of-files</var> is a list of ALI and object files. The object
file list must be the exact list of objects corresponding to the non-Ada
sources whose services are to be included in the DLL. The ALI file list
must be the exact list of ALI files for the corresponding Ada sources
whose services are to be included in the DLL. If <var>list-of-files</var> is
missing, only the static import library is generated.
<p class="noindent">You may specify any of the following switches to <code>gnatdll</code>:
<dl>
<!-- @item -a@ovar{address} -->
<!-- Expanding @ovar macro inline (explanation in macro def comments) -->
<dt><code>-a</code><span class="roman">[</span><var>address</var><span class="roman">]</span><dd><a name="index-g_t_0040option_007b_002da_007d-_0028_0040code_007bgnatdll_007d_0029-1068"></a>Build a non-relocatable DLL at <var>address</var>. If <var>address</var> is not
specified the default address <var>0x11000000</var> will be used. By default,
when this switch is missing, <code>gnatdll</code> builds relocatable DLL. We
advise the reader to build relocatable DLL.
<br><dt><code>-b </code><var>address</var><dd><a name="index-g_t_0040option_007b_002db_007d-_0028_0040code_007bgnatdll_007d_0029-1069"></a>Set the relocatable DLL base address. By default the address is
<code>0x11000000</code>.
<br><dt><code>-bargs </code><var>opts</var><dd><a name="index-g_t_0040option_007b_002dbargs_007d-_0028_0040code_007bgnatdll_007d_0029-1070"></a>Binder options. Pass <var>opts</var> to the binder.
<br><dt><code>-d </code><var>dllfile</var><dd><a name="index-g_t_0040option_007b_002dd_007d-_0028_0040code_007bgnatdll_007d_0029-1071"></a><var>dllfile</var> is the name of the DLL. This switch must be present for
<code>gnatdll</code> to do anything. The name of the generated import library is
obtained algorithmically from <var>dllfile</var> as shown in the following
example: if <var>dllfile</var> is <code>xyz.dll</code>, the import library name is
<code>libxyz.dll.a</code>. The name of the definition file to use (if not specified
by option <samp><span class="option">-e</span></samp>) is obtained algorithmically from <var>dllfile</var>
as shown in the following example:
if <var>dllfile</var> is <code>xyz.dll</code>, the definition
file used is <code>xyz.def</code>.
<br><dt><code>-e </code><var>deffile</var><dd><a name="index-g_t_0040option_007b_002de_007d-_0028_0040code_007bgnatdll_007d_0029-1072"></a><var>deffile</var> is the name of the definition file.
<br><dt><code>-g</code><dd><a name="index-g_t_0040option_007b_002dg_007d-_0028_0040code_007bgnatdll_007d_0029-1073"></a>Generate debugging information. This information is stored in the object
file and copied from there to the final DLL file by the linker,
where it can be read by the debugger. You must use the
<samp><span class="option">-g</span></samp> switch if you plan on using the debugger or the symbolic
stack traceback.
<br><dt><code>-h</code><dd><a name="index-g_t_0040option_007b_002dh_007d-_0028_0040code_007bgnatdll_007d_0029-1074"></a>Help mode. Displays <code>gnatdll</code> switch usage information.
<br><dt><code>-Idir</code><dd><a name="index-g_t_0040option_007b_002dI_007d-_0028_0040code_007bgnatdll_007d_0029-1075"></a>Direct <code>gnatdll</code> to search the <var>dir</var> directory for source and
object files needed to build the DLL.
(see <a href="#Search-Paths-and-the-Run_002dTime-Library-_0028RTL_0029">Search Paths and the Run-Time Library (RTL)</a>).
<br><dt><code>-k</code><dd><a name="index-g_t_0040option_007b_002dk_007d-_0028_0040code_007bgnatdll_007d_0029-1076"></a>Removes the <code>@</code><var>nn</var> suffix from the import library's exported
names, but keeps them for the link names. You must specify this
option if you want to use a <code>Stdcall</code> function in a DLL for which
the <code>@</code><var>nn</var> suffix has been removed. This is the case for most
of the Windows NT DLL for example. This option has no effect when
<samp><span class="option">-n</span></samp> option is specified.
<br><dt><code>-l </code><var>file</var><dd><a name="index-g_t_0040option_007b_002dl_007d-_0028_0040code_007bgnatdll_007d_0029-1077"></a>The list of ALI and object files used to build the DLL are listed in
<var>file</var>, instead of being given in the command line. Each line in
<var>file</var> contains the name of an ALI or object file.
<br><dt><code>-n</code><dd><a name="index-g_t_0040option_007b_002dn_007d-_0028_0040code_007bgnatdll_007d_0029-1078"></a>No Import. Do not create the import library.
<br><dt><code>-q</code><dd><a name="index-g_t_0040option_007b_002dq_007d-_0028_0040code_007bgnatdll_007d_0029-1079"></a>Quiet mode. Do not display unnecessary messages.
<br><dt><code>-v</code><dd><a name="index-g_t_0040option_007b_002dv_007d-_0028_0040code_007bgnatdll_007d_0029-1080"></a>Verbose mode. Display extra information.
<br><dt><code>-largs </code><var>opts</var><dd><a name="index-g_t_0040option_007b_002dlargs_007d-_0028_0040code_007bgnatdll_007d_0029-1081"></a>Linker options. Pass <var>opts</var> to the linker.
</dl>
<div class="node">
<a name="gnatdll-Example"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#gnatdll-behind-the-Scenes">gnatdll behind the Scenes</a>,
Up: <a rel="up" accesskey="u" href="#Using-gnatdll">Using gnatdll</a>
</div>
<h5 class="subsubsection">G.11.7.1 <code>gnatdll</code> Example</h5>
<p class="noindent">As an example the command to build a relocatable DLL from <samp><span class="file">api.adb</span></samp>
once <samp><span class="file">api.adb</span></samp> has been compiled and <samp><span class="file">api.def</span></samp> created is
<pre class="smallexample"> $ gnatdll -d api.dll api.ali
</pre>
<p class="noindent">The above command creates two files: <samp><span class="file">libapi.dll.a</span></samp> (the import
library) and <samp><span class="file">api.dll</span></samp> (the actual DLL). If you want to create
only the DLL, just type:
<pre class="smallexample"> $ gnatdll -d api.dll -n api.ali
</pre>
<p class="noindent">Alternatively if you want to create just the import library, type:
<pre class="smallexample"> $ gnatdll -d api.dll
</pre>
<div class="node">
<a name="gnatdll-behind-the-Scenes"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Using-dlltool">Using dlltool</a>,
Previous: <a rel="previous" accesskey="p" href="#gnatdll-Example">gnatdll Example</a>,
Up: <a rel="up" accesskey="u" href="#Using-gnatdll">Using gnatdll</a>
</div>
<h5 class="subsubsection">G.11.7.2 <code>gnatdll</code> behind the Scenes</h5>
<p class="noindent">This section details the steps involved in creating a DLL. <code>gnatdll</code>
does these steps for you. Unless you are interested in understanding what
goes on behind the scenes, you should skip this section.
<p>We use the previous example of a DLL containing the Ada package <code>API</code>,
to illustrate the steps necessary to build a DLL. The starting point is a
set of objects that will make up the DLL and the corresponding ALI
files. In the case of this example this means that <samp><span class="file">api.o</span></samp> and
<samp><span class="file">api.ali</span></samp> are available. To build a relocatable DLL, <code>gnatdll</code> does
the following:
<ol type=1 start=1>
<li><code>gnatdll</code> builds the base file (<samp><span class="file">api.base</span></samp>). A base file gives
the information necessary to generate relocation information for the
DLL.
<pre class="smallexample"> $ gnatbind -n api
$ gnatlink api -o api.jnk -mdll -Wl,--base-file,api.base
</pre>
<p class="noindent">In addition to the base file, the <samp><span class="command">gnatlink</span></samp> command generates an
output file <samp><span class="file">api.jnk</span></samp> which can be discarded. The <samp><span class="option">-mdll</span></samp> switch
asks <samp><span class="command">gnatlink</span></samp> to generate the routines <code>DllMain</code> and
<code>DllMainCRTStartup</code> that are called by the Windows loader when the DLL
is loaded into memory.
<li><code>gnatdll</code> uses <code>dlltool</code> (see <a href="#Using-dlltool">Using dlltool</a>) to build the
export table (<samp><span class="file">api.exp</span></samp>). The export table contains the relocation
information in a form which can be used during the final link to ensure
that the Windows loader is able to place the DLL anywhere in memory.
<pre class="smallexample"> $ dlltool --dllname api.dll --def api.def --base-file api.base \
--output-exp api.exp
</pre>
<li><code>gnatdll</code> builds the base file using the new export table. Note that
<samp><span class="command">gnatbind</span></samp> must be called once again since the binder generated file
has been deleted during the previous call to <samp><span class="command">gnatlink</span></samp>.
<pre class="smallexample"> $ gnatbind -n api
$ gnatlink api -o api.jnk api.exp -mdll
-Wl,--base-file,api.base
</pre>
<li><code>gnatdll</code> builds the new export table using the new base file and
generates the DLL import library <samp><span class="file">libAPI.dll.a</span></samp>.
<pre class="smallexample"> $ dlltool --dllname api.dll --def api.def --base-file api.base \
--output-exp api.exp --output-lib libAPI.a
</pre>
<li>Finally <code>gnatdll</code> builds the relocatable DLL using the final export
table.
<pre class="smallexample"> $ gnatbind -n api
$ gnatlink api api.exp -o api.dll -mdll
</pre>
</ol>
<div class="node">
<a name="Using-dlltool"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#gnatdll-behind-the-Scenes">gnatdll behind the Scenes</a>,
Up: <a rel="up" accesskey="u" href="#Using-gnatdll">Using gnatdll</a>
</div>
<h5 class="subsubsection">G.11.7.3 Using <code>dlltool</code></h5>
<p class="noindent"><code>dlltool</code> is the low-level tool used by <code>gnatdll</code> to build
DLLs and static import libraries. This section summarizes the most
common <code>dlltool</code> switches. The form of the <code>dlltool</code> command
is
<pre class="smallexample"> <!-- $ dlltool @ovar{switches} -->
<!-- Expanding @ovar macro inline (explanation in macro def comments) -->
$ dlltool <span class="roman">[</span><var>switches</var><span class="roman">]</span>
</pre>
<p class="noindent"><code>dlltool</code> switches include:
<dl>
<dt><samp><span class="option">--base-file </span><var>basefile</var></samp><dd><a name="index-g_t_0040option_007b_002d_002dbase_002dfile_007d-_0028_0040command_007bdlltool_007d_0029-1082"></a>Read the base file <var>basefile</var> generated by the linker. This switch
is used to create a relocatable DLL.
<br><dt><samp><span class="option">--def </span><var>deffile</var></samp><dd><a name="index-g_t_0040option_007b_002d_002ddef_007d-_0028_0040command_007bdlltool_007d_0029-1083"></a>Read the definition file.
<br><dt><samp><span class="option">--dllname </span><var>name</var></samp><dd><a name="index-g_t_0040option_007b_002d_002ddllname_007d-_0028_0040command_007bdlltool_007d_0029-1084"></a>Gives the name of the DLL. This switch is used to embed the name of the
DLL in the static import library generated by <code>dlltool</code> with switch
<samp><span class="option">--output-lib</span></samp>.
<br><dt><samp><span class="option">-k</span></samp><dd><a name="index-g_t_0040option_007b_002dk_007d-_0028_0040command_007bdlltool_007d_0029-1085"></a>Kill <code>@</code><var>nn</var> from exported names
(see <a href="#Windows-Calling-Conventions">Windows Calling Conventions</a>
for a discussion about <code>Stdcall</code>-style symbols.
<br><dt><samp><span class="option">--help</span></samp><dd><a name="index-g_t_0040option_007b_002d_002dhelp_007d-_0028_0040command_007bdlltool_007d_0029-1086"></a>Prints the <code>dlltool</code> switches with a concise description.
<br><dt><samp><span class="option">--output-exp </span><var>exportfile</var></samp><dd><a name="index-g_t_0040option_007b_002d_002doutput_002dexp_007d-_0028_0040command_007bdlltool_007d_0029-1087"></a>Generate an export file <var>exportfile</var>. The export file contains the
export table (list of symbols in the DLL) and is used to create the DLL.
<br><dt><samp><span class="option">--output-lib </span><var>libfile</var></samp><dd><a name="index-g_t_0040option_007b_002d_002doutput_002dlib_007d-_0028_0040command_007bdlltool_007d_0029-1088"></a>Generate a static import library <var>libfile</var>.
<br><dt><samp><span class="option">-v</span></samp><dd><a name="index-g_t_0040option_007b_002dv_007d-_0028_0040command_007bdlltool_007d_0029-1089"></a>Verbose mode.
<br><dt><samp><span class="option">--as </span><var>assembler-name</var></samp><dd><a name="index-g_t_0040option_007b_002d_002das_007d-_0028_0040command_007bdlltool_007d_0029-1090"></a>Use <var>assembler-name</var> as the assembler. The default is <code>as</code>.
</dl>
<div class="node">
<a name="GNAT-and-Windows-Resources"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Debugging-a-DLL">Debugging a DLL</a>,
Previous: <a rel="previous" accesskey="p" href="#Building-DLLs-with-gnatdll">Building DLLs with gnatdll</a>,
Up: <a rel="up" accesskey="u" href="#Microsoft-Windows-Topics">Microsoft Windows Topics</a>
</div>
<h3 class="section">G.12 GNAT and Windows Resources</h3>
<p><a name="index-Resources_002c-windows-1091"></a>
<ul class="menu">
<li><a accesskey="1" href="#Building-Resources">Building Resources</a>
<li><a accesskey="2" href="#Compiling-Resources">Compiling Resources</a>
<li><a accesskey="3" href="#Using-Resources">Using Resources</a>
</ul>
<p class="noindent">Resources are an easy way to add Windows specific objects to your
application. The objects that can be added as resources include:
<ul>
<li>menus
<li>accelerators
<li>dialog boxes
<li>string tables
<li>bitmaps
<li>cursors
<li>icons
<li>fonts
</ul>
<p class="noindent">This section explains how to build, compile and use resources.
<div class="node">
<a name="Building-Resources"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Compiling-Resources">Compiling Resources</a>,
Up: <a rel="up" accesskey="u" href="#GNAT-and-Windows-Resources">GNAT and Windows Resources</a>
</div>
<h4 class="subsection">G.12.1 Building Resources</h4>
<p><a name="index-Resources_002c-building-1092"></a>
A resource file is an ASCII file. By convention resource files have an
<samp><span class="file">.rc</span></samp> extension.
The easiest way to build a resource file is to use Microsoft tools
such as <code>imagedit.exe</code> to build bitmaps, icons and cursors and
<code>dlgedit.exe</code> to build dialogs.
It is always possible to build an <samp><span class="file">.rc</span></samp> file yourself by writing a
resource script.
<p>It is not our objective to explain how to write a resource file. A
complete description of the resource script language can be found in the
Microsoft documentation.
<div class="node">
<a name="Compiling-Resources"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Using-Resources">Using Resources</a>,
Previous: <a rel="previous" accesskey="p" href="#Building-Resources">Building Resources</a>,
Up: <a rel="up" accesskey="u" href="#GNAT-and-Windows-Resources">GNAT and Windows Resources</a>
</div>
<h4 class="subsection">G.12.2 Compiling Resources</h4>
<p><a name="index-rc-1093"></a><a name="index-windres-1094"></a><a name="index-Resources_002c-compiling-1095"></a>
This section describes how to build a GNAT-compatible (COFF) object file
containing the resources. This is done using the Resource Compiler
<code>windres</code> as follows:
<pre class="smallexample"> $ windres -i myres.rc -o myres.o
</pre>
<p class="noindent">By default <code>windres</code> will run <samp><span class="command">gcc</span></samp> to preprocess the <samp><span class="file">.rc</span></samp>
file. You can specify an alternate preprocessor (usually named
<samp><span class="file">cpp.exe</span></samp>) using the <code>windres</code> <samp><span class="option">--preprocessor</span></samp>
parameter. A list of all possible options may be obtained by entering
the command <code>windres</code> <samp><span class="option">--help</span></samp>.
<p>It is also possible to use the Microsoft resource compiler <code>rc.exe</code>
to produce a <samp><span class="file">.res</span></samp> file (binary resource file). See the
corresponding Microsoft documentation for further details. In this case
you need to use <code>windres</code> to translate the <samp><span class="file">.res</span></samp> file to a
GNAT-compatible object file as follows:
<pre class="smallexample"> $ windres -i myres.res -o myres.o
</pre>
<div class="node">
<a name="Using-Resources"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Compiling-Resources">Compiling Resources</a>,
Up: <a rel="up" accesskey="u" href="#GNAT-and-Windows-Resources">GNAT and Windows Resources</a>
</div>
<h4 class="subsection">G.12.3 Using Resources</h4>
<p><a name="index-Resources_002c-using-1096"></a>
To include the resource file in your program just add the
GNAT-compatible object file for the resource(s) to the linker
arguments. With <samp><span class="command">gnatmake</span></samp> this is done by using the <samp><span class="option">-largs</span></samp>
option:
<pre class="smallexample"> $ gnatmake myprog -largs myres.o
</pre>
<div class="node">
<a name="Debugging-a-DLL"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Setting-Stack-Size-from-gnatlink">Setting Stack Size from gnatlink</a>,
Previous: <a rel="previous" accesskey="p" href="#GNAT-and-Windows-Resources">GNAT and Windows Resources</a>,
Up: <a rel="up" accesskey="u" href="#Microsoft-Windows-Topics">Microsoft Windows Topics</a>
</div>
<h3 class="section">G.13 Debugging a DLL</h3>
<p><a name="index-DLL-debugging-1097"></a>
<ul class="menu">
<li><a accesskey="1" href="#Program-and-DLL-Both-Built-with-GCC_002fGNAT">Program and DLL Both Built with GCC/GNAT</a>
<li><a accesskey="2" href="#Program-Built-with-Foreign-Tools-and-DLL-Built-with-GCC_002fGNAT">Program Built with Foreign Tools and DLL Built with GCC/GNAT</a>
</ul>
<p class="noindent">Debugging a DLL is similar to debugging a standard program. But
we have to deal with two different executable parts: the DLL and the
program that uses it. We have the following four possibilities:
<ol type=1 start=1>
<li>The program and the DLL are built with <code>GCC/GNAT</code>.
<li>The program is built with foreign tools and the DLL is built with
<code>GCC/GNAT</code>.
<li>The program is built with <code>GCC/GNAT</code> and the DLL is built with
foreign tools.
</ol>
<p class="noindent">In this section we address only cases one and two above.
There is no point in trying to debug
a DLL with <code>GNU/GDB</code>, if there is no GDB-compatible debugging
information in it. To do so you must use a debugger compatible with the
tools suite used to build the DLL.
<div class="node">
<a name="Program-and-DLL-Both-Built-with-GCC%2fGNAT"></a>
<a name="Program-and-DLL-Both-Built-with-GCC_002fGNAT"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Program-Built-with-Foreign-Tools-and-DLL-Built-with-GCC_002fGNAT">Program Built with Foreign Tools and DLL Built with GCC/GNAT</a>,
Up: <a rel="up" accesskey="u" href="#Debugging-a-DLL">Debugging a DLL</a>
</div>
<h4 class="subsection">G.13.1 Program and DLL Both Built with GCC/GNAT</h4>
<p class="noindent">This is the simplest case. Both the DLL and the program have <code>GDB</code>
compatible debugging information. It is then possible to break anywhere in
the process. Let's suppose here that the main procedure is named
<code>ada_main</code> and that in the DLL there is an entry point named
<code>ada_dll</code>.
<p class="noindent">The DLL (see <a href="#Introduction-to-Dynamic-Link-Libraries-_0028DLLs_0029">Introduction to Dynamic Link Libraries (DLLs)</a>) and
program must have been built with the debugging information (see GNAT -g
switch). Here are the step-by-step instructions for debugging it:
<ol type=1 start=1>
<li>Launch <code>GDB</code> on the main program.
<pre class="smallexample"> $ gdb -nw ada_main
</pre>
<li>Start the program and stop at the beginning of the main procedure
<pre class="smallexample"> (gdb) start
</pre>
<p class="noindent">This step is required to be able to set a breakpoint inside the DLL. As long
as the program is not run, the DLL is not loaded. This has the
consequence that the DLL debugging information is also not loaded, so it is not
possible to set a breakpoint in the DLL.
<li>Set a breakpoint inside the DLL
<pre class="smallexample"> (gdb) break ada_dll
(gdb) cont
</pre>
</ol>
<p class="noindent">At this stage a breakpoint is set inside the DLL. From there on
you can use the standard approach to debug the whole program
(see <a href="#Running-and-Debugging-Ada-Programs">Running and Debugging Ada Programs</a>).
<div class="node">
<a name="Program-Built-with-Foreign-Tools-and-DLL-Built-with-GCC%2fGNAT"></a>
<a name="Program-Built-with-Foreign-Tools-and-DLL-Built-with-GCC_002fGNAT"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Program-and-DLL-Both-Built-with-GCC_002fGNAT">Program and DLL Both Built with GCC/GNAT</a>,
Up: <a rel="up" accesskey="u" href="#Debugging-a-DLL">Debugging a DLL</a>
</div>
<h4 class="subsection">G.13.2 Program Built with Foreign Tools and DLL Built with GCC/GNAT</h4>
<ul class="menu">
<li><a accesskey="1" href="#Debugging-the-DLL-Directly">Debugging the DLL Directly</a>
<li><a accesskey="2" href="#Attaching-to-a-Running-Process">Attaching to a Running Process</a>
</ul>
<p class="noindent">In this case things are slightly more complex because it is not possible to
start the main program and then break at the beginning to load the DLL and the
associated DLL debugging information. It is not possible to break at the
beginning of the program because there is no <code>GDB</code> debugging information,
and therefore there is no direct way of getting initial control. This
section addresses this issue by describing some methods that can be used
to break somewhere in the DLL to debug it.
<p class="noindent">First suppose that the main procedure is named <code>main</code> (this is for
example some C code built with Microsoft Visual C) and that there is a
DLL named <code>test.dll</code> containing an Ada entry point named
<code>ada_dll</code>.
<p class="noindent">The DLL (see <a href="#Introduction-to-Dynamic-Link-Libraries-_0028DLLs_0029">Introduction to Dynamic Link Libraries (DLLs)</a>) must have
been built with debugging information (see GNAT -g option).
<div class="node">
<a name="Debugging-the-DLL-Directly"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Attaching-to-a-Running-Process">Attaching to a Running Process</a>,
Up: <a rel="up" accesskey="u" href="#Program-Built-with-Foreign-Tools-and-DLL-Built-with-GCC_002fGNAT">Program Built with Foreign Tools and DLL Built with GCC/GNAT</a>
</div>
<h5 class="subsubsection">G.13.2.1 Debugging the DLL Directly</h5>
<ol type=1 start=1>
<li>Find out the executable starting address
<pre class="smallexample"> $ objdump --file-header main.exe
</pre>
<p>The starting address is reported on the last line. For example:
<pre class="smallexample"> main.exe: file format pei-i386
architecture: i386, flags 0x0000010a:
EXEC_P, HAS_DEBUG, D_PAGED
start address 0x00401010
</pre>
<li>Launch the debugger on the executable.
<pre class="smallexample"> $ gdb main.exe
</pre>
<li>Set a breakpoint at the starting address, and launch the program.
<pre class="smallexample"> $ (gdb) break *0x00401010
$ (gdb) run
</pre>
<p>The program will stop at the given address.
<li>Set a breakpoint on a DLL subroutine.
<pre class="smallexample"> (gdb) break ada_dll.adb:45
</pre>
<p>Or if you want to break using a symbol on the DLL, you need first to
select the Ada language (language used by the DLL).
<pre class="smallexample"> (gdb) set language ada
(gdb) break ada_dll
</pre>
<li>Continue the program.
<pre class="smallexample"> (gdb) cont
</pre>
<p class="noindent">This will run the program until it reaches the breakpoint that has been
set. From that point you can use the standard way to debug a program
as described in (see <a href="#Running-and-Debugging-Ada-Programs">Running and Debugging Ada Programs</a>).
</ol>
<p class="noindent">It is also possible to debug the DLL by attaching to a running process.
<div class="node">
<a name="Attaching-to-a-Running-Process"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Debugging-the-DLL-Directly">Debugging the DLL Directly</a>,
Up: <a rel="up" accesskey="u" href="#Program-Built-with-Foreign-Tools-and-DLL-Built-with-GCC_002fGNAT">Program Built with Foreign Tools and DLL Built with GCC/GNAT</a>
</div>
<h5 class="subsubsection">G.13.2.2 Attaching to a Running Process</h5>
<p><a name="index-DLL-debugging_002c-attach-to-process-1098"></a>
With <code>GDB</code> it is always possible to debug a running process by
attaching to it. It is possible to debug a DLL this way. The limitation
of this approach is that the DLL must run long enough to perform the
attach operation. It may be useful for instance to insert a time wasting
loop in the code of the DLL to meet this criterion.
<ol type=1 start=1>
<li>Launch the main program <samp><span class="file">main.exe</span></samp>.
<pre class="smallexample"> $ main
</pre>
<li>Use the Windows <i>Task Manager</i> to find the process ID. Let's say
that the process PID for <samp><span class="file">main.exe</span></samp> is 208.
<li>Launch gdb.
<pre class="smallexample"> $ gdb
</pre>
<li>Attach to the running process to be debugged.
<pre class="smallexample"> (gdb) attach 208
</pre>
<li>Load the process debugging information.
<pre class="smallexample"> (gdb) symbol-file main.exe
</pre>
<li>Break somewhere in the DLL.
<pre class="smallexample"> (gdb) break ada_dll
</pre>
<li>Continue process execution.
<pre class="smallexample"> (gdb) cont
</pre>
</ol>
<p class="noindent">This last step will resume the process execution, and stop at
the breakpoint we have set. From there you can use the standard
approach to debug a program as described in
(see <a href="#Running-and-Debugging-Ada-Programs">Running and Debugging Ada Programs</a>).
<div class="node">
<a name="Setting-Stack-Size-from-gnatlink"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Setting-Heap-Size-from-gnatlink">Setting Heap Size from gnatlink</a>,
Previous: <a rel="previous" accesskey="p" href="#Debugging-a-DLL">Debugging a DLL</a>,
Up: <a rel="up" accesskey="u" href="#Microsoft-Windows-Topics">Microsoft Windows Topics</a>
</div>
<h3 class="section">G.14 Setting Stack Size from <samp><span class="command">gnatlink</span></samp></h3>
<p class="noindent">It is possible to specify the program stack size at link time. On modern
versions of Windows, starting with XP, this is mostly useful to set the size of
the main stack (environment task). The other task stacks are set with pragma
Storage_Size or with the <samp><span class="command">gnatbind -d</span></samp> command.
<p>Since older versions of Windows (2000, NT4, etc.) do not allow setting the
reserve size of individual tasks, the link-time stack size applies to all
tasks, and pragma Storage_Size has no effect.
In particular, Stack Overflow checks are made against this
link-time specified size.
<p>This setting can be done with
<samp><span class="command">gnatlink</span></samp> using either:
<ul>
<li>using <samp><span class="option">-Xlinker</span></samp> linker option
<pre class="smallexample"> $ gnatlink hello -Xlinker --stack=0x10000,0x1000
</pre>
<p>This sets the stack reserve size to 0x10000 bytes and the stack commit
size to 0x1000 bytes.
<li>using <samp><span class="option">-Wl</span></samp> linker option
<pre class="smallexample"> $ gnatlink hello -Wl,--stack=0x1000000
</pre>
<p>This sets the stack reserve size to 0x1000000 bytes. Note that with
<samp><span class="option">-Wl</span></samp> option it is not possible to set the stack commit size
because the coma is a separator for this option.
</ul>
<div class="node">
<a name="Setting-Heap-Size-from-gnatlink"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Setting-Stack-Size-from-gnatlink">Setting Stack Size from gnatlink</a>,
Up: <a rel="up" accesskey="u" href="#Microsoft-Windows-Topics">Microsoft Windows Topics</a>
</div>
<h3 class="section">G.15 Setting Heap Size from <samp><span class="command">gnatlink</span></samp></h3>
<p class="noindent">Under Windows systems, it is possible to specify the program heap size from
<samp><span class="command">gnatlink</span></samp> using either:
<ul>
<li>using <samp><span class="option">-Xlinker</span></samp> linker option
<pre class="smallexample"> $ gnatlink hello -Xlinker --heap=0x10000,0x1000
</pre>
<p>This sets the heap reserve size to 0x10000 bytes and the heap commit
size to 0x1000 bytes.
<li>using <samp><span class="option">-Wl</span></samp> linker option
<pre class="smallexample"> $ gnatlink hello -Wl,--heap=0x1000000
</pre>
<p>This sets the heap reserve size to 0x1000000 bytes. Note that with
<samp><span class="option">-Wl</span></samp> option it is not possible to set the heap commit size
because the coma is a separator for this option.
</ul>
<!-- ********************************** -->
<!-- * GNU Free Documentation License * -->
<!-- ********************************** -->
<!-- Special handling for inclusion in the install manual. -->
<!-- man begin DESCRIPTION -->
<div class="node">
<a name="GNU-Free-Documentation-License"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Index">Index</a>,
Previous: <a rel="previous" accesskey="p" href="#Microsoft-Windows-Topics">Microsoft Windows Topics</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="unnumbered">GNU Free Documentation License</h2>
<p><a name="index-FDL_002c-GNU-Free-Documentation-License-1099"></a><div align="center">Version 1.3, 3 November 2008</div>
<pre class="display"> Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
<a href="http://fsf.org/">http://fsf.org/</a>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
</pre>
<ol type=1 start=0>
<li>PREAMBLE
<p>The purpose of this License is to make a manual, textbook, or other
functional and useful document <dfn>free</dfn> in the sense of freedom: to
assure everyone the effective freedom to copy and redistribute it,
with or without modifying it, either commercially or noncommercially.
Secondarily, this License preserves for the author and publisher a way
to get credit for their work, while not being considered responsible
for modifications made by others.
<p>This License is a kind of “copyleft”, which means that derivative
works of the document must themselves be free in the same sense. It
complements the GNU General Public License, which is a copyleft
license designed for free software.
<p>We have designed this License in order to use it for manuals for free
software, because free software needs free documentation: a free
program should come with manuals providing the same freedoms that the
software does. But this License is not limited to software manuals;
it can be used for any textual work, regardless of subject matter or
whether it is published as a printed book. We recommend this License
principally for works whose purpose is instruction or reference.
<li>APPLICABILITY AND DEFINITIONS
<p>This License applies to any manual or other work, in any medium, that
contains a notice placed by the copyright holder saying it can be
distributed under the terms of this License. Such a notice grants a
world-wide, royalty-free license, unlimited in duration, to use that
work under the conditions stated herein. The “Document”, below,
refers to any such manual or work. Any member of the public is a
licensee, and is addressed as “you”. You accept the license if you
copy, modify or distribute the work in a way requiring permission
under copyright law.
<p>A “Modified Version” of the Document means any work containing the
Document or a portion of it, either copied verbatim, or with
modifications and/or translated into another language.
<p>A “Secondary Section” is a named appendix or a front-matter section
of the Document that deals exclusively with the relationship of the
publishers or authors of the Document to the Document's overall
subject (or to related matters) and contains nothing that could fall
directly within that overall subject. (Thus, if the Document is in
part a textbook of mathematics, a Secondary Section may not explain
any mathematics.) The relationship could be a matter of historical
connection with the subject or with related matters, or of legal,
commercial, philosophical, ethical or political position regarding
them.
<p>The “Invariant Sections” are certain Secondary Sections whose titles
are designated, as being those of Invariant Sections, in the notice
that says that the Document is released under this License. If a
section does not fit the above definition of Secondary then it is not
allowed to be designated as Invariant. The Document may contain zero
Invariant Sections. If the Document does not identify any Invariant
Sections then there are none.
<p>The “Cover Texts” are certain short passages of text that are listed,
as Front-Cover Texts or Back-Cover Texts, in the notice that says that
the Document is released under this License. A Front-Cover Text may
be at most 5 words, and a Back-Cover Text may be at most 25 words.
<p>A “Transparent” copy of the Document means a machine-readable copy,
represented in a format whose specification is available to the
general public, that is suitable for revising the document
straightforwardly with generic text editors or (for images composed of
pixels) generic paint programs or (for drawings) some widely available
drawing editor, and that is suitable for input to text formatters or
for automatic translation to a variety of formats suitable for input
to text formatters. A copy made in an otherwise Transparent file
format whose markup, or absence of markup, has been arranged to thwart
or discourage subsequent modification by readers is not Transparent.
An image format is not Transparent if used for any substantial amount
of text. A copy that is not “Transparent” is called “Opaque”.
<p>Examples of suitable formats for Transparent copies include plain
<span class="sc">ascii</span> without markup, Texinfo input format, LaTeX input
format, <acronym>SGML</acronym> or <acronym>XML</acronym> using a publicly available
<acronym>DTD</acronym>, and standard-conforming simple <acronym>HTML</acronym>,
PostScript or <acronym>PDF</acronym> designed for human modification. Examples
of transparent image formats include <acronym>PNG</acronym>, <acronym>XCF</acronym> and
<acronym>JPG</acronym>. Opaque formats include proprietary formats that can be
read and edited only by proprietary word processors, <acronym>SGML</acronym> or
<acronym>XML</acronym> for which the <acronym>DTD</acronym> and/or processing tools are
not generally available, and the machine-generated <acronym>HTML</acronym>,
PostScript or <acronym>PDF</acronym> produced by some word processors for
output purposes only.
<p>The “Title Page” means, for a printed book, the title page itself,
plus such following pages as are needed to hold, legibly, the material
this License requires to appear in the title page. For works in
formats which do not have any title page as such, “Title Page” means
the text near the most prominent appearance of the work's title,
preceding the beginning of the body of the text.
<p>The “publisher” means any person or entity that distributes copies
of the Document to the public.
<p>A section “Entitled XYZ” means a named subunit of the Document whose
title either is precisely XYZ or contains XYZ in parentheses following
text that translates XYZ in another language. (Here XYZ stands for a
specific section name mentioned below, such as “Acknowledgements”,
“Dedications”, “Endorsements”, or “History”.) To “Preserve the Title”
of such a section when you modify the Document means that it remains a
section “Entitled XYZ” according to this definition.
<p>The Document may include Warranty Disclaimers next to the notice which
states that this License applies to the Document. These Warranty
Disclaimers are considered to be included by reference in this
License, but only as regards disclaiming warranties: any other
implication that these Warranty Disclaimers may have is void and has
no effect on the meaning of this License.
<li>VERBATIM COPYING
<p>You may copy and distribute the Document in any medium, either
commercially or noncommercially, provided that this License, the
copyright notices, and the license notice saying this License applies
to the Document are reproduced in all copies, and that you add no other
conditions whatsoever to those of this License. You may not use
technical measures to obstruct or control the reading or further
copying of the copies you make or distribute. However, you may accept
compensation in exchange for copies. If you distribute a large enough
number of copies you must also follow the conditions in section 3.
<p>You may also lend copies, under the same conditions stated above, and
you may publicly display copies.
<li>COPYING IN QUANTITY
<p>If you publish printed copies (or copies in media that commonly have
printed covers) of the Document, numbering more than 100, and the
Document's license notice requires Cover Texts, you must enclose the
copies in covers that carry, clearly and legibly, all these Cover
Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
the back cover. Both covers must also clearly and legibly identify
you as the publisher of these copies. The front cover must present
the full title with all words of the title equally prominent and
visible. You may add other material on the covers in addition.
Copying with changes limited to the covers, as long as they preserve
the title of the Document and satisfy these conditions, can be treated
as verbatim copying in other respects.
<p>If the required texts for either cover are too voluminous to fit
legibly, you should put the first ones listed (as many as fit
reasonably) on the actual cover, and continue the rest onto adjacent
pages.
<p>If you publish or distribute Opaque copies of the Document numbering
more than 100, you must either include a machine-readable Transparent
copy along with each Opaque copy, or state in or with each Opaque copy
a computer-network location from which the general network-using
public has access to download using public-standard network protocols
a complete Transparent copy of the Document, free of added material.
If you use the latter option, you must take reasonably prudent steps,
when you begin distribution of Opaque copies in quantity, to ensure
that this Transparent copy will remain thus accessible at the stated
location until at least one year after the last time you distribute an
Opaque copy (directly or through your agents or retailers) of that
edition to the public.
<p>It is requested, but not required, that you contact the authors of the
Document well before redistributing any large number of copies, to give
them a chance to provide you with an updated version of the Document.
<li>MODIFICATIONS
<p>You may copy and distribute a Modified Version of the Document under
the conditions of sections 2 and 3 above, provided that you release
the Modified Version under precisely this License, with the Modified
Version filling the role of the Document, thus licensing distribution
and modification of the Modified Version to whoever possesses a copy
of it. In addition, you must do these things in the Modified Version:
<ol type=A start=1>
<li>Use in the Title Page (and on the covers, if any) a title distinct
from that of the Document, and from those of previous versions
(which should, if there were any, be listed in the History section
of the Document). You may use the same title as a previous version
if the original publisher of that version gives permission.
<li>List on the Title Page, as authors, one or more persons or entities
responsible for authorship of the modifications in the Modified
Version, together with at least five of the principal authors of the
Document (all of its principal authors, if it has fewer than five),
unless they release you from this requirement.
<li>State on the Title page the name of the publisher of the
Modified Version, as the publisher.
<li>Preserve all the copyright notices of the Document.
<li>Add an appropriate copyright notice for your modifications
adjacent to the other copyright notices.
<li>Include, immediately after the copyright notices, a license notice
giving the public permission to use the Modified Version under the
terms of this License, in the form shown in the Addendum below.
<li>Preserve in that license notice the full lists of Invariant Sections
and required Cover Texts given in the Document's license notice.
<li>Include an unaltered copy of this License.
<li>Preserve the section Entitled “History”, Preserve its Title, and add
to it an item stating at least the title, year, new authors, and
publisher of the Modified Version as given on the Title Page. If
there is no section Entitled “History” in the Document, create one
stating the title, year, authors, and publisher of the Document as
given on its Title Page, then add an item describing the Modified
Version as stated in the previous sentence.
<li>Preserve the network location, if any, given in the Document for
public access to a Transparent copy of the Document, and likewise
the network locations given in the Document for previous versions
it was based on. These may be placed in the “History” section.
You may omit a network location for a work that was published at
least four years before the Document itself, or if the original
publisher of the version it refers to gives permission.
<li>For any section Entitled “Acknowledgements” or “Dedications”, Preserve
the Title of the section, and preserve in the section all the
substance and tone of each of the contributor acknowledgements and/or
dedications given therein.
<li>Preserve all the Invariant Sections of the Document,
unaltered in their text and in their titles. Section numbers
or the equivalent are not considered part of the section titles.
<li>Delete any section Entitled “Endorsements”. Such a section
may not be included in the Modified Version.
<li>Do not retitle any existing section to be Entitled “Endorsements” or
to conflict in title with any Invariant Section.
<li>Preserve any Warranty Disclaimers.
</ol>
<p>If the Modified Version includes new front-matter sections or
appendices that qualify as Secondary Sections and contain no material
copied from the Document, you may at your option designate some or all
of these sections as invariant. To do this, add their titles to the
list of Invariant Sections in the Modified Version's license notice.
These titles must be distinct from any other section titles.
<p>You may add a section Entitled “Endorsements”, provided it contains
nothing but endorsements of your Modified Version by various
parties—for example, statements of peer review or that the text has
been approved by an organization as the authoritative definition of a
standard.
<p>You may add a passage of up to five words as a Front-Cover Text, and a
passage of up to 25 words as a Back-Cover Text, to the end of the list
of Cover Texts in the Modified Version. Only one passage of
Front-Cover Text and one of Back-Cover Text may be added by (or
through arrangements made by) any one entity. If the Document already
includes a cover text for the same cover, previously added by you or
by arrangement made by the same entity you are acting on behalf of,
you may not add another; but you may replace the old one, on explicit
permission from the previous publisher that added the old one.
<p>The author(s) and publisher(s) of the Document do not by this License
give permission to use their names for publicity for or to assert or
imply endorsement of any Modified Version.
<li>COMBINING DOCUMENTS
<p>You may combine the Document with other documents released under this
License, under the terms defined in section 4 above for modified
versions, provided that you include in the combination all of the
Invariant Sections of all of the original documents, unmodified, and
list them all as Invariant Sections of your combined work in its
license notice, and that you preserve all their Warranty Disclaimers.
<p>The combined work need only contain one copy of this License, and
multiple identical Invariant Sections may be replaced with a single
copy. If there are multiple Invariant Sections with the same name but
different contents, make the title of each such section unique by
adding at the end of it, in parentheses, the name of the original
author or publisher of that section if known, or else a unique number.
Make the same adjustment to the section titles in the list of
Invariant Sections in the license notice of the combined work.
<p>In the combination, you must combine any sections Entitled “History”
in the various original documents, forming one section Entitled
“History”; likewise combine any sections Entitled “Acknowledgements”,
and any sections Entitled “Dedications”. You must delete all
sections Entitled “Endorsements.”
<li>COLLECTIONS OF DOCUMENTS
<p>You may make a collection consisting of the Document and other documents
released under this License, and replace the individual copies of this
License in the various documents with a single copy that is included in
the collection, provided that you follow the rules of this License for
verbatim copying of each of the documents in all other respects.
<p>You may extract a single document from such a collection, and distribute
it individually under this License, provided you insert a copy of this
License into the extracted document, and follow this License in all
other respects regarding verbatim copying of that document.
<li>AGGREGATION WITH INDEPENDENT WORKS
<p>A compilation of the Document or its derivatives with other separate
and independent documents or works, in or on a volume of a storage or
distribution medium, is called an “aggregate” if the copyright
resulting from the compilation is not used to limit the legal rights
of the compilation's users beyond what the individual works permit.
When the Document is included in an aggregate, this License does not
apply to the other works in the aggregate which are not themselves
derivative works of the Document.
<p>If the Cover Text requirement of section 3 is applicable to these
copies of the Document, then if the Document is less than one half of
the entire aggregate, the Document's Cover Texts may be placed on
covers that bracket the Document within the aggregate, or the
electronic equivalent of covers if the Document is in electronic form.
Otherwise they must appear on printed covers that bracket the whole
aggregate.
<li>TRANSLATION
<p>Translation is considered a kind of modification, so you may
distribute translations of the Document under the terms of section 4.
Replacing Invariant Sections with translations requires special
permission from their copyright holders, but you may include
translations of some or all Invariant Sections in addition to the
original versions of these Invariant Sections. You may include a
translation of this License, and all the license notices in the
Document, and any Warranty Disclaimers, provided that you also include
the original English version of this License and the original versions
of those notices and disclaimers. In case of a disagreement between
the translation and the original version of this License or a notice
or disclaimer, the original version will prevail.
<p>If a section in the Document is Entitled “Acknowledgements”,
“Dedications”, or “History”, the requirement (section 4) to Preserve
its Title (section 1) will typically require changing the actual
title.
<li>TERMINATION
<p>You may not copy, modify, sublicense, or distribute the Document
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense, or distribute it is void, and
will automatically terminate your rights under this License.
<p>However, if you cease all violation of this License, then your license
from a particular copyright holder is reinstated (a) provisionally,
unless and until the copyright holder explicitly and finally
terminates your license, and (b) permanently, if the copyright holder
fails to notify you of the violation by some reasonable means prior to
60 days after the cessation.
<p>Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
<p>Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, receipt of a copy of some or all of the same material does
not give you any rights to use it.
<li>FUTURE REVISIONS OF THIS LICENSE
<p>The Free Software Foundation may publish new, revised versions
of the GNU Free Documentation License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns. See
<a href="http://www.gnu.org/copyleft/">http://www.gnu.org/copyleft/</a>.
<p>Each version of the License is given a distinguishing version number.
If the Document specifies that a particular numbered version of this
License “or any later version” applies to it, you have the option of
following the terms and conditions either of that specified version or
of any later version that has been published (not as a draft) by the
Free Software Foundation. If the Document does not specify a version
number of this License, you may choose any version ever published (not
as a draft) by the Free Software Foundation. If the Document
specifies that a proxy can decide which future versions of this
License can be used, that proxy's public statement of acceptance of a
version permanently authorizes you to choose that version for the
Document.
<li>RELICENSING
<p>“Massive Multiauthor Collaboration Site” (or “MMC Site”) means any
World Wide Web server that publishes copyrightable works and also
provides prominent facilities for anybody to edit those works. A
public wiki that anybody can edit is an example of such a server. A
“Massive Multiauthor Collaboration” (or “MMC”) contained in the
site means any set of copyrightable works thus published on the MMC
site.
<p>“CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0
license published by Creative Commons Corporation, a not-for-profit
corporation with a principal place of business in San Francisco,
California, as well as future copyleft versions of that license
published by that same organization.
<p>“Incorporate” means to publish or republish a Document, in whole or
in part, as part of another Document.
<p>An MMC is “eligible for relicensing” if it is licensed under this
License, and if all works that were first published under this License
somewhere other than this MMC, and subsequently incorporated in whole
or in part into the MMC, (1) had no cover texts or invariant sections,
and (2) were thus incorporated prior to November 1, 2008.
<p>The operator of an MMC Site may republish an MMC contained in the site
under CC-BY-SA on the same site at any time before August 1, 2009,
provided the MMC is eligible for relicensing.
</ol>
<h3 class="unnumberedsec">ADDENDUM: How to use this License for your documents</h3>
<p>To use this License in a document you have written, include a copy of
the License in the document and put the following copyright and
license notices just after the title page:
<pre class="smallexample"> Copyright (C) <var>year</var> <var>your name</var>.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
Texts. A copy of the license is included in the section entitled ``GNU
Free Documentation License''.
</pre>
<p>If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
replace the “with...Texts.” line with this:
<pre class="smallexample"> with the Invariant Sections being <var>list their titles</var>, with
the Front-Cover Texts being <var>list</var>, and with the Back-Cover Texts
being <var>list</var>.
</pre>
<p>If you have Invariant Sections without Cover Texts, or some other
combination of the three, merge those two alternatives to suit the
situation.
<p>If your document contains nontrivial examples of program code, we
recommend releasing these examples in parallel under your choice of
free software license, such as the GNU General Public License,
to permit their use in free software.
<!-- Local Variables: -->
<!-- ispell-local-pdict: "ispell-dict" -->
<!-- End: -->
<!-- man end -->
<!-- GNU Free Documentation License -->
<div class="node">
<a name="Index"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#GNU-Free-Documentation-License">GNU Free Documentation License</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="unnumbered">Index</h2>
<ul class="index-cp" compact>
<li><a href="#index-g_t_0040option_007b_002d_002das_007d-_0028_0040command_007bdlltool_007d_0029-1090"><samp><span class="option">--as</span></samp> (<samp><span class="command">dlltool</span></samp>)</a>: <a href="#Using-dlltool">Using dlltool</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dbase_002dfile_007d-_0028_0040command_007bdlltool_007d_0029-1082"><samp><span class="option">--base-file</span></samp> (<samp><span class="command">dlltool</span></samp>)</a>: <a href="#Using-dlltool">Using dlltool</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dcategory_0040var_007bx_007d_007d-_0028_0040command_007bgnatmetric_007d_0029-812"><samp><span class="option">--category</span><var>x</var></samp> (<samp><span class="command">gnatmetric</span></samp>)</a>: <a href="#Object_002dOriented-Metrics-Control">Object-Oriented Metrics Control</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002ddef_007d-_0028_0040command_007bdlltool_007d_0029-1083"><samp><span class="option">--def</span></samp> (<samp><span class="command">dlltool</span></samp>)</a>: <a href="#Using-dlltool">Using dlltool</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002ddemangle_007d-_0028_0040code_007bgprof_007d_0029-943"><samp><span class="option">--demangle</span></samp> (<code>gprof</code>)</a>: <a href="#Running-gprof">Running gprof</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002ddllname_007d-_0028_0040command_007bdlltool_007d_0029-1084"><samp><span class="option">--dllname</span></samp> (<samp><span class="command">dlltool</span></samp>)</a>: <a href="#Using-dlltool">Using dlltool</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002deol_007d-_0028_0040code_007bgnatpp_007d_0029-779"><samp><span class="option">--eol</span></samp> (<code>gnatpp</code>)</a>: <a href="#Output-File-Control">Output File Control</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dext_007d-_0028_0040command_007bgnatfind_007d_0029-731"><samp><span class="option">--ext</span></samp> (<samp><span class="command">gnatfind</span></samp>)</a>: <a href="#Switches-for-gnatfind">Switches for gnatfind</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dext_007d-_0028_0040command_007bgnatxref_007d_0029-717"><samp><span class="option">--ext</span></samp> (<samp><span class="command">gnatxref</span></samp>)</a>: <a href="#Switches-for-gnatxref">Switches for gnatxref</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dGCC_003d_007d-_0028_0040code_007bgnatchop_007d_0029-617"><samp><span class="option">--GCC=</span></samp> (<code>gnatchop</code>)</a>: <a href="#Switches-for-gnatchop">Switches for gnatchop</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dGCC_003dcompiler_005fname_007d-_0028_0040command_007bgnatlink_007d_0029-505"><samp><span class="option">--GCC=compiler_name</span></samp> (<samp><span class="command">gnatlink</span></samp>)</a>: <a href="#Switches-for-gnatlink">Switches for gnatlink</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dGCC_003dcompiler_005fname_007d-_0028_0040command_007bgnatmake_007d_0029-511"><samp><span class="option">--GCC=compiler_name</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dGNATBIND_003dbinder_005fname_007d-_0028_0040command_007bgnatmake_007d_0029-512"><samp><span class="option">--GNATBIND=binder_name</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dGNATLINK_003dlinker_005fname_007d-_0028_0040command_007bgnatmake_007d_0029-513"><samp><span class="option">--GNATLINK=linker_name</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dheader_002dfile_007d-_0028_0040command_007bgnatstub_007d_0029-896"><samp><span class="option">--header-file</span></samp> (<samp><span class="command">gnatstub</span></samp>)</a>: <a href="#Switches-for-gnatstub">Switches for gnatstub</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dhelp_007d-_0028_0040command_007bdlltool_007d_0029-1086"><samp><span class="option">--help</span></samp> (<samp><span class="command">dlltool</span></samp>)</a>: <a href="#Using-dlltool">Using dlltool</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dhelp_007d-_0040command_007bgnatbind_007d-407"><samp><span class="option">--help</span></samp> <samp><span class="command">gnatbind</span></samp></a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dhelp_007d-_0040command_007bgnatchop_007d-608"><samp><span class="option">--help</span></samp> <samp><span class="command">gnatchop</span></samp></a>: <a href="#Switches-for-gnatchop">Switches for gnatchop</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dhelp_007d-_0040command_007bgnatclean_007d-846"><samp><span class="option">--help</span></samp> <samp><span class="command">gnatclean</span></samp></a>: <a href="#Switches-for-gnatclean">Switches for gnatclean</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dhelp_007d-_0040command_007bgnatfind_007d-725"><samp><span class="option">--help</span></samp> <samp><span class="command">gnatfind</span></samp></a>: <a href="#Switches-for-gnatfind">Switches for gnatfind</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dhelp_007d-_0040command_007bgnatlink_007d-494"><samp><span class="option">--help</span></samp> <samp><span class="command">gnatlink</span></samp></a>: <a href="#Switches-for-gnatlink">Switches for gnatlink</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dhelp_007d-_0040command_007bgnatls_007d-829"><samp><span class="option">--help</span></samp> <samp><span class="command">gnatls</span></samp></a>: <a href="#Switches-for-gnatls">Switches for gnatls</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dhelp_007d-_0040command_007bgnatmake_007d-510"><samp><span class="option">--help</span></samp> <samp><span class="command">gnatmake</span></samp></a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dhelp_007d-_0040command_007bgnatname_007d-623"><samp><span class="option">--help</span></samp> <samp><span class="command">gnatname</span></samp></a>: <a href="#Switches-for-gnatname">Switches for gnatname</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dhelp_007d-_0040command_007bgnatxref_007d-711"><samp><span class="option">--help</span></samp> <samp><span class="command">gnatxref</span></samp></a>: <a href="#Switches-for-gnatxref">Switches for gnatxref</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dignore_007d-_0028_0040command_007bgnatelim_007d_0029-597"><samp><span class="option">--ignore</span></samp> (<samp><span class="command">gnatelim</span></samp>)</a>: <a href="#Running-gnatelim">Running gnatelim</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dlines_0040var_007bx_007d_007d-_0028_0040command_007bgnatmetric_007d_0029-799"><samp><span class="option">--lines</span><var>x</var></samp> (<samp><span class="command">gnatmetric</span></samp>)</a>: <a href="#Line-Metrics-Control">Line Metrics Control</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dLINK_003d_007d-_0028_0040command_007bgnatlink_007d_0029-506"><samp><span class="option">--LINK=</span></samp> (<samp><span class="command">gnatlink</span></samp>)</a>: <a href="#Switches-for-gnatlink">Switches for gnatlink</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dno_002dcategory_0040var_007bx_007d_007d-_0028_0040command_007bgnatmetric_007d_0029-813"><samp><span class="option">--no-category</span><var>x</var></samp> (<samp><span class="command">gnatmetric</span></samp>)</a>: <a href="#Object_002dOriented-Metrics-Control">Object-Oriented Metrics Control</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dno_002dcomplexity_0040var_007bx_007d_007d-806"><samp><span class="option">--no-complexity</span><var>x</var></samp></a>: <a href="#Complexity-Metrics-Control">Complexity Metrics Control</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dno_002delim_002ddispatch_007d-_0028_0040command_007bgnatelim_007d_0029-596"><samp><span class="option">--no-elim-dispatch</span></samp> (<samp><span class="command">gnatelim</span></samp>)</a>: <a href="#Running-gnatelim">Running gnatelim</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dno_002dexception_007d-_0028_0040command_007bgnatstub_007d_0029-906"><samp><span class="option">--no-exception</span></samp> (<samp><span class="command">gnatstub</span></samp>)</a>: <a href="#Switches-for-gnatstub">Switches for gnatstub</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dno_002dlines_0040var_007bx_007d_007d-800"><samp><span class="option">--no-lines</span><var>x</var></samp></a>: <a href="#Line-Metrics-Control">Line Metrics Control</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dno_002dlocal_002dheader_007d-_0028_0040command_007bgnatstub_007d_0029-907"><samp><span class="option">--no-local-header</span></samp> (<samp><span class="command">gnatstub</span></samp>)</a>: <a href="#Switches-for-gnatstub">Switches for gnatstub</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dno_002dpackage_0040var_007bx_007d_007d-_0028_0040command_007bgnatmetric_007d_0029-811"><samp><span class="option">--no-package</span><var>x</var></samp> (<samp><span class="command">gnatmetric</span></samp>)</a>: <a href="#Object_002dOriented-Metrics-Control">Object-Oriented Metrics Control</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dno_002dseparate_002dis_007d-_0028_0040command_007bgnatpp_007d_0029-757"><samp><span class="option">--no-separate-is</span></samp> (<samp><span class="command">gnatpp</span></samp>)</a>: <a href="#Construct-Layout-Control">Construct Layout Control</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dno_002dseparate_002dloop_002dthen_007d-_0028_0040command_007bgnatpp_007d_0029-760"><samp><span class="option">--no-separate-loop-then</span></samp> (<samp><span class="command">gnatpp</span></samp>)</a>: <a href="#Construct-Layout-Control">Construct Layout Control</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dno_002dsyntax_0040var_007bx_007d_007d-_0028_0040command_007bgnatmetric_007d_0029-803"><samp><span class="option">--no-syntax</span><var>x</var></samp> (<samp><span class="command">gnatmetric</span></samp>)</a>: <a href="#Syntax-Metrics-Control">Syntax Metrics Control</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002doutput_002dexp_007d-_0028_0040command_007bdlltool_007d_0029-1087"><samp><span class="option">--output-exp</span></samp> (<samp><span class="command">dlltool</span></samp>)</a>: <a href="#Using-dlltool">Using dlltool</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002doutput_002dlib_007d-_0028_0040command_007bdlltool_007d_0029-1088"><samp><span class="option">--output-lib</span></samp> (<samp><span class="command">dlltool</span></samp>)</a>: <a href="#Using-dlltool">Using dlltool</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dpackage_0040var_007bx_007d_007d-_0028_0040command_007bgnatmetric_007d_0029-810"><samp><span class="option">--package</span><var>x</var></samp> (<samp><span class="command">gnatmetric</span></samp>)</a>: <a href="#Object_002dOriented-Metrics-Control">Object-Oriented Metrics Control</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dRTS_007d-_0028_0040command_007bgcc_007d_0029-177"><samp><span class="option">--RTS</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dRTS_007d-_0028_0040code_007bgnatbind_007d_0029-432"><samp><span class="option">--RTS</span></samp> (<code>gnatbind</code>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dRTS_007d-_0028_0040command_007bgnatfind_007d_0029-732"><samp><span class="option">--RTS</span></samp> (<samp><span class="command">gnatfind</span></samp>)</a>: <a href="#Switches-for-gnatfind">Switches for gnatfind</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dRTS_007d-_0028_0040code_007bgnatls_007d_0029-841"><samp><span class="option">--RTS</span></samp> (<code>gnatls</code>)</a>: <a href="#Switches-for-gnatls">Switches for gnatls</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dRTS_007d-_0028_0040command_007bgnatmake_007d_0029-562"><samp><span class="option">--RTS</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dRTS_007d-_0028_0040code_007bgnatpp_007d_0029-772"><samp><span class="option">--RTS</span></samp> (<code>gnatpp</code>)</a>: <a href="#Setting-the-Source-Search-Path">Setting the Source Search Path</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dRTS_007d-_0028_0040command_007bgnatxref_007d_0029-718"><samp><span class="option">--RTS</span></samp> (<samp><span class="command">gnatxref</span></samp>)</a>: <a href="#Switches-for-gnatxref">Switches for gnatxref</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dRTS_007d-option-979"><samp><span class="option">--RTS</span></samp> option</a>: <a href="#Specifying-a-Run_002dTime-Library">Specifying a Run-Time Library</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dRTS_003dsjlj_007d-_0028_0040command_007bgnatmake_007d_0029-395"><samp><span class="option">--RTS=sjlj</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Exception-Handling-Control">Exception Handling Control</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dRTS_003dzcx_007d-_0028_0040command_007bgnatmake_007d_0029-396"><samp><span class="option">--RTS=zcx</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Exception-Handling-Control">Exception Handling Control</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dseparate_002dlabel_007d-_0028_0040command_007bgnatpp_007d_0029-758"><samp><span class="option">--separate-label</span></samp> (<samp><span class="command">gnatpp</span></samp>)</a>: <a href="#Construct-Layout-Control">Construct Layout Control</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dseparate_002dloop_002dthen_007d-_0028_0040command_007bgnatpp_007d_0029-759"><samp><span class="option">--separate-loop-then</span></samp> (<samp><span class="command">gnatpp</span></samp>)</a>: <a href="#Construct-Layout-Control">Construct Layout Control</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dseparate_002dstmt_002dname_007d-_0028_0040command_007bgnatpp_007d_0029-762"><samp><span class="option">--separate-stmt-name</span></samp> (<samp><span class="command">gnatpp</span></samp>)</a>: <a href="#Construct-Layout-Control">Construct Layout Control</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dsubdirs_003d_007d-_0028gnatmake-and-gnatclean_0029-707"><samp><span class="option">--subdirs=</span></samp> (gnatmake and gnatclean)</a>: <a href="#Switches-Related-to-Project-Files">Switches Related to Project Files</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dsyntax_0040var_007bx_007d_007d-_0028_0040command_007bgnatmetric_007d_0029-802"><samp><span class="option">--syntax</span><var>x</var></samp> (<samp><span class="command">gnatmetric</span></samp>)</a>: <a href="#Syntax-Metrics-Control">Syntax Metrics Control</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002duse_002don_002dnew_002dline_007d-_0028_0040command_007bgnatpp_007d_0029-761"><samp><span class="option">--use-on-new-line</span></samp> (<samp><span class="command">gnatpp</span></samp>)</a>: <a href="#Construct-Layout-Control">Construct Layout Control</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dversion_007d-_0040command_007bgnatbind_007d-406"><samp><span class="option">--version</span></samp> <samp><span class="command">gnatbind</span></samp></a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dversion_007d-_0040command_007bgnatchop_007d-607"><samp><span class="option">--version</span></samp> <samp><span class="command">gnatchop</span></samp></a>: <a href="#Switches-for-gnatchop">Switches for gnatchop</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dversion_007d-_0040command_007bgnatclean_007d-845"><samp><span class="option">--version</span></samp> <samp><span class="command">gnatclean</span></samp></a>: <a href="#Switches-for-gnatclean">Switches for gnatclean</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dversion_007d-_0040command_007bgnatfind_007d-724"><samp><span class="option">--version</span></samp> <samp><span class="command">gnatfind</span></samp></a>: <a href="#Switches-for-gnatfind">Switches for gnatfind</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dversion_007d-_0040command_007bgnatlink_007d-493"><samp><span class="option">--version</span></samp> <samp><span class="command">gnatlink</span></samp></a>: <a href="#Switches-for-gnatlink">Switches for gnatlink</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dversion_007d-_0040command_007bgnatls_007d-828"><samp><span class="option">--version</span></samp> <samp><span class="command">gnatls</span></samp></a>: <a href="#Switches-for-gnatls">Switches for gnatls</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dversion_007d-_0040command_007bgnatmake_007d-509"><samp><span class="option">--version</span></samp> <samp><span class="command">gnatmake</span></samp></a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dversion_007d-_0040command_007bgnatname_007d-622"><samp><span class="option">--version</span></samp> <samp><span class="command">gnatname</span></samp></a>: <a href="#Switches-for-gnatname">Switches for gnatname</a></li>
<li><a href="#index-g_t_0040option_007b_002d_002dversion_007d-_0040command_007bgnatxref_007d-710"><samp><span class="option">--version</span></samp> <samp><span class="command">gnatxref</span></samp></a>: <a href="#Switches-for-gnatxref">Switches for gnatxref</a></li>
<li><a href="#index-g_t_0040option_007b_002d83_007d-_0028_0040code_007bgnathtml_007d_0029-919"><samp><span class="option">-83</span></samp> (<code>gnathtml</code>)</a>: <a href="#Converting-Ada-Files-to-html-with-gnathtml">Converting Ada Files to html with gnathtml</a></li>
<li><a href="#index-g_t_0040option_007b_002dA_007d-_0028_0040command_007bgnatbind_007d_0029-411"><samp><span class="option">-A</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002da_007d-_0028_0040code_007bgnatdll_007d_0029-1068"><samp><span class="option">-a</span></samp> (<code>gnatdll</code>)</a>: <a href="#Using-gnatdll">Using gnatdll</a></li>
<li><a href="#index-g_t_0040option_007b_002da_007d-_0028_0040command_007bgnatfind_007d_0029-726"><samp><span class="option">-a</span></samp> (<samp><span class="command">gnatfind</span></samp>)</a>: <a href="#Switches-for-gnatfind">Switches for gnatfind</a></li>
<li><a href="#index-g_t_0040option_007b_002da_007d-_0028_0040code_007bgnatls_007d_0029-830"><samp><span class="option">-a</span></samp> (<code>gnatls</code>)</a>: <a href="#Switches-for-gnatls">Switches for gnatls</a></li>
<li><a href="#index-g_t_0040option_007b_002dA_007d-_0028_0040command_007bgnatmake_007d_0029-554"><samp><span class="option">-A</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002da_007d-_0028_0040command_007bgnatmake_007d_0029-514"><samp><span class="option">-a</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002da_007d-_0028_0040command_007bgnatxref_007d_0029-712"><samp><span class="option">-a</span></samp> (<samp><span class="command">gnatxref</span></samp>)</a>: <a href="#Switches-for-gnatxref">Switches for gnatxref</a></li>
<li><a href="#index-g_t_0040option_007b_002da_007d-_0040command_007bgnatbind_007d-408"><samp><span class="option">-a</span></samp> <samp><span class="command">gnatbind</span></samp></a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002daI_007d-_0028_0040command_007bgnatbind_007d_0029-486"><samp><span class="option">-aI</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Search-Paths-for-gnatbind">Search Paths for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002daI_007d-_0028_0040command_007bgnatbind_007d_0029-410"><samp><span class="option">-aI</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002daI_007d-_0028_0040code_007bgnatls_007d_0029-838"><samp><span class="option">-aI</span></samp> (<code>gnatls</code>)</a>: <a href="#Switches-for-gnatls">Switches for gnatls</a></li>
<li><a href="#index-g_t_0040option_007b_002daI_007d-_0028_0040command_007bgnatmake_007d_0029-550"><samp><span class="option">-aI</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002daIDIR_007d-_0028_0040command_007bgnatfind_007d_0029-727"><samp><span class="option">-aIDIR</span></samp> (<samp><span class="command">gnatfind</span></samp>)</a>: <a href="#Switches-for-gnatfind">Switches for gnatfind</a></li>
<li><a href="#index-g_t_0040option_007b_002daIDIR_007d-_0028_0040command_007bgnatxref_007d_0029-713"><samp><span class="option">-aIDIR</span></samp> (<samp><span class="command">gnatxref</span></samp>)</a>: <a href="#Switches-for-gnatxref">Switches for gnatxref</a></li>
<li><a href="#index-g_t_0040option_007b_002daL_007d-_0028_0040command_007bgnatmake_007d_0029-551"><samp><span class="option">-aL</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dA_0040var_007bn_007d_007d-_0028_0040command_007bgnatpp_007d_0029-745"><samp><span class="option">-A</span><var>n</var></samp> (<samp><span class="command">gnatpp</span></samp>)</a>: <a href="#Alignment-Control">Alignment Control</a></li>
<li><a href="#index-g_t_0040option_007b_002daO_007d-_0028_0040command_007bgnatbind_007d_0029-487"><samp><span class="option">-aO</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Search-Paths-for-gnatbind">Search Paths for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002daO_007d-_0028_0040command_007bgnatbind_007d_0029-409"><samp><span class="option">-aO</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002daO_007d-_0028_0040code_007bgnatclean_007d_0029-858"><samp><span class="option">-aO</span></samp> (<code>gnatclean</code>)</a>: <a href="#Switches-for-gnatclean">Switches for gnatclean</a></li>
<li><a href="#index-g_t_0040option_007b_002daO_007d-_0028_0040code_007bgnatls_007d_0029-837"><samp><span class="option">-aO</span></samp> (<code>gnatls</code>)</a>: <a href="#Switches-for-gnatls">Switches for gnatls</a></li>
<li><a href="#index-g_t_0040option_007b_002daO_007d-_0028_0040command_007bgnatmake_007d_0029-552"><samp><span class="option">-aO</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002daODIR_007d-_0028_0040command_007bgnatfind_007d_0029-728"><samp><span class="option">-aODIR</span></samp> (<samp><span class="command">gnatfind</span></samp>)</a>: <a href="#Switches-for-gnatfind">Switches for gnatfind</a></li>
<li><a href="#index-g_t_0040option_007b_002daODIR_007d-_0028_0040command_007bgnatxref_007d_0029-714"><samp><span class="option">-aODIR</span></samp> (<samp><span class="command">gnatxref</span></samp>)</a>: <a href="#Switches-for-gnatxref">Switches for gnatxref</a></li>
<li><a href="#index-g_t_0040option_007b_002daP_007d-_0028any-project_002daware-tool_0029-705"><samp><span class="option">-aP</span></samp> (any project-aware tool)</a>: <a href="#Switches-Related-to-Project-Files">Switches Related to Project Files</a></li>
<li><a href="#index-g_t_0040option_007b_002da_0040var_007bx_007d_007d-_0028_0040command_007bgnatpp_007d_0029-747"><samp><span class="option">-a</span><var>x</var></samp> (<samp><span class="command">gnatpp</span></samp>)</a>: <a href="#Casing-Control">Casing Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dB_007d-_0028_0040command_007bgcc_007d_0029-93"><samp><span class="option">-B</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002db_007d-_0028_0040command_007bgcc_007d_0029-92"><samp><span class="option">-b</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002db_007d-_0028_0040code_007bgnatbind_007d_0029-455"><samp><span class="option">-b</span></samp> (<code>gnatbind</code>)</a>: <a href="#Binder-Error-Message-Control">Binder Error Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002db_007d-_0028_0040command_007bgnatbind_007d_0029-412"><samp><span class="option">-b</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002db_007d-_0028_0040code_007bgnatdll_007d_0029-1069"><samp><span class="option">-b</span></samp> (<code>gnatdll</code>)</a>: <a href="#Using-gnatdll">Using gnatdll</a></li>
<li><a href="#index-g_t_0040option_007b_002dB_007d-_0028_0040command_007bgnatlink_007d_0029-504"><samp><span class="option">-B</span></samp> (<samp><span class="command">gnatlink</span></samp>)</a>: <a href="#Switches-for-gnatlink">Switches for gnatlink</a></li>
<li><a href="#index-g_t_0040option_007b_002db_007d-_0028_0040command_007bgnatlink_007d_0029-503"><samp><span class="option">-b</span></samp> (<samp><span class="command">gnatlink</span></samp>)</a>: <a href="#Switches-for-gnatlink">Switches for gnatlink</a></li>
<li><a href="#index-g_t_0040option_007b_002db_007d-_0028_0040command_007bgnatmake_007d_0029-515"><samp><span class="option">-b</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002db_007d-_0028_0040code_007bgnatmem_007d_0029-880"><samp><span class="option">-b</span></samp> (<code>gnatmem</code>)</a>: <a href="#Switches-for-gnatmem">Switches for gnatmem</a></li>
<li><a href="#index-g_t_0040option_007b_002db_007d-_0028_0040command_007bgnatprep_007d_0029-819"><samp><span class="option">-b</span></samp> (<samp><span class="command">gnatprep</span></samp>)</a>: <a href="#Switches-for-gnatprep">Switches for gnatprep</a></li>
<li><a href="#index-g_t_0040option_007b_002dbargs_007d-_0028_0040code_007bgnatdll_007d_0029-1070"><samp><span class="option">-bargs</span></samp> (<code>gnatdll</code>)</a>: <a href="#Using-gnatdll">Using gnatdll</a></li>
<li><a href="#index-g_t_0040option_007b_002dbargs_007d-_0028_0040command_007bgnatmake_007d_0029-564"><samp><span class="option">-bargs</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Mode-Switches-for-gnatmake">Mode Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dC_007d-_0028_0040command_007bgcc_007d_0029-916"><samp><span class="option">-C</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches">Switches</a></li>
<li><a href="#index-g_t_0040option_007b_002dc_007d-_0028_0040command_007bgcc_007d_0029-94"><samp><span class="option">-c</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dc_007d-_0028_0040code_007bgnatbind_007d_0029-466"><samp><span class="option">-c</span></samp> (<code>gnatbind</code>)</a>: <a href="#Output-Control">Output Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dc_007d-_0028_0040command_007bgnatbind_007d_0029-413"><samp><span class="option">-c</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dc_007d-_0028_0040code_007bgnatchop_007d_0029-609"><samp><span class="option">-c</span></samp> (<code>gnatchop</code>)</a>: <a href="#Switches-for-gnatchop">Switches for gnatchop</a></li>
<li><a href="#index-g_t_0040option_007b_002dc_007d-_0028_0040code_007bgnatclean_007d_0029-847"><samp><span class="option">-c</span></samp> (<code>gnatclean</code>)</a>: <a href="#Switches-for-gnatclean">Switches for gnatclean</a></li>
<li><a href="#index-g_t_0040option_007b_002dC_007d-_0028_0040command_007bgnatmake_007d_0029-517"><samp><span class="option">-C</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dc_007d-_0028_0040command_007bgnatmake_007d_0029-516"><samp><span class="option">-c</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dc_007d-_0028_0040code_007bgnatname_007d_0029-624"><samp><span class="option">-c</span></samp> (<code>gnatname</code>)</a>: <a href="#Switches-for-gnatname">Switches for gnatname</a></li>
<li><a href="#index-g_t_0040option_007b_002dC_007d-_0028_0040command_007bgnatprep_007d_0029-821"><samp><span class="option">-C</span></samp> (<samp><span class="command">gnatprep</span></samp>)</a>: <a href="#Switches-for-gnatprep">Switches for gnatprep</a></li>
<li><a href="#index-g_t_0040option_007b_002dc_007d-_0028_0040command_007bgnatprep_007d_0029-820"><samp><span class="option">-c</span></samp> (<samp><span class="command">gnatprep</span></samp>)</a>: <a href="#Switches-for-gnatprep">Switches for gnatprep</a></li>
<li><a href="#index-g_t_0040option_007b_002dC_003d_007d-_0028_0040command_007bgnatmake_007d_0029-518"><samp><span class="option">-C=</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dcargs_007d-_0028_0040command_007bgnatmake_007d_0029-563"><samp><span class="option">-cargs</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Mode-Switches-for-gnatmake">Mode Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dcc_007d-_0028_0040code_007bgnathtml_007d_0029-920"><samp><span class="option">-cc</span></samp> (<code>gnathtml</code>)</a>: <a href="#Converting-Ada-Files-to-html-with-gnathtml">Converting Ada Files to html with gnathtml</a></li>
<li><a href="#index-g_t_0040option_007b_002dcl_007d-_0028_0040command_007bgnatpp_007d_0029-765"><samp><span class="option">-cl</span></samp> (<samp><span class="command">gnatpp</span></samp>)</a>: <a href="#General-Text-Layout-Control">General Text Layout Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dc_0040var_007bn_007d_007d-_0028_0040command_007bgnatpp_007d_0029-754"><samp><span class="option">-c</span><var>n</var></samp> (<samp><span class="command">gnatpp</span></samp>)</a>: <a href="#Construct-Layout-Control">Construct Layout Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dcomplexity_0040var_007bx_007d_007d-_0028_0040command_007bgnatmetric_007d_0029-805"><samp><span class="option">-complexity</span><var>x</var></samp> (<samp><span class="command">gnatmetric</span></samp>)</a>: <a href="#Complexity-Metrics-Control">Complexity Metrics Control</a></li>
<li><a href="#index-g_t_002dcoverage-936">-coverage</a>: <a href="#Code-Coverage-of-Ada-Programs-using-gcov">Code Coverage of Ada Programs using gcov</a></li>
<li><a href="#index-g_t_0040option_007b_002dD_007d-_0028_0040command_007bgnatbind_007d_0029-415"><samp><span class="option">-D</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dD_007d-_0028_0040code_007bgnatclean_007d_0029-848"><samp><span class="option">-D</span></samp> (<code>gnatclean</code>)</a>: <a href="#Switches-for-gnatclean">Switches for gnatclean</a></li>
<li><a href="#index-g_t_0040option_007b_002dd_007d-_0028_0040code_007bgnatdll_007d_0029-1071"><samp><span class="option">-d</span></samp> (<code>gnatdll</code>)</a>: <a href="#Using-gnatdll">Using gnatdll</a></li>
<li><a href="#index-g_t_0040option_007b_002dd_007d-_0028_0040code_007bgnatfind_007d_0029-733"><samp><span class="option">-d</span></samp> (<code>gnatfind</code>)</a>: <a href="#Switches-for-gnatfind">Switches for gnatfind</a></li>
<li><a href="#index-g_t_0040option_007b_002dD_007d-_0028_0040code_007bgnathtml_007d_0029-922"><samp><span class="option">-D</span></samp> (<code>gnathtml</code>)</a>: <a href="#Converting-Ada-Files-to-html-with-gnathtml">Converting Ada Files to html with gnathtml</a></li>
<li><a href="#index-g_t_0040option_007b_002dd_007d-_0028_0040code_007bgnathtml_007d_0029-921"><samp><span class="option">-d</span></samp> (<code>gnathtml</code>)</a>: <a href="#Converting-Ada-Files-to-html-with-gnathtml">Converting Ada Files to html with gnathtml</a></li>
<li><a href="#index-g_t_0040option_007b_002dd_007d-_0028_0040code_007bgnatls_007d_0029-831"><samp><span class="option">-d</span></samp> (<code>gnatls</code>)</a>: <a href="#Switches-for-gnatls">Switches for gnatls</a></li>
<li><a href="#index-g_t_0040option_007b_002dD_007d-_0028_0040command_007bgnatmake_007d_0029-520"><samp><span class="option">-D</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dd_007d-_0028_0040command_007bgnatmake_007d_0029-519"><samp><span class="option">-d</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dd_007d-_0028_0040command_007bgnatmetric_007d_0029-790"><samp><span class="option">-d</span></samp> (<samp><span class="command">gnatmetric</span></samp>)</a>: <a href="#Output-Files-Control">Output Files Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dD_007d-_0028_0040code_007bgnatname_007d_0029-626"><samp><span class="option">-D</span></samp> (<code>gnatname</code>)</a>: <a href="#Switches-for-gnatname">Switches for gnatname</a></li>
<li><a href="#index-g_t_0040option_007b_002dd_007d-_0028_0040code_007bgnatname_007d_0029-625"><samp><span class="option">-d</span></samp> (<code>gnatname</code>)</a>: <a href="#Switches-for-gnatname">Switches for gnatname</a></li>
<li><a href="#index-g_t_0040option_007b_002dD_007d-_0028_0040command_007bgnatpp_007d_0029-751"><samp><span class="option">-D</span></samp> (<samp><span class="command">gnatpp</span></samp>)</a>: <a href="#Casing-Control">Casing Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dD_007d-_0028_0040command_007bgnatprep_007d_0029-822"><samp><span class="option">-D</span></samp> (<samp><span class="command">gnatprep</span></samp>)</a>: <a href="#Switches-for-gnatprep">Switches for gnatprep</a></li>
<li><a href="#index-g_t_0040option_007b_002dd_007d-_0028_0040command_007bgnatxref_007d_0029-719"><samp><span class="option">-d</span></samp> (<samp><span class="command">gnatxref</span></samp>)</a>: <a href="#Switches-for-gnatxref">Switches for gnatxref</a></li>
<li><a href="#index-g_t_0040option_007b_002dD_002d_007d-_0028_0040command_007bgnatpp_007d_0029-752"><samp><span class="option">-D-</span></samp> (<samp><span class="command">gnatpp</span></samp>)</a>: <a href="#Casing-Control">Casing Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dd_0040var_007bnn_007d_0040r_007b_005b_007dk_0040r_007b_007c_007dm_0040r_007b_005d_007d_007d-_0028_0040command_007bgnatbind_007d_0029-414"><samp><span class="option">-d</span><var>nn</var><span class="option">[k|m]</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002de_007d-_0028_0040code_007bgnatbind_007d_0029-467"><samp><span class="option">-e</span></samp> (<code>gnatbind</code>)</a>: <a href="#Output-Control">Output Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dE_007d-_0028_0040command_007bgnatbind_007d_0029-417"><samp><span class="option">-E</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002de_007d-_0028_0040command_007bgnatbind_007d_0029-416"><samp><span class="option">-e</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002de_007d-_0028_0040code_007bgnatdll_007d_0029-1072"><samp><span class="option">-e</span></samp> (<code>gnatdll</code>)</a>: <a href="#Using-gnatdll">Using gnatdll</a></li>
<li><a href="#index-g_t_0040option_007b_002de_007d-_0028_0040command_007bgnatfind_007d_0029-734"><samp><span class="option">-e</span></samp> (<samp><span class="command">gnatfind</span></samp>)</a>: <a href="#Switches-for-gnatfind">Switches for gnatfind</a></li>
<li><a href="#index-g_t_0040option_007b_002de_007d-_0028_0040command_007bgnatpp_007d_0029-766"><samp><span class="option">-e</span></samp> (<samp><span class="command">gnatpp</span></samp>)</a>: <a href="#Other-Formatting-Options">Other Formatting Options</a></li>
<li><a href="#index-g_t_0040option_007b_002dE_007d-_0028_0040code_007bgprof_007d_0029-945"><samp><span class="option">-E</span></samp> (<code>gprof</code>)</a>: <a href="#Running-gprof">Running gprof</a></li>
<li><a href="#index-g_t_0040option_007b_002de_007d-_0028_0040code_007bgprof_007d_0029-944"><samp><span class="option">-e</span></samp> (<code>gprof</code>)</a>: <a href="#Running-gprof">Running gprof</a></li>
<li><a href="#index-g_t_0040option_007b_002deL_007d-_0028any-project_002daware-tool_0029-706"><samp><span class="option">-eL</span></samp> (any project-aware tool)</a>: <a href="#Switches-Related-to-Project-Files">Switches Related to Project Files</a></li>
<li><a href="#index-g_t_0040option_007b_002deL_007d-_0028_0040command_007bgnatmake_007d_0029-521"><samp><span class="option">-eL</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002deS_007d-_0028_0040command_007bgnatmake_007d_0029-524"><samp><span class="option">-eS</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dext_007d-_0028_0040code_007bgnathtml_007d_0029-923"><samp><span class="option">-ext</span></samp> (<code>gnathtml</code>)</a>: <a href="#Converting-Ada-Files-to-html-with-gnathtml">Converting Ada Files to html with gnathtml</a></li>
<li><a href="#index-g_t_0040option_007b_002dF_007d-_0028_0040command_007bgnatbind_007d_0029-418"><samp><span class="option">-F</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dF_007d-_0028_0040code_007bgnatclean_007d_0029-849"><samp><span class="option">-F</span></samp> (<code>gnatclean</code>)</a>: <a href="#Switches-for-gnatclean">Switches for gnatclean</a></li>
<li><a href="#index-g_t_0040option_007b_002df_007d-_0028_0040command_007bgnatfind_007d_0029-735"><samp><span class="option">-f</span></samp> (<samp><span class="command">gnatfind</span></samp>)</a>: <a href="#Switches-for-gnatfind">Switches for gnatfind</a></li>
<li><a href="#index-g_t_0040option_007b_002df_007d-_0028_0040code_007bgnathtml_007d_0029-924"><samp><span class="option">-f</span></samp> (<code>gnathtml</code>)</a>: <a href="#Converting-Ada-Files-to-html-with-gnathtml">Converting Ada Files to html with gnathtml</a></li>
<li><a href="#index-g_t_0040option_007b_002df_007d-_0028_0040command_007bgnatlink_007d_0029-496"><samp><span class="option">-f</span></samp> (<samp><span class="command">gnatlink</span></samp>)</a>: <a href="#Switches-for-gnatlink">Switches for gnatlink</a></li>
<li><a href="#index-g_t_0040option_007b_002dF_007d-_0028_0040command_007bgnatmake_007d_0029-526"><samp><span class="option">-F</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002df_007d-_0028_0040command_007bgnatmake_007d_0029-525"><samp><span class="option">-f</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002df_007d-_0028_0040code_007bgnatname_007d_0029-627"><samp><span class="option">-f</span></samp> (<code>gnatname</code>)</a>: <a href="#Switches-for-gnatname">Switches for gnatname</a></li>
<li><a href="#index-g_t_0040option_007b_002df_007d-_0028_0040command_007bgnatstub_007d_0029-893"><samp><span class="option">-f</span></samp> (<samp><span class="command">gnatstub</span></samp>)</a>: <a href="#Switches-for-gnatstub">Switches for gnatstub</a></li>
<li><a href="#index-g_t_0040option_007b_002df_007d-_0028_0040command_007bgnatxref_007d_0029-720"><samp><span class="option">-f</span></samp> (<samp><span class="command">gnatxref</span></samp>)</a>: <a href="#Switches-for-gnatxref">Switches for gnatxref</a></li>
<li><a href="#index-g_t_0040option_007b_002dF_007d-_0028_0040code_007bgprof_007d_0029-947"><samp><span class="option">-F</span></samp> (<code>gprof</code>)</a>: <a href="#Running-gprof">Running gprof</a></li>
<li><a href="#index-g_t_0040option_007b_002df_007d-_0028_0040code_007bgprof_007d_0029-946"><samp><span class="option">-f</span></samp> (<code>gprof</code>)</a>: <a href="#Running-gprof">Running gprof</a></li>
<li><a href="#index-g_t_0040option_007b_002dfcallgraph_002dinfo_007d-_0028_0040command_007bgcc_007d_0029-103"><samp><span class="option">-fcallgraph-info</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dfdata_002dsections_007d-_0028_0040command_007bgcc_007d_0029-605"><samp><span class="option">-fdata-sections</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Compilation-options">Compilation options</a></li>
<li><a href="#index-g_t_0040option_007b_002dfdump_002dada_002dspec_007d-_0028_0040command_007bgcc_007d_0029-914"><samp><span class="option">-fdump-ada-spec</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches">Switches</a></li>
<li><a href="#index-g_t_0040option_007b_002dfdump_002dada_002dspec_002dslim_007d-_0028_0040command_007bgcc_007d_0029-915"><samp><span class="option">-fdump-ada-spec-slim</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches">Switches</a></li>
<li><a href="#index-g_t_0040option_007b_002dff_007d-_0028_0040command_007bgnatpp_007d_0029-767"><samp><span class="option">-ff</span></samp> (<samp><span class="command">gnatpp</span></samp>)</a>: <a href="#Other-Formatting-Options">Other Formatting Options</a></li>
<li><a href="#index-g_t_0040option_007b_002dffunction_002dsections_007d-_0028_0040command_007bgcc_007d_0029-604"><samp><span class="option">-ffunction-sections</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Compilation-options">Compilation options</a></li>
<li><a href="#index-g_t_0040option_007b_002dfiles_007d-_0028_0040code_007bgnatelim_007d_0029-593"><samp><span class="option">-files</span></samp> (<code>gnatelim</code>)</a>: <a href="#Running-gnatelim">Running gnatelim</a></li>
<li><a href="#index-g_t_0040option_007b_002dfiles_007d-_0028_0040code_007bgnatls_007d_0029-836"><samp><span class="option">-files</span></samp> (<code>gnatls</code>)</a>: <a href="#Switches-for-gnatls">Switches for gnatls</a></li>
<li><a href="#index-g_t_0040option_007b_002dfiles_007d-_0028_0040code_007bgnatmetric_007d_0029-814"><samp><span class="option">-files</span></samp> (<code>gnatmetric</code>)</a>: <a href="#Other-gnatmetric-Switches">Other gnatmetric Switches</a></li>
<li><a href="#index-g_t_0040option_007b_002dfiles_007d-_0028_0040code_007bgnatpp_007d_0029-781"><samp><span class="option">-files</span></samp> (<code>gnatpp</code>)</a>: <a href="#Other-gnatpp-Switches">Other gnatpp Switches</a></li>
<li><a href="#index-g_t_0040option_007b_002dfno_002dinline_007d-_0028_0040command_007bgcc_007d_0029-583"><samp><span class="option">-fno-inline</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Inlining-of-Subprograms">Inlining of Subprograms</a></li>
<li><a href="#index-g_t_0040option_007b_002dfno_002dinline_007d-_0028_0040command_007bgcc_007d_0029-95"><samp><span class="option">-fno-inline</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dfno_002dinline_002dfunctions_007d-_0028_0040command_007bgcc_007d_0029-584"><samp><span class="option">-fno-inline-functions</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Inlining-of-Subprograms">Inlining of Subprograms</a></li>
<li><a href="#index-g_t_0040option_007b_002dfno_002dinline_002dfunctions_007d-_0028_0040command_007bgcc_007d_0029-96"><samp><span class="option">-fno-inline-functions</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dfno_002dinline_002dfunctions_002dcalled_002donce_007d-_0028_0040command_007bgcc_007d_0029-586"><samp><span class="option">-fno-inline-functions-called-once</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Inlining-of-Subprograms">Inlining of Subprograms</a></li>
<li><a href="#index-g_t_0040option_007b_002dfno_002dinline_002dfunctions_002dcalled_002donce_007d-_0028_0040command_007bgcc_007d_0029-98"><samp><span class="option">-fno-inline-functions-called-once</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dfno_002dinline_002dsmall_002dfunctions_007d-_0028_0040command_007bgcc_007d_0029-585"><samp><span class="option">-fno-inline-small-functions</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Inlining-of-Subprograms">Inlining of Subprograms</a></li>
<li><a href="#index-g_t_0040option_007b_002dfno_002dinline_002dsmall_002dfunctions_007d-_0028_0040command_007bgcc_007d_0029-97"><samp><span class="option">-fno-inline-small-functions</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dfno_002divopts_007d-_0028_0040command_007bgcc_007d_0029-99"><samp><span class="option">-fno-ivopts</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dfno_002dstrict_002daliasing_007d-_0028_0040command_007bgcc_007d_0029-100"><samp><span class="option">-fno-strict-aliasing</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_002dfprofile_002darcs-934">-fprofile-arcs</a>: <a href="#Code-Coverage-of-Ada-Programs-using-gcov">Code Coverage of Ada Programs using gcov</a></li>
<li><a href="#index-g_t_002dfstack_002dcheck-885">-fstack-check</a>: <a href="#Stack-Overflow-Checking">Stack Overflow Checking</a></li>
<li><a href="#index-g_t_0040option_007b_002dfstack_002dcheck_007d-_0028_0040command_007bgcc_007d_0029-351"><samp><span class="option">-fstack-check</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Run_002dTime-Checks">Run-Time Checks</a></li>
<li><a href="#index-g_t_0040option_007b_002dfstack_002dcheck_007d-_0028_0040command_007bgcc_007d_0029-101"><samp><span class="option">-fstack-check</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_002dfstack_002dusage-888">-fstack-usage</a>: <a href="#Static-Stack-Usage-Analysis">Static Stack Usage Analysis</a></li>
<li><a href="#index-g_t_0040option_007b_002dfstack_002dusage_007d-_0028_0040command_007bgcc_007d_0029-102"><samp><span class="option">-fstack-usage</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_002dftest_002dcoverage-935">-ftest-coverage</a>: <a href="#Code-Coverage-of-Ada-Programs-using-gcov">Code Coverage of Ada Programs using gcov</a></li>
<li><a href="#index-g_t_0040option_007b_002dfverbose_002dasm_007d-_0028_0040command_007bgcc_007d_0029-179"><samp><span class="option">-fverbose-asm</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dg_007d-_0028_0040command_007bgcc_007d_0029-580"><samp><span class="option">-g</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Debugging-Optimized-Code">Debugging Optimized Code</a></li>
<li><a href="#index-g_t_0040option_007b_002dg_007d-_0028_0040command_007bgcc_007d_0029-104"><samp><span class="option">-g</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dg_007d-_0028_0040code_007bgnatdll_007d_0029-1073"><samp><span class="option">-g</span></samp> (<code>gnatdll</code>)</a>: <a href="#Using-gnatdll">Using gnatdll</a></li>
<li><a href="#index-g_t_0040option_007b_002dg_007d-_0028_0040command_007bgnatfind_007d_0029-736"><samp><span class="option">-g</span></samp> (<samp><span class="command">gnatfind</span></samp>)</a>: <a href="#Switches-for-gnatfind">Switches for gnatfind</a></li>
<li><a href="#index-g_t_0040option_007b_002dg_007d-_0028_0040command_007bgnatlink_007d_0029-498"><samp><span class="option">-g</span></samp> (<samp><span class="command">gnatlink</span></samp>)</a>: <a href="#Switches-for-gnatlink">Switches for gnatlink</a></li>
<li><a href="#index-g_t_0040option_007b_002dg_007d-_0028_0040command_007bgnatmake_007d_0029-527"><samp><span class="option">-g</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dg_007d-_0028_0040command_007bgnatxref_007d_0029-721"><samp><span class="option">-g</span></samp> (<samp><span class="command">gnatxref</span></samp>)</a>: <a href="#Switches-for-gnatxref">Switches for gnatxref</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnat_002dp_007d-_0028_0040command_007bgcc_007d_0029-340"><samp><span class="option">-gnat-p</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Run_002dTime-Checks">Run-Time Checks</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnat_002dp_007d-_0028_0040command_007bgcc_007d_0029-145"><samp><span class="option">-gnat-p</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnat05_007d-_0028_0040command_007bgcc_007d_0029-365"><samp><span class="option">-gnat05</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Compiling-Different-Versions-of-Ada">Compiling Different Versions of Ada</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnat05_007d-_0028_0040command_007bgcc_007d_0029-107"><samp><span class="option">-gnat05</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnat12_007d-_0028_0040command_007bgcc_007d_0029-368"><samp><span class="option">-gnat12</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Compiling-Different-Versions-of-Ada">Compiling Different Versions of Ada</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnat12_007d-_0028_0040command_007bgcc_007d_0029-109"><samp><span class="option">-gnat12</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnat2005_007d-_0028_0040command_007bgcc_007d_0029-366"><samp><span class="option">-gnat2005</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Compiling-Different-Versions-of-Ada">Compiling Different Versions of Ada</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnat2005_007d-_0028_0040command_007bgcc_007d_0029-108"><samp><span class="option">-gnat2005</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnat2012_007d-_0028_0040command_007bgcc_007d_0029-369"><samp><span class="option">-gnat2012</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Compiling-Different-Versions-of-Ada">Compiling Different Versions of Ada</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnat2012_007d-_0028_0040command_007bgcc_007d_0029-110"><samp><span class="option">-gnat2012</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnat83_007d-_0028_0040command_007bgcc_007d_0029-359"><samp><span class="option">-gnat83</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Compiling-Different-Versions-of-Ada">Compiling Different Versions of Ada</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnat83_007d-_0028_0040command_007bgcc_007d_0029-105"><samp><span class="option">-gnat83</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnat95_007d-_0028_0040command_007bgcc_007d_0029-363"><samp><span class="option">-gnat95</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Compiling-Different-Versions-of-Ada">Compiling Different Versions of Ada</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnat95_007d-_0028_0040command_007bgcc_007d_0029-106"><samp><span class="option">-gnat95</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnata_007d-_0028_0040command_007bgcc_007d_0029-311"><samp><span class="option">-gnata</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Debugging-and-Assertion-Control">Debugging and Assertion Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatA_007d-_0028_0040command_007bgcc_007d_0029-112"><samp><span class="option">-gnatA</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnata_007d-_0028_0040command_007bgcc_007d_0029-111"><samp><span class="option">-gnata</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnata_007d-switch-1038"><samp><span class="option">-gnata</span></samp> switch</a>: <a href="#Debugging-_002d-A-Special-Case">Debugging - A Special Case</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatb_007d-_0028_0040command_007bgcc_007d_0029-191"><samp><span class="option">-gnatb</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Output-and-Error-Message-Control">Output and Error Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatB_007d-_0028_0040command_007bgcc_007d_0029-114"><samp><span class="option">-gnatB</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatb_007d-_0028_0040command_007bgcc_007d_0029-113"><samp><span class="option">-gnatb</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatc_007d-_0028_0040command_007bgcc_007d_0029-357"><samp><span class="option">-gnatc</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Using-gcc-for-Semantic-Checking">Using gcc for Semantic Checking</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatC_007d-_0028_0040command_007bgcc_007d_0029-116"><samp><span class="option">-gnatC</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatc_007d-_0028_0040command_007bgcc_007d_0029-115"><samp><span class="option">-gnatc</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatD_007d-_0028_0040command_007bgcc_007d_0029-388"><samp><span class="option">-gnatD</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Debugging-Control">Debugging Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatd_007d-_0028_0040command_007bgcc_007d_0029-385"><samp><span class="option">-gnatd</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Debugging-Control">Debugging Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatd_007d-_0028_0040command_007bgcc_007d_0029-117"><samp><span class="option">-gnatd</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatD_005bnn_005d_007d-_0028_0040command_007bgcc_007d_0029-118"><samp><span class="option">-gnatD[nn]</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatdc_007d-switch-960"><samp><span class="option">-gnatdc</span></samp> switch</a>: <a href="#GNAT-Abnormal-Termination-or-Failure-to-Terminate">GNAT Abnormal Termination or Failure to Terminate</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatE_007d-_0028_0040command_007bgcc_007d_0029-348"><samp><span class="option">-gnatE</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Run_002dTime-Checks">Run-Time Checks</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatE_007d-_0028_0040command_007bgcc_007d_0029-128"><samp><span class="option">-gnatE</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatec_007d-_0028_0040command_007bgcc_007d_0029-119"><samp><span class="option">-gnatec</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatec_007d-_0028_0040code_007bgnatpp_007d_0029-771"><samp><span class="option">-gnatec</span></samp> (<code>gnatpp</code>)</a>: <a href="#Setting-the-Source-Search-Path">Setting the Source Search Path</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatec_007d-_0028_0040command_007bgnatstub_007d_0029-899"><samp><span class="option">-gnatec</span></samp> (<samp><span class="command">gnatstub</span></samp>)</a>: <a href="#Switches-for-gnatstub">Switches for gnatstub</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnateD_007d-_0028_0040command_007bgcc_007d_0029-400"><samp><span class="option">-gnateD</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Integrated-Preprocessing">Integrated Preprocessing</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnateD_007d-_0028_0040command_007bgcc_007d_0029-120"><samp><span class="option">-gnateD</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnateE_007d-_0028_0040command_007bgcc_007d_0029-121"><samp><span class="option">-gnateE</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatef_007d-_0028_0040command_007bgcc_007d_0029-122"><samp><span class="option">-gnatef</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnateG_007d-_0028_0040command_007bgcc_007d_0029-123"><samp><span class="option">-gnateG</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatem_007d-_0028_0040command_007bgcc_007d_0029-398"><samp><span class="option">-gnatem</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Units-to-Sources-Mapping-Files">Units to Sources Mapping Files</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatem_007d-_0028_0040command_007bgcc_007d_0029-124"><samp><span class="option">-gnatem</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatep_007d-_0028_0040command_007bgcc_007d_0029-399"><samp><span class="option">-gnatep</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Integrated-Preprocessing">Integrated Preprocessing</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnateP_007d-_0028_0040command_007bgcc_007d_0029-126"><samp><span class="option">-gnateP</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatep_007d-_0028_0040command_007bgcc_007d_0029-125"><samp><span class="option">-gnatep</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnateS_007d-_0028_0040command_007bgcc_007d_0029-127"><samp><span class="option">-gnateS</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatf_007d-_0028_0040command_007bgcc_007d_0029-193"><samp><span class="option">-gnatf</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Output-and-Error-Message-Control">Output and Error Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatF_007d-_0028_0040command_007bgcc_007d_0029-130"><samp><span class="option">-gnatF</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatf_007d-_0028_0040command_007bgcc_007d_0029-129"><samp><span class="option">-gnatf</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatG_007d-_0028_0040command_007bgcc_007d_0029-386"><samp><span class="option">-gnatG</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Debugging-Control">Debugging Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatg_007d-_0028_0040command_007bgcc_007d_0029-131"><samp><span class="option">-gnatg</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatG_005bnn_005d_007d-_0028_0040command_007bgcc_007d_0029-132"><samp><span class="option">-gnatG[nn]</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnath_007d-_0028_0040command_007bgcc_007d_0029-133"><samp><span class="option">-gnath</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnati_007d-_0028_0040command_007bgcc_007d_0029-374"><samp><span class="option">-gnati</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Character-Set-Control">Character Set Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatI_007d-_0028_0040command_007bgcc_007d_0029-135"><samp><span class="option">-gnatI</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnati_007d-_0028_0040command_007bgcc_007d_0029-134"><samp><span class="option">-gnati</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatjnn_007d-_0028_0040command_007bgcc_007d_0029-195"><samp><span class="option">-gnatjnn</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Output-and-Error-Message-Control">Output and Error Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatjnn_007d-_0028_0040command_007bgcc_007d_0029-136"><samp><span class="option">-gnatjnn</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatk_007d-_0028_0040command_007bgcc_007d_0029-376"><samp><span class="option">-gnatk</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#File-Naming-Control">File Naming Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatk_007d-_0028_0040command_007bgcc_007d_0029-137"><samp><span class="option">-gnatk</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatL_007d-_0028_0040command_007bgcc_007d_0029-387"><samp><span class="option">-gnatL</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Debugging-Control">Debugging Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatl_007d-_0028_0040command_007bgcc_007d_0029-187"><samp><span class="option">-gnatl</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Output-and-Error-Message-Control">Output and Error Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatL_007d-_0028_0040command_007bgcc_007d_0029-139"><samp><span class="option">-gnatL</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatl_007d-_0028_0040command_007bgcc_007d_0029-138"><samp><span class="option">-gnatl</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatl_003dfname_007d-_0028_0040command_007bgcc_007d_0029-189"><samp><span class="option">-gnatl=fname</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Output-and-Error-Message-Control">Output and Error Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatm_007d-_0028_0040command_007bgcc_007d_0029-192"><samp><span class="option">-gnatm</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Output-and-Error-Message-Control">Output and Error Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatm_007d-_0028_0040command_007bgcc_007d_0029-140"><samp><span class="option">-gnatm</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatN_007d-_0028_0040command_007bgcc_007d_0029-378"><samp><span class="option">-gnatN</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Subprogram-Inlining-Control">Subprogram Inlining Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatn_007d-_0028_0040command_007bgcc_007d_0029-377"><samp><span class="option">-gnatn</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Subprogram-Inlining-Control">Subprogram Inlining Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatN_007d-_0028_0040command_007bgcc_007d_0029-142"><samp><span class="option">-gnatN</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatn_007d-_0028_0040command_007bgcc_007d_0029-141"><samp><span class="option">-gnatn</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatN_007d-switch-46"><samp><span class="option">-gnatN</span></samp> switch</a>: <a href="#Source-Dependencies">Source Dependencies</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatn_007d-switch-45"><samp><span class="option">-gnatn</span></samp> switch</a>: <a href="#Source-Dependencies">Source Dependencies</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnato_007d-_0028_0040command_007bgcc_007d_0029-570"><samp><span class="option">-gnato</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Controlling-Run_002dTime-Checks">Controlling Run-Time Checks</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnato_007d-_0028_0040command_007bgcc_007d_0029-344"><samp><span class="option">-gnato</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Run_002dTime-Checks">Run-Time Checks</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnato_007d-_0028_0040command_007bgcc_007d_0029-143"><samp><span class="option">-gnato</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnato_007d-_0028_0040command_007bgnatstub_007d_0029-902"><samp><span class="option">-gnato</span></samp> (<samp><span class="command">gnatstub</span></samp>)</a>: <a href="#Switches-for-gnatstub">Switches for gnatstub</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatp_007d-_0028_0040command_007bgcc_007d_0029-569"><samp><span class="option">-gnatp</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Controlling-Run_002dTime-Checks">Controlling Run-Time Checks</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatp_007d-_0028_0040command_007bgcc_007d_0029-336"><samp><span class="option">-gnatp</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Run_002dTime-Checks">Run-Time Checks</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatP_007d-_0028_0040command_007bgcc_007d_0029-146"><samp><span class="option">-gnatP</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatp_007d-_0028_0040command_007bgcc_007d_0029-144"><samp><span class="option">-gnatp</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatQ_007d-_0028_0040command_007bgcc_007d_0029-197"><samp><span class="option">-gnatQ</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Output-and-Error-Message-Control">Output and Error Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatq_007d-_0028_0040command_007bgcc_007d_0029-196"><samp><span class="option">-gnatq</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Output-and-Error-Message-Control">Output and Error Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatQ_007d-_0028_0040command_007bgcc_007d_0029-148"><samp><span class="option">-gnatQ</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatq_007d-_0028_0040command_007bgcc_007d_0029-147"><samp><span class="option">-gnatq</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatR_007d-_0028_0040command_007bgcc_007d_0029-392"><samp><span class="option">-gnatR</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Debugging-Control">Debugging Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatr_007d-_0028_0040command_007bgcc_007d_0029-390"><samp><span class="option">-gnatr</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Debugging-Control">Debugging Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatR_007d-_0028_0040command_007bgcc_007d_0029-150"><samp><span class="option">-gnatR</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatr_007d-_0028_0040command_007bgcc_007d_0029-149"><samp><span class="option">-gnatr</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatS_007d-_0028_0040command_007bgcc_007d_0029-393"><samp><span class="option">-gnatS</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Debugging-Control">Debugging Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnats_007d-_0028_0040command_007bgcc_007d_0029-355"><samp><span class="option">-gnats</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Using-gcc-for-Syntax-Checking">Using gcc for Syntax Checking</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatS_007d-_0028_0040command_007bgcc_007d_0029-152"><samp><span class="option">-gnatS</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnats_007d-_0028_0040command_007bgcc_007d_0029-151"><samp><span class="option">-gnats</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatt_007d-_0028_0040command_007bgcc_007d_0029-379"><samp><span class="option">-gnatt</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Auxiliary-Output-Control">Auxiliary Output Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatT_007d-_0028_0040command_007bgcc_007d_0029-154"><samp><span class="option">-gnatT</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatt_007d-_0028_0040command_007bgcc_007d_0029-153"><samp><span class="option">-gnatt</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatu_007d-_0028_0040command_007bgcc_007d_0029-382"><samp><span class="option">-gnatu</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Auxiliary-Output-Control">Auxiliary Output Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatU_007d-_0028_0040command_007bgcc_007d_0029-190"><samp><span class="option">-gnatU</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Output-and-Error-Message-Control">Output and Error Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatU_007d-_0028_0040command_007bgcc_007d_0029-156"><samp><span class="option">-gnatU</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatu_007d-_0028_0040command_007bgcc_007d_0029-155"><samp><span class="option">-gnatu</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatv_007d-_0028_0040command_007bgcc_007d_0029-185"><samp><span class="option">-gnatv</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Output-and-Error-Message-Control">Output and Error Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatV_007d-_0028_0040command_007bgcc_007d_0029-158"><samp><span class="option">-gnatV</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatv_007d-_0028_0040command_007bgcc_007d_0029-157"><samp><span class="option">-gnatv</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatVa_007d-_0028_0040command_007bgcc_007d_0029-316"><samp><span class="option">-gnatVa</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Validity-Checking">Validity Checking</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatVc_007d-_0028_0040command_007bgcc_007d_0029-317"><samp><span class="option">-gnatVc</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Validity-Checking">Validity Checking</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatVd_007d-_0028_0040command_007bgcc_007d_0029-318"><samp><span class="option">-gnatVd</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Validity-Checking">Validity Checking</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatVe_007d-_0028_0040command_007bgcc_007d_0029-319"><samp><span class="option">-gnatVe</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Validity-Checking">Validity Checking</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatVf_007d-_0028_0040command_007bgcc_007d_0029-320"><samp><span class="option">-gnatVf</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Validity-Checking">Validity Checking</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatVi_007d-_0028_0040command_007bgcc_007d_0029-321"><samp><span class="option">-gnatVi</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Validity-Checking">Validity Checking</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatVm_007d-_0028_0040command_007bgcc_007d_0029-322"><samp><span class="option">-gnatVm</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Validity-Checking">Validity Checking</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatVn_007d-_0028_0040command_007bgcc_007d_0029-323"><samp><span class="option">-gnatVn</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Validity-Checking">Validity Checking</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatVo_007d-_0028_0040command_007bgcc_007d_0029-324"><samp><span class="option">-gnatVo</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Validity-Checking">Validity Checking</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatVp_007d-_0028_0040command_007bgcc_007d_0029-325"><samp><span class="option">-gnatVp</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Validity-Checking">Validity Checking</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatVr_007d-_0028_0040command_007bgcc_007d_0029-326"><samp><span class="option">-gnatVr</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Validity-Checking">Validity Checking</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatVs_007d-_0028_0040command_007bgcc_007d_0029-327"><samp><span class="option">-gnatVs</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Validity-Checking">Validity Checking</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatVt_007d-_0028_0040command_007bgcc_007d_0029-328"><samp><span class="option">-gnatVt</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Validity-Checking">Validity Checking</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatW_007d-_0028_0040command_007bgcc_007d_0029-375"><samp><span class="option">-gnatW</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Character-Set-Control">Character Set Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatW_007d-_0028_0040command_007bgcc_007d_0029-160"><samp><span class="option">-gnatW</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatw_007d-_0028_0040command_007bgcc_007d_0029-159"><samp><span class="option">-gnatw</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatw_002eA_007d-_0028_0040command_007bgcc_007d_0029-203"><samp><span class="option">-gnatw.A</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatw_002ea_007d-_0028_0040command_007bgcc_007d_0029-201"><samp><span class="option">-gnatw.a</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatw_002eb_007d-_0028_0040command_007bgcc_007d_0029-210"><samp><span class="option">-gnatw.b</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatw_002ec_007d-_0028_0040command_007bgcc_007d_0029-216"><samp><span class="option">-gnatw.c</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatw_002ee_007d-_0028_0040command_007bgcc_007d_0029-225"><samp><span class="option">-gnatw.e</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatw_002eH_007d-_0028_0040command_007bgcc_007d_0029-238"><samp><span class="option">-gnatw.H</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatw_002eh_007d-_0028_0040command_007bgcc_007d_0029-236"><samp><span class="option">-gnatw.h</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatw_002eI_007d-_0028_0040command_007bgcc_007d_0029-242"><samp><span class="option">-gnatw.I</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatw_002ei_007d-_0028_0040command_007bgcc_007d_0029-241"><samp><span class="option">-gnatw.i</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatw_002eM_007d-_0028_0040command_007bgcc_007d_0029-255"><samp><span class="option">-gnatw.M</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatw_002em_007d-_0028_0040command_007bgcc_007d_0029-254"><samp><span class="option">-gnatw.m</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatw_002eO_007d-_0028_0040command_007bgcc_007d_0029-261"><samp><span class="option">-gnatw.O</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatw_002eo_007d-_0028_0040command_007bgcc_007d_0029-260"><samp><span class="option">-gnatw.o</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatw_002eP_007d-_0028_0040command_007bgcc_007d_0029-267"><samp><span class="option">-gnatw.P</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatw_002ep_007d-_0028_0040command_007bgcc_007d_0029-265"><samp><span class="option">-gnatw.p</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatw_002er_007d-_0028_0040command_007bgcc_007d_0029-273"><samp><span class="option">-gnatw.r</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatw_002eS_007d-_0028_0040command_007bgcc_007d_0029-278"><samp><span class="option">-gnatw.S</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatw_002es_007d-_0028_0040command_007bgcc_007d_0029-276"><samp><span class="option">-gnatw.s</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatw_002eU_007d-_0028_0040command_007bgcc_007d_0029-286"><samp><span class="option">-gnatw.U</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatw_002eu_007d-_0028_0040command_007bgcc_007d_0029-285"><samp><span class="option">-gnatw.u</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatw_002eW_007d-_0028_0040command_007bgcc_007d_0029-295"><samp><span class="option">-gnatw.W</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatw_002ew_007d-_0028_0040command_007bgcc_007d_0029-293"><samp><span class="option">-gnatw.w</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwA_007d-_0028_0040command_007bgcc_007d_0029-200"><samp><span class="option">-gnatwA</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwa_007d-_0028_0040command_007bgcc_007d_0029-199"><samp><span class="option">-gnatwa</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwB_007d-_0028_0040command_007bgcc_007d_0029-209"><samp><span class="option">-gnatwB</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwb_007d-_0028_0040command_007bgcc_007d_0029-205"><samp><span class="option">-gnatwb</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwC_007d-_0028_0040command_007bgcc_007d_0029-215"><samp><span class="option">-gnatwC</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwc_007d-_0028_0040command_007bgcc_007d_0029-213"><samp><span class="option">-gnatwc</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwD_007d-_0028_0040command_007bgcc_007d_0029-220"><samp><span class="option">-gnatwD</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwd_007d-_0028_0040command_007bgcc_007d_0029-219"><samp><span class="option">-gnatwd</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwe_007d-_0028_0040command_007bgcc_007d_0029-223"><samp><span class="option">-gnatwe</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwF_007d-_0028_0040command_007bgcc_007d_0029-229"><samp><span class="option">-gnatwF</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwf_007d-_0028_0040command_007bgcc_007d_0029-227"><samp><span class="option">-gnatwf</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwG_007d-_0028_0040command_007bgcc_007d_0029-232"><samp><span class="option">-gnatwG</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwg_007d-_0028_0040command_007bgcc_007d_0029-230"><samp><span class="option">-gnatwg</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwH_007d-_0028_0040command_007bgcc_007d_0029-235"><samp><span class="option">-gnatwH</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwh_007d-_0028_0040command_007bgcc_007d_0029-233"><samp><span class="option">-gnatwh</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwI_007d-_0028_0040command_007bgcc_007d_0029-240"><samp><span class="option">-gnatwI</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwi_007d-_0028_0040command_007bgcc_007d_0029-239"><samp><span class="option">-gnatwi</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwJ_007d-_0028_0040command_007bgcc_007d_0029-246"><samp><span class="option">-gnatwJ</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwj_007d-_0028_0040command_007bgcc_007d_0029-243"><samp><span class="option">-gnatwj</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwK_007d-_0028_0040command_007bgcc_007d_0029-248"><samp><span class="option">-gnatwK</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwk_007d-_0028_0040command_007bgcc_007d_0029-247"><samp><span class="option">-gnatwk</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwL_007d-_0028_0040command_007bgcc_007d_0029-251"><samp><span class="option">-gnatwL</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwl_007d-_0028_0040command_007bgcc_007d_0029-249"><samp><span class="option">-gnatwl</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwm_007d-_0028_0040command_007bgcc_007d_0029-299"><samp><span class="option">-gnatwm</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwM_007d-_0028_0040command_007bgcc_007d_0029-253"><samp><span class="option">-gnatwM</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwm_007d-_0028_0040command_007bgcc_007d_0029-252"><samp><span class="option">-gnatwm</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwn_007d-_0028_0040command_007bgcc_007d_0029-256"><samp><span class="option">-gnatwn</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwO_007d-_0028_0040command_007bgcc_007d_0029-259"><samp><span class="option">-gnatwO</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwo_007d-_0028_0040command_007bgcc_007d_0029-257"><samp><span class="option">-gnatwo</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwP_007d-_0028_0040command_007bgcc_007d_0029-264"><samp><span class="option">-gnatwP</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwp_007d-_0028_0040command_007bgcc_007d_0029-262"><samp><span class="option">-gnatwp</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwQ_007d-_0028_0040command_007bgcc_007d_0029-270"><samp><span class="option">-gnatwQ</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwq_007d-_0028_0040command_007bgcc_007d_0029-268"><samp><span class="option">-gnatwq</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwR_007d-_0028_0040command_007bgcc_007d_0029-272"><samp><span class="option">-gnatwR</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwr_007d-_0028_0040command_007bgcc_007d_0029-271"><samp><span class="option">-gnatwr</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatws_007d-_0028_0040command_007bgcc_007d_0029-275"><samp><span class="option">-gnatws</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwT_007d-_0028_0040command_007bgcc_007d_0029-282"><samp><span class="option">-gnatwT</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwt_007d-_0028_0040command_007bgcc_007d_0029-279"><samp><span class="option">-gnatwt</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwT_007d-_0028_0040command_007bgcc_007d_0029-274"><samp><span class="option">-gnatwT</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwU_007d-_0028_0040command_007bgcc_007d_0029-284"><samp><span class="option">-gnatwU</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwu_007d-_0028_0040command_007bgcc_007d_0029-283"><samp><span class="option">-gnatwu</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwV_007d-_0028_0040command_007bgcc_007d_0029-289"><samp><span class="option">-gnatwV</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwv_007d-_0028_0040command_007bgcc_007d_0029-287"><samp><span class="option">-gnatwv</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwW_007d-_0028_0040command_007bgcc_007d_0029-292"><samp><span class="option">-gnatwW</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatww_007d-_0028_0040command_007bgcc_007d_0029-290"><samp><span class="option">-gnatww</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwX_007d-_0028_0040command_007bgcc_007d_0029-298"><samp><span class="option">-gnatwX</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwx_007d-_0028_0040command_007bgcc_007d_0029-296"><samp><span class="option">-gnatwx</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwY_007d-_0028_0040command_007bgcc_007d_0029-302"><samp><span class="option">-gnatwY</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwy_007d-_0028_0040command_007bgcc_007d_0029-300"><samp><span class="option">-gnatwy</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwZ_007d-_0028_0040command_007bgcc_007d_0029-306"><samp><span class="option">-gnatwZ</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatwz_007d-_0028_0040command_007bgcc_007d_0029-304"><samp><span class="option">-gnatwz</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatx_007d-_0028_0040command_007bgcc_007d_0029-394"><samp><span class="option">-gnatx</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Debugging-Control">Debugging Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatX_007d-_0028_0040command_007bgcc_007d_0029-371"><samp><span class="option">-gnatX</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Compiling-Different-Versions-of-Ada">Compiling Different Versions of Ada</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatX_007d-_0028_0040command_007bgcc_007d_0029-162"><samp><span class="option">-gnatX</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatx_007d-_0028_0040command_007bgcc_007d_0029-161"><samp><span class="option">-gnatx</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnaty_007d-_0028_0040command_007bgcc_007d_0029-330"><samp><span class="option">-gnaty</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Style-Checking">Style Checking</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnaty_007d-_0028_0040command_007bgcc_007d_0029-163"><samp><span class="option">-gnaty</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnaty_007d-_0028_0040command_007bgnatstub_007d_0029-901"><samp><span class="option">-gnaty</span></samp> (<samp><span class="command">gnatstub</span></samp>)</a>: <a href="#Switches-for-gnatstub">Switches for gnatstub</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatyM_007d-_0028_0040command_007bgnatstub_007d_0029-900"><samp><span class="option">-gnatyM</span></samp> (<samp><span class="command">gnatstub</span></samp>)</a>: <a href="#Switches-for-gnatstub">Switches for gnatstub</a></li>
<li><a href="#index-g_t_0040option_007b_002dgnatz_007d-_0028_0040command_007bgcc_007d_0029-164"><samp><span class="option">-gnatz</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dh_007d-_0028_0040code_007bgnatbind_007d_0029-468"><samp><span class="option">-h</span></samp> (<code>gnatbind</code>)</a>: <a href="#Output-Control">Output Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dh_007d-_0028_0040command_007bgnatbind_007d_0029-419"><samp><span class="option">-h</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dh_007d-_0028_0040code_007bgnatclean_007d_0029-850"><samp><span class="option">-h</span></samp> (<code>gnatclean</code>)</a>: <a href="#Switches-for-gnatclean">Switches for gnatclean</a></li>
<li><a href="#index-g_t_0040option_007b_002dh_007d-_0028_0040code_007bgnatdll_007d_0029-1074"><samp><span class="option">-h</span></samp> (<code>gnatdll</code>)</a>: <a href="#Using-gnatdll">Using gnatdll</a></li>
<li><a href="#index-g_t_0040option_007b_002dh_007d-_0028_0040code_007bgnatls_007d_0029-832"><samp><span class="option">-h</span></samp> (<code>gnatls</code>)</a>: <a href="#Switches-for-gnatls">Switches for gnatls</a></li>
<li><a href="#index-g_t_0040option_007b_002dh_007d-_0028_0040code_007bgnatname_007d_0029-628"><samp><span class="option">-h</span></samp> (<code>gnatname</code>)</a>: <a href="#Switches-for-gnatname">Switches for gnatname</a></li>
<li><a href="#index-g_t_0040option_007b_002dH32_007d-_0028_0040command_007bgnatbind_007d_0029-420"><samp><span class="option">-H32</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dH64_007d-_0028_0040command_007bgnatbind_007d_0029-421"><samp><span class="option">-H64</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dhg_007d-_0028_0040command_007bgnatstub_007d_0029-895"><samp><span class="option">-hg</span></samp> (<samp><span class="command">gnatstub</span></samp>)</a>: <a href="#Switches-for-gnatstub">Switches for gnatstub</a></li>
<li><a href="#index-g_t_0040option_007b_002dhs_007d-_0028_0040command_007bgnatstub_007d_0029-894"><samp><span class="option">-hs</span></samp> (<samp><span class="command">gnatstub</span></samp>)</a>: <a href="#Switches-for-gnatstub">Switches for gnatstub</a></li>
<li><a href="#index-g_t_0040option_007b_002dI_007d-_0028_0040command_007bgcc_007d_0029-165"><samp><span class="option">-I</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dI_007d-_0028_0040command_007bgnatbind_007d_0029-485"><samp><span class="option">-I</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Search-Paths-for-gnatbind">Search Paths for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dI_007d-_0028_0040command_007bgnatbind_007d_0029-423"><samp><span class="option">-I</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dI_007d-_0028_0040code_007bgnatclean_007d_0029-859"><samp><span class="option">-I</span></samp> (<code>gnatclean</code>)</a>: <a href="#Switches-for-gnatclean">Switches for gnatclean</a></li>
<li><a href="#index-g_t_0040option_007b_002dI_007d-_0028_0040code_007bgnatdll_007d_0029-1075"><samp><span class="option">-I</span></samp> (<code>gnatdll</code>)</a>: <a href="#Using-gnatdll">Using gnatdll</a></li>
<li><a href="#index-g_t_0040option_007b_002dI_007d-_0028_0040code_007bgnathtml_007d_0029-926"><samp><span class="option">-I</span></samp> (<code>gnathtml</code>)</a>: <a href="#Converting-Ada-Files-to-html-with-gnathtml">Converting Ada Files to html with gnathtml</a></li>
<li><a href="#index-g_t_0040option_007b_002dI_007d-_0028_0040code_007bgnatls_007d_0029-839"><samp><span class="option">-I</span></samp> (<code>gnatls</code>)</a>: <a href="#Switches-for-gnatls">Switches for gnatls</a></li>
<li><a href="#index-g_t_0040option_007b_002dI_007d-_0028_0040command_007bgnatmake_007d_0029-555"><samp><span class="option">-I</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002di_007d-_0028_0040command_007bgnatmake_007d_0029-528"><samp><span class="option">-i</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002di_007d-_0028_0040code_007bgnatmem_007d_0029-881"><samp><span class="option">-i</span></samp> (<code>gnatmem</code>)</a>: <a href="#Switches-for-gnatmem">Switches for gnatmem</a></li>
<li><a href="#index-g_t_0040option_007b_002dI_007d-_0028_0040code_007bgnatpp_007d_0029-769"><samp><span class="option">-I</span></samp> (<code>gnatpp</code>)</a>: <a href="#Setting-the-Source-Search-Path">Setting the Source Search Path</a></li>
<li><a href="#index-g_t_0040option_007b_002di_007d-_0028_0040command_007bgnatpp_007d_0029-764"><samp><span class="option">-i</span></samp> (<samp><span class="command">gnatpp</span></samp>)</a>: <a href="#General-Text-Layout-Control">General Text Layout Control</a></li>
<li><a href="#index-g_t_0040option_007b_002di_007d-_0028_0040command_007bgnatstub_007d_0029-903"><samp><span class="option">-i</span></samp> (<samp><span class="command">gnatstub</span></samp>)</a>: <a href="#Switches-for-gnatstub">Switches for gnatstub</a></li>
<li><a href="#index-g_t_0040option_007b_002dI_002d_007d-_0028_0040command_007bgcc_007d_0029-167"><samp><span class="option">-I-</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dI_002d_007d-_0028_0040command_007bgnatbind_007d_0029-424"><samp><span class="option">-I-</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dI_002d_007d-_0028_0040code_007bgnatclean_007d_0029-860"><samp><span class="option">-I-</span></samp> (<code>gnatclean</code>)</a>: <a href="#Switches-for-gnatclean">Switches for gnatclean</a></li>
<li><a href="#index-g_t_0040option_007b_002dI_002d_007d-_0028_0040code_007bgnatls_007d_0029-840"><samp><span class="option">-I-</span></samp> (<code>gnatls</code>)</a>: <a href="#Switches-for-gnatls">Switches for gnatls</a></li>
<li><a href="#index-g_t_0040option_007b_002dI_002d_007d-_0028_0040command_007bgnatmake_007d_0029-556"><samp><span class="option">-I-</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dI_002d_007d-_0028_0040code_007bgnatpp_007d_0029-770"><samp><span class="option">-I-</span></samp> (<code>gnatpp</code>)</a>: <a href="#Setting-the-Source-Search-Path">Setting the Source Search Path</a></li>
<li><a href="#index-g_t_0040option_007b_002dI_002d_007d-_0028_0040command_007bgnatstub_007d_0029-898"><samp><span class="option">-I-</span></samp> (<samp><span class="command">gnatstub</span></samp>)</a>: <a href="#Switches-for-gnatstub">Switches for gnatstub</a></li>
<li><a href="#index-g_t_0040option_007b_002dIDIR_007d-_0028_0040command_007bgnatfind_007d_0029-737"><samp><span class="option">-IDIR</span></samp> (<samp><span class="command">gnatfind</span></samp>)</a>: <a href="#Switches-for-gnatfind">Switches for gnatfind</a></li>
<li><a href="#index-g_t_0040option_007b_002dIDIR_007d-_0028_0040command_007bgnatstub_007d_0029-897"><samp><span class="option">-IDIR</span></samp> (<samp><span class="command">gnatstub</span></samp>)</a>: <a href="#Switches-for-gnatstub">Switches for gnatstub</a></li>
<li><a href="#index-g_t_0040option_007b_002dIDIR_007d-_0028_0040command_007bgnatxref_007d_0029-722"><samp><span class="option">-IDIR</span></samp> (<samp><span class="command">gnatxref</span></samp>)</a>: <a href="#Switches-for-gnatxref">Switches for gnatxref</a></li>
<li><a href="#index-g_t_0040option_007b_002dj_007d-_0028_0040command_007bgnatmake_007d_0029-529"><samp><span class="option">-j</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dk_007d-_0028_0040command_007bdlltool_007d_0029-1085"><samp><span class="option">-k</span></samp> (<samp><span class="command">dlltool</span></samp>)</a>: <a href="#Using-dlltool">Using dlltool</a></li>
<li><a href="#index-g_t_0040option_007b_002dK_007d-_0028_0040code_007bgnatbind_007d_0029-469"><samp><span class="option">-K</span></samp> (<code>gnatbind</code>)</a>: <a href="#Output-Control">Output Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dk_007d-_0028_0040code_007bgnatchop_007d_0029-610"><samp><span class="option">-k</span></samp> (<code>gnatchop</code>)</a>: <a href="#Switches-for-gnatchop">Switches for gnatchop</a></li>
<li><a href="#index-g_t_0040option_007b_002dk_007d-_0028_0040code_007bgnatdll_007d_0029-1076"><samp><span class="option">-k</span></samp> (<code>gnatdll</code>)</a>: <a href="#Using-gnatdll">Using gnatdll</a></li>
<li><a href="#index-g_t_0040option_007b_002dk_007d-_0028_0040command_007bgnatmake_007d_0029-531"><samp><span class="option">-k</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dk_007d-_0028_0040command_007bgnatstub_007d_0029-904"><samp><span class="option">-k</span></samp> (<samp><span class="command">gnatstub</span></samp>)</a>: <a href="#Switches-for-gnatstub">Switches for gnatstub</a></li>
<li><a href="#index-g_t_0040option_007b_002dk_0040var_007bx_007d_007d-_0028_0040command_007bgnatpp_007d_0029-748"><samp><span class="option">-k</span><var>x</var></samp> (<samp><span class="command">gnatpp</span></samp>)</a>: <a href="#Casing-Control">Casing Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dl_007d-_0028_0040code_007bgnatbind_007d_0029-470"><samp><span class="option">-l</span></samp> (<code>gnatbind</code>)</a>: <a href="#Output-Control">Output Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dL_007d-_0028_0040command_007bgnatbind_007d_0029-426"><samp><span class="option">-L</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dl_007d-_0028_0040command_007bgnatbind_007d_0029-425"><samp><span class="option">-l</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dl_007d-_0028_0040code_007bgnatdll_007d_0029-1077"><samp><span class="option">-l</span></samp> (<code>gnatdll</code>)</a>: <a href="#Using-gnatdll">Using gnatdll</a></li>
<li><a href="#index-g_t_0040option_007b_002dl_007d-_0028_0040code_007bgnathtml_007d_0029-925"><samp><span class="option">-l</span></samp> (<code>gnathtml</code>)</a>: <a href="#Converting-Ada-Files-to-html-with-gnathtml">Converting Ada Files to html with gnathtml</a></li>
<li><a href="#index-g_t_0040option_007b_002dL_007d-_0028_0040command_007bgnatmake_007d_0029-558"><samp><span class="option">-L</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dl_007d-_0028_0040command_007bgnatmake_007d_0029-532"><samp><span class="option">-l</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dl_007d-_0028_0040command_007bgnatstub_007d_0029-905"><samp><span class="option">-l</span></samp> (<samp><span class="command">gnatstub</span></samp>)</a>: <a href="#Switches-for-gnatstub">Switches for gnatstub</a></li>
<li><a href="#index-g_t_0040option_007b_002dlargs_007d-_0028_0040code_007bgnatdll_007d_0029-1081"><samp><span class="option">-largs</span></samp> (<code>gnatdll</code>)</a>: <a href="#Using-gnatdll">Using gnatdll</a></li>
<li><a href="#index-g_t_0040option_007b_002dlargs_007d-_0028_0040command_007bgnatmake_007d_0029-565"><samp><span class="option">-largs</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Mode-Switches-for-gnatmake">Mode Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dl_0040var_007bn_007d_007d-_0028_0040command_007bgnatpp_007d_0029-755"><samp><span class="option">-l</span><var>n</var></samp> (<samp><span class="command">gnatpp</span></samp>)</a>: <a href="#Construct-Layout-Control">Construct Layout Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dlog_007d-_0028_0040command_007bgnatelim_007d_0029-594"><samp><span class="option">-log</span></samp> (<samp><span class="command">gnatelim</span></samp>)</a>: <a href="#Running-gnatelim">Running gnatelim</a></li>
<li><a href="#index-g_t_0040option_007b_002dM_007d-_0028_0040code_007bgnatbind_007d_0029-457"><samp><span class="option">-M</span></samp> (<code>gnatbind</code>)</a>: <a href="#Binder-Error-Message-Control">Binder Error Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dm_007d-_0028_0040code_007bgnatbind_007d_0029-456"><samp><span class="option">-m</span></samp> (<code>gnatbind</code>)</a>: <a href="#Binder-Error-Message-Control">Binder Error Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dm_007d-_0028_0040command_007bgnatbind_007d_0029-428"><samp><span class="option">-m</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dM_007d-_0028_0040command_007bgnatbind_007d_0029-427"><samp><span class="option">-M</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dM_007d-_0028_0040command_007bgnatmake_007d_0029-535"><samp><span class="option">-M</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dm_007d-_0028_0040command_007bgnatmake_007d_0029-533"><samp><span class="option">-m</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dm_007d-_0028_0040code_007bgnatmem_007d_0029-882"><samp><span class="option">-m</span></samp> (<code>gnatmem</code>)</a>: <a href="#Switches-for-gnatmem">Switches for gnatmem</a></li>
<li><a href="#index-g_t_0040option_007b_002dM_007d-_0028_0040command_007bgnatpp_007d_0029-763"><samp><span class="option">-M</span></samp> (<samp><span class="command">gnatpp</span></samp>)</a>: <a href="#General-Text-Layout-Control">General Text Layout Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dmargs_007d-_0028_0040command_007bgnatmake_007d_0029-566"><samp><span class="option">-margs</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Mode-Switches-for-gnatmake">Mode Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dmbig_002dswitch_007d-_0028_0040command_007bgcc_007d_0029-169"><samp><span class="option">-mbig-switch</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_002dmwindows-1053">-mwindows</a>: <a href="#CONSOLE-and-WINDOWS-subsystems">CONSOLE and WINDOWS subsystems</a></li>
<li><a href="#index-g_t_0040option_007b_002dn_007d-_0028_0040code_007bgnatbind_007d_0029-474"><samp><span class="option">-n</span></samp> (<code>gnatbind</code>)</a>: <a href="#Binding-with-Non_002dAda-Main-Programs">Binding with Non-Ada Main Programs</a></li>
<li><a href="#index-g_t_0040option_007b_002dn_007d-_0028_0040command_007bgnatbind_007d_0029-429"><samp><span class="option">-n</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dn_007d-_0028_0040code_007bgnatclean_007d_0029-851"><samp><span class="option">-n</span></samp> (<code>gnatclean</code>)</a>: <a href="#Switches-for-gnatclean">Switches for gnatclean</a></li>
<li><a href="#index-g_t_0040option_007b_002dn_007d-_0028_0040code_007bgnatdll_007d_0029-1078"><samp><span class="option">-n</span></samp> (<code>gnatdll</code>)</a>: <a href="#Using-gnatdll">Using gnatdll</a></li>
<li><a href="#index-g_t_0040option_007b_002dn_007d-_0028_0040command_007bgnatlink_007d_0029-499"><samp><span class="option">-n</span></samp> (<samp><span class="command">gnatlink</span></samp>)</a>: <a href="#Switches-for-gnatlink">Switches for gnatlink</a></li>
<li><a href="#index-g_t_0040option_007b_002dn_007d-_0028_0040command_007bgnatmake_007d_0029-536"><samp><span class="option">-n</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dN_007d-_0028_0040command_007bgnatpp_007d_0029-756"><samp><span class="option">-N</span></samp> (<samp><span class="command">gnatpp</span></samp>)</a>: <a href="#Construct-Layout-Control">Construct Layout Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dne_007d-_0028_0040command_007bgnatmetric_007d_0029-807"><samp><span class="option">-ne</span></samp> (<samp><span class="command">gnatmetric</span></samp>)</a>: <a href="#Complexity-Metrics-Control">Complexity Metrics Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dnostdinc_007d-_0028_0040command_007bgcc_007d_0029-173"><samp><span class="option">-nostdinc</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dnostdinc_007d-_0028_0040command_007bgnatbind_007d_0029-430"><samp><span class="option">-nostdinc</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dnostdinc_007d-_0028_0040command_007bgnatfind_007d_0029-729"><samp><span class="option">-nostdinc</span></samp> (<samp><span class="command">gnatfind</span></samp>)</a>: <a href="#Switches-for-gnatfind">Switches for gnatfind</a></li>
<li><a href="#index-g_t_0040option_007b_002dnostdinc_007d-_0028_0040command_007bgnatmake_007d_0029-560"><samp><span class="option">-nostdinc</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dnostdinc_007d-_0028_0040command_007bgnatxref_007d_0029-715"><samp><span class="option">-nostdinc</span></samp> (<samp><span class="command">gnatxref</span></samp>)</a>: <a href="#Switches-for-gnatxref">Switches for gnatxref</a></li>
<li><a href="#index-g_t_0040option_007b_002dnostdlib_007d-_0028_0040command_007bgcc_007d_0029-174"><samp><span class="option">-nostdlib</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dnostdlib_007d-_0028_0040command_007bgnatbind_007d_0029-431"><samp><span class="option">-nostdlib</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dnostdlib_007d-_0028_0040command_007bgnatfind_007d_0029-730"><samp><span class="option">-nostdlib</span></samp> (<samp><span class="command">gnatfind</span></samp>)</a>: <a href="#Switches-for-gnatfind">Switches for gnatfind</a></li>
<li><a href="#index-g_t_0040option_007b_002dnostdlib_007d-_0028_0040command_007bgnatmake_007d_0029-561"><samp><span class="option">-nostdlib</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dnostdlib_007d-_0028_0040command_007bgnatxref_007d_0029-716"><samp><span class="option">-nostdlib</span></samp> (<samp><span class="command">gnatxref</span></samp>)</a>: <a href="#Switches-for-gnatxref">Switches for gnatxref</a></li>
<li><a href="#index-g_t_0040option_007b_002dnt_007d-_0028_0040command_007bgnatmetric_007d_0029-789"><samp><span class="option">-nt</span></samp> (<samp><span class="command">gnatmetric</span></samp>)</a>: <a href="#Output-Files-Control">Output Files Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dn_0040var_007bx_007d_007d-_0028_0040command_007bgnatmetric_007d_0029-797"><samp><span class="option">-n</span><var>x</var></samp> (<samp><span class="command">gnatmetric</span></samp>)</a>: <a href="#Disable-Metrics-For-Local-Units">Disable Metrics For Local Units</a></li>
<li><a href="#index-g_t_0040option_007b_002dn_0040var_007bx_007d_007d-_0028_0040command_007bgnatpp_007d_0029-749"><samp><span class="option">-n</span><var>x</var></samp> (<samp><span class="command">gnatpp</span></samp>)</a>: <a href="#Casing-Control">Casing Control</a></li>
<li><a href="#index-g_t_0040option_007b_002do-_007d-_0028_0040command_007bgnatbind_007d_0029-433"><samp><span class="option">-o </span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dO_007d-_0028_0040command_007bgcc_007d_0029-577"><samp><span class="option">-O</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Optimization-Levels">Optimization Levels</a></li>
<li><a href="#index-g_t_0040option_007b_002dO_007d-_0028_0040command_007bgcc_007d_0029-175"><samp><span class="option">-O</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002do_007d-_0028_0040command_007bgcc_007d_0029-172"><samp><span class="option">-o</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002do_007d-_0028_0040command_007bgnatbind_007d_0029-479"><samp><span class="option">-o</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Binding-with-Non_002dAda-Main-Programs">Binding with Non-Ada Main Programs</a></li>
<li><a href="#index-g_t_0040option_007b_002do_007d-_0028_0040code_007bgnatbind_007d_0029-472"><samp><span class="option">-o</span></samp> (<code>gnatbind</code>)</a>: <a href="#Output-Control">Output Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dO_007d-_0028_0040code_007bgnatbind_007d_0029-471"><samp><span class="option">-O</span></samp> (<code>gnatbind</code>)</a>: <a href="#Output-Control">Output Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dO_007d-_0028_0040command_007bgnatbind_007d_0029-434"><samp><span class="option">-O</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002do_007d-_0028_0040command_007bgnatelim_007d_0029-598"><samp><span class="option">-o</span></samp> (<samp><span class="command">gnatelim</span></samp>)</a>: <a href="#Running-gnatelim">Running gnatelim</a></li>
<li><a href="#index-g_t_0040option_007b_002do_007d-_0028_0040code_007bgnathtml_007d_0029-927"><samp><span class="option">-o</span></samp> (<code>gnathtml</code>)</a>: <a href="#Converting-Ada-Files-to-html-with-gnathtml">Converting Ada Files to html with gnathtml</a></li>
<li><a href="#index-g_t_0040option_007b_002do_007d-_0028_0040command_007bgnatlink_007d_0029-502"><samp><span class="option">-o</span></samp> (<samp><span class="command">gnatlink</span></samp>)</a>: <a href="#Switches-for-gnatlink">Switches for gnatlink</a></li>
<li><a href="#index-g_t_0040option_007b_002do_007d-_0028_0040code_007bgnatls_007d_0029-833"><samp><span class="option">-o</span></samp> (<code>gnatls</code>)</a>: <a href="#Switches-for-gnatls">Switches for gnatls</a></li>
<li><a href="#index-g_t_0040option_007b_002do_007d-_0028_0040command_007bgnatmake_007d_0029-537"><samp><span class="option">-o</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002do_007d-_0028_0040command_007bgnatmetric_007d_0029-791"><samp><span class="option">-o</span></samp> (<samp><span class="command">gnatmetric</span></samp>)</a>: <a href="#Output-Files-Control">Output Files Control</a></li>
<li><a href="#index-g_t_0040option_007b_002do_007d-_0028_0040code_007bgnatpp_007d_0029-774"><samp><span class="option">-o</span></samp> (<code>gnatpp</code>)</a>: <a href="#Output-File-Control">Output File Control</a></li>
<li><a href="#index-g_t_0040option_007b_002do_007d-_0028_0040command_007bgnatstub_007d_0029-908"><samp><span class="option">-o</span></samp> (<samp><span class="command">gnatstub</span></samp>)</a>: <a href="#Switches-for-gnatstub">Switches for gnatstub</a></li>
<li><a href="#index-g_t_0040option_007b_002dof_007d-_0028_0040code_007bgnatpp_007d_0029-775"><samp><span class="option">-of</span></samp> (<code>gnatpp</code>)</a>: <a href="#Output-File-Control">Output File Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dog_007d-_0028_0040command_007bgnatmetric_007d_0029-792"><samp><span class="option">-og</span></samp> (<samp><span class="command">gnatmetric</span></samp>)</a>: <a href="#Output-Files-Control">Output Files Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dox_007d-_0028_0040command_007bgnatmetric_007d_0029-793"><samp><span class="option">-ox</span></samp> (<samp><span class="command">gnatmetric</span></samp>)</a>: <a href="#Output-Files-Control">Output Files Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dP_007d-_0028any-project_002daware-tool_0029-702"><samp><span class="option">-P</span></samp> (any project-aware tool)</a>: <a href="#Switches-Related-to-Project-Files">Switches Related to Project Files</a></li>
<li><a href="#index-g_t_0040option_007b_002dp_007d-_0028_0040code_007bgnatbind_007d_0029-465"><samp><span class="option">-p</span></samp> (<code>gnatbind</code>)</a>: <a href="#Elaboration-Control">Elaboration Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dp_007d-_0028_0040command_007bgnatbind_007d_0029-435"><samp><span class="option">-p</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dp_007d-_0028_0040code_007bgnatchop_007d_0029-611"><samp><span class="option">-p</span></samp> (<code>gnatchop</code>)</a>: <a href="#Switches-for-gnatchop">Switches for gnatchop</a></li>
<li><a href="#index-g_t_0040option_007b_002dP_007d-_0028_0040code_007bgnatclean_007d_0029-852"><samp><span class="option">-P</span></samp> (<code>gnatclean</code>)</a>: <a href="#Switches-for-gnatclean">Switches for gnatclean</a></li>
<li><a href="#index-g_t_0040option_007b_002dp_007d-_0028_0040code_007bgnathtml_007d_0029-928"><samp><span class="option">-p</span></samp> (<code>gnathtml</code>)</a>: <a href="#Converting-Ada-Files-to-html-with-gnathtml">Converting Ada Files to html with gnathtml</a></li>
<li><a href="#index-g_t_0040option_007b_002dP_007d-_0028_0040command_007bgnatmake_007d_0029-539"><samp><span class="option">-P</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dp_007d-_0028_0040command_007bgnatmake_007d_0029-538"><samp><span class="option">-p</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dP_007d-_0028_0040code_007bgnatname_007d_0029-629"><samp><span class="option">-P</span></samp> (<code>gnatname</code>)</a>: <a href="#Switches-for-gnatname">Switches for gnatname</a></li>
<li><a href="#index-g_t_0040option_007b_002dpass_002dexit_002dcodes_007d-_0028_0040command_007bgcc_007d_0029-383"><samp><span class="option">-pass-exit-codes</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Auxiliary-Output-Control">Auxiliary Output Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dpass_002dexit_002dcodes_007d-_0028_0040command_007bgcc_007d_0029-176"><samp><span class="option">-pass-exit-codes</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dpFILE_007d-_0028_0040command_007bgnatfind_007d_0029-738"><samp><span class="option">-pFILE</span></samp> (<samp><span class="command">gnatfind</span></samp>)</a>: <a href="#Switches-for-gnatfind">Switches for gnatfind</a></li>
<li><a href="#index-g_t_0040option_007b_002dpFILE_007d-_0028_0040command_007bgnatxref_007d_0029-723"><samp><span class="option">-pFILE</span></samp> (<samp><span class="command">gnatxref</span></samp>)</a>: <a href="#Switches-for-gnatxref">Switches for gnatxref</a></li>
<li><a href="#index-g_t_002dpg-941">-pg</a>: <a href="#Compilation-for-profiling">Compilation for profiling</a></li>
<li><a href="#index-g_t_002dpg-939">-pg</a>: <a href="#Profiling-an-Ada-Program-using-gprof">Profiling an Ada Program using gprof</a></li>
<li><a href="#index-g_t_0040option_007b_002dpipe_007d-_0028_0040code_007bgnatpp_007d_0029-773"><samp><span class="option">-pipe</span></samp> (<code>gnatpp</code>)</a>: <a href="#Output-File-Control">Output File Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dp_0040var_007bx_007d_007d-_0028_0040command_007bgnatpp_007d_0029-750"><samp><span class="option">-p</span><var>x</var></samp> (<samp><span class="command">gnatpp</span></samp>)</a>: <a href="#Casing-Control">Casing Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dq_007d-_0028_0040code_007bgnatchop_007d_0029-612"><samp><span class="option">-q</span></samp> (<code>gnatchop</code>)</a>: <a href="#Switches-for-gnatchop">Switches for gnatchop</a></li>
<li><a href="#index-g_t_0040option_007b_002dq_007d-_0028_0040code_007bgnatclean_007d_0029-853"><samp><span class="option">-q</span></samp> (<code>gnatclean</code>)</a>: <a href="#Switches-for-gnatclean">Switches for gnatclean</a></li>
<li><a href="#index-g_t_0040option_007b_002dq_007d-_0028_0040code_007bgnatdll_007d_0029-1079"><samp><span class="option">-q</span></samp> (<code>gnatdll</code>)</a>: <a href="#Using-gnatdll">Using gnatdll</a></li>
<li><a href="#index-g_t_0040option_007b_002dq_007d-_0028_0040command_007bgnatelim_007d_0029-599"><samp><span class="option">-q</span></samp> (<samp><span class="command">gnatelim</span></samp>)</a>: <a href="#Running-gnatelim">Running gnatelim</a></li>
<li><a href="#index-g_t_0040option_007b_002dq_007d-_0028_0040command_007bgnatmake_007d_0029-540"><samp><span class="option">-q</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dq_007d-_0028_0040code_007bgnatmem_007d_0029-878"><samp><span class="option">-q</span></samp> (<code>gnatmem</code>)</a>: <a href="#Switches-for-gnatmem">Switches for gnatmem</a></li>
<li><a href="#index-g_t_0040option_007b_002dq_007d-_0028_0040code_007bgnatmetric_007d_0029-816"><samp><span class="option">-q</span></samp> (<code>gnatmetric</code>)</a>: <a href="#Other-gnatmetric-Switches">Other gnatmetric Switches</a></li>
<li><a href="#index-g_t_0040option_007b_002dq_007d-_0028_0040command_007bgnatstub_007d_0029-909"><samp><span class="option">-q</span></samp> (<samp><span class="command">gnatstub</span></samp>)</a>: <a href="#Switches-for-gnatstub">Switches for gnatstub</a></li>
<li><a href="#index-g_t_0040option_007b_002dr_007d-_0028_0040code_007bgnatbind_007d_0029-473"><samp><span class="option">-r</span></samp> (<code>gnatbind</code>)</a>: <a href="#Output-Control">Output Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dR_007d-_0028_0040command_007bgnatbind_007d_0029-436"><samp><span class="option">-R</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dr_007d-_0028_0040code_007bgnatchop_007d_0029-613"><samp><span class="option">-r</span></samp> (<code>gnatchop</code>)</a>: <a href="#Switches-for-gnatchop">Switches for gnatchop</a></li>
<li><a href="#index-g_t_0040option_007b_002dr_007d-_0028_0040code_007bgnatclean_007d_0029-854"><samp><span class="option">-r</span></samp> (<code>gnatclean</code>)</a>: <a href="#Switches-for-gnatclean">Switches for gnatclean</a></li>
<li><a href="#index-g_t_0040option_007b_002dr_007d-_0028_0040command_007bgnatfind_007d_0029-739"><samp><span class="option">-r</span></samp> (<samp><span class="command">gnatfind</span></samp>)</a>: <a href="#Switches-for-gnatfind">Switches for gnatfind</a></li>
<li><a href="#index-g_t_0040option_007b_002dr_007d-_0028_0040code_007bgnatpp_007d_0029-776"><samp><span class="option">-r</span></samp> (<code>gnatpp</code>)</a>: <a href="#Output-File-Control">Output File Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dr_007d-_0028_0040command_007bgnatprep_007d_0029-823"><samp><span class="option">-r</span></samp> (<samp><span class="command">gnatprep</span></samp>)</a>: <a href="#Switches-for-gnatprep">Switches for gnatprep</a></li>
<li><a href="#index-g_t_0040option_007b_002dr_007d-_0028_0040command_007bgnatstub_007d_0029-910"><samp><span class="option">-r</span></samp> (<samp><span class="command">gnatstub</span></samp>)</a>: <a href="#Switches-for-gnatstub">Switches for gnatstub</a></li>
<li><a href="#index-g_t_0040option_007b_002drf_007d-_0028_0040code_007bgnatpp_007d_0029-777"><samp><span class="option">-rf</span></samp> (<code>gnatpp</code>)</a>: <a href="#Output-File-Control">Output File Control</a></li>
<li><a href="#index-g_t_0040option_007b_002drnb_007d-_0028_0040code_007bgnatpp_007d_0029-778"><samp><span class="option">-rnb</span></samp> (<code>gnatpp</code>)</a>: <a href="#Output-File-Control">Output File Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dS_007d-_0028_0040command_007bgcc_007d_0029-178"><samp><span class="option">-S</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002ds_007d-_0028_0040code_007bgnatbind_007d_0029-451"><samp><span class="option">-s</span></samp> (<code>gnatbind</code>)</a>: <a href="#Consistency_002dChecking-Modes">Consistency-Checking Modes</a></li>
<li><a href="#index-g_t_0040option_007b_002dS_007d-_0028_0040command_007bgnatbind_007d_0029-438"><samp><span class="option">-S</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002ds_007d-_0028_0040command_007bgnatbind_007d_0029-437"><samp><span class="option">-s</span></samp> (<samp><span class="command">gnatbind</span></samp>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002ds_007d-_0028_0040command_007bgnatfind_007d_0029-740"><samp><span class="option">-s</span></samp> (<samp><span class="command">gnatfind</span></samp>)</a>: <a href="#Switches-for-gnatfind">Switches for gnatfind</a></li>
<li><a href="#index-g_t_0040option_007b_002ds_007d-_0028_0040code_007bgnatls_007d_0029-834"><samp><span class="option">-s</span></samp> (<code>gnatls</code>)</a>: <a href="#Switches-for-gnatls">Switches for gnatls</a></li>
<li><a href="#index-g_t_0040option_007b_002ds_007d-_0028_0040command_007bgnatmake_007d_0029-541"><samp><span class="option">-s</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002ds_007d-_0028_0040code_007bgnatmem_007d_0029-883"><samp><span class="option">-s</span></samp> (<code>gnatmem</code>)</a>: <a href="#Switches-for-gnatmem">Switches for gnatmem</a></li>
<li><a href="#index-g_t_0040option_007b_002ds_007d-_0028_0040command_007bgnatprep_007d_0029-824"><samp><span class="option">-s</span></samp> (<samp><span class="command">gnatprep</span></samp>)</a>: <a href="#Switches-for-gnatprep">Switches for gnatprep</a></li>
<li><a href="#index-g_t_0040option_007b_002dsc_007d-_0028_0040code_007bgnathtml_007d_0029-929"><samp><span class="option">-sc</span></samp> (<code>gnathtml</code>)</a>: <a href="#Converting-Ada-Files-to-html-with-gnathtml">Converting Ada Files to html with gnathtml</a></li>
<li><a href="#index-g_t_0040option_007b_002dsfn_007d-_0028_0040command_007bgnatmetric_007d_0029-794"><samp><span class="option">-sfn</span></samp> (<samp><span class="command">gnatmetric</span></samp>)</a>: <a href="#Output-Files-Control">Output Files Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dshared_007d-_0028_0040code_007bgnatbind_007d_0029-441"><samp><span class="option">-shared</span></samp> (<code>gnatbind</code>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dstatic_007d-_0028_0040code_007bgnatbind_007d_0029-440"><samp><span class="option">-static</span></samp> (<code>gnatbind</code>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dt_007d-_0028_0040code_007bgnatbind_007d_0029-461"><samp><span class="option">-t</span></samp> (<code>gnatbind</code>)</a>: <a href="#Binder-Error-Message-Control">Binder Error Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dT_007d-_0028_0040code_007bgnatbind_007d_0029-443"><samp><span class="option">-T</span></samp> (<code>gnatbind</code>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dt_007d-_0028_0040code_007bgnatbind_007d_0029-442"><samp><span class="option">-t</span></samp> (<code>gnatbind</code>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dt_007d-_0028_0040command_007bgnatelim_007d_0029-600"><samp><span class="option">-t</span></samp> (<samp><span class="command">gnatelim</span></samp>)</a>: <a href="#Running-gnatelim">Running gnatelim</a></li>
<li><a href="#index-g_t_0040option_007b_002dt_007d-_0028_0040command_007bgnatfind_007d_0029-741"><samp><span class="option">-t</span></samp> (<samp><span class="command">gnatfind</span></samp>)</a>: <a href="#Switches-for-gnatfind">Switches for gnatfind</a></li>
<li><a href="#index-g_t_0040option_007b_002dt_007d-_0028_0040code_007bgnathtml_007d_0029-930"><samp><span class="option">-t</span></samp> (<code>gnathtml</code>)</a>: <a href="#Converting-Ada-Files-to-html-with-gnathtml">Converting Ada Files to html with gnathtml</a></li>
<li><a href="#index-g_t_0040option_007b_002dT_007d-_0028_0040command_007bgnatpp_007d_0029-768"><samp><span class="option">-T</span></samp> (<samp><span class="command">gnatpp</span></samp>)</a>: <a href="#Other-Formatting-Options">Other Formatting Options</a></li>
<li><a href="#index-g_t_0040option_007b_002dt_007d-_0028_0040command_007bgnatstub_007d_0029-911"><samp><span class="option">-t</span></samp> (<samp><span class="command">gnatstub</span></samp>)</a>: <a href="#Switches-for-gnatstub">Switches for gnatstub</a></li>
<li><a href="#index-g_t_0040option_007b_002dT0_007d-option-1002"><samp><span class="option">-T0</span></samp> option</a>: <a href="#HP_002dUX_002dSpecific-Considerations">HP-UX-Specific Considerations</a></li>
<li><a href="#index-g_t_0040option_007b_002dT0_007d-option-985"><samp><span class="option">-T0</span></samp> option</a>: <a href="#Choosing-the-Scheduling-Policy">Choosing the Scheduling Policy</a></li>
<li><a href="#index-g_t_0040option_007b_002du_007d-_0028_0040code_007bgnatbind_007d_0029-444"><samp><span class="option">-u</span></samp> (<code>gnatbind</code>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002du_007d-_0028_0040code_007bgnatls_007d_0029-835"><samp><span class="option">-u</span></samp> (<code>gnatls</code>)</a>: <a href="#Switches-for-gnatls">Switches for gnatls</a></li>
<li><a href="#index-g_t_0040option_007b_002dU_007d-_0028_0040command_007bgnatmake_007d_0029-543"><samp><span class="option">-U</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002du_007d-_0028_0040command_007bgnatmake_007d_0029-542"><samp><span class="option">-u</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002du_007d-_0028_0040command_007bgnatprep_007d_0029-825"><samp><span class="option">-u</span></samp> (<samp><span class="command">gnatprep</span></samp>)</a>: <a href="#Switches-for-gnatprep">Switches for gnatprep</a></li>
<li><a href="#index-g_t_0040option_007b_002dv_007d-_0028_0040command_007bdlltool_007d_0029-1089"><samp><span class="option">-v</span></samp> (<samp><span class="command">dlltool</span></samp>)</a>: <a href="#Using-dlltool">Using dlltool</a></li>
<li><a href="#index-g_t_0040option_007b_002dV_007d-_0028_0040command_007bgcc_007d_0029-181"><samp><span class="option">-V</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dv_007d-_0028_0040command_007bgcc_007d_0029-180"><samp><span class="option">-v</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dv_007d-_0028_0040code_007bgnatbind_007d_0029-454"><samp><span class="option">-v</span></samp> (<code>gnatbind</code>)</a>: <a href="#Binder-Error-Message-Control">Binder Error Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dv_007d-_0028_0040code_007bgnatbind_007d_0029-445"><samp><span class="option">-v</span></samp> (<code>gnatbind</code>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dv_007d-_0028_0040code_007bgnatchop_007d_0029-615"><samp><span class="option">-v</span></samp> (<code>gnatchop</code>)</a>: <a href="#Switches-for-gnatchop">Switches for gnatchop</a></li>
<li><a href="#index-g_t_0040option_007b_002dv_007d-_0028_0040code_007bgnatclean_007d_0029-855"><samp><span class="option">-v</span></samp> (<code>gnatclean</code>)</a>: <a href="#Switches-for-gnatclean">Switches for gnatclean</a></li>
<li><a href="#index-g_t_0040option_007b_002dv_007d-_0028_0040code_007bgnatdll_007d_0029-1080"><samp><span class="option">-v</span></samp> (<code>gnatdll</code>)</a>: <a href="#Using-gnatdll">Using gnatdll</a></li>
<li><a href="#index-g_t_0040option_007b_002dv_007d-_0028_0040command_007bgnatelim_007d_0029-601"><samp><span class="option">-v</span></samp> (<samp><span class="command">gnatelim</span></samp>)</a>: <a href="#Running-gnatelim">Running gnatelim</a></li>
<li><a href="#index-g_t_0040option_007b_002dv_007d-_0028_0040command_007bgnatlink_007d_0029-500"><samp><span class="option">-v</span></samp> (<samp><span class="command">gnatlink</span></samp>)</a>: <a href="#Switches-for-gnatlink">Switches for gnatlink</a></li>
<li><a href="#index-g_t_0040option_007b_002dv_007d-_0028_0040code_007bgnatls_007d_0029-842"><samp><span class="option">-v</span></samp> (<code>gnatls</code>)</a>: <a href="#Switches-for-gnatls">Switches for gnatls</a></li>
<li><a href="#index-g_t_0040option_007b_002dv_007d-_0028_0040command_007bgnatmake_007d_0029-544"><samp><span class="option">-v</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dv_007d-_0028_0040code_007bgnatmetric_007d_0029-815"><samp><span class="option">-v</span></samp> (<code>gnatmetric</code>)</a>: <a href="#Other-gnatmetric-Switches">Other gnatmetric Switches</a></li>
<li><a href="#index-g_t_0040option_007b_002dv_007d-_0028_0040code_007bgnatname_007d_0029-630"><samp><span class="option">-v</span></samp> (<code>gnatname</code>)</a>: <a href="#Switches-for-gnatname">Switches for gnatname</a></li>
<li><a href="#index-g_t_0040option_007b_002dv_007d-_0028_0040code_007bgnatpp_007d_0029-782"><samp><span class="option">-v</span></samp> (<code>gnatpp</code>)</a>: <a href="#Other-gnatpp-Switches">Other gnatpp Switches</a></li>
<li><a href="#index-g_t_0040option_007b_002dv_007d-_0028_0040command_007bgnatstub_007d_0029-912"><samp><span class="option">-v</span></samp> (<samp><span class="command">gnatstub</span></samp>)</a>: <a href="#Switches-for-gnatstub">Switches for gnatstub</a></li>
<li><a href="#index-g_t_0040option_007b_002dv-_002dv_007d-_0028_0040command_007bgnatlink_007d_0029-501"><samp><span class="option">-v -v</span></samp> (<samp><span class="command">gnatlink</span></samp>)</a>: <a href="#Switches-for-gnatlink">Switches for gnatlink</a></li>
<li><a href="#index-g_t_0040option_007b_002dv-_002dv_007d-_0028_0040code_007bgnatname_007d_0029-631"><samp><span class="option">-v -v</span></samp> (<code>gnatname</code>)</a>: <a href="#Switches-for-gnatname">Switches for gnatname</a></li>
<li><a href="#index-g_t_0040option_007b_002dv_007d-option-_0028for-GPRbuild_0029-654"><samp><span class="option">-v</span></samp> option (for GPRbuild)</a>: <a href="#Compiling-with-Project-Files">Compiling with Project Files</a></li>
<li><a href="#index-g_t_0040option_007b_002dvl_007d-_0028_0040command_007bgnatmake_007d_0029-545"><samp><span class="option">-vl</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dvm_007d-_0028_0040command_007bgnatmake_007d_0029-546"><samp><span class="option">-vm</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dvP_007d-_0028any-project_002daware-tool_0029-704"><samp><span class="option">-vP</span></samp> (any project-aware tool)</a>: <a href="#Switches-Related-to-Project-Files">Switches Related to Project Files</a></li>
<li><a href="#index-g_t_0040option_007b_002dvP_007d-_0028_0040code_007bgnatclean_007d_0029-856"><samp><span class="option">-vP</span></samp> (<code>gnatclean</code>)</a>: <a href="#Switches-for-gnatclean">Switches for gnatclean</a></li>
<li><a href="#index-g_t_0040option_007b_002dw_007d-310"><samp><span class="option">-w</span></samp></a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dw_007d-_0028_0040command_007bgcc_007d_0029-182"><samp><span class="option">-w</span></samp> (<samp><span class="command">gcc</span></samp>)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040option_007b_002dw_007d-_0028_0040code_007bgnatbind_007d_0029-446"><samp><span class="option">-w</span></samp> (<code>gnatbind</code>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dw_007d-_0028_0040code_007bgnatchop_007d_0029-616"><samp><span class="option">-w</span></samp> (<code>gnatchop</code>)</a>: <a href="#Switches-for-gnatchop">Switches for gnatchop</a></li>
<li><a href="#index-g_t_0040option_007b_002dw_007d-_0028_0040code_007bgnatpp_007d_0029-783"><samp><span class="option">-w</span></samp> (<code>gnatpp</code>)</a>: <a href="#Other-gnatpp-Switches">Other gnatpp Switches</a></li>
<li><a href="#index-g_t_0040option_007b_002dW_007d-_0028_0040command_007bgnatpp_007d_0029-780"><samp><span class="option">-W</span></samp> (<samp><span class="command">gnatpp</span></samp>)</a>: <a href="#Output-File-Control">Output File Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dWall_007d-309"><samp><span class="option">-Wall</span></samp></a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dwe_007d-_0028_0040code_007bgnatbind_007d_0029-460"><samp><span class="option">-we</span></samp> (<code>gnatbind</code>)</a>: <a href="#Binder-Error-Message-Control">Binder Error Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dwq_007d-_0028_0040command_007bgnatelim_007d_0029-602"><samp><span class="option">-wq</span></samp> (<samp><span class="command">gnatelim</span></samp>)</a>: <a href="#Running-gnatelim">Running gnatelim</a></li>
<li><a href="#index-g_t_0040option_007b_002dws_007d-_0028_0040code_007bgnatbind_007d_0029-458"><samp><span class="option">-ws</span></samp> (<code>gnatbind</code>)</a>: <a href="#Binder-Error-Message-Control">Binder Error Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dWuninitialized_007d-308"><samp><span class="option">-Wuninitialized</span></samp></a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dWunused_007d-307"><samp><span class="option">-Wunused</span></samp></a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dWx_007d-_0028_0040code_007bgnatbind_007d_0029-452"><samp><span class="option">-Wx</span></samp> (<code>gnatbind</code>)</a>: <a href="#Consistency_002dChecking-Modes">Consistency-Checking Modes</a></li>
<li><a href="#index-g_t_0040option_007b_002dWx_007d-_0028_0040code_007bgnatbind_007d_0029-447"><samp><span class="option">-Wx</span></samp> (<code>gnatbind</code>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dX_007d-678"><samp><span class="option">-X</span></samp></a>: <a href="#Scenarios-in-Projects">Scenarios in Projects</a></li>
<li><a href="#index-g_t_0040option_007b_002dX_007d-_0028any-project_002daware-tool_0029-703"><samp><span class="option">-X</span></samp> (any project-aware tool)</a>: <a href="#Switches-Related-to-Project-Files">Switches Related to Project Files</a></li>
<li><a href="#index-g_t_0040option_007b_002dx_007d-_0028_0040code_007bgnatbind_007d_0029-453"><samp><span class="option">-x</span></samp> (<code>gnatbind</code>)</a>: <a href="#Consistency_002dChecking-Modes">Consistency-Checking Modes</a></li>
<li><a href="#index-g_t_0040option_007b_002dx_007d-_0028_0040code_007bgnatbind_007d_0029-448"><samp><span class="option">-x</span></samp> (<code>gnatbind</code>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dX_007d-_0028_0040code_007bgnatclean_007d_0029-857"><samp><span class="option">-X</span></samp> (<code>gnatclean</code>)</a>: <a href="#Switches-for-gnatclean">Switches for gnatclean</a></li>
<li><a href="#index-g_t_0040option_007b_002dx_007d-_0028_0040command_007bgnatmake_007d_0029-548"><samp><span class="option">-x</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040option_007b_002dx_007d-_0028_0040command_007bgnatmetric_007d_0029-787"><samp><span class="option">-x</span></samp> (<samp><span class="command">gnatmetric</span></samp>)</a>: <a href="#Output-Files-Control">Output Files Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dx_007d-_0028_0040code_007bgnatname_007d_0029-632"><samp><span class="option">-x</span></samp> (<code>gnatname</code>)</a>: <a href="#Switches-for-gnatname">Switches for gnatname</a></li>
<li><a href="#index-g_t_0040option_007b_002dxs_007d-_0028_0040command_007bgnatmetric_007d_0029-788"><samp><span class="option">-xs</span></samp> (<samp><span class="command">gnatmetric</span></samp>)</a>: <a href="#Output-Files-Control">Output Files Control</a></li>
<li><a href="#index-g_t_0040option_007b_002dy_007d-_0028_0040code_007bgnatbind_007d_0029-449"><samp><span class="option">-y</span></samp> (<code>gnatbind</code>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dz_007d-_0028_0040code_007bgnatbind_007d_0029-480"><samp><span class="option">-z</span></samp> (<code>gnatbind</code>)</a>: <a href="#Binding-Programs-with-No-Main-Subprogram">Binding Programs with No Main Subprogram</a></li>
<li><a href="#index-g_t_0040option_007b_002dz_007d-_0028_0040code_007bgnatbind_007d_0029-450"><samp><span class="option">-z</span></samp> (<code>gnatbind</code>)</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040option_007b_002dz_007d-_0028_0040command_007bgnatmake_007d_0029-549"><samp><span class="option">-z</span></samp> (<samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_002edef-1060"><code>.def</code></a>: <a href="#The-Definition-File">The Definition File</a></li>
<li><a href="#index-g_t_005f_005fgnat_005ffinalize-1012"><code>__gnat_finalize</code></a>: <a href="#Example-of-Binder-Output-File">Example of Binder Output File</a></li>
<li><a href="#index-g_t_005f_005fgnat_005finitialize-1011"><code>__gnat_initialize</code></a>: <a href="#Example-of-Binder-Output-File">Example of Binder Output File</a></li>
<li><a href="#index-g_t_0040code_007b_005f_005fgnat_005fmalloc_007d-422"><code>__gnat_malloc</code></a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_005f_005fgnat_005fset_005fglobals-1005"><code>__gnat_set_globals</code></a>: <a href="#Example-of-Binder-Output-File">Example of Binder Output File</a></li>
<li><a href="#index-g_t_005fmain-918"><code>_main</code></a>: <a href="#The-External-Symbol-Naming-Scheme-of-GNAT">The External Symbol Naming Scheme of GNAT</a></li>
<li><a href="#index-Access-before-elaboration-332">Access before elaboration</a>: <a href="#Run_002dTime-Checks">Run-Time Checks</a></li>
<li><a href="#index-Access_002dto_002dsubprogram-1032">Access-to-subprogram</a>: <a href="#Elaboration-for-Access_002dto_002dSubprogram-Values">Elaboration for Access-to-Subprogram Values</a></li>
<li><a href="#index-ACVC_002c-Ada-83-tests-360">ACVC, Ada 83 tests</a>: <a href="#Compiling-Different-Versions-of-Ada">Compiling Different Versions of Ada</a></li>
<li><a href="#index-Ada-961"><code>Ada</code></a>: <a href="#Naming-Conventions-for-GNAT-Source-Files">Naming Conventions for GNAT Source Files</a></li>
<li><a href="#index-Ada-488"><code>Ada</code></a>: <a href="#Search-Paths-for-gnatbind">Search Paths for gnatbind</a></li>
<li><a href="#index-Ada-2005-compatibility-issues-warnings-301">Ada 2005 compatibility issues warnings</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Ada-2005-Language-Reference-Manual-2">Ada 2005 Language Reference Manual</a>: <a href="#What-You-Should-Know-before-Reading-This-Guide">What You Should Know before Reading This Guide</a></li>
<li><a href="#index-Ada-2005-mode-367">Ada 2005 mode</a>: <a href="#Compiling-Different-Versions-of-Ada">Compiling Different Versions of Ada</a></li>
<li><a href="#index-Ada-2012-mode-370">Ada 2012 mode</a>: <a href="#Compiling-Different-Versions-of-Ada">Compiling Different Versions of Ada</a></li>
<li><a href="#index-Ada-83-mode-361">Ada 83 mode</a>: <a href="#Compiling-Different-Versions-of-Ada">Compiling Different Versions of Ada</a></li>
<li><a href="#index-Ada-95-Language-Reference-Manual-1">Ada 95 Language Reference Manual</a>: <a href="#What-You-Should-Know-before-Reading-This-Guide">What You Should Know before Reading This Guide</a></li>
<li><a href="#index-Ada-95-mode-364">Ada 95 mode</a>: <a href="#Compiling-Different-Versions-of-Ada">Compiling Different Versions of Ada</a></li>
<li><a href="#index-Ada-expressions-951">Ada expressions</a>: <a href="#Using-Ada-Expressions">Using Ada Expressions</a></li>
<li><a href="#index-Ada-language-extensions-372">Ada language extensions</a>: <a href="#Compiling-Different-Versions-of-Ada">Compiling Different Versions of Ada</a></li>
<li><a href="#index-Ada-Library-Information-files-47">Ada Library Information files</a>: <a href="#The-Ada-Library-Information-Files">The Ada Library Information Files</a></li>
<li><a href="#index-Ada_002eCharacters_002eLatin_005f1-20"><code>Ada.Characters.Latin_1</code></a>: <a href="#Latin_002d1">Latin-1</a></li>
<li><a href="#index-ADA_005fINCLUDE_005fPATH-402"><code>ADA_INCLUDE_PATH</code></a>: <a href="#Search-Paths-and-the-Run_002dTime-Library-_0028RTL_0029">Search Paths and the Run-Time Library (RTL)</a></li>
<li><a href="#index-ADA_005fOBJECTS_005fPATH-484"><code>ADA_OBJECTS_PATH</code></a>: <a href="#Search-Paths-for-gnatbind">Search Paths for gnatbind</a></li>
<li><a href="#index-ADA_005fPRJ_005fINCLUDE_005fFILE-401"><code>ADA_PRJ_INCLUDE_FILE</code></a>: <a href="#Search-Paths-and-the-Run_002dTime-Library-_0028RTL_0029">Search Paths and the Run-Time Library (RTL)</a></li>
<li><a href="#index-ADA_005fPRJ_005fOBJECTS_005fFILE-483"><code>ADA_PRJ_OBJECTS_FILE</code></a>: <a href="#Search-Paths-for-gnatbind">Search Paths for gnatbind</a></li>
<li><a href="#index-g_t_0040code_007bADA_005fPROJECT_005fPATH_007d-863"><code>ADA_PROJECT_PATH</code></a>: <a href="#Installing-a-library">Installing a library</a></li>
<li><a href="#index-g_t_0040code_007bADA_005fPROJECT_005fPATH_007d-672"><code>ADA_PROJECT_PATH</code></a>: <a href="#Project-Dependencies">Project Dependencies</a></li>
<li><a href="#index-adafinal-1009"><code>adafinal</code></a>: <a href="#Example-of-Binder-Output-File">Example of Binder Output File</a></li>
<li><a href="#index-adafinal-476"><code>adafinal</code></a>: <a href="#Binding-with-Non_002dAda-Main-Programs">Binding with Non-Ada Main Programs</a></li>
<li><a href="#index-adainit-1004"><code>adainit</code></a>: <a href="#Example-of-Binder-Output-File">Example of Binder Output File</a></li>
<li><a href="#index-adainit-475"><code>adainit</code></a>: <a href="#Binding-with-Non_002dAda-Main-Programs">Binding with Non-Ada Main Programs</a></li>
<li><a href="#index-Address-Clauses_002c-warnings-258">Address Clauses, warnings</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-AIX-resolver-library-997">AIX resolver library</a>: <a href="#AIX_002dSpecific-Considerations">AIX-Specific Considerations</a></li>
<li><a href="#index-g_t_0040file_007bALI_007d-files-48"><samp><span class="file">ALI</span></samp> files</a>: <a href="#The-Ada-Library-Information-Files">The Ada Library Information Files</a></li>
<li><a href="#index-Aliasing-588">Aliasing</a>: <a href="#Optimization-and-Strict-Aliasing">Optimization and Strict Aliasing</a></li>
<li><a href="#index-Alignment-control-in-_0040command_007bgnatpp_007d-744">Alignment control in <samp><span class="command">gnatpp</span></samp></a>: <a href="#Alignment-Control">Alignment Control</a></li>
<li><a href="#index-Annex-A-962">Annex A</a>: <a href="#Naming-Conventions-for-GNAT-Source-Files">Naming Conventions for GNAT Source Files</a></li>
<li><a href="#index-Annex-B-964">Annex B</a>: <a href="#Naming-Conventions-for-GNAT-Source-Files">Naming Conventions for GNAT Source Files</a></li>
<li><a href="#index-APIENTRY-1056"><code>APIENTRY</code></a>: <a href="#Windows-Calling-Conventions">Windows Calling Conventions</a></li>
<li><a href="#index-Arbitrary-File-Naming-Conventions-621">Arbitrary File Naming Conventions</a>: <a href="#Handling-Arbitrary-File-Naming-Conventions-Using-gnatname">Handling Arbitrary File Naming Conventions Using gnatname</a></li>
<li><a href="#index-ASIS-891">ASIS</a>: <a href="#Verifying-Properties-Using-gnatcheck">Verifying Properties Using gnatcheck</a></li>
<li><a href="#index-Asm-59"><code>Asm</code></a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Assert-312"><code>Assert</code></a>: <a href="#Debugging-and-Assertion-Control">Debugging and Assertion Control</a></li>
<li><a href="#index-Assert-failures-202">Assert failures</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Assertions-314">Assertions</a>: <a href="#Debugging-and-Assertion-Control">Debugging and Assertion Control</a></li>
<li><a href="#index-Bad-fixed-values-206">Bad fixed values</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Biased-representation-211">Biased representation</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Binder-consistency-checks-463">Binder consistency checks</a>: <a href="#Binder-Error-Message-Control">Binder Error Message Control</a></li>
<li><a href="#index-Binder-output-file-50">Binder output file</a>: <a href="#Interfacing-to-C">Interfacing to C</a></li>
<li><a href="#index-Binder_002c-multiple-input-files-478">Binder, multiple input files</a>: <a href="#Binding-with-Non_002dAda-Main-Programs">Binding with Non-Ada Main Programs</a></li>
<li><a href="#index-binding-913"><code>binding</code></a>: <a href="#Generating-Ada-Bindings-for-C-and-C_002b_002b-headers">Generating Ada Bindings for C and C++ headers</a></li>
<li><a href="#index-g_t_0040code_007bBody_007d-666"><code>Body</code></a>: <a href="#Naming-Schemes">Naming Schemes</a></li>
<li><a href="#index-g_t_0040code_007bBody_005fSuffix_007d-661"><code>Body_Suffix</code></a>: <a href="#Naming-Schemes">Naming Schemes</a></li>
<li><a href="#index-Breakpoints-and-tasks-954">Breakpoints and tasks</a>: <a href="#Ada-Tasks">Ada Tasks</a></li>
<li><a href="#index-Building-the-GNAT-Run_002dTime-Library-867">Building the GNAT Run-Time Library</a>: <a href="#Rebuilding-the-GNAT-Run_002dTime-Library">Rebuilding the GNAT Run-Time Library</a></li>
<li><a href="#index-C-63"><code>C</code></a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-C-varargs-function-66"><code>C varargs function</code></a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-C_002b_002b-73"><code>C++</code></a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Calling-Conventions-52">Calling Conventions</a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-cannot-generate-code-90">cannot generate code</a>: <a href="#Compiling-Programs">Compiling Programs</a></li>
<li><a href="#index-case-statement-681">case statement</a>: <a href="#Scenarios-in-Projects">Scenarios in Projects</a></li>
<li><a href="#index-g_t_0040code_007bcase_007d-statement-_0028effect-of-_0040option_007b_002dmbig_002dswitch_007d-option_0029-170"><code>case</code> statement (effect of <samp><span class="option">-mbig-switch</span></samp> option)</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-g_t_0040code_007bCasing_007d-657"><code>Casing</code></a>: <a href="#Naming-Schemes">Naming Schemes</a></li>
<li><a href="#index-Casing-control-in-_0040command_007bgnatpp_007d-746">Casing control in <samp><span class="command">gnatpp</span></samp></a>: <a href="#Casing-Control">Casing Control</a></li>
<li><a href="#index-g_t_0040code_007bCeiling_005fLocking_007d-_0028under-rts_002dpthread_0029-994"><code>Ceiling_Locking</code> (under rts-pthread)</a>: <a href="#Solaris-Threads-Issues">Solaris Threads Issues</a></li>
<li><a href="#index-Check_002c-elaboration-350">Check, elaboration</a>: <a href="#Run_002dTime-Checks">Run-Time Checks</a></li>
<li><a href="#index-Check_002c-overflow-346">Check, overflow</a>: <a href="#Run_002dTime-Checks">Run-Time Checks</a></li>
<li><a href="#index-Checks_002c-access-before-elaboration-334">Checks, access before elaboration</a>: <a href="#Run_002dTime-Checks">Run-Time Checks</a></li>
<li><a href="#index-Checks_002c-division-by-zero-333">Checks, division by zero</a>: <a href="#Run_002dTime-Checks">Run-Time Checks</a></li>
<li><a href="#index-Checks_002c-elaboration-1017">Checks, elaboration</a>: <a href="#Checking-the-Elaboration-Order">Checking the Elaboration Order</a></li>
<li><a href="#index-Checks_002c-overflow-572">Checks, overflow</a>: <a href="#Controlling-Run_002dTime-Checks">Controlling Run-Time Checks</a></li>
<li><a href="#index-Checks_002c-stack-overflow-checking-335">Checks, stack overflow checking</a>: <a href="#Run_002dTime-Checks">Run-Time Checks</a></li>
<li><a href="#index-Checks_002c-suppressing-338">Checks, suppressing</a>: <a href="#Run_002dTime-Checks">Run-Time Checks</a></li>
<li><a href="#index-Cleaning-tool-844">Cleaning tool</a>: <a href="#Cleaning-Up-Using-gnatclean">Cleaning Up Using gnatclean</a></li>
<li><a href="#index-COBOL-62"><code>COBOL</code></a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Code-Coverage-937">Code Coverage</a>: <a href="#Code-Coverage-of-Ada-Programs-using-gcov">Code Coverage of Ada Programs using gcov</a></li>
<li><a href="#index-Code-Coverage-931">Code Coverage</a>: <a href="#Code-Coverage-and-Profiling">Code Coverage and Profiling</a></li>
<li><a href="#index-code-page-437-31">code page 437</a>: <a href="#Other-8_002dBit-Codes">Other 8-Bit Codes</a></li>
<li><a href="#index-code-page-850-32">code page 850</a>: <a href="#Other-8_002dBit-Codes">Other 8-Bit Codes</a></li>
<li><a href="#index-Combining-GNAT-switches-183">Combining GNAT switches</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-command-line-length-649">command line length</a>: <a href="#Tools-Options-in-Project-Files">Tools Options in Project Files</a></li>
<li><a href="#index-Command-line-length-495">Command line length</a>: <a href="#Switches-for-gnatlink">Switches for gnatlink</a></li>
<li><a href="#index-Compatibility-_0028between-Ada-83-and-Ada-95-_002f-Ada-2005_0029-1045">Compatibility (between Ada 83 and Ada 95 / Ada 2005)</a>: <a href="#Compatibility-with-Ada-83">Compatibility with Ada 83</a></li>
<li><a href="#index-Compatibility-between-Ada-95-and-Ada-2005-1047">Compatibility between Ada 95 and Ada 2005</a>: <a href="#Compatibility-between-Ada-95-and-Ada-2005">Compatibility between Ada 95 and Ada 2005</a></li>
<li><a href="#index-Compatibility-with-Ada-83-358">Compatibility with Ada 83</a>: <a href="#Compiling-Different-Versions-of-Ada">Compiling Different Versions of Ada</a></li>
<li><a href="#index-Compilation-model-9">Compilation model</a>: <a href="#The-GNAT-Compilation-Model">The GNAT Compilation Model</a></li>
<li><a href="#index-Complexity-metrics-control-in-_0040command_007bgnatmetric_007d-804">Complexity metrics control in <samp><span class="command">gnatmetric</span></samp></a>: <a href="#Complexity-Metrics-Control">Complexity Metrics Control</a></li>
<li><a href="#index-Component-clause_002c-missing-217">Component clause, missing</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Conditional-compilation-1034">Conditional compilation</a>: <a href="#Conditional-Compilation">Conditional Compilation</a></li>
<li><a href="#index-Conditionals_002c-constant-214">Conditionals, constant</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Configuration-pragmas-618">Configuration pragmas</a>: <a href="#Configuration-Pragmas">Configuration Pragmas</a></li>
<li><a href="#index-Consistency-checks_002c-in-binder-464">Consistency checks, in binder</a>: <a href="#Binder-Error-Message-Control">Binder Error Message Control</a></li>
<li><a href="#index-CONSOLE-Subsystem-1051">CONSOLE Subsystem</a>: <a href="#CONSOLE-and-WINDOWS-subsystems">CONSOLE and WINDOWS subsystems</a></li>
<li><a href="#index-Convention-Ada-55">Convention Ada</a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Convention-Asm-58">Convention Asm</a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Convention-Assembler-57">Convention Assembler</a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Convention-C-65">Convention C</a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Convention-C_002b_002b-75">Convention C++</a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Convention-COBOL-61">Convention COBOL</a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Convention-Default-69">Convention Default</a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Convention-DLL-82">Convention DLL</a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Convention-External-71">Convention External</a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Convention-Fortran-78">Convention Fortran</a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Convention-Stdcall-80">Convention Stdcall</a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Convention-Stubbed-86">Convention Stubbed</a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Convention-Win32-84">Convention Win32</a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Conventions-3">Conventions</a>: <a href="#Conventions">Conventions</a></li>
<li><a href="#index-Coupling-metrics-_0028in-in-_0040command_007bgnatmetric_007d_0029-809">Coupling metrics (in in <samp><span class="command">gnatmetric</span></samp>)</a>: <a href="#Object_002dOriented-Metrics-Control">Object-Oriented Metrics Control</a></li>
<li><a href="#index-CR-13"><code>CR</code></a>: <a href="#Source-Representation">Source Representation</a></li>
<li><a href="#index-Cyrillic-28">Cyrillic</a>: <a href="#Other-8_002dBit-Codes">Other 8-Bit Codes</a></li>
<li><a href="#index-Deactivated-code_002c-warnings-280">Deactivated code, warnings</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Debug-313"><code>Debug</code></a>: <a href="#Debugging-and-Assertion-Control">Debugging and Assertion Control</a></li>
<li><a href="#index-Debug-Pool-875"><code>Debug Pool</code></a>: <a href="#The-GNAT-Debug-Pool-Facility">The GNAT Debug Pool Facility</a></li>
<li><a href="#index-Debugger-949">Debugger</a>: <a href="#Running-and-Debugging-Ada-Programs">Running and Debugging Ada Programs</a></li>
<li><a href="#index-Debugging-948">Debugging</a>: <a href="#Running-and-Debugging-Ada-Programs">Running and Debugging Ada Programs</a></li>
<li><a href="#index-Debugging-Generic-Units-956">Debugging Generic Units</a>: <a href="#Debugging-Generic-Units">Debugging Generic Units</a></li>
<li><a href="#index-Debugging-information_002c-including-497">Debugging information, including</a>: <a href="#Switches-for-gnatlink">Switches for gnatlink</a></li>
<li><a href="#index-Debugging-optimized-code-578">Debugging optimized code</a>: <a href="#Debugging-Optimized-Code">Debugging Optimized Code</a></li>
<li><a href="#index-Debugging-options-384">Debugging options</a>: <a href="#Debugging-Control">Debugging Control</a></li>
<li><a href="#index-Default-70"><code>Default</code></a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-g_t_0040code_007bDefault_005fSwitches_007d-651"><code>Default_Switches</code></a>: <a href="#Tools-Options-in-Project-Files">Tools Options in Project Files</a></li>
<li><a href="#index-Definition-file-1059">Definition file</a>: <a href="#The-Definition-File">The Definition File</a></li>
<li><a href="#index-Deleted-code_002c-warnings-281">Deleted code, warnings</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Dependencies_002c-producing-list-534">Dependencies, producing list</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-Dependency-rules-508">Dependency rules</a>: <a href="#The-GNAT-Make-Program-gnatmake">The GNAT Make Program gnatmake</a></li>
<li><a href="#index-Dereferencing_002c-implicit-222">Dereferencing, implicit</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Disable-Metrics-For-Local-Units-in-_0040command_007bgnatmetric_007d-795">Disable Metrics For Local Units in <samp><span class="command">gnatmetric</span></samp></a>: <a href="#Disable-Metrics-For-Local-Units">Disable Metrics For Local Units</a></li>
<li><a href="#index-Division-by-zero-331">Division by zero</a>: <a href="#Run_002dTime-Checks">Run-Time Checks</a></li>
<li><a href="#index-DLL-1057"><code>DLL</code></a>: <a href="#Introduction-to-Dynamic-Link-Libraries-_0028DLLs_0029">Introduction to Dynamic Link Libraries (DLLs)</a></li>
<li><a href="#index-DLL-81"><code>DLL</code></a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-DLL-debugging-1097">DLL debugging</a>: <a href="#Debugging-a-DLL">Debugging a DLL</a></li>
<li><a href="#index-DLL-debugging_002c-attach-to-process-1098">DLL debugging, attach to process</a>: <a href="#Attaching-to-a-Running-Process">Attaching to a Running Process</a></li>
<li><a href="#index-DLLs-and-elaboration-1065">DLLs and elaboration</a>: <a href="#Ada-DLLs-and-Elaboration">Ada DLLs and Elaboration</a></li>
<li><a href="#index-DLLs-and-finalization-1066">DLLs and finalization</a>: <a href="#Ada-DLLs-and-Finalization">Ada DLLs and Finalization</a></li>
<li><a href="#index-DLLs_002c-building-1063">DLLs, building</a>: <a href="#Building-DLLs-with-gnatdll">Building DLLs with gnatdll</a></li>
<li><a href="#index-DLLs_002c-building-1062">DLLs, building</a>: <a href="#Building-DLLs-with-GNAT">Building DLLs with GNAT</a></li>
<li><a href="#index-DLLs_002c-building-1061">DLLs, building</a>: <a href="#Building-DLLs-with-GNAT-Project-files">Building DLLs with GNAT Project files</a></li>
<li><a href="#index-g_t_0040code_007bDot_005fReplacement_007d-658"><code>Dot_Replacement</code></a>: <a href="#Naming-Schemes">Naming Schemes</a></li>
<li><a href="#index-Elaborate-1024"><code>Elaborate</code></a>: <a href="#Controlling-the-Elaboration-Order">Controlling the Elaboration Order</a></li>
<li><a href="#index-Elaborate_005fAll-1026"><code>Elaborate_All</code></a>: <a href="#Controlling-the-Elaboration-Order">Controlling the Elaboration Order</a></li>
<li><a href="#index-Elaborate_005fBody-1022"><code>Elaborate_Body</code></a>: <a href="#Controlling-the-Elaboration-Order">Controlling the Elaboration Order</a></li>
<li><a href="#index-Elaboration-checks-1016">Elaboration checks</a>: <a href="#Checking-the-Elaboration-Order">Checking the Elaboration Order</a></li>
<li><a href="#index-Elaboration-checks-349">Elaboration checks</a>: <a href="#Run_002dTime-Checks">Run-Time Checks</a></li>
<li><a href="#index-Elaboration-control-1033">Elaboration control</a>: <a href="#Summary-of-Procedures-for-Elaboration-Control">Summary of Procedures for Elaboration Control</a></li>
<li><a href="#index-Elaboration-control-1015">Elaboration control</a>: <a href="#Elaboration-Order-Handling-in-GNAT">Elaboration Order Handling in GNAT</a></li>
<li><a href="#index-Elaboration-of-library-tasks-1030">Elaboration of library tasks</a>: <a href="#Elaboration-Issues-for-Library-Tasks">Elaboration Issues for Library Tasks</a></li>
<li><a href="#index-Elaboration-order-control-87">Elaboration order control</a>: <a href="#Comparison-between-GNAT-and-C_002fC_002b_002b-Compilation-Models">Comparison between GNAT and C/C++ Compilation Models</a></li>
<li><a href="#index-Elaboration_002c-warnings-250">Elaboration, warnings</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Eligible-local-unit-_0028for-_0040command_007bgnatmetric_007d_0029-796">Eligible local unit (for <samp><span class="command">gnatmetric</span></samp>)</a>: <a href="#Disable-Metrics-For-Local-Units">Disable Metrics For Local Units</a></li>
<li><a href="#index-End-of-source-file-16">End of source file</a>: <a href="#Source-Representation">Source Representation</a></li>
<li><a href="#index-Error-messages_002c-suppressing-194">Error messages, suppressing</a>: <a href="#Output-and-Error-Message-Control">Output and Error Message Control</a></li>
<li><a href="#index-EUC-Coding-35">EUC Coding</a>: <a href="#Wide-Character-Encodings">Wide Character Encodings</a></li>
<li><a href="#index-Exceptions-952">Exceptions</a>: <a href="#Ada-Exceptions">Ada Exceptions</a></li>
<li><a href="#index-g_t_0040code_007bExcluded_005fSource_005fDirs_007d-637"><code>Excluded_Source_Dirs</code></a>: <a href="#Source-Files-and-Directories">Source Files and Directories</a></li>
<li><a href="#index-g_t_0040code_007bExcluded_005fSource_005fFiles_007d-699"><code>Excluded_Source_Files</code></a>: <a href="#Project-Extension">Project Extension</a></li>
<li><a href="#index-g_t_0040code_007bExcluded_005fSource_005fFiles_007d-643"><code>Excluded_Source_Files</code></a>: <a href="#Source-Files-and-Directories">Source Files and Directories</a></li>
<li><a href="#index-g_t_0040code_007bExcluded_005fSource_005fList_005fFile_007d-700"><code>Excluded_Source_List_File</code></a>: <a href="#Project-Extension">Project Extension</a></li>
<li><a href="#index-g_t_0040code_007bExcluded_005fSource_005fList_005fFile_007d-645"><code>Excluded_Source_List_File</code></a>: <a href="#Source-Files-and-Directories">Source Files and Directories</a></li>
<li><a href="#index-g_t_0040code_007bExec_005fDir_007d-647"><code>Exec_Dir</code></a>: <a href="#Object-and-Exec-Directory">Object and Exec Directory</a></li>
<li><a href="#index-g_t_0040code_007bExecutable_007d-655"><code>Executable</code></a>: <a href="#Executable-File-Names">Executable File Names</a></li>
<li><a href="#index-g_t_0040code_007bExecutable_005fSuffix_007d-656"><code>Executable_Suffix</code></a>: <a href="#Executable-File-Names">Executable File Names</a></li>
<li><a href="#index-Export-917"><code>Export</code></a>: <a href="#The-External-Symbol-Naming-Scheme-of-GNAT">The External Symbol Naming Scheme of GNAT</a></li>
<li><a href="#index-Export-table-1064">Export table</a>: <a href="#Exporting-Ada-Entities">Exporting Ada Entities</a></li>
<li><a href="#index-Export_002fImport-pragma-warnings-297">Export/Import pragma warnings</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-extends-all-701">extends all</a>: <a href="#Project-Hierarchy-Extension">Project Hierarchy Extension</a></li>
<li><a href="#index-g_t_0040code_007bexternal_007d-679"><code>external</code></a>: <a href="#Scenarios-in-Projects">Scenarios in Projects</a></li>
<li><a href="#index-External-72"><code>External</code></a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-g_t_0040code_007bExternally_005fBuilt_007d-670"><code>Externally_Built</code></a>: <a href="#Project-Dependencies">Project Dependencies</a></li>
<li><a href="#index-FDL_002c-GNU-Free-Documentation-License-1099">FDL, GNU Free Documentation License</a>: <a href="#GNU-Free-Documentation-License">GNU Free Documentation License</a></li>
<li><a href="#index-Features_002c-obsolescent-244">Features, obsolescent</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-FF-15"><code>FF</code></a>: <a href="#Source-Representation">Source Representation</a></li>
<li><a href="#index-File-names-40">File names</a>: <a href="#Alternative-File-Naming-Schemes">Alternative File Naming Schemes</a></li>
<li><a href="#index-File-names-36">File names</a>: <a href="#Using-Other-File-Names">Using Other File Names</a></li>
<li><a href="#index-File-naming-schemes_002c-alternative-39">File naming schemes, alternative</a>: <a href="#Alternative-File-Naming-Schemes">Alternative File Naming Schemes</a></li>
<li><a href="#index-Fixed_002dpoint-Small-value-207">Fixed-point Small value</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Foreign-Languages-51">Foreign Languages</a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Formals_002c-unreferenced-228">Formals, unreferenced</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Fortran-76"><code>Fortran</code></a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-gcov-933">gcov</a>: <a href="#Code-Coverage-of-Ada-Programs-using-gcov">Code Coverage of Ada Programs using gcov</a></li>
<li><a href="#index-gdb-950"><code>gdb</code></a>: <a href="#Running-and-Debugging-Ada-Programs">Running and Debugging Ada Programs</a></li>
<li><a href="#index-Generic-formal-parameters-362">Generic formal parameters</a>: <a href="#Compiling-Different-Versions-of-Ada">Compiling Different Versions of Ada</a></li>
<li><a href="#index-Generics-957">Generics</a>: <a href="#Debugging-Generic-Units">Debugging Generic Units</a></li>
<li><a href="#index-Generics-43">Generics</a>: <a href="#Generating-Object-Files">Generating Object Files</a></li>
<li><a href="#index-g_t_0040code_007bGlobal_005fCompilation_005fSwitches_007d-676"><code>Global_Compilation_Switches</code></a>: <a href="#Global-Attributes">Global Attributes</a></li>
<li><a href="#index-g_t_0040code_007bGlobal_005fConfiguration_005fPragmas_007d-675"><code>Global_Configuration_Pragmas</code></a>: <a href="#Global-Attributes">Global Attributes</a></li>
<li><a href="#index-GNAT-966"><code>GNAT</code></a>: <a href="#Naming-Conventions-for-GNAT-Source-Files">Naming Conventions for GNAT Source Files</a></li>
<li><a href="#index-GNAT-491"><code>GNAT</code></a>: <a href="#Search-Paths-for-gnatbind">Search Paths for gnatbind</a></li>
<li><a href="#index-GNAT-Abnormal-Termination-or-Failure-to-Terminate-959">GNAT Abnormal Termination or Failure to Terminate</a>: <a href="#GNAT-Abnormal-Termination-or-Failure-to-Terminate">GNAT Abnormal Termination or Failure to Terminate</a></li>
<li><a href="#index-GNAT-compilation-model-8">GNAT compilation model</a>: <a href="#The-GNAT-Compilation-Model">The GNAT Compilation Model</a></li>
<li><a href="#index-GNAT-extensions-373">GNAT extensions</a>: <a href="#Compiling-Different-Versions-of-Ada">Compiling Different Versions of Ada</a></li>
<li><a href="#index-GNAT-library-88">GNAT library</a>: <a href="#Comparison-between-GNAT-and-Conventional-Ada-Library-Models">Comparison between GNAT and Conventional Ada Library Models</a></li>
<li><a href="#index-GNAT-Programming-Studio-_0028GPS_0029-7">GNAT Programming Studio (GPS)</a>: <a href="#Introduction-to-GPS">Introduction to GPS</a></li>
<li><a href="#index-GNAT-Run_002dTime-Library_002c-rebuilding-866">GNAT Run-Time Library, rebuilding</a>: <a href="#Rebuilding-the-GNAT-Run_002dTime-Library">Rebuilding the GNAT Run-Time Library</a></li>
<li><a href="#index-g_t_0040file_007bgnat_002eadc_007d-620"><samp><span class="file">gnat.adc</span></samp></a>: <a href="#The-Configuration-Pragmas-Files">The Configuration Pragmas Files</a></li>
<li><a href="#index-g_t_0040file_007bgnat_002eadc_007d-38"><samp><span class="file">gnat.adc</span></samp></a>: <a href="#Using-Other-File-Names">Using Other File Names</a></li>
<li><a href="#index-gnat1-91"><code>gnat1</code></a>: <a href="#Compiling-Programs">Compiling Programs</a></li>
<li><a href="#index-gnat_005fargc-482"><code>gnat_argc</code></a>: <a href="#Command_002dLine-Access">Command-Line Access</a></li>
<li><a href="#index-gnat_005fargv-481"><code>gnat_argv</code></a>: <a href="#Command_002dLine-Access">Command-Line Access</a></li>
<li><a href="#index-GNAT_005fINIT_005fSCALARS-439">GNAT_INIT_SCALARS</a>: <a href="#Switches-for-gnatbind">Switches for gnatbind</a></li>
<li><a href="#index-g_t_0040env_007bGNAT_005fPROCESSOR_007d-environment-variable-_0028on-Sparc-Solaris_0029-995"><samp><span class="env">GNAT_PROCESSOR</span></samp> environment variable (on Sparc Solaris)</a>: <a href="#Solaris-Threads-Issues">Solaris Threads Issues</a></li>
<li><a href="#index-GNAT_005fSTACK_005fLIMIT-886">GNAT_STACK_LIMIT</a>: <a href="#Stack-Overflow-Checking">Stack Overflow Checking</a></li>
<li><a href="#index-gnatbind-404"><code>gnatbind</code></a>: <a href="#Binding-Using-gnatbind">Binding Using gnatbind</a></li>
<li><a href="#index-gnatcheck-889"><code>gnatcheck</code></a>: <a href="#Verifying-Properties-Using-gnatcheck">Verifying Properties Using gnatcheck</a></li>
<li><a href="#index-gnatchop-606"><code>gnatchop</code></a>: <a href="#Renaming-Files-Using-gnatchop">Renaming Files Using gnatchop</a></li>
<li><a href="#index-gnatclean-843"><code>gnatclean</code></a>: <a href="#Cleaning-Up-Using-gnatclean">Cleaning Up Using gnatclean</a></li>
<li><a href="#index-gnatdll-1067"><code>gnatdll</code></a>: <a href="#Using-gnatdll">Using gnatdll</a></li>
<li><a href="#index-gnatelim-592"><code>gnatelim</code></a>: <a href="#Reducing-Size-of-Ada-Executables-with-gnatelim">Reducing Size of Ada Executables with gnatelim</a></li>
<li><a href="#index-gnatfind-709"><code>gnatfind</code></a>: <a href="#The-Cross_002dReferencing-Tools-gnatxref-and-gnatfind">The Cross-Referencing Tools gnatxref and gnatfind</a></li>
<li><a href="#index-gnatkr-817"><code>gnatkr</code></a>: <a href="#File-Name-Krunching-Using-gnatkr">File Name Krunching Using gnatkr</a></li>
<li><a href="#index-gnatlink-492"><code>gnatlink</code></a>: <a href="#Linking-Using-gnatlink">Linking Using gnatlink</a></li>
<li><a href="#index-gnatls-826"><code>gnatls</code></a>: <a href="#The-GNAT-Library-Browser-gnatls">The GNAT Library Browser gnatls</a></li>
<li><a href="#index-gnatmake-507"><code>gnatmake</code></a>: <a href="#The-GNAT-Make-Program-gnatmake">The GNAT Make Program gnatmake</a></li>
<li><a href="#index-gnatmem-877"><code>gnatmem</code></a>: <a href="#The-gnatmem-Tool">The gnatmem Tool</a></li>
<li><a href="#index-gnatmetric-784"><code>gnatmetric</code></a>: <a href="#The-GNAT-Metric-Tool-gnatmetric">The GNAT Metric Tool gnatmetric</a></li>
<li><a href="#index-gnatpp-742"><code>gnatpp</code></a>: <a href="#The-GNAT-Pretty_002dPrinter-gnatpp">The GNAT Pretty-Printer gnatpp</a></li>
<li><a href="#index-g_t_0040code_007bgnatprep_007d-1043"><code>gnatprep</code></a>: <a href="#Preprocessing">Preprocessing</a></li>
<li><a href="#index-gnatprep-818"><code>gnatprep</code></a>: <a href="#Preprocessing-Using-gnatprep">Preprocessing Using gnatprep</a></li>
<li><a href="#index-gnatstub-892"><code>gnatstub</code></a>: <a href="#Creating-Sample-Bodies-Using-gnatstub">Creating Sample Bodies Using gnatstub</a></li>
<li><a href="#index-gnatxref-708"><code>gnatxref</code></a>: <a href="#The-Cross_002dReferencing-Tools-gnatxref-and-gnatfind">The Cross-Referencing Tools gnatxref and gnatfind</a></li>
<li><a href="#index-GNU-make-872">GNU make</a>: <a href="#Using-gnatmake-in-a-Makefile">Using gnatmake in a Makefile</a></li>
<li><a href="#index-g_t_0040code_007bGPR_005fPROJECT_005fPATH_007d-864"><code>GPR_PROJECT_PATH</code></a>: <a href="#Installing-a-library">Installing a library</a></li>
<li><a href="#index-g_t_0040code_007bGPR_005fPROJECT_005fPATH_007d-673"><code>GPR_PROJECT_PATH</code></a>: <a href="#Project-Dependencies">Project Dependencies</a></li>
<li><a href="#index-gprof-938">gprof</a>: <a href="#Profiling-an-Ada-Program-using-gprof">Profiling an Ada Program using gprof</a></li>
<li><a href="#index-GPS-_0028GNAT-Programming-Studio_0029-6">GPS (GNAT Programming Studio)</a>: <a href="#Introduction-to-GPS">Introduction to GPS</a></li>
<li><a href="#index-Hiding-of-Declarations-234">Hiding of Declarations</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-HP_002dUX-and-_0040option_007b_002dmbig_002dswitch_007d-option-171">HP-UX and <samp><span class="option">-mbig-switch</span></samp> option</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-HP_002dUX-Scheduling-1000">HP-UX Scheduling</a>: <a href="#HP_002dUX_002dSpecific-Considerations">HP-UX-Specific Considerations</a></li>
<li><a href="#index-HT-12"><code>HT</code></a>: <a href="#Source-Representation">Source Representation</a></li>
<li><a href="#index-g_t_0040code_007bIgnore_005fSource_005fSub_005fDirs_007d-638"><code>Ignore_Source_Sub_Dirs</code></a>: <a href="#Source-Files-and-Directories">Source Files and Directories</a></li>
<li><a href="#index-g_t_0040code_007bImplementation_007d-667"><code>Implementation</code></a>: <a href="#Naming-Schemes">Naming Schemes</a></li>
<li><a href="#index-g_t_0040code_007bImplementation_005fExceptions_007d-669"><code>Implementation_Exceptions</code></a>: <a href="#Naming-Schemes">Naming Schemes</a></li>
<li><a href="#index-g_t_0040code_007bImplementation_005fSuffix_007d-662"><code>Implementation_Suffix</code></a>: <a href="#Naming-Schemes">Naming Schemes</a></li>
<li><a href="#index-Implicit-dereferencing-221">Implicit dereferencing</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Import-library-1058">Import library</a>: <a href="#Creating-an-Import-Library">Creating an Import Library</a></li>
<li><a href="#index-Improving-performance-568">Improving performance</a>: <a href="#Improving-Performance">Improving Performance</a></li>
<li><a href="#index-g_t_0040code_007bInheritance_005fLocking_007d-_0028under-rts_002dpthread_0029-993"><code>Inheritance_Locking</code> (under rts-pthread)</a>: <a href="#Solaris-Threads-Issues">Solaris Threads Issues</a></li>
<li><a href="#index-Inline-582"><code>Inline</code></a>: <a href="#Inlining-of-Subprograms">Inlining of Subprograms</a></li>
<li><a href="#index-Inline-44"><code>Inline</code></a>: <a href="#Source-Dependencies">Source Dependencies</a></li>
<li><a href="#index-Inlining-89">Inlining</a>: <a href="#Comparison-between-GNAT-and-Conventional-Ada-Library-Models">Comparison between GNAT and Conventional Ada Library Models</a></li>
<li><a href="#index-Inlining_002c-warnings-263">Inlining, warnings</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Interfaces-963"><code>Interfaces</code></a>: <a href="#Naming-Conventions-for-GNAT-Source-Files">Naming Conventions for GNAT Source Files</a></li>
<li><a href="#index-Interfaces-490"><code>Interfaces</code></a>: <a href="#Search-Paths-for-gnatbind">Search Paths for gnatbind</a></li>
<li><a href="#index-Interfacing-to-Ada-53">Interfacing to Ada</a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Interfacing-to-Assembly-56">Interfacing to Assembly</a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Interfacing-to-C-64">Interfacing to C</a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Interfacing-to-C-varargs-function-67">Interfacing to C varargs function</a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Interfacing-to-C_002b_002b-74">Interfacing to C++</a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Interfacing-to-COBOL-60">Interfacing to COBOL</a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Interfacing-to-Fortran-77">Interfacing to Fortran</a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Internal-trees_002c-writing-to-file-381">Internal trees, writing to file</a>: <a href="#Auxiliary-Output-Control">Auxiliary Output Control</a></li>
<li><a href="#index-Irix-libraries-998">Irix libraries</a>: <a href="#Irix_002dSpecific-Considerations">Irix-Specific Considerations</a></li>
<li><a href="#index-ISO-8859_002d15-29">ISO 8859-15</a>: <a href="#Other-8_002dBit-Codes">Other 8-Bit Codes</a></li>
<li><a href="#index-ISO-8859_002d2-22">ISO 8859-2</a>: <a href="#Other-8_002dBit-Codes">Other 8-Bit Codes</a></li>
<li><a href="#index-ISO-8859_002d3-24">ISO 8859-3</a>: <a href="#Other-8_002dBit-Codes">Other 8-Bit Codes</a></li>
<li><a href="#index-ISO-8859_002d4-26">ISO 8859-4</a>: <a href="#Other-8_002dBit-Codes">Other 8-Bit Codes</a></li>
<li><a href="#index-ISO-8859_002d5-27">ISO 8859-5</a>: <a href="#Other-8_002dBit-Codes">Other 8-Bit Codes</a></li>
<li><a href="#index-g_t_0040code_007bLanguages_007d-639"><code>Languages</code></a>: <a href="#Source-Files-and-Directories">Source Files and Directories</a></li>
<li><a href="#index-Latin_002d1-1046">Latin-1</a>: <a href="#Changed-semantics">Changed semantics</a></li>
<li><a href="#index-Latin_002d1-19">Latin-1</a>: <a href="#Latin_002d1">Latin-1</a></li>
<li><a href="#index-Latin_002d1-10">Latin-1</a>: <a href="#Source-Representation">Source Representation</a></li>
<li><a href="#index-Latin_002d2-21">Latin-2</a>: <a href="#Other-8_002dBit-Codes">Other 8-Bit Codes</a></li>
<li><a href="#index-Latin_002d3-23">Latin-3</a>: <a href="#Other-8_002dBit-Codes">Other 8-Bit Codes</a></li>
<li><a href="#index-Latin_002d4-25">Latin-4</a>: <a href="#Other-8_002dBit-Codes">Other 8-Bit Codes</a></li>
<li><a href="#index-Latin_002d9-30">Latin-9</a>: <a href="#Other-8_002dBit-Codes">Other 8-Bit Codes</a></li>
<li><a href="#index-Layout-control-in-_0040command_007bgnatpp_007d-753">Layout control in <samp><span class="command">gnatpp</span></samp></a>: <a href="#Construct-Layout-Control">Construct Layout Control</a></li>
<li><a href="#index-g_t_0040code_007bLeading_005fLibrary_005fOptions_007d-689"><code>Leading_Library_Options</code></a>: <a href="#Building-Libraries">Building Libraries</a></li>
<li><a href="#index-LF-14"><code>LF</code></a>: <a href="#Source-Representation">Source Representation</a></li>
<li><a href="#index-Library-browser-827">Library browser</a>: <a href="#The-GNAT-Library-Browser-gnatls">The GNAT Library Browser gnatls</a></li>
<li><a href="#index-Library-tasks_002c-elaboration-issues-1029">Library tasks, elaboration issues</a>: <a href="#Elaboration-Issues-for-Library-Tasks">Elaboration Issues for Library Tasks</a></li>
<li><a href="#index-Library_002c-building_002c-installing_002c-using-862">Library, building, installing, using</a>: <a href="#GNAT-and-Libraries">GNAT and Libraries</a></li>
<li><a href="#index-g_t_0040code_007bLibrary_005fALI_005fDir_007d-685"><code>Library_ALI_Dir</code></a>: <a href="#Building-Libraries">Building Libraries</a></li>
<li><a href="#index-g_t_0040code_007bLibrary_005fAuto_005fInit_007d-693"><code>Library_Auto_Init</code></a>: <a href="#Stand_002dalone-Library-Projects">Stand-alone Library Projects</a></li>
<li><a href="#index-g_t_0040code_007bLibrary_005fDir_007d-694"><code>Library_Dir</code></a>: <a href="#Stand_002dalone-Library-Projects">Stand-alone Library Projects</a></li>
<li><a href="#index-g_t_0040code_007bLibrary_005fDir_007d-683"><code>Library_Dir</code></a>: <a href="#Building-Libraries">Building Libraries</a></li>
<li><a href="#index-g_t_0040code_007bLibrary_005fGCC_007d-687"><code>Library_GCC</code></a>: <a href="#Building-Libraries">Building Libraries</a></li>
<li><a href="#index-g_t_0040code_007bLibrary_005fInterface_007d-692"><code>Library_Interface</code></a>: <a href="#Stand_002dalone-Library-Projects">Stand-alone Library Projects</a></li>
<li><a href="#index-g_t_0040code_007bLibrary_005fKind_007d-684"><code>Library_Kind</code></a>: <a href="#Building-Libraries">Building Libraries</a></li>
<li><a href="#index-g_t_0040code_007bLibrary_005fName_007d-682"><code>Library_Name</code></a>: <a href="#Building-Libraries">Building Libraries</a></li>
<li><a href="#index-g_t_0040code_007bLibrary_005fOptions_007d-688"><code>Library_Options</code></a>: <a href="#Building-Libraries">Building Libraries</a></li>
<li><a href="#index-g_t_0040code_007bLibrary_005fReference_005fSymbol_005fFile_007d-697"><code>Library_Reference_Symbol_File</code></a>: <a href="#Stand_002dalone-Library-Projects">Stand-alone Library Projects</a></li>
<li><a href="#index-g_t_0040code_007bLibrary_005fSrc_005fDir_007d-695"><code>Library_Src_Dir</code></a>: <a href="#Stand_002dalone-Library-Projects">Stand-alone Library Projects</a></li>
<li><a href="#index-g_t_0040code_007bLibrary_005fSymbol_005fFile_007d-698"><code>Library_Symbol_File</code></a>: <a href="#Stand_002dalone-Library-Projects">Stand-alone Library Projects</a></li>
<li><a href="#index-g_t_0040code_007bLibrary_005fSymbol_005fPolicy_007d-696"><code>Library_Symbol_Policy</code></a>: <a href="#Stand_002dalone-Library-Projects">Stand-alone Library Projects</a></li>
<li><a href="#index-g_t_0040code_007bLibrary_005fVersion_007d-686"><code>Library_Version</code></a>: <a href="#Building-Libraries">Building Libraries</a></li>
<li><a href="#index-Line-metrics-control-in-_0040command_007bgnatmetric_007d-798">Line metrics control in <samp><span class="command">gnatmetric</span></samp></a>: <a href="#Line-Metrics-Control">Line Metrics Control</a></li>
<li><a href="#index-Linker-libraries-559">Linker libraries</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040code_007bLinker_005fOptions_007d-690"><code>Linker_Options</code></a>: <a href="#Building-Libraries">Building Libraries</a></li>
<li><a href="#index-Linux-threads-libraries-996">Linux threads libraries</a>: <a href="#Linux_002dSpecific-Considerations">Linux-Specific Considerations</a></li>
<li><a href="#index-g_t_0040code_007bLocal_005fConfiguration_005fPragmas_007d-653"><code>Local_Configuration_Pragmas</code></a>: <a href="#Tools-Options-in-Project-Files">Tools Options in Project Files</a></li>
<li><a href="#index-g_t_0040code_007bLocally_005fRemoved_005fFiles_007d-644"><code>Locally_Removed_Files</code></a>: <a href="#Source-Files-and-Directories">Source Files and Directories</a></li>
<li><a href="#index-Machine_005fOverflows-347"><code>Machine_Overflows</code></a>: <a href="#Run_002dTime-Checks">Run-Time Checks</a></li>
<li><a href="#index-g_t_0040code_007bMain_007d-648"><code>Main</code></a>: <a href="#Main-Subprograms">Main Subprograms</a></li>
<li><a href="#index-Main-Program-1010"><code>Main Program</code></a>: <a href="#Example-of-Binder-Output-File">Example of Binder Output File</a></li>
<li><a href="#index-make-870"><code>make</code></a>: <a href="#Using-the-GNU-make-Utility">Using the GNU make Utility</a></li>
<li><a href="#index-makefile-871"><code>makefile</code></a>: <a href="#Using-gnatmake-in-a-Makefile">Using gnatmake in a Makefile</a></li>
<li><a href="#index-Memory-Pool-873"><code>Memory Pool</code></a>: <a href="#Some-Useful-Memory-Pools">Some Useful Memory Pools</a></li>
<li><a href="#index-Metric-tool-785">Metric tool</a>: <a href="#The-GNAT-Metric-Tool-gnatmetric">The GNAT Metric Tool gnatmetric</a></li>
<li><a href="#index-Mixed-Language-Programming-49">Mixed Language Programming</a>: <a href="#Mixed-Language-Programming">Mixed Language Programming</a></li>
<li><a href="#index-Multiple-units_002c-syntax-checking-356">Multiple units, syntax checking</a>: <a href="#Using-gcc-for-Syntax-Checking">Using gcc for Syntax Checking</a></li>
<li><a href="#index-g_t_0040var_007bN_007d-_0028_0040code_007bgnatmem_007d_0029-879"><var>N</var> (<code>gnatmem</code>)</a>: <a href="#Switches-for-gnatmem">Switches for gnatmem</a></li>
<li><a href="#index-Naming-scheme-640">Naming scheme</a>: <a href="#Source-Files-and-Directories">Source Files and Directories</a></li>
<li><a href="#index-naming-scheme-523">naming scheme</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-No_005fEntry_005fCalls_005fIn_005fElaboration_005fCode-1031">No_Entry_Calls_In_Elaboration_Code</a>: <a href="#Elaboration-Issues-for-Library-Tasks">Elaboration Issues for Library Tasks</a></li>
<li><a href="#index-No_005fStrict_005fAliasing-590">No_Strict_Aliasing</a>: <a href="#Optimization-and-Strict-Aliasing">Optimization and Strict Aliasing</a></li>
<li><a href="#index-Object-file-list-1013"><code>Object file list</code></a>: <a href="#Example-of-Binder-Output-File">Example of Binder Output File</a></li>
<li><a href="#index-Object_002dOriented-metrics-control-in-_0040command_007bgnatmetric_007d-808">Object-Oriented metrics control in <samp><span class="command">gnatmetric</span></samp></a>: <a href="#Object_002dOriented-Metrics-Control">Object-Oriented Metrics Control</a></li>
<li><a href="#index-g_t_0040code_007bObject_005fDir_007d-646"><code>Object_Dir</code></a>: <a href="#Object-and-Exec-Directory">Object and Exec Directory</a></li>
<li><a href="#index-Obsolescent-features-245">Obsolescent features</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Optimization-and-debugging-579">Optimization and debugging</a>: <a href="#Debugging-Optimized-Code">Debugging Optimized Code</a></li>
<li><a href="#index-Optimization-Switches-587">Optimization Switches</a>: <a href="#Other-Optimization-Switches">Other Optimization Switches</a></li>
<li><a href="#index-Order-of-elaboration-1014">Order of elaboration</a>: <a href="#Elaboration-Order-Handling-in-GNAT">Elaboration Order Handling in GNAT</a></li>
<li><a href="#index-Other-Ada-compilers-54">Other Ada compilers</a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Output-file-control-in-_0040command_007bgnatmetric_007d-786">Output file control in <samp><span class="command">gnatmetric</span></samp></a>: <a href="#Output-Files-Control">Output Files Control</a></li>
<li><a href="#index-Overflow-checks-571">Overflow checks</a>: <a href="#Controlling-Run_002dTime-Checks">Controlling Run-Time Checks</a></li>
<li><a href="#index-Overflow-checks-345">Overflow checks</a>: <a href="#Run_002dTime-Checks">Run-Time Checks</a></li>
<li><a href="#index-Parallel-make-530">Parallel make</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-Parameter-order_002c-warnings-266">Parameter order, warnings</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Parentheses_002c-warnings-269">Parentheses, warnings</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-portability-635">portability</a>: <a href="#Source-Files-and-Directories">Source Files and Directories</a></li>
<li><a href="#index-pragma-_0040code_007bAssert_007d-1036">pragma <code>Assert</code></a>: <a href="#Debugging-_002d-A-Special-Case">Debugging - A Special Case</a></li>
<li><a href="#index-pragma-_0040code_007bAssertion_005fPolicy_007d-1037">pragma <code>Assertion_Policy</code></a>: <a href="#Debugging-_002d-A-Special-Case">Debugging - A Special Case</a></li>
<li><a href="#index-pragma-_0040code_007bDebug_007d-1039">pragma <code>Debug</code></a>: <a href="#Debugging-_002d-A-Special-Case">Debugging - A Special Case</a></li>
<li><a href="#index-pragma-_0040code_007bDebug_005fPolicy_007d-1040">pragma <code>Debug_Policy</code></a>: <a href="#Debugging-_002d-A-Special-Case">Debugging - A Special Case</a></li>
<li><a href="#index-Pragma-Elaborate-1028">Pragma Elaborate</a>: <a href="#Treatment-of-Pragma-Elaborate">Treatment of Pragma Elaborate</a></li>
<li><a href="#index-pragma-Elaborate-1025">pragma Elaborate</a>: <a href="#Controlling-the-Elaboration-Order">Controlling the Elaboration Order</a></li>
<li><a href="#index-pragma-Elaborate_005fAll-1027">pragma Elaborate_All</a>: <a href="#Controlling-the-Elaboration-Order">Controlling the Elaboration Order</a></li>
<li><a href="#index-pragma-Elaborate_005fBody-1023">pragma Elaborate_Body</a>: <a href="#Controlling-the-Elaboration-Order">Controlling the Elaboration Order</a></li>
<li><a href="#index-pragma-Inline-581">pragma Inline</a>: <a href="#Inlining-of-Subprograms">Inlining of Subprograms</a></li>
<li><a href="#index-pragma-Locking_005fPolicy-_0028under-rts_002dpthread_0029-992">pragma Locking_Policy (under rts-pthread)</a>: <a href="#Solaris-Threads-Issues">Solaris Threads Issues</a></li>
<li><a href="#index-pragma-Preelaborate-1021">pragma Preelaborate</a>: <a href="#Controlling-the-Elaboration-Order">Controlling the Elaboration Order</a></li>
<li><a href="#index-pragma-Pure-1018">pragma Pure</a>: <a href="#Controlling-the-Elaboration-Order">Controlling the Elaboration Order</a></li>
<li><a href="#index-pragma-Restrictions-391">pragma Restrictions</a>: <a href="#Debugging-Control">Debugging Control</a></li>
<li><a href="#index-pragma-Suppress-575">pragma Suppress</a>: <a href="#Controlling-Run_002dTime-Checks">Controlling Run-Time Checks</a></li>
<li><a href="#index-pragma-Task_005fDispatching_005fPolicy-1003">pragma Task_Dispatching_Policy</a>: <a href="#HP_002dUX_002dSpecific-Considerations">HP-UX-Specific Considerations</a></li>
<li><a href="#index-pragma-Task_005fDispatching_005fPolicy-986">pragma Task_Dispatching_Policy</a>: <a href="#Choosing-the-Scheduling-Policy">Choosing the Scheduling Policy</a></li>
<li><a href="#index-pragma-Time_005fSlice-1001">pragma Time_Slice</a>: <a href="#HP_002dUX_002dSpecific-Considerations">HP-UX-Specific Considerations</a></li>
<li><a href="#index-pragma-Time_005fSlice-984">pragma Time_Slice</a>: <a href="#Choosing-the-Scheduling-Policy">Choosing the Scheduling Policy</a></li>
<li><a href="#index-pragma-Unsuppress-576">pragma Unsuppress</a>: <a href="#Controlling-Run_002dTime-Checks">Controlling Run-Time Checks</a></li>
<li><a href="#index-Pragmas_002c-configuration-619">Pragmas, configuration</a>: <a href="#Configuration-Pragmas">Configuration Pragmas</a></li>
<li><a href="#index-Pragmas_002c-unrecognized-231">Pragmas, unrecognized</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Preelaborate-1020"><code>Preelaborate</code></a>: <a href="#Controlling-the-Elaboration-Order">Controlling the Elaboration Order</a></li>
<li><a href="#index-Preprocessing-1042">Preprocessing</a>: <a href="#Preprocessing">Preprocessing</a></li>
<li><a href="#index-Preprocessors-_0028contrasted-with-conditional-compilation_0029-1035">Preprocessors (contrasted with conditional compilation)</a>: <a href="#Use-of-Boolean-Constants">Use of Boolean Constants</a></li>
<li><a href="#index-Pretty_002dPrinter-743">Pretty-Printer</a>: <a href="#The-GNAT-Pretty_002dPrinter-gnatpp">The GNAT Pretty-Printer gnatpp</a></li>
<li><a href="#index-Profiling-942">Profiling</a>: <a href="#Compilation-for-profiling">Compilation for profiling</a></li>
<li><a href="#index-Profiling-940">Profiling</a>: <a href="#Profiling-an-Ada-Program-using-gprof">Profiling an Ada Program using gprof</a></li>
<li><a href="#index-Profiling-932">Profiling</a>: <a href="#Code-Coverage-and-Profiling">Code Coverage and Profiling</a></li>
<li><a href="#index-project-file-packages-650">project file packages</a>: <a href="#Tools-Options-in-Project-Files">Tools Options in Project Files</a></li>
<li><a href="#index-project-path-671">project path</a>: <a href="#Project-Dependencies">Project Dependencies</a></li>
<li><a href="#index-project-qualifier-674">project qualifier</a>: <a href="#Sharing-Between-Projects">Sharing Between Projects</a></li>
<li><a href="#index-g_t_0040code_007bPTHREAD_005fPRIO_005fINHERIT_007d-policy-_0028under-rts_002dpthread_0029-990"><code>PTHREAD_PRIO_INHERIT</code> policy (under rts-pthread)</a>: <a href="#Solaris-Threads-Issues">Solaris Threads Issues</a></li>
<li><a href="#index-g_t_0040code_007bPTHREAD_005fPRIO_005fPROTECT_007d-policy-_0028under-rts_002dpthread_0029-991"><code>PTHREAD_PRIO_PROTECT</code> policy (under rts-pthread)</a>: <a href="#Solaris-Threads-Issues">Solaris Threads Issues</a></li>
<li><a href="#index-Pure-1019"><code>Pure</code></a>: <a href="#Controlling-the-Elaboration-Order">Controlling the Elaboration Order</a></li>
<li><a href="#index-rc-1093"><code>rc</code></a>: <a href="#Compiling-Resources">Compiling Resources</a></li>
<li><a href="#index-Rebuilding-the-GNAT-Run_002dTime-Library-868">Rebuilding the GNAT Run-Time Library</a>: <a href="#Rebuilding-the-GNAT-Run_002dTime-Library">Rebuilding the GNAT Run-Time Library</a></li>
<li><a href="#index-Recompilation_002c-by-_0040command_007bgnatmake_007d-567">Recompilation, by <samp><span class="command">gnatmake</span></samp></a>: <a href="#Notes-on-the-Command-Line">Notes on the Command Line</a></li>
<li><a href="#index-Record-Representation-_0028component-sizes_0029-277">Record Representation (component sizes)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Record-Representation-_0028gaps_0029-237">Record Representation (gaps)</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Remote-Debugging-using-gdbserver-958">Remote Debugging using gdbserver</a>: <a href="#Remote-Debugging-using-gdbserver">Remote Debugging using gdbserver</a></li>
<li><a href="#index-Resources_002c-building-1092">Resources, building</a>: <a href="#Building-Resources">Building Resources</a></li>
<li><a href="#index-Resources_002c-compiling-1095">Resources, compiling</a>: <a href="#Compiling-Resources">Compiling Resources</a></li>
<li><a href="#index-Resources_002c-using-1096">Resources, using</a>: <a href="#Using-Resources">Using Resources</a></li>
<li><a href="#index-Resources_002c-windows-1091">Resources, windows</a>: <a href="#GNAT-and-Windows-Resources">GNAT and Windows Resources</a></li>
<li><a href="#index-RTL-166">RTL</a>: <a href="#Switches-for-gcc">Switches for gcc</a></li>
<li><a href="#index-rts_002dpthread-threads-library-989">rts-pthread threads library</a>: <a href="#Solaris-Threads-Issues">Solaris Threads Issues</a></li>
<li><a href="#index-RTX-libraries-999">RTX libraries</a>: <a href="#RTX_002dSpecific-Considerations">RTX-Specific Considerations</a></li>
<li><a href="#index-Run_002dtime-libraries-_0028platform_002dspecific-information_0029-974">Run-time libraries (platform-specific information)</a>: <a href="#Platform_002dSpecific-Information-for-the-Run_002dTime-Libraries">Platform-Specific Information for the Run-Time Libraries</a></li>
<li><a href="#index-Run_002dTime-Library_002c-rebuilding-869">Run-Time Library, rebuilding</a>: <a href="#Rebuilding-the-GNAT-Run_002dTime-Library">Rebuilding the GNAT Run-Time Library</a></li>
<li><a href="#index-scenarios-677">scenarios</a>: <a href="#Scenarios-in-Projects">Scenarios in Projects</a></li>
<li><a href="#index-g_t_0040code_007bSCHED_005fFIFO_007d-scheduling-policy-980"><code>SCHED_FIFO</code> scheduling policy</a>: <a href="#Choosing-the-Scheduling-Policy">Choosing the Scheduling Policy</a></li>
<li><a href="#index-g_t_0040code_007bSCHED_005fOTHER_007d-scheduling-policy-982"><code>SCHED_OTHER</code> scheduling policy</a>: <a href="#Choosing-the-Scheduling-Policy">Choosing the Scheduling Policy</a></li>
<li><a href="#index-g_t_0040code_007bSCHED_005fRR_007d-scheduling-policy-981"><code>SCHED_RR</code> scheduling policy</a>: <a href="#Choosing-the-Scheduling-Policy">Choosing the Scheduling Policy</a></li>
<li><a href="#index-SDP_005fTable_005fBuild-1006"><code>SDP_Table_Build</code></a>: <a href="#Example-of-Binder-Output-File">Example of Binder Output File</a></li>
<li><a href="#index-Search-paths_002c-for-_0040command_007bgnatmake_007d-553">Search paths, for <samp><span class="command">gnatmake</span></samp></a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-g_t_0040code_007bSeparate_005fSuffix_007d-663"><code>Separate_Suffix</code></a>: <a href="#Naming-Schemes">Naming Schemes</a></li>
<li><a href="#index-setjmp_002flongjmp-Exception-Model-977">setjmp/longjmp Exception Model</a>: <a href="#Platform_002dSpecific-Information-for-the-Run_002dTime-Libraries">Platform-Specific Information for the Run-Time Libraries</a></li>
<li><a href="#index-Shift-JIS-Coding-34">Shift JIS Coding</a>: <a href="#Wide-Character-Encodings">Wide Character Encodings</a></li>
<li><a href="#index-SJLJ-_0028setjmp_002flongjmp-Exception-Model_0029-978">SJLJ (setjmp/longjmp Exception Model)</a>: <a href="#Platform_002dSpecific-Information-for-the-Run_002dTime-Libraries">Platform-Specific Information for the Run-Time Libraries</a></li>
<li><a href="#index-Small-value-208">Small value</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Solaris-Sparc-threads-libraries-988">Solaris Sparc threads libraries</a>: <a href="#Solaris_002dSpecific-Considerations">Solaris-Specific Considerations</a></li>
<li><a href="#index-Source-directories-633">Source directories</a>: <a href="#Source-Files-and-Directories">Source Files and Directories</a></li>
<li><a href="#index-Source-directories_002c-recursive-636">Source directories, recursive</a>: <a href="#Source-Files-and-Directories">Source Files and Directories</a></li>
<li><a href="#index-Source-file_002c-end-17">Source file, end</a>: <a href="#Source-Representation">Source Representation</a></li>
<li><a href="#index-Source-files_002c-suppressing-search-861">Source files, suppressing search</a>: <a href="#Switches-for-gnatclean">Switches for gnatclean</a></li>
<li><a href="#index-Source-files_002c-suppressing-search-557">Source files, suppressing search</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-Source-files_002c-use-by-binder-405">Source files, use by binder</a>: <a href="#Running-gnatbind">Running gnatbind</a></li>
<li><a href="#index-g_t_0040code_007bSource_005fDirs_007d-634"><code>Source_Dirs</code></a>: <a href="#Source-Files-and-Directories">Source Files and Directories</a></li>
<li><a href="#index-Source_005fFile_005fName-pragma-41">Source_File_Name pragma</a>: <a href="#Alternative-File-Naming-Schemes">Alternative File Naming Schemes</a></li>
<li><a href="#index-Source_005fFile_005fName-pragma-37">Source_File_Name pragma</a>: <a href="#Using-Other-File-Names">Using Other File Names</a></li>
<li><a href="#index-g_t_0040code_007bSource_005fFiles_007d-641"><code>Source_Files</code></a>: <a href="#Source-Files-and-Directories">Source Files and Directories</a></li>
<li><a href="#index-g_t_0040code_007bSource_005fList_005fFile_007d-642"><code>Source_List_File</code></a>: <a href="#Source-Files-and-Directories">Source Files and Directories</a></li>
<li><a href="#index-Source_005fReference-614"><code>Source_Reference</code></a>: <a href="#Switches-for-gnatchop">Switches for gnatchop</a></li>
<li><a href="#index-g_t_0040code_007bSpec_007d-664"><code>Spec</code></a>: <a href="#Naming-Schemes">Naming Schemes</a></li>
<li><a href="#index-g_t_0040code_007bSpec_005fSuffix_007d-659"><code>Spec_Suffix</code></a>: <a href="#Naming-Schemes">Naming Schemes</a></li>
<li><a href="#index-g_t_0040code_007bSpecification_007d-665"><code>Specification</code></a>: <a href="#Naming-Schemes">Naming Schemes</a></li>
<li><a href="#index-g_t_0040code_007bSpecification_005fExceptions_007d-668"><code>Specification_Exceptions</code></a>: <a href="#Naming-Schemes">Naming Schemes</a></li>
<li><a href="#index-g_t_0040code_007bSpecification_005fSuffix_007d-660"><code>Specification_Suffix</code></a>: <a href="#Naming-Schemes">Naming Schemes</a></li>
<li><a href="#index-Stack-Overflow-Checking-884">Stack Overflow Checking</a>: <a href="#Stack-Overflow-Checking">Stack Overflow Checking</a></li>
<li><a href="#index-Stack-Overflow-Checking-352">Stack Overflow Checking</a>: <a href="#Run_002dTime-Checks">Run-Time Checks</a></li>
<li><a href="#index-stack-traceback-968">stack traceback</a>: <a href="#Stack-Traceback">Stack Traceback</a></li>
<li><a href="#index-stack-unwinding-969">stack unwinding</a>: <a href="#Stack-Traceback">Stack Traceback</a></li>
<li><a href="#index-Stand_002dalone-library_002c-building_002c-using-865">Stand-alone library, building, using</a>: <a href="#Stand_002dalone-Ada-Libraries">Stand-alone Ada Libraries</a></li>
<li><a href="#index-standalone-libraries-691">standalone libraries</a>: <a href="#Stand_002dalone-Library-Projects">Stand-alone Library Projects</a></li>
<li><a href="#index-Static-Stack-Usage-Analysis-887">Static Stack Usage Analysis</a>: <a href="#Static-Stack-Usage-Analysis">Static Stack Usage Analysis</a></li>
<li><a href="#index-Stdcall-1055"><code>Stdcall</code></a>: <a href="#Windows-Calling-Conventions">Windows Calling Conventions</a></li>
<li><a href="#index-Stdcall-79"><code>Stdcall</code></a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-stderr-184"><code>stderr</code></a>: <a href="#Output-and-Error-Message-Control">Output and Error Message Control</a></li>
<li><a href="#index-stdout-186"><code>stdout</code></a>: <a href="#Output-and-Error-Message-Control">Output and Error Message Control</a></li>
<li><a href="#index-storage_002c-pool-874">storage, pool</a>: <a href="#Some-Useful-Memory-Pools">Some Useful Memory Pools</a></li>
<li><a href="#index-storage_002c-pool_002c-memory-corruption-876">storage, pool, memory corruption</a>: <a href="#The-GNAT-Debug-Pool-Facility">The GNAT Debug Pool Facility</a></li>
<li><a href="#index-Strict-Aliasing-589">Strict Aliasing</a>: <a href="#Optimization-and-Strict-Aliasing">Optimization and Strict Aliasing</a></li>
<li><a href="#index-String-indexing-warnings-291">String indexing warnings</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Stubbed-85"><code>Stubbed</code></a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Style-checking-329"><code>Style checking</code></a>: <a href="#Style-Checking">Style Checking</a></li>
<li><a href="#index-SUB-18"><code>SUB</code></a>: <a href="#Source-Representation">Source Representation</a></li>
<li><a href="#index-Subunits-42">Subunits</a>: <a href="#Generating-Object-Files">Generating Object Files</a></li>
<li><a href="#index-Subunits-_0028and-conditional-compilation_0029-1041">Subunits (and conditional compilation)</a>: <a href="#Use-of-Alternative-Implementations">Use of Alternative Implementations</a></li>
<li><a href="#index-Suppress-573"><code>Suppress</code></a>: <a href="#Controlling-Run_002dTime-Checks">Controlling Run-Time Checks</a></li>
<li><a href="#index-Suppress-339"><code>Suppress</code></a>: <a href="#Run_002dTime-Checks">Run-Time Checks</a></li>
<li><a href="#index-Suppressing-checks-337">Suppressing checks</a>: <a href="#Run_002dTime-Checks">Run-Time Checks</a></li>
<li><a href="#index-g_t_0040code_007bSwitches_007d-652"><code>Switches</code></a>: <a href="#Tools-Options-in-Project-Files">Tools Options in Project Files</a></li>
<li><a href="#index-symbolic-links-522">symbolic links</a>: <a href="#Switches-for-gnatmake">Switches for gnatmake</a></li>
<li><a href="#index-Syntax-metrics-control-in-_0040command_007bgnatmetric_007d-801">Syntax metrics control in <samp><span class="command">gnatmetric</span></samp></a>: <a href="#Syntax-Metrics-Control">Syntax Metrics Control</a></li>
<li><a href="#index-System-965"><code>System</code></a>: <a href="#Naming-Conventions-for-GNAT-Source-Files">Naming Conventions for GNAT Source Files</a></li>
<li><a href="#index-System-489"><code>System</code></a>: <a href="#Search-Paths-for-gnatbind">Search Paths for gnatbind</a></li>
<li><a href="#index-System_002eIO-403"><code>System.IO</code></a>: <a href="#Search-Paths-and-the-Run_002dTime-Library-_0028RTL_0029">Search Paths and the Run-Time Library (RTL)</a></li>
<li><a href="#index-Task-switching-955">Task switching</a>: <a href="#Ada-Tasks">Ada Tasks</a></li>
<li><a href="#index-Tasking-and-threads-libraries-972">Tasking and threads libraries</a>: <a href="#Platform_002dSpecific-Information-for-the-Run_002dTime-Libraries">Platform-Specific Information for the Run-Time Libraries</a></li>
<li><a href="#index-Tasks-953">Tasks</a>: <a href="#Ada-Tasks">Ada Tasks</a></li>
<li><a href="#index-Temporary-files-1054">Temporary files</a>: <a href="#Temporary-Files">Temporary Files</a></li>
<li><a href="#index-g_t_0040code_007bText_005fIO_007d-and-performance-591"><code>Text_IO</code> and performance</a>: <a href="#Text_005fIO-Suggestions">Text_IO Suggestions</a></li>
<li><a href="#index-Threads-libraries-and-tasking-973">Threads libraries and tasking</a>: <a href="#Platform_002dSpecific-Information-for-the-Run_002dTime-Libraries">Platform-Specific Information for the Run-Time Libraries</a></li>
<li><a href="#index-Time-stamp-checks_002c-in-binder-462">Time stamp checks, in binder</a>: <a href="#Binder-Error-Message-Control">Binder Error Message Control</a></li>
<li><a href="#index-traceback-967">traceback</a>: <a href="#Stack-Traceback">Stack Traceback</a></li>
<li><a href="#index-traceback_002c-non_002dsymbolic-970">traceback, non-symbolic</a>: <a href="#Non_002dSymbolic-Traceback">Non-Symbolic Traceback</a></li>
<li><a href="#index-traceback_002c-symbolic-971">traceback, symbolic</a>: <a href="#Symbolic-Traceback">Symbolic Traceback</a></li>
<li><a href="#index-typed-variable-680">typed variable</a>: <a href="#Scenarios-in-Projects">Scenarios in Projects</a></li>
<li><a href="#index-Typographical-conventions-4">Typographical conventions</a>: <a href="#Conventions">Conventions</a></li>
<li><a href="#index-Unassigned-variable-warnings-288">Unassigned variable warnings</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Unchecked_005fConversion-warnings-305">Unchecked_Conversion warnings</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Unsuppress-574"><code>Unsuppress</code></a>: <a href="#Controlling-Run_002dTime-Checks">Controlling Run-Time Checks</a></li>
<li><a href="#index-Unsuppress-354"><code>Unsuppress</code></a>: <a href="#Run_002dTime-Checks">Run-Time Checks</a></li>
<li><a href="#index-unused-subprogram_002fdata-elimination-603"><code>unused subprogram/data elimination</code></a>: <a href="#Reducing-Size-of-Executables-with-unused-subprogram_002fdata-elimination">Reducing Size of Executables with unused subprogram/data elimination</a></li>
<li><a href="#index-Upper_002dHalf-Coding-33">Upper-Half Coding</a>: <a href="#Wide-Character-Encodings">Wide Character Encodings</a></li>
<li><a href="#index-Validity-Checking-315"><code>Validity Checking</code></a>: <a href="#Validity-Checking">Validity Checking</a></li>
<li><a href="#index-varargs-function-interfaces-68">varargs function interfaces</a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Version-skew-_0028avoided-by-_0040command_007bgnatmake_007d_0029-5">Version skew (avoided by <samp><span class="command">gnatmake</span></samp>)</a>: <a href="#Running-a-Simple-Ada-Program">Running a Simple Ada Program</a></li>
<li><a href="#index-Volatile-parameter-1044">Volatile parameter</a>: <a href="#The-Volatile-Parameter">The Volatile Parameter</a></li>
<li><a href="#index-VT-11"><code>VT</code></a>: <a href="#Source-Representation">Source Representation</a></li>
<li><a href="#index-Warning-messages-198">Warning messages</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Warnings-459">Warnings</a>: <a href="#Binder-Error-Message-Control">Binder Error Message Control</a></li>
<li><a href="#index-Warnings-Off-control-294">Warnings Off control</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Warnings_002c-activate-every-optional-warning-226">Warnings, activate every optional warning</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Warnings_002c-treat-as-error-224">Warnings, treat as error</a>: <a href="#Warning-Message-Control">Warning Message Control</a></li>
<li><a href="#index-Win32-83"><code>Win32</code></a>: <a href="#Calling-Conventions">Calling Conventions</a></li>
<li><a href="#index-Windows-95-1049">Windows 95</a>: <a href="#Microsoft-Windows-Topics">Microsoft Windows Topics</a></li>
<li><a href="#index-Windows-98-1050">Windows 98</a>: <a href="#Microsoft-Windows-Topics">Microsoft Windows Topics</a></li>
<li><a href="#index-Windows-NT-1048">Windows NT</a>: <a href="#Microsoft-Windows-Topics">Microsoft Windows Topics</a></li>
<li><a href="#index-WINDOWS-Subsystem-1052">WINDOWS Subsystem</a>: <a href="#CONSOLE-and-WINDOWS-subsystems">CONSOLE and WINDOWS subsystems</a></li>
<li><a href="#index-windres-1094"><code>windres</code></a>: <a href="#Compiling-Resources">Compiling Resources</a></li>
<li><a href="#index-Writing-internal-trees-380">Writing internal trees</a>: <a href="#Auxiliary-Output-Control">Auxiliary Output Control</a></li>
<li><a href="#index-ZCX-_0028Zero_002dCost-Exceptions_0029-976">ZCX (Zero-Cost Exceptions)</a>: <a href="#Platform_002dSpecific-Information-for-the-Run_002dTime-Libraries">Platform-Specific Information for the Run-Time Libraries</a></li>
<li><a href="#index-Zero-Cost-Exceptions-1007"><code>Zero Cost Exceptions</code></a>: <a href="#Example-of-Binder-Output-File">Example of Binder Output File</a></li>
<li><a href="#index-Zero-Cost-Exceptions-397">Zero Cost Exceptions</a>: <a href="#Exception-Handling-Control">Exception Handling Control</a></li>
<li><a href="#index-Zero_002dCost-Exceptions-975">Zero-Cost Exceptions</a>: <a href="#Platform_002dSpecific-Information-for-the-Run_002dTime-Libraries">Platform-Specific Information for the Run-Time Libraries</a></li>
</ul>
<div class="contents">
<h2>Table of Contents</h2>
<ul>
<li><a name="toc_Top" href="#Top">GNAT User's Guide</a>
<li><a name="toc_About-This-Guide" href="#About-This-Guide">About This Guide</a>
<ul>
<li><a href="#What-This-Guide-Contains">What This Guide Contains</a>
<li><a href="#What-You-Should-Know-before-Reading-This-Guide">What You Should Know before Reading This Guide</a>
<li><a href="#Related-Information">Related Information</a>
<li><a href="#Conventions">Conventions</a>
</li></ul>
<li><a name="toc_Getting-Started-with-GNAT" href="#Getting-Started-with-GNAT">1 Getting Started with GNAT</a>
<ul>
<li><a href="#Running-GNAT">1.1 Running GNAT</a>
<li><a href="#Running-a-Simple-Ada-Program">1.2 Running a Simple Ada Program</a>
<li><a href="#Running-a-Program-with-Multiple-Units">1.3 Running a Program with Multiple Units</a>
<li><a href="#Using-the-gnatmake-Utility">1.4 Using the <samp><span class="command">gnatmake</span></samp> Utility</a>
<li><a href="#Introduction-to-GPS">1.5 Introduction to GPS</a>
<ul>
<li><a href="#Building-a-New-Program-with-GPS">1.5.1 Building a New Program with GPS</a>
<li><a href="#Simple-Debugging-with-GPS">1.5.2 Simple Debugging with GPS</a>
</li></ul>
</li></ul>
<li><a name="toc_The-GNAT-Compilation-Model" href="#The-GNAT-Compilation-Model">2 The GNAT Compilation Model</a>
<ul>
<li><a href="#Source-Representation">2.1 Source Representation</a>
<li><a href="#Foreign-Language-Representation">2.2 Foreign Language Representation</a>
<ul>
<li><a href="#Latin_002d1">2.2.1 Latin-1</a>
<li><a href="#Other-8_002dBit-Codes">2.2.2 Other 8-Bit Codes</a>
<li><a href="#Wide-Character-Encodings">2.2.3 Wide Character Encodings</a>
</li></ul>
<li><a href="#File-Naming-Rules">2.3 File Naming Rules</a>
<li><a href="#Using-Other-File-Names">2.4 Using Other File Names</a>
<li><a href="#Alternative-File-Naming-Schemes">2.5 Alternative File Naming Schemes</a>
<li><a href="#Generating-Object-Files">2.6 Generating Object Files</a>
<li><a href="#Source-Dependencies">2.7 Source Dependencies</a>
<li><a href="#The-Ada-Library-Information-Files">2.8 The Ada Library Information Files</a>
<li><a href="#Binding-an-Ada-Program">2.9 Binding an Ada Program</a>
<li><a href="#Mixed-Language-Programming">2.10 Mixed Language Programming</a>
<ul>
<li><a href="#Interfacing-to-C">2.10.1 Interfacing to C</a>
<li><a href="#Calling-Conventions">2.10.2 Calling Conventions</a>
</li></ul>
<li><a href="#Building-Mixed-Ada-_0026-C_002b_002b-Programs">2.11 Building Mixed Ada and C++ Programs</a>
<ul>
<li><a href="#Interfacing-to-C_002b_002b">2.11.1 Interfacing to C++</a>
<li><a href="#Linking-a-Mixed-C_002b_002b-_0026-Ada-Program">2.11.2 Linking a Mixed C++ & Ada Program</a>
<li><a href="#A-Simple-Example">2.11.3 A Simple Example</a>
<li><a href="#Interfacing-with-C_002b_002b-constructors">2.11.4 Interfacing with C++ constructors</a>
<li><a href="#Interfacing-with-C_002b_002b-at-the-Class-Level">2.11.5 Interfacing with C++ at the Class Level</a>
</li></ul>
<li><a href="#Comparison-between-GNAT-and-C_002fC_002b_002b-Compilation-Models">2.12 Comparison between GNAT and C/C++ Compilation Models</a>
<li><a href="#Comparison-between-GNAT-and-Conventional-Ada-Library-Models">2.13 Comparison between GNAT and Conventional Ada Library Models</a>
</li></ul>
<li><a name="toc_Compiling-Using-gcc" href="#Compiling-Using-gcc">3 Compiling Using <samp><span class="command">gcc</span></samp></a>
<ul>
<li><a href="#Compiling-Programs">3.1 Compiling Programs</a>
<li><a href="#Switches-for-gcc">3.2 Switches for <samp><span class="command">gcc</span></samp></a>
<ul>
<li><a href="#Output-and-Error-Message-Control">3.2.1 Output and Error Message Control</a>
<li><a href="#Warning-Message-Control">3.2.2 Warning Message Control</a>
<li><a href="#Debugging-and-Assertion-Control">3.2.3 Debugging and Assertion Control</a>
<li><a href="#Validity-Checking">3.2.4 Validity Checking</a>
<li><a href="#Style-Checking">3.2.5 Style Checking</a>
<li><a href="#Run_002dTime-Checks">3.2.6 Run-Time Checks</a>
<li><a href="#Using-gcc-for-Syntax-Checking">3.2.7 Using <samp><span class="command">gcc</span></samp> for Syntax Checking</a>
<li><a href="#Using-gcc-for-Semantic-Checking">3.2.8 Using <samp><span class="command">gcc</span></samp> for Semantic Checking</a>
<li><a href="#Compiling-Different-Versions-of-Ada">3.2.9 Compiling Different Versions of Ada</a>
<li><a href="#Character-Set-Control">3.2.10 Character Set Control</a>
<li><a href="#File-Naming-Control">3.2.11 File Naming Control</a>
<li><a href="#Subprogram-Inlining-Control">3.2.12 Subprogram Inlining Control</a>
<li><a href="#Auxiliary-Output-Control">3.2.13 Auxiliary Output Control</a>
<li><a href="#Debugging-Control">3.2.14 Debugging Control</a>
<li><a href="#Exception-Handling-Control">3.2.15 Exception Handling Control</a>
<li><a href="#Units-to-Sources-Mapping-Files">3.2.16 Units to Sources Mapping Files</a>
<li><a href="#Integrated-Preprocessing">3.2.17 Integrated Preprocessing</a>
<li><a href="#Code-Generation-Control">3.2.18 Code Generation Control</a>
</li></ul>
<li><a href="#Search-Paths-and-the-Run_002dTime-Library-_0028RTL_0029">3.3 Search Paths and the Run-Time Library (RTL)</a>
<li><a href="#Order-of-Compilation-Issues">3.4 Order of Compilation Issues</a>
<li><a href="#Examples">3.5 Examples</a>
</li></ul>
<li><a name="toc_Binding-Using-gnatbind" href="#Binding-Using-gnatbind">4 Binding Using <code>gnatbind</code></a>
<ul>
<li><a href="#Running-gnatbind">4.1 Running <code>gnatbind</code></a>
<li><a href="#Switches-for-gnatbind">4.2 Switches for <samp><span class="command">gnatbind</span></samp></a>
<ul>
<li><a href="#Consistency_002dChecking-Modes">4.2.1 Consistency-Checking Modes</a>
<li><a href="#Binder-Error-Message-Control">4.2.2 Binder Error Message Control</a>
<li><a href="#Elaboration-Control">4.2.3 Elaboration Control</a>
<li><a href="#Output-Control">4.2.4 Output Control</a>
<li><a href="#Dynamic-Allocation-Control">4.2.5 Dynamic Allocation Control</a>
<li><a href="#Binding-with-Non_002dAda-Main-Programs">4.2.6 Binding with Non-Ada Main Programs</a>
<li><a href="#Binding-Programs-with-No-Main-Subprogram">4.2.7 Binding Programs with No Main Subprogram</a>
</li></ul>
<li><a href="#Command_002dLine-Access">4.3 Command-Line Access</a>
<li><a href="#Search-Paths-for-gnatbind">4.4 Search Paths for <code>gnatbind</code></a>
<li><a href="#Examples-of-gnatbind-Usage">4.5 Examples of <code>gnatbind</code> Usage</a>
</li></ul>
<li><a name="toc_Linking-Using-gnatlink" href="#Linking-Using-gnatlink">5 Linking Using <samp><span class="command">gnatlink</span></samp></a>
<ul>
<li><a href="#Running-gnatlink">5.1 Running <samp><span class="command">gnatlink</span></samp></a>
<li><a href="#Switches-for-gnatlink">5.2 Switches for <samp><span class="command">gnatlink</span></samp></a>
</li></ul>
<li><a name="toc_The-GNAT-Make-Program-gnatmake" href="#The-GNAT-Make-Program-gnatmake">6 The GNAT Make Program <samp><span class="command">gnatmake</span></samp></a>
<ul>
<li><a href="#Running-gnatmake">6.1 Running <samp><span class="command">gnatmake</span></samp></a>
<li><a href="#Switches-for-gnatmake">6.2 Switches for <samp><span class="command">gnatmake</span></samp></a>
<li><a href="#Mode-Switches-for-gnatmake">6.3 Mode Switches for <samp><span class="command">gnatmake</span></samp></a>
<li><a href="#Notes-on-the-Command-Line">6.4 Notes on the Command Line</a>
<li><a href="#How-gnatmake-Works">6.5 How <samp><span class="command">gnatmake</span></samp> Works</a>
<li><a href="#Examples-of-gnatmake-Usage">6.6 Examples of <samp><span class="command">gnatmake</span></samp> Usage</a>
</li></ul>
<li><a name="toc_Improving-Performance" href="#Improving-Performance">7 Improving Performance</a>
<ul>
<li><a href="#Performance-Considerations">7.1 Performance Considerations</a>
<ul>
<li><a href="#Controlling-Run_002dTime-Checks">7.1.1 Controlling Run-Time Checks</a>
<li><a href="#Use-of-Restrictions">7.1.2 Use of Restrictions</a>
<li><a href="#Optimization-Levels">7.1.3 Optimization Levels</a>
<li><a href="#Debugging-Optimized-Code">7.1.4 Debugging Optimized Code</a>
<li><a href="#Inlining-of-Subprograms">7.1.5 Inlining of Subprograms</a>
<li><a href="#Other-Optimization-Switches">7.1.6 Other Optimization Switches</a>
<li><a href="#Optimization-and-Strict-Aliasing">7.1.7 Optimization and Strict Aliasing</a>
</li></ul>
<li><a href="#Text_005fIO-Suggestions">7.2 <code>Text_IO</code> Suggestions</a>
<li><a href="#Reducing-Size-of-Ada-Executables-with-gnatelim">7.3 Reducing Size of Ada Executables with <code>gnatelim</code></a>
<ul>
<li><a href="#About-gnatelim">7.3.1 About <code>gnatelim</code></a>
<li><a href="#Running-gnatelim">7.3.2 Running <code>gnatelim</code></a>
<li><a href="#Processing-Precompiled-Libraries">7.3.3 Processing Precompiled Libraries</a>
<li><a href="#Correcting-the-List-of-Eliminate-Pragmas">7.3.4 Correcting the List of Eliminate Pragmas</a>
<li><a href="#Making-Your-Executables-Smaller">7.3.5 Making Your Executables Smaller</a>
<li><a href="#Summary-of-the-gnatelim-Usage-Cycle">7.3.6 Summary of the <code>gnatelim</code> Usage Cycle</a>
</li></ul>
<li><a href="#Reducing-Size-of-Executables-with-unused-subprogram_002fdata-elimination">7.4 Reducing Size of Executables with Unused Subprogram/Data Elimination</a>
<ul>
<li><a href="#About-unused-subprogram_002fdata-elimination">7.4.1 About unused subprogram/data elimination</a>
<li><a href="#Compilation-options">7.4.2 Compilation options</a>
<li><a href="#Example-of-unused-subprogram_002fdata-elimination">7.4.3 Example of unused subprogram/data elimination</a>
</li></ul>
</li></ul>
<li><a name="toc_Renaming-Files-Using-gnatchop" href="#Renaming-Files-Using-gnatchop">8 Renaming Files Using <code>gnatchop</code></a>
<ul>
<li><a href="#Handling-Files-with-Multiple-Units">8.1 Handling Files with Multiple Units</a>
<li><a href="#Operating-gnatchop-in-Compilation-Mode">8.2 Operating gnatchop in Compilation Mode</a>
<li><a href="#Command-Line-for-gnatchop">8.3 Command Line for <code>gnatchop</code></a>
<li><a href="#Switches-for-gnatchop">8.4 Switches for <code>gnatchop</code></a>
<li><a href="#Examples-of-gnatchop-Usage">8.5 Examples of <code>gnatchop</code> Usage</a>
</li></ul>
<li><a name="toc_Configuration-Pragmas" href="#Configuration-Pragmas">9 Configuration Pragmas</a>
<ul>
<li><a href="#Handling-of-Configuration-Pragmas">9.1 Handling of Configuration Pragmas</a>
<li><a href="#The-Configuration-Pragmas-Files">9.2 The Configuration Pragmas Files</a>
</li></ul>
<li><a name="toc_Handling-Arbitrary-File-Naming-Conventions-Using-gnatname" href="#Handling-Arbitrary-File-Naming-Conventions-Using-gnatname">10 Handling Arbitrary File Naming Conventions Using <code>gnatname</code></a>
<ul>
<li><a href="#Arbitrary-File-Naming-Conventions">10.1 Arbitrary File Naming Conventions</a>
<li><a href="#Running-gnatname">10.2 Running <code>gnatname</code></a>
<li><a href="#Switches-for-gnatname">10.3 Switches for <code>gnatname</code></a>
<li><a href="#Examples-of-gnatname-Usage">10.4 Examples of <code>gnatname</code> Usage</a>
</li></ul>
<li><a name="toc_GNAT-Project-Manager" href="#GNAT-Project-Manager">11 GNAT Project Manager</a>
<ul>
<li><a href="#Introduction">11.1 Introduction</a>
<li><a href="#Building-With-Projects">11.2 Building With Projects</a>
<ul>
<li><a href="#Source-Files-and-Directories">11.2.1 Source Files and Directories</a>
<li><a href="#Object-and-Exec-Directory">11.2.2 Object and Exec Directory</a>
<li><a href="#Main-Subprograms">11.2.3 Main Subprograms</a>
<li><a href="#Tools-Options-in-Project-Files">11.2.4 Tools Options in Project Files</a>
<li><a href="#Compiling-with-Project-Files">11.2.5 Compiling with Project Files</a>
<li><a href="#Executable-File-Names">11.2.6 Executable File Names</a>
<li><a href="#Avoid-Duplication-With-Variables">11.2.7 Avoid Duplication With Variables</a>
<li><a href="#Naming-Schemes">11.2.8 Naming Schemes</a>
</li></ul>
<li><a href="#Organizing-Projects-into-Subsystems">11.3 Organizing Projects into Subsystems</a>
<ul>
<li><a href="#Project-Dependencies">11.3.1 Project Dependencies</a>
<li><a href="#Cyclic-Project-Dependencies">11.3.2 Cyclic Project Dependencies</a>
<li><a href="#Sharing-Between-Projects">11.3.3 Sharing Between Projects</a>
<li><a href="#Global-Attributes">11.3.4 Global Attributes</a>
</li></ul>
<li><a href="#Scenarios-in-Projects">11.4 Scenarios in Projects</a>
<li><a href="#Library-Projects">11.5 Library Projects</a>
<ul>
<li><a href="#Building-Libraries">11.5.1 Building Libraries</a>
<li><a href="#Using-Library-Projects">11.5.2 Using Library Projects</a>
<li><a href="#Stand_002dalone-Library-Projects">11.5.3 Stand-alone Library Projects</a>
<li><a href="#Installing-a-library-with-project-files">11.5.4 Installing a library with project files</a>
</li></ul>
<li><a href="#Project-Extension">11.6 Project Extension</a>
<ul>
<li><a href="#Project-Hierarchy-Extension">11.6.1 Project Hierarchy Extension</a>
</li></ul>
<li><a href="#Project-File-Reference">11.7 Project File Reference</a>
<ul>
<li><a href="#Project-Declaration">11.7.1 Project Declaration</a>
<li><a href="#Qualified-Projects">11.7.2 Qualified Projects</a>
<li><a href="#Declarations">11.7.3 Declarations</a>
<li><a href="#Packages">11.7.4 Packages</a>
<li><a href="#Expressions">11.7.5 Expressions</a>
<li><a href="#External-Values">11.7.6 External Values</a>
<li><a href="#Typed-String-Declaration">11.7.7 Typed String Declaration</a>
<li><a href="#Variables">11.7.8 Variables</a>
<li><a href="#Attributes">11.7.9 Attributes</a>
<li><a href="#Case-Statements">11.7.10 Case Statements</a>
</li></ul>
</li></ul>
<li><a name="toc_Tools-Supporting-Project-Files" href="#Tools-Supporting-Project-Files">12 Tools Supporting Project Files</a>
<ul>
<li><a href="#gnatmake-and-Project-Files">12.1 gnatmake and Project Files</a>
<ul>
<li><a href="#Switches-Related-to-Project-Files">12.1.1 Switches Related to Project Files</a>
<li><a href="#Switches-and-Project-Files">12.1.2 Switches and Project Files</a>
<li><a href="#Specifying-Configuration-Pragmas">12.1.3 Specifying Configuration Pragmas</a>
<li><a href="#Project-Files-and-Main-Subprograms">12.1.4 Project Files and Main Subprograms</a>
<li><a href="#Library-Project-Files">12.1.5 Library Project Files</a>
</li></ul>
<li><a href="#The-GNAT-Driver-and-Project-Files">12.2 The GNAT Driver and Project Files</a>
<li><a href="#The-Development-Environments">12.3 The Development Environments</a>
<li><a href="#Cleaning-up-with-GPRclean">12.4 Cleaning up with GPRclean</a>
<ul>
<li><a href="#Switches-for-GPRclean">12.4.1 Switches for GPRclean</a>
</li></ul>
</li></ul>
<li><a name="toc_The-Cross_002dReferencing-Tools-gnatxref-and-gnatfind" href="#The-Cross_002dReferencing-Tools-gnatxref-and-gnatfind">13 The Cross-Referencing Tools <code>gnatxref</code> and <code>gnatfind</code></a>
<ul>
<li><a href="#Switches-for-gnatxref">13.1 <code>gnatxref</code> Switches</a>
<li><a href="#Switches-for-gnatfind">13.2 <code>gnatfind</code> Switches</a>
<li><a href="#Project-Files-for-gnatxref-and-gnatfind">13.3 Project Files for <samp><span class="command">gnatxref</span></samp> and <samp><span class="command">gnatfind</span></samp></a>
<li><a href="#Regular-Expressions-in-gnatfind-and-gnatxref">13.4 Regular Expressions in <code>gnatfind</code> and <code>gnatxref</code></a>
<li><a href="#Examples-of-gnatxref-Usage">13.5 Examples of <code>gnatxref</code> Usage</a>
<ul>
<li><a href="#Examples-of-gnatxref-Usage">13.5.1 General Usage</a>
<li><a href="#Examples-of-gnatxref-Usage">13.5.2 Using gnatxref with vi</a>
</li></ul>
<li><a href="#Examples-of-gnatfind-Usage">13.6 Examples of <code>gnatfind</code> Usage</a>
</li></ul>
<li><a name="toc_The-GNAT-Pretty_002dPrinter-gnatpp" href="#The-GNAT-Pretty_002dPrinter-gnatpp">14 The GNAT Pretty-Printer <samp><span class="command">gnatpp</span></samp></a>
<ul>
<li><a href="#Switches-for-gnatpp">14.1 Switches for <samp><span class="command">gnatpp</span></samp></a>
<ul>
<li><a href="#Alignment-Control">14.1.1 Alignment Control</a>
<li><a href="#Casing-Control">14.1.2 Casing Control</a>
<li><a href="#Construct-Layout-Control">14.1.3 Construct Layout Control</a>
<li><a href="#General-Text-Layout-Control">14.1.4 General Text Layout Control</a>
<li><a href="#Other-Formatting-Options">14.1.5 Other Formatting Options</a>
<li><a href="#Setting-the-Source-Search-Path">14.1.6 Setting the Source Search Path</a>
<li><a href="#Output-File-Control">14.1.7 Output File Control</a>
<li><a href="#Other-gnatpp-Switches">14.1.8 Other <code>gnatpp</code> Switches</a>
</li></ul>
<li><a href="#Formatting-Rules">14.2 Formatting Rules</a>
<ul>
<li><a href="#White-Space-and-Empty-Lines">14.2.1 White Space and Empty Lines</a>
<li><a href="#Formatting-Comments">14.2.2 Formatting Comments</a>
<li><a href="#Construct-Layout">14.2.3 Construct Layout</a>
<li><a href="#Name-Casing">14.2.4 Name Casing</a>
</li></ul>
</li></ul>
<li><a name="toc_The-GNAT-Metric-Tool-gnatmetric" href="#The-GNAT-Metric-Tool-gnatmetric">15 The GNAT Metric Tool <samp><span class="command">gnatmetric</span></samp></a>
<ul>
<li><a href="#Switches-for-gnatmetric">15.1 Switches for <samp><span class="command">gnatmetric</span></samp></a>
<ul>
<li><a href="#Output-Files-Control">15.1.1 Output File Control</a>
<li><a href="#Disable-Metrics-For-Local-Units">15.1.2 Disable Metrics For Local Units</a>
<li><a href="#Specifying-a-set-of-metrics-to-compute">15.1.3 Specifying a set of metrics to compute</a>
<ul>
<li><a href="#Line-Metrics-Control">15.1.3.1 Line Metrics Control</a>
<li><a href="#Syntax-Metrics-Control">15.1.3.2 Syntax Metrics Control</a>
<li><a href="#Complexity-Metrics-Control">15.1.3.3 Complexity Metrics Control</a>
<li><a href="#Object_002dOriented-Metrics-Control">15.1.3.4 Object-Oriented Metrics Control</a>
</li></ul>
<li><a href="#Other-gnatmetric-Switches">15.1.4 Other <code>gnatmetric</code> Switches</a>
<li><a href="#Generate-project_002dwide-metrics">15.1.5 Generate project-wide metrics</a>
</li></ul>
</li></ul>
<li><a name="toc_File-Name-Krunching-Using-gnatkr" href="#File-Name-Krunching-Using-gnatkr">16 File Name Krunching Using <code>gnatkr</code></a>
<ul>
<li><a href="#About-gnatkr">16.1 About <code>gnatkr</code></a>
<li><a href="#Using-gnatkr">16.2 Using <code>gnatkr</code></a>
<li><a href="#Krunching-Method">16.3 Krunching Method</a>
<li><a href="#Examples-of-gnatkr-Usage">16.4 Examples of <code>gnatkr</code> Usage</a>
</li></ul>
<li><a name="toc_Preprocessing-Using-gnatprep" href="#Preprocessing-Using-gnatprep">17 Preprocessing Using <code>gnatprep</code></a>
<ul>
<li><a href="#Preprocessing-Symbols">17.1 Preprocessing Symbols</a>
<li><a href="#Using-gnatprep">17.2 Using <code>gnatprep</code></a>
<li><a href="#Switches-for-gnatprep">17.3 Switches for <code>gnatprep</code></a>
<li><a href="#Form-of-Definitions-File">17.4 Form of Definitions File</a>
<li><a href="#Form-of-Input-Text-for-gnatprep">17.5 Form of Input Text for <code>gnatprep</code></a>
</li></ul>
<li><a name="toc_The-GNAT-Library-Browser-gnatls" href="#The-GNAT-Library-Browser-gnatls">18 The GNAT Library Browser <code>gnatls</code></a>
<ul>
<li><a href="#Running-gnatls">18.1 Running <code>gnatls</code></a>
<li><a href="#Switches-for-gnatls">18.2 Switches for <code>gnatls</code></a>
<li><a href="#Examples-of-gnatls-Usage">18.3 Example of <code>gnatls</code> Usage</a>
</li></ul>
<li><a name="toc_Cleaning-Up-Using-gnatclean" href="#Cleaning-Up-Using-gnatclean">19 Cleaning Up Using <code>gnatclean</code></a>
<ul>
<li><a href="#Running-gnatclean">19.1 Running <code>gnatclean</code></a>
<li><a href="#Switches-for-gnatclean">19.2 Switches for <code>gnatclean</code></a>
</li></ul>
<li><a name="toc_GNAT-and-Libraries" href="#GNAT-and-Libraries">20 GNAT and Libraries</a>
<ul>
<li><a href="#Introduction-to-Libraries-in-GNAT">20.1 Introduction to Libraries in GNAT</a>
<li><a href="#General-Ada-Libraries">20.2 General Ada Libraries</a>
<ul>
<li><a href="#Building-a-library">20.2.1 Building a library</a>
<li><a href="#Installing-a-library">20.2.2 Installing a library</a>
<li><a href="#Using-a-library">20.2.3 Using a library</a>
</li></ul>
<li><a href="#Stand_002dalone-Ada-Libraries">20.3 Stand-alone Ada Libraries</a>
<ul>
<li><a href="#Introduction-to-Stand_002dalone-Libraries">20.3.1 Introduction to Stand-alone Libraries</a>
<li><a href="#Building-a-Stand_002dalone-Library">20.3.2 Building a Stand-alone Library</a>
<li><a href="#Creating-a-Stand_002dalone-Library-to-be-used-in-a-non_002dAda-context">20.3.3 Creating a Stand-alone Library to be used in a non-Ada context</a>
<li><a href="#Restrictions-in-Stand_002dalone-Libraries">20.3.4 Restrictions in Stand-alone Libraries</a>
</li></ul>
<li><a href="#Rebuilding-the-GNAT-Run_002dTime-Library">20.4 Rebuilding the GNAT Run-Time Library</a>
</li></ul>
<li><a name="toc_Using-the-GNU-make-Utility" href="#Using-the-GNU-make-Utility">21 Using the GNU <code>make</code> Utility</a>
<ul>
<li><a href="#Using-gnatmake-in-a-Makefile">21.1 Using gnatmake in a Makefile</a>
<li><a href="#Automatically-Creating-a-List-of-Directories">21.2 Automatically Creating a List of Directories</a>
<li><a href="#Generating-the-Command-Line-Switches">21.3 Generating the Command Line Switches</a>
<li><a href="#Overcoming-Command-Line-Length-Limits">21.4 Overcoming Command Line Length Limits</a>
</li></ul>
<li><a name="toc_Memory-Management-Issues" href="#Memory-Management-Issues">22 Memory Management Issues</a>
<ul>
<li><a href="#Some-Useful-Memory-Pools">22.1 Some Useful Memory Pools</a>
<li><a href="#The-GNAT-Debug-Pool-Facility">22.2 The GNAT Debug Pool Facility</a>
<li><a href="#The-gnatmem-Tool">22.3 The <samp><span class="command">gnatmem</span></samp> Tool</a>
<ul>
<li><a href="#Running-gnatmem">22.3.1 Running <code>gnatmem</code></a>
<li><a href="#Switches-for-gnatmem">22.3.2 Switches for <code>gnatmem</code></a>
<li><a href="#Example-of-gnatmem-Usage">22.3.3 Example of <code>gnatmem</code> Usage</a>
</li></ul>
</li></ul>
<li><a name="toc_Stack-Related-Facilities" href="#Stack-Related-Facilities">23 Stack Related Facilities</a>
<ul>
<li><a href="#Stack-Overflow-Checking">23.1 Stack Overflow Checking</a>
<li><a href="#Static-Stack-Usage-Analysis">23.2 Static Stack Usage Analysis</a>
<li><a href="#Dynamic-Stack-Usage-Analysis">23.3 Dynamic Stack Usage Analysis</a>
</li></ul>
<li><a name="toc_Verifying-Properties-Using-gnatcheck" href="#Verifying-Properties-Using-gnatcheck">24 Verifying Properties Using <samp><span class="command">gnatcheck</span></samp></a>
<li><a name="toc_Creating-Sample-Bodies-Using-gnatstub" href="#Creating-Sample-Bodies-Using-gnatstub">25 Creating Sample Bodies Using <samp><span class="command">gnatstub</span></samp></a>
<ul>
<li><a href="#Running-gnatstub">25.1 Running <samp><span class="command">gnatstub</span></samp></a>
<li><a href="#Switches-for-gnatstub">25.2 Switches for <samp><span class="command">gnatstub</span></samp></a>
</li></ul>
<li><a name="toc_Generating-Ada-Bindings-for-C-and-C_002b_002b-headers" href="#Generating-Ada-Bindings-for-C-and-C_002b_002b-headers">26 Generating Ada Bindings for C and C++ headers</a>
<ul>
<li><a href="#Running-the-binding-generator">26.1 Running the binding generator</a>
<li><a href="#Generating-bindings-for-C_002b_002b-headers">26.2 Generating bindings for C++ headers</a>
<li><a href="#Switches">26.3 Switches</a>
</li></ul>
<li><a name="toc_Other-Utility-Programs" href="#Other-Utility-Programs">27 Other Utility Programs</a>
<ul>
<li><a href="#Using-Other-Utility-Programs-with-GNAT">27.1 Using Other Utility Programs with GNAT</a>
<li><a href="#The-External-Symbol-Naming-Scheme-of-GNAT">27.2 The External Symbol Naming Scheme of GNAT</a>
<li><a href="#Converting-Ada-Files-to-html-with-gnathtml">27.3 Converting Ada Files to HTML with <code>gnathtml</code></a>
<li><a href="#Installing-gnathtml">27.4 Installing <code>gnathtml</code></a>
</li></ul>
<li><a name="toc_Code-Coverage-and-Profiling" href="#Code-Coverage-and-Profiling">28 Code Coverage and Profiling</a>
<ul>
<li><a href="#Code-Coverage-of-Ada-Programs-using-gcov">28.1 Code Coverage of Ada Programs using gcov</a>
<ul>
<li><a href="#Quick-startup-guide">28.1.1 Quick startup guide</a>
<li><a href="#Gnat-specifics">28.1.2 Gnat specifics</a>
</li></ul>
<li><a href="#Profiling-an-Ada-Program-using-gprof">28.2 Profiling an Ada Program using gprof</a>
<ul>
<li><a href="#Compilation-for-profiling">28.2.1 Compilation for profiling</a>
<li><a href="#Program-execution">28.2.2 Program execution</a>
<li><a href="#Running-gprof">28.2.3 Running gprof</a>
<li><a href="#Interpretation-of-profiling-results">28.2.4 Interpretation of profiling results</a>
</li></ul>
</li></ul>
<li><a name="toc_Running-and-Debugging-Ada-Programs" href="#Running-and-Debugging-Ada-Programs">29 Running and Debugging Ada Programs</a>
<ul>
<li><a href="#The-GNAT-Debugger-GDB">29.1 The GNAT Debugger GDB</a>
<li><a href="#Running-GDB">29.2 Running GDB</a>
<li><a href="#Introduction-to-GDB-Commands">29.3 Introduction to GDB Commands</a>
<li><a href="#Using-Ada-Expressions">29.4 Using Ada Expressions</a>
<li><a href="#Calling-User_002dDefined-Subprograms">29.5 Calling User-Defined Subprograms</a>
<li><a href="#Using-the-Next-Command-in-a-Function">29.6 Using the Next Command in a Function</a>
<li><a href="#Ada-Exceptions">29.7 Stopping when Ada Exceptions are Raised</a>
<li><a href="#Ada-Tasks">29.8 Ada Tasks</a>
<li><a href="#Debugging-Generic-Units">29.9 Debugging Generic Units</a>
<li><a href="#Remote-Debugging-using-gdbserver">29.10 Remote Debugging using gdbserver</a>
<li><a href="#GNAT-Abnormal-Termination-or-Failure-to-Terminate">29.11 GNAT Abnormal Termination or Failure to Terminate</a>
<li><a href="#Naming-Conventions-for-GNAT-Source-Files">29.12 Naming Conventions for GNAT Source Files</a>
<li><a href="#Getting-Internal-Debugging-Information">29.13 Getting Internal Debugging Information</a>
<li><a href="#Stack-Traceback">29.14 Stack Traceback</a>
<ul>
<li><a href="#Non_002dSymbolic-Traceback">29.14.1 Non-Symbolic Traceback</a>
<ul>
<li><a href="#Tracebacks-From-an-Unhandled-Exception">29.14.1.1 Tracebacks From an Unhandled Exception</a>
<li><a href="#Tracebacks-From-Exception-Occurrences-_0028non_002dsymbolic_0029">29.14.1.2 Tracebacks From Exception Occurrences</a>
<li><a href="#Tracebacks-From-Anywhere-in-a-Program-_0028non_002dsymbolic_0029">29.14.1.3 Tracebacks From Anywhere in a Program</a>
</li></ul>
<li><a href="#Symbolic-Traceback">29.14.2 Symbolic Traceback</a>
<ul>
<li><a href="#Tracebacks-From-Exception-Occurrences-_0028symbolic_0029">29.14.2.1 Tracebacks From Exception Occurrences</a>
<li><a href="#Tracebacks-From-Anywhere-in-a-Program-_0028symbolic_0029">29.14.2.2 Tracebacks From Anywhere in a Program</a>
</li></ul>
</li></ul>
</li></ul>
<li><a name="toc_Platform_002dSpecific-Information-for-the-Run_002dTime-Libraries" href="#Platform_002dSpecific-Information-for-the-Run_002dTime-Libraries">Appendix A Platform-Specific Information for the Run-Time Libraries</a>
<ul>
<li><a href="#Summary-of-Run_002dTime-Configurations">A.1 Summary of Run-Time Configurations</a>
<li><a href="#Specifying-a-Run_002dTime-Library">A.2 Specifying a Run-Time Library</a>
<li><a href="#Choosing-the-Scheduling-Policy">A.3 Choosing the Scheduling Policy</a>
<li><a href="#Solaris_002dSpecific-Considerations">A.4 Solaris-Specific Considerations</a>
<ul>
<li><a href="#Solaris-Threads-Issues">A.4.1 Solaris Threads Issues</a>
</li></ul>
<li><a href="#Linux_002dSpecific-Considerations">A.5 Linux-Specific Considerations</a>
<li><a href="#AIX_002dSpecific-Considerations">A.6 AIX-Specific Considerations</a>
<li><a href="#Irix_002dSpecific-Considerations">A.7 Irix-Specific Considerations</a>
<li><a href="#RTX_002dSpecific-Considerations">A.8 RTX-Specific Considerations</a>
<li><a href="#HP_002dUX_002dSpecific-Considerations">A.9 HP-UX-Specific Considerations</a>
</li></ul>
<li><a name="toc_Example-of-Binder-Output-File" href="#Example-of-Binder-Output-File">Appendix B Example of Binder Output File</a>
<li><a name="toc_Elaboration-Order-Handling-in-GNAT" href="#Elaboration-Order-Handling-in-GNAT">Appendix C Elaboration Order Handling in GNAT</a>
<ul>
<li><a href="#Elaboration-Code">C.1 Elaboration Code</a>
<li><a href="#Checking-the-Elaboration-Order">C.2 Checking the Elaboration Order</a>
<li><a href="#Controlling-the-Elaboration-Order">C.3 Controlling the Elaboration Order</a>
<li><a href="#Controlling-Elaboration-in-GNAT-_002d-Internal-Calls">C.4 Controlling Elaboration in GNAT - Internal Calls</a>
<li><a href="#Controlling-Elaboration-in-GNAT-_002d-External-Calls">C.5 Controlling Elaboration in GNAT - External Calls</a>
<li><a href="#Default-Behavior-in-GNAT-_002d-Ensuring-Safety">C.6 Default Behavior in GNAT - Ensuring Safety</a>
<li><a href="#Treatment-of-Pragma-Elaborate">C.7 Treatment of Pragma Elaborate</a>
<li><a href="#Elaboration-Issues-for-Library-Tasks">C.8 Elaboration Issues for Library Tasks</a>
<li><a href="#Mixing-Elaboration-Models">C.9 Mixing Elaboration Models</a>
<li><a href="#What-to-Do-If-the-Default-Elaboration-Behavior-Fails">C.10 What to Do If the Default Elaboration Behavior Fails</a>
<li><a href="#Elaboration-for-Access_002dto_002dSubprogram-Values">C.11 Elaboration for Access-to-Subprogram Values</a>
<li><a href="#Summary-of-Procedures-for-Elaboration-Control">C.12 Summary of Procedures for Elaboration Control</a>
<li><a href="#Other-Elaboration-Order-Considerations">C.13 Other Elaboration Order Considerations</a>
</li></ul>
<li><a name="toc_Conditional-Compilation" href="#Conditional-Compilation">Appendix D Conditional Compilation</a>
<ul>
<li><a href="#Use-of-Boolean-Constants">D.1 Use of Boolean Constants</a>
<li><a href="#Debugging-_002d-A-Special-Case">D.2 Debugging - A Special Case</a>
<li><a href="#Conditionalizing-Declarations">D.3 Conditionalizing Declarations</a>
<li><a href="#Use-of-Alternative-Implementations">D.4 Use of Alternative Implementations</a>
<li><a href="#Preprocessing">D.5 Preprocessing</a>
</li></ul>
<li><a name="toc_Inline-Assembler" href="#Inline-Assembler">Appendix E Inline Assembler</a>
<ul>
<li><a href="#Basic-Assembler-Syntax">E.1 Basic Assembler Syntax</a>
<li><a href="#A-Simple-Example-of-Inline-Assembler">E.2 A Simple Example of Inline Assembler</a>
<li><a href="#Output-Variables-in-Inline-Assembler">E.3 Output Variables in Inline Assembler</a>
<li><a href="#Input-Variables-in-Inline-Assembler">E.4 Input Variables in Inline Assembler</a>
<li><a href="#Inlining-Inline-Assembler-Code">E.5 Inlining Inline Assembler Code</a>
<li><a href="#Other-Asm-Functionality">E.6 Other <code>Asm</code> Functionality</a>
<ul>
<li><a href="#The-Clobber-Parameter">E.6.1 The <code>Clobber</code> Parameter</a>
<li><a href="#The-Volatile-Parameter">E.6.2 The <code>Volatile</code> Parameter</a>
</li></ul>
</li></ul>
<li><a name="toc_Compatibility-and-Porting-Guide" href="#Compatibility-and-Porting-Guide">Appendix F Compatibility and Porting Guide</a>
<ul>
<li><a href="#Compatibility-with-Ada-83">F.1 Compatibility with Ada 83</a>
<ul>
<li><a href="#Legal-Ada-83-programs-that-are-illegal-in-Ada-95">F.1.1 Legal Ada 83 programs that are illegal in Ada 95</a>
<li><a href="#More-deterministic-semantics">F.1.2 More deterministic semantics</a>
<li><a href="#Changed-semantics">F.1.3 Changed semantics</a>
<li><a href="#Other-language-compatibility-issues">F.1.4 Other language compatibility issues</a>
</li></ul>
<li><a href="#Compatibility-between-Ada-95-and-Ada-2005">F.2 Compatibility between Ada 95 and Ada 2005</a>
<li><a href="#Implementation_002ddependent-characteristics">F.3 Implementation-dependent characteristics</a>
<ul>
<li><a href="#Implementation_002ddefined-pragmas">F.3.1 Implementation-defined pragmas</a>
<li><a href="#Implementation_002ddefined-attributes">F.3.2 Implementation-defined attributes</a>
<li><a href="#Libraries">F.3.3 Libraries</a>
<li><a href="#Elaboration-order">F.3.4 Elaboration order</a>
<li><a href="#Target_002dspecific-aspects">F.3.5 Target-specific aspects</a>
</li></ul>
<li><a href="#Compatibility-with-Other-Ada-Systems">F.4 Compatibility with Other Ada Systems</a>
<li><a href="#Representation-Clauses">F.5 Representation Clauses</a>
<li><a href="#Compatibility-with-HP-Ada-83">F.6 Compatibility with HP Ada 83</a>
</li></ul>
<li><a name="toc_Microsoft-Windows-Topics" href="#Microsoft-Windows-Topics">Appendix G Microsoft Windows Topics</a>
<ul>
<li><a href="#Using-GNAT-on-Windows">G.1 Using GNAT on Windows</a>
<li><a href="#Using-a-network-installation-of-GNAT">G.2 Using a network installation of GNAT</a>
<li><a href="#CONSOLE-and-WINDOWS-subsystems">G.3 CONSOLE and WINDOWS subsystems</a>
<li><a href="#Temporary-Files">G.4 Temporary Files</a>
<li><a href="#Mixed_002dLanguage-Programming-on-Windows">G.5 Mixed-Language Programming on Windows</a>
<li><a href="#Windows-Calling-Conventions">G.6 Windows Calling Conventions</a>
<ul>
<li><a href="#C-Calling-Convention">G.6.1 <code>C</code> Calling Convention</a>
<li><a href="#Stdcall-Calling-Convention">G.6.2 <code>Stdcall</code> Calling Convention</a>
<li><a href="#Win32-Calling-Convention">G.6.3 <code>Win32</code> Calling Convention</a>
<li><a href="#DLL-Calling-Convention">G.6.4 <code>DLL</code> Calling Convention</a>
</li></ul>
<li><a href="#Introduction-to-Dynamic-Link-Libraries-_0028DLLs_0029">G.7 Introduction to Dynamic Link Libraries (DLLs)</a>
<li><a href="#Using-DLLs-with-GNAT">G.8 Using DLLs with GNAT</a>
<ul>
<li><a href="#Creating-an-Ada-Spec-for-the-DLL-Services">G.8.1 Creating an Ada Spec for the DLL Services</a>
<li><a href="#Creating-an-Import-Library">G.8.2 Creating an Import Library</a>
<ul>
<li><a href="#The-Definition-File">G.8.2.1 The Definition File</a>
<li><a href="#GNAT_002dStyle-Import-Library">G.8.2.2 GNAT-Style Import Library</a>
<li><a href="#Microsoft_002dStyle-Import-Library">G.8.2.3 Microsoft-Style Import Library</a>
</li></ul>
</li></ul>
<li><a href="#Building-DLLs-with-GNAT-Project-files">G.9 Building DLLs with GNAT Project files</a>
<li><a href="#Building-DLLs-with-GNAT">G.10 Building DLLs with GNAT</a>
<li><a href="#Building-DLLs-with-gnatdll">G.11 Building DLLs with gnatdll</a>
<ul>
<li><a href="#Limitations-When-Using-Ada-DLLs-from-Ada">G.11.1 Limitations When Using Ada DLLs from Ada</a>
<li><a href="#Exporting-Ada-Entities">G.11.2 Exporting Ada Entities</a>
<li><a href="#Ada-DLLs-and-Elaboration">G.11.3 Ada DLLs and Elaboration</a>
<li><a href="#Ada-DLLs-and-Finalization">G.11.4 Ada DLLs and Finalization</a>
<li><a href="#Creating-a-Spec-for-Ada-DLLs">G.11.5 Creating a Spec for Ada DLLs</a>
<li><a href="#Creating-the-Definition-File">G.11.6 Creating the Definition File</a>
<li><a href="#Using-gnatdll">G.11.7 Using <code>gnatdll</code></a>
<ul>
<li><a href="#gnatdll-Example">G.11.7.1 <code>gnatdll</code> Example</a>
<li><a href="#gnatdll-behind-the-Scenes">G.11.7.2 <code>gnatdll</code> behind the Scenes</a>
<li><a href="#Using-dlltool">G.11.7.3 Using <code>dlltool</code></a>
</li></ul>
</li></ul>
<li><a href="#GNAT-and-Windows-Resources">G.12 GNAT and Windows Resources</a>
<ul>
<li><a href="#Building-Resources">G.12.1 Building Resources</a>
<li><a href="#Compiling-Resources">G.12.2 Compiling Resources</a>
<li><a href="#Using-Resources">G.12.3 Using Resources</a>
</li></ul>
<li><a href="#Debugging-a-DLL">G.13 Debugging a DLL</a>
<ul>
<li><a href="#Program-and-DLL-Both-Built-with-GCC_002fGNAT">G.13.1 Program and DLL Both Built with GCC/GNAT</a>
<li><a href="#Program-Built-with-Foreign-Tools-and-DLL-Built-with-GCC_002fGNAT">G.13.2 Program Built with Foreign Tools and DLL Built with GCC/GNAT</a>
<ul>
<li><a href="#Debugging-the-DLL-Directly">G.13.2.1 Debugging the DLL Directly</a>
<li><a href="#Attaching-to-a-Running-Process">G.13.2.2 Attaching to a Running Process</a>
</li></ul>
</li></ul>
<li><a href="#Setting-Stack-Size-from-gnatlink">G.14 Setting Stack Size from <samp><span class="command">gnatlink</span></samp></a>
<li><a href="#Setting-Heap-Size-from-gnatlink">G.15 Setting Heap Size from <samp><span class="command">gnatlink</span></samp></a>
</li></ul>
<li><a name="toc_GNU-Free-Documentation-License" href="#GNU-Free-Documentation-License">GNU Free Documentation License</a>
<ul>
<li><a href="#GNU-Free-Documentation-License">ADDENDUM: How to use this License for your documents</a>
</li></ul>
<li><a name="toc_Index" href="#Index">Index</a>
</li></ul>
</div>
<!-- Put table of contents at end, otherwise it precedes the "title page" in -->
<!-- the .txt version -->
<!-- Edit the pdf file to move the contents to the beginning, after the title -->
<!-- page -->
<div class="footnote">
<hr>
<a name="texinfo-footnotes-in-document"></a><h4>Footnotes</h4><p class="footnote"><small>[<a name="fn-1" href="#fnd-1">1</a>]</small>
Most programs should experience a substantial speed improvement by
being compiled with a ZCX run-time.
This is especially true for
tasking applications or applications with many exception handlers.</p>
<hr></div>
</body></html>
|