| 1 |
.. _About_This_Guide: |
| 2 |
|
| 3 |
About This Guide |
| 4 |
~~~~~~~~~~~~~~~~ |
| 5 |
|
| 6 |
.. only:: PRO |
| 7 |
|
| 8 |
For ease of exposition, 'GNAT Pro' will be referred to simply as |
| 9 |
'GNAT' in the remainder of this document. |
| 10 |
|
| 11 |
This guide describes the use of GNAT, |
| 12 |
a compiler and software development |
| 13 |
toolset for the full Ada programming language. |
| 14 |
It documents the features of the compiler and tools, and explains |
| 15 |
how to use them to build Ada applications. |
| 16 |
|
| 17 |
GNAT implements Ada 95, Ada 2005, Ada 2012, and Ada 2022. You may |
| 18 |
also invoke it in Ada 83 compatibility mode. By default, GNAT assumes |
| 19 |
Ada 2012, but you can use a compiler switch |
| 20 |
(:ref:`Compiling_Different_Versions_of_Ada`) to explicitly specify the |
| 21 |
language version. Throughout this manual, references to 'Ada' without |
| 22 |
a year suffix apply to all versions of the Ada language starting with |
| 23 |
Ada 95. |
| 24 |
|
| 25 |
GNAT supports both the GCC and LLVM back end compilation families. |
| 26 |
Most GNAT versions use the GCC back end, but some are now available using |
| 27 |
the LLVM back end. In some places in this manual, we distinguish between |
| 28 |
the two back ends, but in most cases, everything in this manual applies |
| 29 |
to both back ends. We refer to GNAT with the LLVM back end as 'GNAT LLVM'. |
| 30 |
See :ref:`GNATLLVM` for limitations of GNAT LLVM. |
| 31 |
|
| 32 |
What This Guide Contains |
| 33 |
======================== |
| 34 |
|
| 35 |
This guide contains the following chapters: |
| 36 |
|
| 37 |
* :ref:`Getting_Started_with_GNAT` describes how to get started compiling |
| 38 |
and running Ada programs with the GNAT Ada programming environment. |
| 39 |
|
| 40 |
* :ref:`The_GNAT_Compilation_Model` describes the compilation model used |
| 41 |
by GNAT. |
| 42 |
|
| 43 |
* :ref:`Building_Executable_Programs_With_GNAT` describes how to use the |
| 44 |
main GNAT tools to build executable programs, and it also gives examples of |
| 45 |
using the GNU make utility with GNAT. |
| 46 |
|
| 47 |
* :ref:`GNAT_Utility_Programs` explains the various utility programs that |
| 48 |
are included in the GNAT environment. |
| 49 |
|
| 50 |
* :ref:`GNAT_and_Program_Execution` covers a number of topics related to |
| 51 |
running, debugging, and tuning the performance of programs developed |
| 52 |
with GNAT. |
| 53 |
|
| 54 |
Appendices cover several additional topics: |
| 55 |
|
| 56 |
* :ref:`Platform_Specific_Information` describes the different run-time |
| 57 |
library implementations and also presents information on how to use |
| 58 |
GNAT on several specific platforms. |
| 59 |
|
| 60 |
* :ref:`Example_of_Binder_Output_File` shows the source code for the binder |
| 61 |
output file for a sample program. |
| 62 |
|
| 63 |
* :ref:`Elaboration_Order_Handling_in_GNAT` describes how GNAT helps |
| 64 |
you deal with elaboration order issues. |
| 65 |
|
| 66 |
* :ref:`Inline_Assembler` shows how to use the inline assembly facility |
| 67 |
in an Ada program. |
| 68 |
|
| 69 |
|
| 70 |
|
| 71 |
What You Should Know before Reading This Guide |
| 72 |
============================================== |
| 73 |
|
| 74 |
.. index:: Ada 95 Language Reference Manual |
| 75 |
|
| 76 |
.. index:: Ada 2005 Language Reference Manual |
| 77 |
|
| 78 |
This guide assumes a basic familiarity with the Ada 95 language, as |
| 79 |
described in the International Standard ANSI/ISO/IEC-8652:1995, January |
| 80 |
1995. |
| 81 |
Reference manuals for Ada 95, Ada 2005, and Ada 2012 are included in |
| 82 |
the GNAT documentation package. |
| 83 |
|
| 84 |
|
| 85 |
Related Information |
| 86 |
=================== |
| 87 |
|
| 88 |
For further information about Ada and related tools, please refer to the |
| 89 |
following documents: |
| 90 |
|
| 91 |
* :title:`Ada 95 Reference Manual`, :title:`Ada 2005 Reference Manual`, and |
| 92 |
:title:`Ada 2012 Reference Manual`, which contain reference |
| 93 |
material for the several revisions of the Ada language standard. |
| 94 |
|
| 95 |
* :title:`GNAT Reference_Manual`, which contains all reference material for the GNAT |
| 96 |
implementation of Ada. |
| 97 |
|
| 98 |
* :title:`Using GNAT Studio`, which describes the GNAT Studio |
| 99 |
Integrated Development Environment. |
| 100 |
|
| 101 |
* :title:`GNAT Studio Tutorial`, which introduces the |
| 102 |
main GNAT Studio features through examples. |
| 103 |
|
| 104 |
* :title:`Debugging with GDB`, |
| 105 |
for all details on the use of the GNU source-level debugger. |
| 106 |
|
| 107 |
* :title:`GNU Emacs Manual`, |
| 108 |
for full information on the extensible editor and programming |
| 109 |
environment Emacs. |
| 110 |
|
| 111 |
|
| 112 |
Conventions |
| 113 |
=========== |
| 114 |
.. index:: Conventions, typographical |
| 115 |
|
| 116 |
.. index:: Typographical conventions |
| 117 |
|
| 118 |
Following are examples of the typographical and graphic conventions used |
| 119 |
in this guide: |
| 120 |
|
| 121 |
* ``Functions``, ``utility program names``, ``standard names``, |
| 122 |
and ``classes``. |
| 123 |
|
| 124 |
* ``Option flags`` |
| 125 |
|
| 126 |
* :file:`File names` |
| 127 |
|
| 128 |
* ``Variables`` |
| 129 |
|
| 130 |
* *Emphasis* |
| 131 |
|
| 132 |
* [optional information or parameters] |
| 133 |
|
| 134 |
* Examples are described by text |
| 135 |
|
| 136 |
:: |
| 137 |
|
| 138 |
and then shown this way. |
| 139 |
|
| 140 |
* Commands that you enter are shown as preceded by a prompt string |
| 141 |
comprising the ``$`` character followed by a space. |
| 142 |
|
| 143 |
* Full file names are shown with the '/' character |
| 144 |
as the directory separator; e.g., :file:`parent-dir/subdir/myfile.adb`. |
| 145 |
If you are using GNAT on a Windows platform, please note that |
| 146 |
you should use the '\\' character instead. |