GNAT Reference Manual: About This Guide

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

# About This Guide

This manual contains useful information in writing programs using the GNAT compiler. It includes information on implementation dependent characteristics of GNAT, including all the information required by Annex M of the Ada language standard.

GNAT implements Ada 95, Ada 2005 and Ada 2012, and it may also be invoked in Ada 83 compatibility mode. By default, GNAT assumes Ada 2012, but you can override with a compiler switch to explicitly specify the language version. (Please refer to section `Compiling Different Versions of Ada' in GNAT User's Guide, for details on these switches.) Throughout this manual, references to "Ada" without a year suffix apply to all the Ada versions of the language.

Ada is designed to be highly portable. In general, a program will have the same effect even when compiled by different compilers on different platforms. However, since Ada is designed to be used in a wide variety of applications, it also contains a number of system dependent features to be used in interfacing to the external world.

Note: Any program that makes use of implementation-dependent features may be non-portable. You should follow good programming practice and isolate and clearly document any sections of your program that make use of these features in a non-portable manner.

> What This Reference Manual Contains |  |
> Conventions |  |
> Related Information |  |

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## What This Reference Manual Contains

This reference manual contains the following chapters:

- 1. Implementation Defined Pragmas, lists GNAT implementation-dependent pragmas, which can be used to extend and enhance the functionality of the compiler.

- 3. Implementation Defined Attributes, lists GNAT implementation-dependent attributes, which can be used to extend and enhance the functionality of the compiler.

- 4. Standard and Implementation Defined Restrictions, lists GNAT implementation-dependent restrictions, which can be used to extend and enhance the functionality of the compiler.

- 5. Implementation Advice, provides information on generally desirable behavior which are not requirements that all compilers must follow since it cannot be provided on all systems, or which may be undesirable on some systems.

- 6. Implementation Defined Characteristics, provides a guide to minimizing implementation dependent features.

- 7. Intrinsic Subprograms, describes the intrinsic subprograms implemented by GNAT, and how they can be imported into user application programs.

- 8. Representation Clauses and Pragmas, describes in detail the way that GNAT represents data, and in particular the exact set of representation clauses and pragmas that is accepted.

- 9. Standard Library Routines, provides a listing of packages and a brief description of the functionality that is provided by Ada's extensive set of standard library routines as implemented by GNAT.

- 10. The Implementation of Standard I/O, details how the GNAT implementation of the input-output facilities.

- 11. The GNAT Library, is a catalog of packages that complement the Ada predefined library.

- 12. Interfacing to Other Languages, describes how programs written in Ada using GNAT can be interfaced to other programming languages.

  13. Specialized Needs Annexes, describes the GNAT implementation of all of the specialized needs annexes.

- 14. Implementation of Specific Ada Features, discusses issues related to GNAT's implementation of machine code insertions, tasking, and several other features.

- 15. Implementation of Ada 2012 Features, describes the status of the GNAT implementation of the Ada 2012 language standard.

- 16. Obsolescent Features documents implementation dependent features, including pragmas and attributes, which are considered obsolescent, since there are other preferred ways of achieving the same results. These obsolescent forms are retained for backwards compatibility.

This reference manual 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.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## Conventions

Following are examples of the typographical and graphic conventions used in this guide:

- `Functions`, `utility program names`, `standard names`, and `classes`.

- `Option flags`

- ``File names'`, ``button names'`, and ``field names'`.

- `Variables`, `environment variables`, and metasyntactic variables.

- Emphasis.

- [optional information or parameters]

- Examples are described by text

      and then shown this way.

Commands that are entered by the user are preceded in this manual by the characters ``$ '` (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 ``$'` replaced by whatever prompt character you are using.

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

## Related Information

See the following documents for further information on GNAT:

- See section `About This Guide' in GNAT User's Guide, which provides information on how to use the GNAT compiler system.

- Ada 95 Reference Manual, which contains all reference material for the Ada 95 programming language.

- Ada 95 Annotated Reference Manual, which is an annotated version of the Ada 95 standard. The annotations describe detailed aspects of the design decision, and in particular contain useful sections on Ada 83 compatibility.

- Ada 2005 Reference Manual, which contains all reference material for the Ada 2005 programming language.

- Ada 2005 Annotated Reference Manual, which is an annotated version of the Ada 2005 standard. The annotations describe detailed aspects of the design decision, and in particular contain useful sections on Ada 83 and Ada 95 compatibility.

- DEC Ada, Technical Overview and Comparison on DIGITAL Platforms, which contains specific information on compatibility between GNAT and DEC Ada 83 systems.

- DEC Ada, Language Reference Manual, part number AA-PYZAB-TK which describes in detail the pragmas and attributes provided by the DEC Ada 83 compiler system.

[ << ] | [ >> ] |  |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

This document was generated by GNAT Mailserver on April, 17 2014 using texi2html