/usr/share/doc/gnat-4.8-doc/gnat-style.html is in gnat-4.8-doc 4.8.2-8ubuntu3.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 1992-2012, AdaCore
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". -->
<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNAT Coding Style</title>
<meta name="description" content="GNAT Coding Style">
<meta name="keywords" content="GNAT Coding Style">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="#Top" rel="start" title="Top">
<link href="#Index" rel="index" title="Index">
<link href="#SEC_Contents" rel="contents" title="Table of Contents">
<link href="dir.html#Top" rel="up" title="(dir)">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<h1 class="settitle" align="center">GNAT Coding Style</h1>
<a name="Top"></a>
<div class="header">
<p>
Next: <a href="#General" accesskey="n" rel="next">General</a>, Up: <a href="dir.html#Top" accesskey="u" rel="up">(dir)</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<h1 class="node-heading">Top</h1>
<p>GNAT Coding Style<br>
A Guide for GNAT Developers
</p><br>
<br>
<p>GNAT, The GNU Ada Compiler<br>
</p>
<p>Copyright © 1992-2012, AdaCore
</p>
<p>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”.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#General" accesskey="1">General</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Lexical-Elements" accesskey="2">Lexical Elements</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Declarations-and-Types" accesskey="3">Declarations and Types</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Expressions-and-Names" accesskey="4">Expressions and Names</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Statements" accesskey="5">Statements</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Subprograms" accesskey="6">Subprograms</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Packages" accesskey="7">Packages</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Program-Structure" accesskey="8">Program Structure</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#GNU-Free-Documentation-License" accesskey="9">GNU Free Documentation License</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Index">Index</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="General"></a>
<div class="header">
<p>
Next: <a href="#Lexical-Elements" accesskey="n" rel="next">Lexical Elements</a>, Previous: <a href="#Top" accesskey="p" rel="prev">Top</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="General-1"></a>
<h2 class="chapter">1 General</h2>
<p>Most of GNAT is written in Ada using a consistent style to ensure
readability of the code. This document has been written to help
maintain this consistent style, while having a large group of developers
work on the compiler.
</p>
<p>For the coding style in the C parts of the compiler and run time,
see the GNU Coding Guidelines.
</p>
<p>This document is structured after the <cite>Ada Reference Manual</cite>.
Those familiar with that document should be able to quickly
lookup style rules for particular constructs.
</p>
<hr>
<a name="Lexical-Elements"></a>
<div class="header">
<p>
Next: <a href="#Declarations-and-Types" accesskey="n" rel="next">Declarations and Types</a>, Previous: <a href="#General" accesskey="p" rel="prev">General</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Lexical-Elements-1"></a>
<h2 class="chapter">2 Lexical Elements</h2>
<a name="index-Lexical-elements"></a>
<a name="Character-Set-and-Separators"></a>
<h3 class="section">2.1 Character Set and Separators</h3>
<a name="index-Character-set"></a>
<a name="index-ASCII"></a>
<a name="index-Separators"></a>
<a name="index-End_002dof_002dline"></a>
<a name="index-Line-length"></a>
<a name="index-Indentation"></a>
<ul>
<li> The character set used should be plain 7-bit ASCII.
The only separators allowed are space and the end-of-line sequence.
No other control character or format effector (such as <code>HT</code>,
<code>VT</code>, <code>FF</code>)
should be used.
The normal end-of-line sequence is used, which may be
<code>LF</code>, <code>CR/LF</code> or <code>CR</code>,
depending on the host system. An optional <code>SUB</code>
(<code>16#1A#</code>) may be present as the
last character in the file on hosts using that character as file terminator.
</li><li> Files that are checked in or distributed should be in host format.
</li><li> A line should never be longer than 79 characters, not counting the line
separator.
</li><li> Lines must not have trailing blanks.
</li><li> Indentation is 3 characters per level for <code>if</code> statements, loops, and
<code>case</code> statements.
For exact information on required spacing between lexical
elements, see file <samp>style.adb</samp>.
<a name="index-style_002eadb-file"></a>
</li></ul>
<a name="Identifiers"></a>
<h3 class="section">2.2 Identifiers</h3>
<ul>
<li><a name="index-Identifiers"></a>
</li><li> Identifiers will start with an upper case letter, and each letter following
an underscore will be upper case.
<a name="index-Casing-_0028for-identifiers_0029"></a>
Short acronyms may be all upper case.
All other letters are lower case.
An exception is for identifiers matching a foreign language. In particular,
we use all lower case where appropriate for C.
</li><li> Use underscores to separate words in an identifier.
<a name="index-Underscores"></a>
</li><li> Try to limit your use of abbreviations in identifiers.
It is ok to make a few abbreviations, explain what they mean, and then
use them frequently, but don’t use lots of obscure abbreviations. An
example is the <code>ALI</code> word which stands for Ada Library
Information and is by convention always written in upper-case when
used in entity names.
<div class="smallexample">
<pre class="smallexample"> procedure Find_ALI_Files;
</pre></div>
</li><li> Don’t use the variable name <code>I</code>, use <code>J</code> instead; <code>I</code> is too
easily confused with <code>1</code> in some fonts. Similarly don’t use the
variable <code>O</code>, which is too easily mistaken for the number <code>0</code>.
</li></ul>
<a name="Numeric-Literals"></a>
<h3 class="section">2.3 Numeric Literals</h3>
<a name="index-Numeric-literals"></a>
<ul>
<li> Numeric literals should include underscores where helpful for
readability.
<a name="index-Underscores-1"></a>
<div class="smallexample">
<pre class="smallexample"> 1_000_000
16#8000_0000#
3.14159_26535_89793_23846
</pre></div>
</li></ul>
<a name="Reserved-Words"></a>
<h3 class="section">2.4 Reserved Words</h3>
<a name="index-Reserved-words"></a>
<ul>
<li> Reserved words use all lower case.
<a name="index-Casing-_0028for-reserved-words_0029"></a>
<div class="smallexample">
<pre class="smallexample"> return else
</pre></div>
</li><li> The words <code>Access</code>, <code>Delta</code> and <code>Digits</code> are
capitalized when used as <tt>attribute_designator</tt>.
</li></ul>
<a name="Comments"></a>
<h3 class="section">2.5 Comments</h3>
<a name="index-Comments"></a>
<ul>
<li> A comment starts with <code>--</code> followed by two spaces.
The only exception to this rule (i.e. one space is tolerated) is when the
comment ends with a single space followed by <code>--</code>.
It is also acceptable to have only one space between <code>--</code> and the start
of the comment when the comment is at the end of a line,
after some Ada code.
</li><li> Every sentence in a comment should start with an upper-case letter (including
the first letter of the comment).
<a name="index-Casing-_0028in-comments_0029"></a>
</li><li> When declarations are commented with “hanging” comments, i.e.
comments after the declaration, there is no blank line before the
comment, and if it is absolutely necessary to have blank lines within
the comments, e.g. to make paragraph separations within a single comment,
these blank lines <em>do</em> have a <code>--</code> (unlike the
normal rule, which is to use entirely blank lines for separating
comment paragraphs). The comment starts at same level of indentation
as code it is commenting.
<a name="index-Blank-lines-_0028in-comments_0029"></a>
<a name="index-Indentation-1"></a>
<div class="smallexample">
<pre class="smallexample"> z : Integer;
-- Integer value for storing value of z
--
-- The previous line was a blank line.
</pre></div>
</li><li> Comments that are dubious or incomplete, or that comment on possibly
wrong or incomplete code, should be preceded or followed by <code>???</code>.
</li><li> Comments in a subprogram body must generally be surrounded by blank lines.
An exception is a comment that follows a line containing a single keyword
(<code>begin</code>, <code>else</code>, <code>loop</code>):
<div class="smallexample">
<pre class="smallexample"> begin
-- Comment for the next statement
A := 5;
-- Comment for the B statement
B := 6;
end;
</pre></div>
</li><li> In sequences of statements, comments at the end of the lines should be
aligned.
<a name="index-Alignment-_0028in-comments_0029"></a>
<div class="smallexample">
<pre class="smallexample"> My_Identifier := 5; -- First comment
Other_Id := 6; -- Second comment
</pre></div>
</li><li> Short comments that fit on a single line are <em>not</em> ended with a
period. Comments taking more than a line are punctuated in the normal
manner.
</li><li> Comments should focus on <em>why</em> instead of <em>what</em>.
Descriptions of what subprograms do go with the specification.
</li><li> Comments describing a subprogram spec should specifically mention the
formal argument names. General rule: write a comment that does not
depend on the names of things. The names are supplementary, not
sufficient, as comments.
</li><li> <em>Do not</em> put two spaces after periods in comments.
</li></ul>
<hr>
<a name="Declarations-and-Types"></a>
<div class="header">
<p>
Next: <a href="#Expressions-and-Names" accesskey="n" rel="next">Expressions and Names</a>, Previous: <a href="#Lexical-Elements" accesskey="p" rel="prev">Lexical Elements</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Declarations-and-Types-1"></a>
<h2 class="chapter">3 Declarations and Types</h2>
<a name="index-Declarations-and-Types"></a>
<ul>
<li> In entity declarations, colons must be surrounded by spaces. Colons
should be aligned.
<a name="index-Alignment-_0028in-declarations_0029"></a>
<div class="smallexample">
<pre class="smallexample"> Entity1 : Integer;
My_Entity : Integer;
</pre></div>
</li><li> Declarations should be grouped in a logical order.
Related groups of declarations may be preceded by a header comment.
</li><li> All local subprograms in a subprogram or package body should be declared
before the first local subprogram body.
</li><li> Do not declare local entities that hide global entities.
<a name="index-Hiding-of-outer-entities"></a>
</li><li> Do not declare multiple variables in one declaration that spans lines.
Start a new declaration on each line, instead.
</li><li> The <tt>defining_identifier</tt>s of global declarations serve as
comments of a sort. So don’t choose terse names, but look for names
that give useful information instead.
</li><li> Local names can be shorter, because they are used only within
one context, where comments explain their purpose.
</li><li> When starting an initialization or default expression on the line that follows
the declaration line, use 2 characters for indentation.
<div class="smallexample">
<pre class="smallexample"> Entity1 : Integer :=
Function_Name (Parameters, For_Call);
</pre></div>
</li><li> If an initialization or default expression needs to be continued on subsequent
lines, the continuations should be indented from the start of the expression.
<div class="smallexample">
<pre class="smallexample"> Entity1 : Integer := Long_Function_Name
(parameters for call);
</pre></div>
</li></ul>
<hr>
<a name="Expressions-and-Names"></a>
<div class="header">
<p>
Next: <a href="#Statements" accesskey="n" rel="next">Statements</a>, Previous: <a href="#Declarations-and-Types" accesskey="p" rel="prev">Declarations and Types</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Expressions-and-Names-1"></a>
<h2 class="chapter">4 Expressions and Names</h2>
<a name="index-Expressions-and-names"></a>
<ul>
<li> Every operator must be surrounded by spaces. An exception is that
this rule does not apply to the exponentiation operator, for which
there are no specific layout rules. The reason for this exception
is that sometimes it makes clearer reading to leave out the spaces
around exponentiation.
<a name="index-Operators"></a>
<div class="smallexample">
<pre class="smallexample"> E := A * B**2 + 3 * (C - D);
</pre></div>
</li><li> Use parentheses where they clarify the intended association of operands
with operators:
<a name="index-Parenthesization-of-expressions"></a>
<div class="smallexample">
<pre class="smallexample"> (A / B) * C
</pre></div>
</li></ul>
<hr>
<a name="Statements"></a>
<div class="header">
<p>
Next: <a href="#Subprograms" accesskey="n" rel="next">Subprograms</a>, Previous: <a href="#Expressions-and-Names" accesskey="p" rel="prev">Expressions and Names</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Statements-1"></a>
<h2 class="chapter">5 Statements</h2>
<a name="index-Statements"></a>
<a name="Simple-and-Compound-Statements"></a>
<h3 class="section">5.1 Simple and Compound Statements</h3>
<a name="index-Simple-and-compound-statements"></a>
<ul>
<li> Use only one statement or label per line.
</li><li> A longer <tt>sequence_of_statements</tt> may be divided in logical
groups or separated from surrounding code using a blank line.
</li></ul>
<a name="If-Statements"></a>
<h3 class="section">5.2 If Statements</h3>
<a name="index-if-statement"></a>
<ul>
<li> When the <code>if</code>, <code>elsif</code> or <code>else</code> keywords fit on the
same line with the condition and the <code>then</code> keyword, then the
statement is formatted as follows:
<a name="index-Alignment-_0028in-an-if-statement_0029"></a>
<div class="smallexample">
<pre class="smallexample"> if <var>condition</var> then
...
elsif <var>condition</var> then
...
else
...
end if;
</pre></div>
<p>When the above layout is not possible, <code>then</code> should be aligned
with <code>if</code>, and conditions should preferably be split before an
<code>and</code> or <code>or</code> keyword a follows:
</p>
<div class="smallexample">
<pre class="smallexample"> if <var>long_condition_that_has_to_be_split</var>
and then <var>continued_on_the_next_line</var>
then
...
end if;
</pre></div>
<p>The <code>elsif</code>, <code>else</code> and <code>end if</code> always line up with
the <code>if</code> keyword. The preferred location for splitting the line
is before <code>and</code> or <code>or</code>. The continuation of a condition is
indented with two spaces or as many as needed to make nesting clear.
As an exception, if conditions are closely related either of the
following is allowed:
</p>
<div class="smallexample">
<pre class="smallexample"> if x = lakdsjfhlkashfdlkflkdsalkhfsalkdhflkjdsahf
or else
x = asldkjhalkdsjfhhfd
or else
x = asdfadsfadsf
then
...
end if;
</pre><pre class="smallexample">
</pre><pre class="smallexample"> if x = lakdsjfhlkashfdlkflkdsalkhfsalkdhflkjdsahf or else
x = asldkjhalkdsjfhhfd or else
x = asdfadsfadsf
then
...
end if;
</pre></div>
</li><li> Conditions should use short-circuit forms (<code>and then</code>,
<code>or else</code>), except when the operands are boolean variables
or boolean constants.
<a name="index-Short_002dcircuit-forms"></a>
</li><li> Complex conditions in <code>if</code> statements are indented two characters:
<a name="index-Indentation-_0028in-if-statements_0029"></a>
<div class="smallexample">
<pre class="smallexample"> if <var>this_complex_condition</var>
and then <var>that_other_one</var>
and then <var>one_last_one</var>
then
...
end if;
</pre></div>
<p>There are some cases where complex conditionals can be laid out
in manners that do not follow these rules to preserve better
parallelism between branches, e.g.
</p>
<div class="smallexample">
<pre class="smallexample"> if xyz.abc (gef) = 'c'
or else
xyz.abc (gef) = 'x'
then
...
end if;
</pre></div>
</li><li> Every <code>if</code> block is preceded and followed by a blank line, except
where it begins or ends a <tt>sequence_of_statements</tt>.
<a name="index-Blank-lines-_0028in-an-if-statement_0029"></a>
<div class="smallexample">
<pre class="smallexample"> A := 5;
if A = 5 then
null;
end if;
A := 6;
</pre></div>
</li></ul>
<a name="Case-Statements"></a>
<h3 class="section">5.3 Case Statements</h3>
<a name="index-case-statements"></a>
<ul>
<li> Layout is as below. For long <code>case</code> statements, the extra indentation
can be saved by aligning the <code>when</code> clauses with the opening <code>case</code>.
<div class="smallexample">
<pre class="smallexample"> case <var>expression</var> is
when <var>condition</var> =>
...
when <var>condition</var> =>
...
end case;
</pre></div>
</li></ul>
<a name="Loop-Statements"></a>
<h3 class="section">5.4 Loop Statements</h3>
<a name="index-Loop-statements"></a>
<ul>
<li>When possible, have <code>for</code> or <code>while</code> on one line with the
condition and the <code>loop</code> keyword.
<div class="smallexample">
<pre class="smallexample"> for J in S'Range loop
...
end loop;
</pre></div>
<p>If the condition is too long, split the condition (see “If
statements” above) and align <code>loop</code> with the <code>for</code> or
<code>while</code> keyword.
<a name="index-Alignment-_0028in-a-loop-statement_0029"></a>
</p>
<div class="smallexample">
<pre class="smallexample"> while <var>long_condition_that_has_to_be_split</var>
and then <var>continued_on_the_next_line</var>
loop
...
end loop;
</pre></div>
<p>If the <tt>loop_statement</tt> has an identifier, it is laid out as follows:
</p>
<div class="smallexample">
<pre class="smallexample"> Outer : while not <var>condition</var> loop
...
end Outer;
</pre></div>
</li></ul>
<a name="Block-Statements"></a>
<h3 class="section">5.5 Block Statements</h3>
<a name="index-Block-statement"></a>
<ul>
<li> The <code>declare</code> (optional), <code>begin</code> and <code>end</code> words
are aligned, except when the <tt>block_statement</tt> is named. There
is a blank line before the <code>begin</code> keyword:
<a name="index-Alignment-_0028in-a-block-statement_0029"></a>
<div class="smallexample">
<pre class="smallexample"> Some_Block : declare
...
begin
...
end Some_Block;
</pre></div>
</li></ul>
<hr>
<a name="Subprograms"></a>
<div class="header">
<p>
Next: <a href="#Packages" accesskey="n" rel="next">Packages</a>, Previous: <a href="#Statements" accesskey="p" rel="prev">Statements</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Subprograms-1"></a>
<h2 class="chapter">6 Subprograms</h2>
<a name="index-Subprograms"></a>
<a name="Subprogram-Declarations"></a>
<h3 class="section">6.1 Subprogram Declarations</h3>
<ul>
<li> Do not write the <code>in</code> for parameters.
<div class="smallexample">
<pre class="smallexample"> function Length (S : String) return Integer;
</pre></div>
</li><li> When the declaration line for a procedure or a function is too long to fit
the entire declaration (including the keyword procedure or function) on a
single line, then fold it, putting a single parameter on a line, aligning
the colons, as in:
<div class="smallexample">
<pre class="smallexample"> procedure Set_Heading
(Source : String;
Count : Natural;
Pad : Character := Space;
Fill : Boolean := True);
</pre></div>
<p>In the case of a function, if the entire spec does not fit on one line, then
the return may appear after the last parameter, as in:
</p>
<div class="smallexample">
<pre class="smallexample"> function Head
(Source : String;
Count : Natural;
Pad : Character := Space) return String;
</pre></div>
<p>Or it may appear on its own as a separate line. This form is preferred when
putting the return on the same line as the last parameter would result in
an overlong line. The return type may optionally be aligned with the types
of the parameters (usually we do this aligning if it results only in a small
number of extra spaces, and otherwise we don’t attempt to align). So two
alternative forms for the above spec are:
</p>
<div class="smallexample">
<pre class="smallexample"> function Head
(Source : String;
Count : Natural;
Pad : Character := Space)
return String;
function Head
(Source : String;
Count : Natural;
Pad : Character := Space)
return String;
</pre></div>
</li></ul>
<a name="Subprogram-Bodies"></a>
<h3 class="section">6.2 Subprogram Bodies</h3>
<a name="index-Subprogram-bodies"></a>
<ul>
<li> Function and procedure bodies should usually be sorted alphabetically. Do
not attempt to sort them in some logical order by functionality. For a
sequence of subprogram specs, a general alphabetical sorting is also
usually appropriate, but occasionally it makes sense to group by major
function, with appropriate headers.
</li><li> All subprograms have a header giving the function name, with the following
format:
<div class="smallexample">
<pre class="smallexample"> -----------------
-- My_Function --
-----------------
procedure My_Function is
begin
...
end My_Function;
</pre></div>
<p>Note that the name in the header is preceded by a single space,
not two spaces as for other comments. These headers are used on
nested subprograms as well as outer level subprograms. They may
also be used as headers for sections of comments, or collections
of declarations that are related.
</p>
</li><li> Every subprogram body must have a preceding <tt>subprogram_declaration</tt>,
which includes proper client documentation so that you do not need to
read the subprogram body in order to understand what the subprogram does and
how to call it. All subprograms should be documented, without exceptions.
</li><li> <a name="index-Blank-lines-_0028in-subprogram-bodies_0029"></a>
A sequence of declarations may optionally be separated from the following
begin by a blank line. Just as we optionally allow blank lines in general
between declarations, this blank line should be present only if it improves
readability. Generally we avoid this blank line if the declarative part is
small (one or two lines) and the body has no blank lines, and we include it
if the declarative part is long or if the body has blank lines.
</li><li> If the declarations in a subprogram contain at least one nested
subprogram body, then just before the <code>begin</code> of the enclosing
subprogram, there is a comment line and a blank line:
<div class="smallexample">
<pre class="smallexample"> -- Start of processing for <var>Enclosing_Subprogram</var>
begin
...
end <var>Enclosing_Subprogram</var>;
</pre></div>
</li><li> When nested subprograms are present, variables that are referenced by any
nested subprogram should precede the nested subprogram specs. For variables
that are not referenced by nested procedures, the declarations can either also
be before any of the nested subprogram specs (this is the old style, more
generally used). Or then can come just before the begin, with a header. The
following example shows the two possible styles:
<div class="smallexample">
<pre class="smallexample"> procedure Style1 is
Var_Referenced_In_Nested : Integer;
Var_Referenced_Only_In_Style1 : Integer;
proc Nested;
-- Comments ...
------------
-- Nested --
------------
procedure Nested is
begin
...
end Nested;
-- Start of processing for Style1
begin
...
end Style1;
</pre><pre class="smallexample">
</pre><pre class="smallexample"> procedure Style2 is
Var_Referenced_In_Nested : Integer;
proc Nested;
-- Comments ...
------------
-- Nested --
------------
procedure Nested is
begin
...
end Nested;
-- Local variables
Var_Referenced_Only_In_Style2 : Integer;
-- Start of processing for Style2
begin
...
end Style2;
</pre></div>
<p>For new code, we generally prefer Style2, but we do not insist on
modifying all legacy occurrences of Style1, which is still much
more common in the sources.
</p>
</li></ul>
<hr>
<a name="Packages"></a>
<div class="header">
<p>
Next: <a href="#Program-Structure" accesskey="n" rel="next">Program Structure</a>, Previous: <a href="#Subprograms" accesskey="p" rel="prev">Subprograms</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Packages-and-Visibility-Rules"></a>
<h2 class="chapter">7 Packages and Visibility Rules</h2>
<a name="index-Packages"></a>
<ul>
<li> All program units and subprograms have their name at the end:
<div class="smallexample">
<pre class="smallexample"> package P is
...
end P;
</pre></div>
</li><li> We will use the style of <code>use</code>-ing <code>with</code>-ed packages, with
the context clauses looking like:
<a name="index-use-clauses"></a>
<div class="smallexample">
<pre class="smallexample"> with A; use A;
with B; use B;
</pre></div>
</li><li> Names declared in the visible part of packages should be
unique, to prevent name clashes when the packages are <code>use</code>d.
<a name="index-Name-clash-avoidance"></a>
<div class="smallexample">
<pre class="smallexample"> package Entity is
type Entity_Kind is ...;
...
end Entity;
</pre></div>
</li><li> After the file header comment, the context clause and unit specification
should be the first thing in a <tt>program_unit</tt>.
</li><li> Preelaborate, Pure and Elaborate_Body pragmas should be added right after the
package name, indented an extra level and using the parameterless form:
<div class="smallexample">
<pre class="smallexample"> package Preelaborate_Package is
pragma Preelaborate;
...
end Preelaborate_Package;
</pre></div>
</li></ul>
<hr>
<a name="Program-Structure"></a>
<div class="header">
<p>
Next: <a href="#GNU-Free-Documentation-License" accesskey="n" rel="next">GNU Free Documentation License</a>, Previous: <a href="#Packages" accesskey="p" rel="prev">Packages</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Program-Structure-and-Compilation-Issues"></a>
<h2 class="chapter">8 Program Structure and Compilation Issues</h2>
<a name="index-Program-structure"></a>
<ul>
<li> Every GNAT source file must be compiled with the <samp>-gnatg</samp>
switch to check the coding style.
(Note that you should look at
<samp>style.adb</samp> to see the lexical rules enforced by
<samp>-gnatg</samp>).
<a name="index-_002dgnatg-option-_0028to-gcc_0029"></a>
<a name="index-style_002eadb-file-1"></a>
</li><li> Each source file should contain only one compilation unit.
</li><li> Filenames should be 8 or fewer characters, followed by the <code>.adb</code>
extension for a body or <code>.ads</code> for a spec.
<a name="index-File-name-length"></a>
</li><li> Unit names should be distinct when “krunch”ed to 8 characters
(see <samp>krunch.ads</samp>) and the filenames should match the unit name,
except that they are all lower case.
<a name="index-krunch_002eads-file"></a>
</li></ul>
<hr>
<a name="GNU-Free-Documentation-License"></a>
<div class="header">
<p>
Next: <a href="#Index" accesskey="n" rel="next">Index</a>, Previous: <a href="#Program-Structure" accesskey="p" rel="prev">Program Structure</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="GNU-Free-Documentation-License-1"></a>
<h2 class="unnumbered">GNU Free Documentation License</h2>
<a name="index-FDL_002c-GNU-Free-Documentation-License"></a>
<div align="center">Version 1.3, 3 November 2008
</div>
<div class="display">
<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></div>
<ol>
<li> PREAMBLE
<p>The purpose of this License is to make a manual, textbook, or other
functional and useful document <em>free</em> 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>
<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>
<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.
</p>
</li><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>
<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>
<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>
<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>
<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>
<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>
<p>Examples of suitable formats for Transparent copies include plain
<small>ASCII</small> 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>
<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>
<p>The “publisher” means any person or entity that distributes copies
of the Document to the public.
</p>
<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>
<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.
</p>
</li><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>
<p>You may also lend copies, under the same conditions stated above, and
you may publicly display copies.
</p>
</li><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>
<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>
<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>
<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.
</p>
</li><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:
</p>
<ol>
<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><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><li> State on the Title page the name of the publisher of the
Modified Version, as the publisher.
</li><li> Preserve all the copyright notices of the Document.
</li><li> Add an appropriate copyright notice for your modifications
adjacent to the other copyright notices.
</li><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><li> Preserve in that license notice the full lists of Invariant Sections
and required Cover Texts given in the Document’s license notice.
</li><li> Include an unaltered copy of this License.
</li><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><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><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><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><li> Delete any section Entitled “Endorsements”. Such a section
may not be included in the Modified Version.
</li><li> Do not retitle any existing section to be Entitled “Endorsements” or
to conflict in title with any Invariant Section.
</li><li> Preserve any Warranty Disclaimers.
</li></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>
<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>
<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>
<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.
</p>
</li><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>
<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>
<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.”
</p>
</li><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>
<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.
</p>
</li><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>
<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.
</p>
</li><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>
<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.
</p>
</li><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>
<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>
<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>
<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.
</p>
</li><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>
<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.
</p>
</li><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>
<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>
<p>“Incorporate” means to publish or republish a Document, in whole or
in part, as part of another Document.
</p>
<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>
<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.
</p>
</li></ol>
<a name="ADDENDUM_003a-How-to-use-this-License-for-your-documents"></a>
<h2 class="unnumbered">ADDENDUM: How to use this License for your documents</h2>
<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:
</p>
<div class="smallexample">
<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></div>
<p>If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
replace the “with...Texts.” line with this:
</p>
<div class="smallexample">
<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></div>
<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>
<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.
</p>
<a name="index-GNU-Free-Documentation-License"></a>
<hr>
<a name="Index"></a>
<div class="header">
<p>
Previous: <a href="#GNU-Free-Documentation-License" accesskey="p" rel="prev">GNU Free Documentation License</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Index-1"></a>
<h2 class="unnumbered">Index</h2>
<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter" href="#Index_cp_symbol-1"><b>-</b></a>
<br>
<a class="summary-letter" href="#Index_cp_letter-A"><b>A</b></a>
<a class="summary-letter" href="#Index_cp_letter-B"><b>B</b></a>
<a class="summary-letter" href="#Index_cp_letter-C"><b>C</b></a>
<a class="summary-letter" href="#Index_cp_letter-D"><b>D</b></a>
<a class="summary-letter" href="#Index_cp_letter-E"><b>E</b></a>
<a class="summary-letter" href="#Index_cp_letter-F"><b>F</b></a>
<a class="summary-letter" href="#Index_cp_letter-G"><b>G</b></a>
<a class="summary-letter" href="#Index_cp_letter-H"><b>H</b></a>
<a class="summary-letter" href="#Index_cp_letter-I"><b>I</b></a>
<a class="summary-letter" href="#Index_cp_letter-K"><b>K</b></a>
<a class="summary-letter" href="#Index_cp_letter-L"><b>L</b></a>
<a class="summary-letter" href="#Index_cp_letter-N"><b>N</b></a>
<a class="summary-letter" href="#Index_cp_letter-O"><b>O</b></a>
<a class="summary-letter" href="#Index_cp_letter-P"><b>P</b></a>
<a class="summary-letter" href="#Index_cp_letter-R"><b>R</b></a>
<a class="summary-letter" href="#Index_cp_letter-S"><b>S</b></a>
<a class="summary-letter" href="#Index_cp_letter-U"><b>U</b></a>
</td></tr></table>
<table class="index-cp" border="0">
<tr><td></td><th align="left">Index Entry</th><td> </td><th align="left"> Section</th></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_symbol-1">-</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002dgnatg-option-_0028to-gcc_0029"><samp>-gnatg</samp> option (to gcc)</a>:</td><td> </td><td valign="top"><a href="#Program-Structure">Program Structure</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-A">A</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Alignment-_0028in-a-block-statement_0029">Alignment (in a block statement)</a>:</td><td> </td><td valign="top"><a href="#Statements">Statements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Alignment-_0028in-a-loop-statement_0029">Alignment (in a loop statement)</a>:</td><td> </td><td valign="top"><a href="#Statements">Statements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Alignment-_0028in-an-if-statement_0029">Alignment (in an <code>if</code> statement)</a>:</td><td> </td><td valign="top"><a href="#Statements">Statements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Alignment-_0028in-comments_0029">Alignment (in comments)</a>:</td><td> </td><td valign="top"><a href="#Lexical-Elements">Lexical Elements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Alignment-_0028in-declarations_0029">Alignment (in declarations)</a>:</td><td> </td><td valign="top"><a href="#Declarations-and-Types">Declarations and Types</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ASCII">ASCII</a>:</td><td> </td><td valign="top"><a href="#Lexical-Elements">Lexical Elements</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-B">B</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Blank-lines-_0028in-an-if-statement_0029">Blank lines (in an <code>if</code> statement)</a>:</td><td> </td><td valign="top"><a href="#Statements">Statements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Blank-lines-_0028in-comments_0029">Blank lines (in comments)</a>:</td><td> </td><td valign="top"><a href="#Lexical-Elements">Lexical Elements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Blank-lines-_0028in-subprogram-bodies_0029">Blank lines (in subprogram bodies)</a>:</td><td> </td><td valign="top"><a href="#Subprograms">Subprograms</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Block-statement">Block statement</a>:</td><td> </td><td valign="top"><a href="#Statements">Statements</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-C">C</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-case-statements"><code>case</code> statements</a>:</td><td> </td><td valign="top"><a href="#Statements">Statements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Casing-_0028for-identifiers_0029">Casing (for identifiers)</a>:</td><td> </td><td valign="top"><a href="#Lexical-Elements">Lexical Elements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Casing-_0028for-reserved-words_0029">Casing (for reserved words)</a>:</td><td> </td><td valign="top"><a href="#Lexical-Elements">Lexical Elements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Casing-_0028in-comments_0029">Casing (in comments)</a>:</td><td> </td><td valign="top"><a href="#Lexical-Elements">Lexical Elements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Character-set">Character set</a>:</td><td> </td><td valign="top"><a href="#Lexical-Elements">Lexical Elements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Comments">Comments</a>:</td><td> </td><td valign="top"><a href="#Lexical-Elements">Lexical Elements</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-D">D</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Declarations-and-Types">Declarations and Types</a>:</td><td> </td><td valign="top"><a href="#Declarations-and-Types">Declarations and Types</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-E">E</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-End_002dof_002dline">End-of-line</a>:</td><td> </td><td valign="top"><a href="#Lexical-Elements">Lexical Elements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Expressions-and-names">Expressions and names</a>:</td><td> </td><td valign="top"><a href="#Expressions-and-Names">Expressions and Names</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-F">F</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-FDL_002c-GNU-Free-Documentation-License">FDL, GNU Free Documentation License</a>:</td><td> </td><td valign="top"><a href="#GNU-Free-Documentation-License">GNU Free Documentation License</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-File-name-length">File name length</a>:</td><td> </td><td valign="top"><a href="#Program-Structure">Program Structure</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-G">G</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-GNU-Free-Documentation-License">GNU Free Documentation License</a>:</td><td> </td><td valign="top"><a href="#GNU-Free-Documentation-License">GNU Free Documentation License</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-H">H</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Hiding-of-outer-entities">Hiding of outer entities</a>:</td><td> </td><td valign="top"><a href="#Declarations-and-Types">Declarations and Types</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-I">I</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Identifiers">Identifiers</a>:</td><td> </td><td valign="top"><a href="#Lexical-Elements">Lexical Elements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-if-statement"><code>if</code> statement</a>:</td><td> </td><td valign="top"><a href="#Statements">Statements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Indentation">Indentation</a>:</td><td> </td><td valign="top"><a href="#Lexical-Elements">Lexical Elements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Indentation-1">Indentation</a>:</td><td> </td><td valign="top"><a href="#Lexical-Elements">Lexical Elements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Indentation-_0028in-if-statements_0029">Indentation (in <code>if</code> statements)</a>:</td><td> </td><td valign="top"><a href="#Statements">Statements</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-K">K</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-krunch_002eads-file"><samp>krunch.ads</samp> file</a>:</td><td> </td><td valign="top"><a href="#Program-Structure">Program Structure</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-L">L</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Lexical-elements">Lexical elements</a>:</td><td> </td><td valign="top"><a href="#Lexical-Elements">Lexical Elements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Line-length">Line length</a>:</td><td> </td><td valign="top"><a href="#Lexical-Elements">Lexical Elements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Loop-statements">Loop statements</a>:</td><td> </td><td valign="top"><a href="#Statements">Statements</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-N">N</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Name-clash-avoidance">Name clash avoidance</a>:</td><td> </td><td valign="top"><a href="#Packages">Packages</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Numeric-literals">Numeric literals</a>:</td><td> </td><td valign="top"><a href="#Lexical-Elements">Lexical Elements</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-O">O</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Operators">Operators</a>:</td><td> </td><td valign="top"><a href="#Expressions-and-Names">Expressions and Names</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-P">P</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Packages">Packages</a>:</td><td> </td><td valign="top"><a href="#Packages">Packages</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Parenthesization-of-expressions">Parenthesization of expressions</a>:</td><td> </td><td valign="top"><a href="#Expressions-and-Names">Expressions and Names</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Program-structure">Program structure</a>:</td><td> </td><td valign="top"><a href="#Program-Structure">Program Structure</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-R">R</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Reserved-words">Reserved words</a>:</td><td> </td><td valign="top"><a href="#Lexical-Elements">Lexical Elements</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-S">S</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Separators">Separators</a>:</td><td> </td><td valign="top"><a href="#Lexical-Elements">Lexical Elements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Short_002dcircuit-forms">Short-circuit forms</a>:</td><td> </td><td valign="top"><a href="#Statements">Statements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Simple-and-compound-statements">Simple and compound statements</a>:</td><td> </td><td valign="top"><a href="#Statements">Statements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Statements">Statements</a>:</td><td> </td><td valign="top"><a href="#Statements">Statements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-style_002eadb-file"><samp>style.adb</samp> file</a>:</td><td> </td><td valign="top"><a href="#Lexical-Elements">Lexical Elements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-style_002eadb-file-1"><samp>style.adb</samp> file</a>:</td><td> </td><td valign="top"><a href="#Program-Structure">Program Structure</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Subprogram-bodies">Subprogram bodies</a>:</td><td> </td><td valign="top"><a href="#Subprograms">Subprograms</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Subprograms">Subprograms</a>:</td><td> </td><td valign="top"><a href="#Subprograms">Subprograms</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-U">U</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Underscores">Underscores</a>:</td><td> </td><td valign="top"><a href="#Lexical-Elements">Lexical Elements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Underscores-1">Underscores</a>:</td><td> </td><td valign="top"><a href="#Lexical-Elements">Lexical Elements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-use-clauses"><code>use</code> clauses</a>:</td><td> </td><td valign="top"><a href="#Packages">Packages</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
</table>
<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter" href="#Index_cp_symbol-1"><b>-</b></a>
<br>
<a class="summary-letter" href="#Index_cp_letter-A"><b>A</b></a>
<a class="summary-letter" href="#Index_cp_letter-B"><b>B</b></a>
<a class="summary-letter" href="#Index_cp_letter-C"><b>C</b></a>
<a class="summary-letter" href="#Index_cp_letter-D"><b>D</b></a>
<a class="summary-letter" href="#Index_cp_letter-E"><b>E</b></a>
<a class="summary-letter" href="#Index_cp_letter-F"><b>F</b></a>
<a class="summary-letter" href="#Index_cp_letter-G"><b>G</b></a>
<a class="summary-letter" href="#Index_cp_letter-H"><b>H</b></a>
<a class="summary-letter" href="#Index_cp_letter-I"><b>I</b></a>
<a class="summary-letter" href="#Index_cp_letter-K"><b>K</b></a>
<a class="summary-letter" href="#Index_cp_letter-L"><b>L</b></a>
<a class="summary-letter" href="#Index_cp_letter-N"><b>N</b></a>
<a class="summary-letter" href="#Index_cp_letter-O"><b>O</b></a>
<a class="summary-letter" href="#Index_cp_letter-P"><b>P</b></a>
<a class="summary-letter" href="#Index_cp_letter-R"><b>R</b></a>
<a class="summary-letter" href="#Index_cp_letter-S"><b>S</b></a>
<a class="summary-letter" href="#Index_cp_letter-U"><b>U</b></a>
</td></tr></table>
<a name="SEC_Contents"></a>
<h2 class="contents-heading">Table of Contents</h2>
<div class="contents">
<ul class="no-bullet">
<li><a name="toc-General-1" href="#General">1 General</a></li>
<li><a name="toc-Lexical-Elements-1" href="#Lexical-Elements">2 Lexical Elements</a>
<ul class="no-bullet">
<li><a name="toc-Character-Set-and-Separators" href="#Character-Set-and-Separators">2.1 Character Set and Separators</a></li>
<li><a name="toc-Identifiers" href="#Identifiers">2.2 Identifiers</a></li>
<li><a name="toc-Numeric-Literals" href="#Numeric-Literals">2.3 Numeric Literals</a></li>
<li><a name="toc-Reserved-Words" href="#Reserved-Words">2.4 Reserved Words</a></li>
<li><a name="toc-Comments" href="#Comments">2.5 Comments</a></li>
</ul></li>
<li><a name="toc-Declarations-and-Types-1" href="#Declarations-and-Types">3 Declarations and Types</a></li>
<li><a name="toc-Expressions-and-Names-1" href="#Expressions-and-Names">4 Expressions and Names</a></li>
<li><a name="toc-Statements-1" href="#Statements">5 Statements</a>
<ul class="no-bullet">
<li><a name="toc-Simple-and-Compound-Statements" href="#Simple-and-Compound-Statements">5.1 Simple and Compound Statements</a></li>
<li><a name="toc-If-Statements" href="#If-Statements">5.2 If Statements</a></li>
<li><a name="toc-Case-Statements" href="#Case-Statements">5.3 Case Statements</a></li>
<li><a name="toc-Loop-Statements" href="#Loop-Statements">5.4 Loop Statements</a></li>
<li><a name="toc-Block-Statements" href="#Block-Statements">5.5 Block Statements</a></li>
</ul></li>
<li><a name="toc-Subprograms-1" href="#Subprograms">6 Subprograms</a>
<ul class="no-bullet">
<li><a name="toc-Subprogram-Declarations" href="#Subprogram-Declarations">6.1 Subprogram Declarations</a></li>
<li><a name="toc-Subprogram-Bodies" href="#Subprogram-Bodies">6.2 Subprogram Bodies</a></li>
</ul></li>
<li><a name="toc-Packages-and-Visibility-Rules" href="#Packages">7 Packages and Visibility Rules</a></li>
<li><a name="toc-Program-Structure-and-Compilation-Issues" href="#Program-Structure">8 Program Structure and Compilation Issues</a></li>
<li><a name="toc-GNU-Free-Documentation-License-1" href="#GNU-Free-Documentation-License">GNU Free Documentation License</a></li>
<li><a name="toc-ADDENDUM_003a-How-to-use-this-License-for-your-documents" href="#ADDENDUM_003a-How-to-use-this-License-for-your-documents">ADDENDUM: How to use this License for your documents</a></li>
<li><a name="toc-Index-1" href="#Index">Index</a></li>
</ul>
</div>
<hr>
</body>
</html>
|