| 1 |
.. role:: switch(samp) |
| 2 |
|
| 3 |
.. _The_GNAT_Library: |
| 4 |
|
| 5 |
**************** |
| 6 |
The GNAT Library |
| 7 |
**************** |
| 8 |
|
| 9 |
The GNAT library contains a number of general and special purpose packages. |
| 10 |
It represents functionality that the GNAT developers have found useful, and |
| 11 |
which is made available to GNAT users. The packages described here are fully |
| 12 |
supported, and upwards compatibility will be maintained in future releases, |
| 13 |
so you can use these facilities with the confidence that the same functionality |
| 14 |
will be available in future releases. |
| 15 |
|
| 16 |
The chapter here simply gives a brief summary of the facilities available. |
| 17 |
The full documentation is found in the spec file for the package. The full |
| 18 |
sources of these library packages, including both spec and body, are provided |
| 19 |
with all GNAT releases. For example, to find out the full specifications of |
| 20 |
the SPITBOL pattern matching capability, including a full tutorial and |
| 21 |
extensive examples, look in the :file:`g-spipat.ads` file in the library. |
| 22 |
|
| 23 |
For each entry here, the package name (as it would appear in a ``with`` |
| 24 |
clause) is given, followed by the name of the corresponding spec file in |
| 25 |
parentheses. The packages are children in four hierarchies, ``Ada``, |
| 26 |
``Interfaces``, ``System``, and ``GNAT``, the latter being a |
| 27 |
GNAT-specific hierarchy. |
| 28 |
|
| 29 |
Note that an application program should only use packages in one of these |
| 30 |
four hierarchies if the package is defined in the Ada Reference Manual, |
| 31 |
or is listed in this section of the GNAT Programmers Reference Manual. |
| 32 |
All other units should be considered internal implementation units and |
| 33 |
should not be directly ``with``\ ed by application code. The use of |
| 34 |
a ``with`` clause that references one of these internal implementation |
| 35 |
units makes an application potentially dependent on changes in versions |
| 36 |
of GNAT, and will generate a warning message. |
| 37 |
|
| 38 |
.. _`Ada.Characters.Latin_9_(a-chlat9.ads)`: |
| 39 |
|
| 40 |
``Ada.Characters.Latin_9`` (:file:`a-chlat9.ads`) |
| 41 |
================================================= |
| 42 |
|
| 43 |
.. index:: Ada.Characters.Latin_9 (a-chlat9.ads) |
| 44 |
|
| 45 |
.. index:: Latin_9 constants for Character |
| 46 |
|
| 47 |
This child of ``Ada.Characters`` |
| 48 |
provides a set of definitions corresponding to those in the |
| 49 |
RM-defined package ``Ada.Characters.Latin_1`` but with the |
| 50 |
few modifications required for ``Latin-9``. |
| 51 |
The provision of such a package |
| 52 |
is specifically authorized by the Ada Reference Manual |
| 53 |
(RM A.3.3(27)). |
| 54 |
|
| 55 |
.. _`Ada.Characters.Wide_Latin_1_(a-cwila1.ads)`: |
| 56 |
|
| 57 |
``Ada.Characters.Wide_Latin_1`` (:file:`a-cwila1.ads`) |
| 58 |
====================================================== |
| 59 |
|
| 60 |
.. index:: Ada.Characters.Wide_Latin_1 (a-cwila1.ads) |
| 61 |
|
| 62 |
.. index:: Latin_1 constants for Wide_Character |
| 63 |
|
| 64 |
This child of ``Ada.Characters`` |
| 65 |
provides a set of definitions corresponding to those in the |
| 66 |
RM-defined package ``Ada.Characters.Latin_1`` but with the |
| 67 |
types of the constants being ``Wide_Character`` |
| 68 |
instead of ``Character``. The provision of such a package |
| 69 |
is specifically authorized by the Ada Reference Manual |
| 70 |
(RM A.3.3(27)). |
| 71 |
|
| 72 |
.. _`Ada.Characters.Wide_Latin_9_(a-cwila9.ads)`: |
| 73 |
|
| 74 |
``Ada.Characters.Wide_Latin_9`` (:file:`a-cwila9.ads`) |
| 75 |
====================================================== |
| 76 |
|
| 77 |
.. index:: Ada.Characters.Wide_Latin_9 (a-cwila9.ads) |
| 78 |
|
| 79 |
.. index:: Latin_9 constants for Wide_Character |
| 80 |
|
| 81 |
This child of ``Ada.Characters`` |
| 82 |
provides a set of definitions corresponding to those in the |
| 83 |
GNAT defined package ``Ada.Characters.Latin_9`` but with the |
| 84 |
types of the constants being ``Wide_Character`` |
| 85 |
instead of ``Character``. The provision of such a package |
| 86 |
is specifically authorized by the Ada Reference Manual |
| 87 |
(RM A.3.3(27)). |
| 88 |
|
| 89 |
.. _`Ada.Characters.Wide_Wide_Latin_1_(a-chzla1.ads)`: |
| 90 |
|
| 91 |
``Ada.Characters.Wide_Wide_Latin_1`` (:file:`a-chzla1.ads`) |
| 92 |
=========================================================== |
| 93 |
|
| 94 |
.. index:: Ada.Characters.Wide_Wide_Latin_1 (a-chzla1.ads) |
| 95 |
|
| 96 |
.. index:: Latin_1 constants for Wide_Wide_Character |
| 97 |
|
| 98 |
This child of ``Ada.Characters`` |
| 99 |
provides a set of definitions corresponding to those in the |
| 100 |
RM-defined package ``Ada.Characters.Latin_1`` but with the |
| 101 |
types of the constants being ``Wide_Wide_Character`` |
| 102 |
instead of ``Character``. The provision of such a package |
| 103 |
is specifically authorized by the Ada Reference Manual |
| 104 |
(RM A.3.3(27)). |
| 105 |
|
| 106 |
.. _`Ada.Characters.Wide_Wide_Latin_9_(a-chzla9.ads)`: |
| 107 |
|
| 108 |
``Ada.Characters.Wide_Wide_Latin_9`` (:file:`a-chzla9.ads`) |
| 109 |
=========================================================== |
| 110 |
|
| 111 |
.. index:: Ada.Characters.Wide_Wide_Latin_9 (a-chzla9.ads) |
| 112 |
|
| 113 |
.. index:: Latin_9 constants for Wide_Wide_Character |
| 114 |
|
| 115 |
This child of ``Ada.Characters`` |
| 116 |
provides a set of definitions corresponding to those in the |
| 117 |
GNAT defined package ``Ada.Characters.Latin_9`` but with the |
| 118 |
types of the constants being ``Wide_Wide_Character`` |
| 119 |
instead of ``Character``. The provision of such a package |
| 120 |
is specifically authorized by the Ada Reference Manual |
| 121 |
(RM A.3.3(27)). |
| 122 |
|
| 123 |
.. _`Ada.Containers.Bounded_Holders_(a-coboho.ads)`: |
| 124 |
|
| 125 |
``Ada.Containers.Bounded_Holders`` (:file:`a-coboho.ads`) |
| 126 |
========================================================= |
| 127 |
|
| 128 |
.. index:: Ada.Containers.Bounded_Holders (a-coboho.ads) |
| 129 |
|
| 130 |
.. index:: Formal container for vectors |
| 131 |
|
| 132 |
This child of ``Ada.Containers`` defines a modified version of |
| 133 |
Indefinite_Holders that avoids heap allocation. |
| 134 |
|
| 135 |
.. _`Ada.Command_Line.Environment_(a-colien.ads)`: |
| 136 |
|
| 137 |
``Ada.Command_Line.Environment`` (:file:`a-colien.ads`) |
| 138 |
======================================================= |
| 139 |
|
| 140 |
.. index:: Ada.Command_Line.Environment (a-colien.ads) |
| 141 |
|
| 142 |
.. index:: Environment entries |
| 143 |
|
| 144 |
This child of ``Ada.Command_Line`` |
| 145 |
provides a mechanism for obtaining environment values on systems |
| 146 |
where this concept makes sense. |
| 147 |
|
| 148 |
.. _`Ada.Command_Line.Remove_(a-colire.ads)`: |
| 149 |
|
| 150 |
``Ada.Command_Line.Remove`` (:file:`a-colire.ads`) |
| 151 |
================================================== |
| 152 |
|
| 153 |
.. index:: Ada.Command_Line.Remove (a-colire.ads) |
| 154 |
|
| 155 |
.. index:: Removing command line arguments |
| 156 |
|
| 157 |
.. index:: Command line, argument removal |
| 158 |
|
| 159 |
This child of ``Ada.Command_Line`` |
| 160 |
provides a mechanism for logically removing |
| 161 |
arguments from the argument list. Once removed, an argument is not visible |
| 162 |
to further calls to the subprograms in ``Ada.Command_Line``. These calls |
| 163 |
will not see the removed argument. |
| 164 |
|
| 165 |
.. _`Ada.Command_Line.Response_File_(a-clrefi.ads)`: |
| 166 |
|
| 167 |
``Ada.Command_Line.Response_File`` (:file:`a-clrefi.ads`) |
| 168 |
========================================================= |
| 169 |
|
| 170 |
.. index:: Ada.Command_Line.Response_File (a-clrefi.ads) |
| 171 |
|
| 172 |
.. index:: Response file for command line |
| 173 |
|
| 174 |
.. index:: Command line, response file |
| 175 |
|
| 176 |
.. index:: Command line, handling long command lines |
| 177 |
|
| 178 |
This child of ``Ada.Command_Line`` provides a mechanism facilities for |
| 179 |
getting command line arguments from a text file, called a "response file". |
| 180 |
Using a response file allow passing a set of arguments to an executable longer |
| 181 |
than the maximum allowed by the system on the command line. |
| 182 |
|
| 183 |
.. _`Ada.Direct_IO.C_Streams_(a-diocst.ads)`: |
| 184 |
|
| 185 |
``Ada.Direct_IO.C_Streams`` (:file:`a-diocst.ads`) |
| 186 |
================================================== |
| 187 |
|
| 188 |
.. index:: Ada.Direct_IO.C_Streams (a-diocst.ads) |
| 189 |
|
| 190 |
.. index:: C Streams, Interfacing with Direct_IO |
| 191 |
|
| 192 |
This package provides subprograms that allow interfacing between |
| 193 |
C streams and ``Direct_IO``. The stream identifier can be |
| 194 |
extracted from a file opened on the Ada side, and an Ada file |
| 195 |
can be constructed from a stream opened on the C side. |
| 196 |
|
| 197 |
.. _`Ada.Exceptions.Is_Null_Occurrence_(a-einuoc.ads)`: |
| 198 |
|
| 199 |
``Ada.Exceptions.Is_Null_Occurrence`` (:file:`a-einuoc.ads`) |
| 200 |
============================================================ |
| 201 |
|
| 202 |
.. index:: Ada.Exceptions.Is_Null_Occurrence (a-einuoc.ads) |
| 203 |
|
| 204 |
.. index:: Null_Occurrence, testing for |
| 205 |
|
| 206 |
This child subprogram provides a way of testing for the null |
| 207 |
exception occurrence (``Null_Occurrence``) without raising |
| 208 |
an exception. |
| 209 |
|
| 210 |
.. _`Ada.Exceptions.Last_Chance_Handler_(a-elchha.ads)`: |
| 211 |
|
| 212 |
``Ada.Exceptions.Last_Chance_Handler`` (:file:`a-elchha.ads`) |
| 213 |
============================================================= |
| 214 |
|
| 215 |
.. index:: Ada.Exceptions.Last_Chance_Handler (a-elchha.ads) |
| 216 |
|
| 217 |
.. index:: Null_Occurrence, testing for |
| 218 |
|
| 219 |
This child subprogram is used for handling otherwise unhandled |
| 220 |
exceptions (hence the name last chance), and perform clean ups before |
| 221 |
terminating the program. Note that this subprogram never returns. |
| 222 |
|
| 223 |
.. _`Ada.Exceptions.Traceback_(a-exctra.ads)`: |
| 224 |
|
| 225 |
``Ada.Exceptions.Traceback`` (:file:`a-exctra.ads`) |
| 226 |
=================================================== |
| 227 |
|
| 228 |
.. index:: Ada.Exceptions.Traceback (a-exctra.ads) |
| 229 |
|
| 230 |
.. index:: Traceback for Exception Occurrence |
| 231 |
|
| 232 |
This child package provides the subprogram (``Tracebacks``) to |
| 233 |
give a traceback array of addresses based on an exception |
| 234 |
occurrence. |
| 235 |
|
| 236 |
.. _`Ada.Sequential_IO.C_Streams_(a-siocst.ads)`: |
| 237 |
|
| 238 |
``Ada.Sequential_IO.C_Streams`` (:file:`a-siocst.ads`) |
| 239 |
====================================================== |
| 240 |
|
| 241 |
.. index:: Ada.Sequential_IO.C_Streams (a-siocst.ads) |
| 242 |
|
| 243 |
.. index:: C Streams, Interfacing with Sequential_IO |
| 244 |
|
| 245 |
This package provides subprograms that allow interfacing between |
| 246 |
C streams and ``Sequential_IO``. The stream identifier can be |
| 247 |
extracted from a file opened on the Ada side, and an Ada file |
| 248 |
can be constructed from a stream opened on the C side. |
| 249 |
|
| 250 |
.. _`Ada.Streams.Stream_IO.C_Streams_(a-ssicst.ads)`: |
| 251 |
|
| 252 |
``Ada.Streams.Stream_IO.C_Streams`` (:file:`a-ssicst.ads`) |
| 253 |
========================================================== |
| 254 |
|
| 255 |
.. index:: Ada.Streams.Stream_IO.C_Streams (a-ssicst.ads) |
| 256 |
|
| 257 |
.. index:: C Streams, Interfacing with Stream_IO |
| 258 |
|
| 259 |
This package provides subprograms that allow interfacing between |
| 260 |
C streams and ``Stream_IO``. The stream identifier can be |
| 261 |
extracted from a file opened on the Ada side, and an Ada file |
| 262 |
can be constructed from a stream opened on the C side. |
| 263 |
|
| 264 |
.. _`Ada.Strings.Unbounded.Text_IO_(a-suteio.ads)`: |
| 265 |
|
| 266 |
``Ada.Strings.Unbounded.Text_IO`` (:file:`a-suteio.ads`) |
| 267 |
======================================================== |
| 268 |
|
| 269 |
.. index:: Ada.Strings.Unbounded.Text_IO (a-suteio.ads) |
| 270 |
|
| 271 |
.. index:: Unbounded_String, IO support |
| 272 |
|
| 273 |
.. index:: Text_IO, extensions for unbounded strings |
| 274 |
|
| 275 |
This package provides subprograms for Text_IO for unbounded |
| 276 |
strings, avoiding the necessity for an intermediate operation |
| 277 |
with ordinary strings. |
| 278 |
|
| 279 |
.. _`Ada.Strings.Wide_Unbounded.Wide_Text_IO_(a-swuwti.ads)`: |
| 280 |
|
| 281 |
``Ada.Strings.Wide_Unbounded.Wide_Text_IO`` (:file:`a-swuwti.ads`) |
| 282 |
================================================================== |
| 283 |
|
| 284 |
.. index:: Ada.Strings.Wide_Unbounded.Wide_Text_IO (a-swuwti.ads) |
| 285 |
|
| 286 |
.. index:: Unbounded_Wide_String, IO support |
| 287 |
|
| 288 |
.. index:: Text_IO, extensions for unbounded wide strings |
| 289 |
|
| 290 |
This package provides subprograms for Text_IO for unbounded |
| 291 |
wide strings, avoiding the necessity for an intermediate operation |
| 292 |
with ordinary wide strings. |
| 293 |
|
| 294 |
.. _`Ada.Strings.Wide_Wide_Unbounded.Wide_Wide_Text_IO_(a-szuzti.ads)`: |
| 295 |
|
| 296 |
``Ada.Strings.Wide_Wide_Unbounded.Wide_Wide_Text_IO`` (:file:`a-szuzti.ads`) |
| 297 |
============================================================================ |
| 298 |
|
| 299 |
.. index:: Ada.Strings.Wide_Wide_Unbounded.Wide_Wide_Text_IO (a-szuzti.ads) |
| 300 |
|
| 301 |
.. index:: Unbounded_Wide_Wide_String, IO support |
| 302 |
|
| 303 |
.. index:: Text_IO, extensions for unbounded wide wide strings |
| 304 |
|
| 305 |
This package provides subprograms for Text_IO for unbounded |
| 306 |
wide wide strings, avoiding the necessity for an intermediate operation |
| 307 |
with ordinary wide wide strings. |
| 308 |
|
| 309 |
.. _`Ada.Task_Initialization_(a-tasini.ads)`: |
| 310 |
|
| 311 |
``Ada.Task_Initialization`` (:file:`a-tasini.ads`) |
| 312 |
================================================== |
| 313 |
|
| 314 |
.. index:: Ada.Task_Initialization (a-tasini.ads) |
| 315 |
|
| 316 |
This package provides a way to set a global initialization handler that |
| 317 |
is automatically invoked whenever a task is activated. Handlers are |
| 318 |
parameterless procedures. Note that such a handler is only invoked for |
| 319 |
those tasks activated after the handler is set. |
| 320 |
|
| 321 |
.. _`Ada.Text_IO.C_Streams_(a-tiocst.ads)`: |
| 322 |
|
| 323 |
``Ada.Text_IO.C_Streams`` (:file:`a-tiocst.ads`) |
| 324 |
================================================ |
| 325 |
|
| 326 |
.. index:: Ada.Text_IO.C_Streams (a-tiocst.ads) |
| 327 |
|
| 328 |
.. index:: C Streams, Interfacing with ``Text_IO`` |
| 329 |
|
| 330 |
This package provides subprograms that allow interfacing between |
| 331 |
C streams and ``Text_IO``. The stream identifier can be |
| 332 |
extracted from a file opened on the Ada side, and an Ada file |
| 333 |
can be constructed from a stream opened on the C side. |
| 334 |
|
| 335 |
.. _`Ada.Text_IO.Reset_Standard_Files_(a-tirsfi.ads)`: |
| 336 |
|
| 337 |
``Ada.Text_IO.Reset_Standard_Files`` (:file:`a-tirsfi.ads`) |
| 338 |
=========================================================== |
| 339 |
|
| 340 |
.. index:: Ada.Text_IO.Reset_Standard_Files (a-tirsfi.ads) |
| 341 |
|
| 342 |
.. index:: Text_IO resetting standard files |
| 343 |
|
| 344 |
This procedure is used to reset the status of the standard files used |
| 345 |
by Ada.Text_IO. This is useful in a situation (such as a restart in an |
| 346 |
embedded application) where the status of the files may change during |
| 347 |
execution (for example a standard input file may be redefined to be |
| 348 |
interactive). |
| 349 |
|
| 350 |
.. _`Ada.Wide_Characters.Unicode_(a-wichun.ads)`: |
| 351 |
|
| 352 |
``Ada.Wide_Characters.Unicode`` (:file:`a-wichun.ads`) |
| 353 |
====================================================== |
| 354 |
|
| 355 |
.. index:: Ada.Wide_Characters.Unicode (a-wichun.ads) |
| 356 |
|
| 357 |
.. index:: Unicode categorization, Wide_Character |
| 358 |
|
| 359 |
This package provides subprograms that allow categorization of |
| 360 |
Wide_Character values according to Unicode categories. |
| 361 |
|
| 362 |
.. _`Ada.Wide_Text_IO.C_Streams_(a-wtcstr.ads)`: |
| 363 |
|
| 364 |
``Ada.Wide_Text_IO.C_Streams`` (:file:`a-wtcstr.ads`) |
| 365 |
===================================================== |
| 366 |
|
| 367 |
.. index:: Ada.Wide_Text_IO.C_Streams (a-wtcstr.ads) |
| 368 |
|
| 369 |
.. index:: C Streams, Interfacing with ``Wide_Text_IO`` |
| 370 |
|
| 371 |
This package provides subprograms that allow interfacing between |
| 372 |
C streams and ``Wide_Text_IO``. The stream identifier can be |
| 373 |
extracted from a file opened on the Ada side, and an Ada file |
| 374 |
can be constructed from a stream opened on the C side. |
| 375 |
|
| 376 |
.. _`Ada.Wide_Text_IO.Reset_Standard_Files_(a-wrstfi.ads)`: |
| 377 |
|
| 378 |
``Ada.Wide_Text_IO.Reset_Standard_Files`` (:file:`a-wrstfi.ads`) |
| 379 |
================================================================ |
| 380 |
|
| 381 |
.. index:: Ada.Wide_Text_IO.Reset_Standard_Files (a-wrstfi.ads) |
| 382 |
|
| 383 |
.. index:: Wide_Text_IO resetting standard files |
| 384 |
|
| 385 |
This procedure is used to reset the status of the standard files used |
| 386 |
by Ada.Wide_Text_IO. This is useful in a situation (such as a restart in an |
| 387 |
embedded application) where the status of the files may change during |
| 388 |
execution (for example a standard input file may be redefined to be |
| 389 |
interactive). |
| 390 |
|
| 391 |
.. _`Ada.Wide_Wide_Characters.Unicode_(a-zchuni.ads)`: |
| 392 |
|
| 393 |
``Ada.Wide_Wide_Characters.Unicode`` (:file:`a-zchuni.ads`) |
| 394 |
=========================================================== |
| 395 |
|
| 396 |
.. index:: Ada.Wide_Wide_Characters.Unicode (a-zchuni.ads) |
| 397 |
|
| 398 |
.. index:: Unicode categorization, Wide_Wide_Character |
| 399 |
|
| 400 |
This package provides subprograms that allow categorization of |
| 401 |
Wide_Wide_Character values according to Unicode categories. |
| 402 |
|
| 403 |
.. _`Ada.Wide_Wide_Text_IO.C_Streams_(a-ztcstr.ads)`: |
| 404 |
|
| 405 |
``Ada.Wide_Wide_Text_IO.C_Streams`` (:file:`a-ztcstr.ads`) |
| 406 |
========================================================== |
| 407 |
|
| 408 |
.. index:: Ada.Wide_Wide_Text_IO.C_Streams (a-ztcstr.ads) |
| 409 |
|
| 410 |
.. index:: C Streams, Interfacing with ``Wide_Wide_Text_IO`` |
| 411 |
|
| 412 |
This package provides subprograms that allow interfacing between |
| 413 |
C streams and ``Wide_Wide_Text_IO``. The stream identifier can be |
| 414 |
extracted from a file opened on the Ada side, and an Ada file |
| 415 |
can be constructed from a stream opened on the C side. |
| 416 |
|
| 417 |
.. _`Ada.Wide_Wide_Text_IO.Reset_Standard_Files_(a-zrstfi.ads)`: |
| 418 |
|
| 419 |
``Ada.Wide_Wide_Text_IO.Reset_Standard_Files`` (:file:`a-zrstfi.ads`) |
| 420 |
===================================================================== |
| 421 |
|
| 422 |
.. index:: Ada.Wide_Wide_Text_IO.Reset_Standard_Files (a-zrstfi.ads) |
| 423 |
|
| 424 |
.. index:: Wide_Wide_Text_IO resetting standard files |
| 425 |
|
| 426 |
This procedure is used to reset the status of the standard files used |
| 427 |
by Ada.Wide_Wide_Text_IO. This is useful in a situation (such as a |
| 428 |
restart in an embedded application) where the status of the files may |
| 429 |
change during execution (for example a standard input file may be |
| 430 |
redefined to be interactive). |
| 431 |
|
| 432 |
.. _`GNAT.Altivec_(g-altive.ads)`: |
| 433 |
|
| 434 |
``GNAT.Altivec`` (:file:`g-altive.ads`) |
| 435 |
======================================= |
| 436 |
|
| 437 |
.. index:: GNAT.Altivec (g-altive.ads) |
| 438 |
|
| 439 |
.. index:: AltiVec |
| 440 |
|
| 441 |
This is the root package of the GNAT AltiVec binding. It provides |
| 442 |
definitions of constants and types common to all the versions of the |
| 443 |
binding. |
| 444 |
|
| 445 |
.. _`GNAT.Altivec.Conversions_(g-altcon.ads)`: |
| 446 |
|
| 447 |
``GNAT.Altivec.Conversions`` (:file:`g-altcon.ads`) |
| 448 |
=================================================== |
| 449 |
|
| 450 |
.. index:: GNAT.Altivec.Conversions (g-altcon.ads) |
| 451 |
|
| 452 |
.. index:: AltiVec |
| 453 |
|
| 454 |
This package provides the Vector/View conversion routines. |
| 455 |
|
| 456 |
.. _`GNAT.Altivec.Vector_Operations_(g-alveop.ads)`: |
| 457 |
|
| 458 |
``GNAT.Altivec.Vector_Operations`` (:file:`g-alveop.ads`) |
| 459 |
========================================================= |
| 460 |
|
| 461 |
.. index:: GNAT.Altivec.Vector_Operations (g-alveop.ads) |
| 462 |
|
| 463 |
.. index:: AltiVec |
| 464 |
|
| 465 |
This package exposes the Ada interface to the AltiVec operations on |
| 466 |
vector objects. A soft emulation is included by default in the GNAT |
| 467 |
library. The hard binding is provided as a separate package. This unit |
| 468 |
is common to both bindings. |
| 469 |
|
| 470 |
.. _`GNAT.Altivec.Vector_Types_(g-alvety.ads)`: |
| 471 |
|
| 472 |
``GNAT.Altivec.Vector_Types`` (:file:`g-alvety.ads`) |
| 473 |
==================================================== |
| 474 |
|
| 475 |
.. index:: GNAT.Altivec.Vector_Types (g-alvety.ads) |
| 476 |
|
| 477 |
.. index:: AltiVec |
| 478 |
|
| 479 |
This package exposes the various vector types part of the Ada binding |
| 480 |
to AltiVec facilities. |
| 481 |
|
| 482 |
.. _`GNAT.Altivec.Vector_Views_(g-alvevi.ads)`: |
| 483 |
|
| 484 |
``GNAT.Altivec.Vector_Views`` (:file:`g-alvevi.ads`) |
| 485 |
==================================================== |
| 486 |
|
| 487 |
.. index:: GNAT.Altivec.Vector_Views (g-alvevi.ads) |
| 488 |
|
| 489 |
.. index:: AltiVec |
| 490 |
|
| 491 |
This package provides public 'View' data types from/to which private |
| 492 |
vector representations can be converted via |
| 493 |
GNAT.Altivec.Conversions. This allows convenient access to individual |
| 494 |
vector elements and provides a simple way to initialize vector |
| 495 |
objects. |
| 496 |
|
| 497 |
.. _`GNAT.Array_Split_(g-arrspl.ads)`: |
| 498 |
|
| 499 |
``GNAT.Array_Split`` (:file:`g-arrspl.ads`) |
| 500 |
=========================================== |
| 501 |
|
| 502 |
.. index:: GNAT.Array_Split (g-arrspl.ads) |
| 503 |
|
| 504 |
.. index:: Array splitter |
| 505 |
|
| 506 |
Useful array-manipulation routines: given a set of separators, split |
| 507 |
an array wherever the separators appear, and provide direct access |
| 508 |
to the resulting slices. |
| 509 |
|
| 510 |
.. _`GNAT.AWK_(g-awk.ads)`: |
| 511 |
|
| 512 |
``GNAT.AWK`` (:file:`g-awk.ads`) |
| 513 |
================================ |
| 514 |
|
| 515 |
.. index:: GNAT.AWK (g-awk.ads) |
| 516 |
|
| 517 |
.. index:: Parsing |
| 518 |
|
| 519 |
.. index:: AWK |
| 520 |
|
| 521 |
Provides AWK-like parsing functions, with an easy interface for parsing one |
| 522 |
or more files containing formatted data. The file is viewed as a database |
| 523 |
where each record is a line and a field is a data element in this line. |
| 524 |
|
| 525 |
.. _`GNAT.Binary_Search_(g-binsea.ads)`: |
| 526 |
|
| 527 |
``GNAT.Binary_Search`` (:file:`g-binsea.ads`) |
| 528 |
================================================ |
| 529 |
|
| 530 |
.. index:: GNAT.Binary_Search (g-binsea.ads) |
| 531 |
|
| 532 |
.. index:: Binary search |
| 533 |
|
| 534 |
Allow binary search of a sorted array (or of an array-like container; |
| 535 |
the generic does not reference the array directly). |
| 536 |
|
| 537 |
.. _`GNAT.Bind_Environment_(g-binenv.ads)`: |
| 538 |
|
| 539 |
``GNAT.Bind_Environment`` (:file:`g-binenv.ads`) |
| 540 |
================================================ |
| 541 |
|
| 542 |
.. index:: GNAT.Bind_Environment (g-binenv.ads) |
| 543 |
|
| 544 |
.. index:: Bind environment |
| 545 |
|
| 546 |
Provides access to key=value associations captured at bind time. |
| 547 |
These associations can be specified using the :switch:`-V` binder command |
| 548 |
line switch. |
| 549 |
|
| 550 |
.. _`GNAT.Branch_Prediction_(g-brapre.ads)`: |
| 551 |
|
| 552 |
``GNAT.Branch_Prediction`` (:file:`g-brapre.ads`) |
| 553 |
================================================= |
| 554 |
|
| 555 |
.. index:: GNAT.Branch_Prediction (g-brapre.ads) |
| 556 |
|
| 557 |
.. index:: Branch Prediction |
| 558 |
|
| 559 |
Provides routines giving hints to the branch predictor of the code generator. |
| 560 |
|
| 561 |
.. _`GNAT.Bounded_Buffers_(g-boubuf.ads)`: |
| 562 |
|
| 563 |
``GNAT.Bounded_Buffers`` (:file:`g-boubuf.ads`) |
| 564 |
=============================================== |
| 565 |
|
| 566 |
.. index:: GNAT.Bounded_Buffers (g-boubuf.ads) |
| 567 |
|
| 568 |
.. index:: Parsing |
| 569 |
|
| 570 |
.. index:: Bounded Buffers |
| 571 |
|
| 572 |
Provides a concurrent generic bounded buffer abstraction. Instances are |
| 573 |
useful directly or as parts of the implementations of other abstractions, |
| 574 |
such as mailboxes. |
| 575 |
|
| 576 |
.. _`GNAT.Bounded_Mailboxes_(g-boumai.ads)`: |
| 577 |
|
| 578 |
``GNAT.Bounded_Mailboxes`` (:file:`g-boumai.ads`) |
| 579 |
================================================= |
| 580 |
|
| 581 |
.. index:: GNAT.Bounded_Mailboxes (g-boumai.ads) |
| 582 |
|
| 583 |
.. index:: Parsing |
| 584 |
|
| 585 |
.. index:: Mailboxes |
| 586 |
|
| 587 |
Provides a thread-safe asynchronous intertask mailbox communication facility. |
| 588 |
|
| 589 |
.. _`GNAT.Bubble_Sort_(g-bubsor.ads)`: |
| 590 |
|
| 591 |
``GNAT.Bubble_Sort`` (:file:`g-bubsor.ads`) |
| 592 |
=========================================== |
| 593 |
|
| 594 |
.. index:: GNAT.Bubble_Sort (g-bubsor.ads) |
| 595 |
|
| 596 |
.. index:: Sorting |
| 597 |
|
| 598 |
.. index:: Bubble sort |
| 599 |
|
| 600 |
Provides a general implementation of bubble sort usable for sorting arbitrary |
| 601 |
data items. Exchange and comparison procedures are provided by passing |
| 602 |
access-to-procedure values. |
| 603 |
|
| 604 |
.. _`GNAT.Bubble_Sort_A_(g-busora.ads)`: |
| 605 |
|
| 606 |
``GNAT.Bubble_Sort_A`` (:file:`g-busora.ads`) |
| 607 |
============================================= |
| 608 |
|
| 609 |
.. index:: GNAT.Bubble_Sort_A (g-busora.ads) |
| 610 |
|
| 611 |
.. index:: Sorting |
| 612 |
|
| 613 |
.. index:: Bubble sort |
| 614 |
|
| 615 |
Provides a general implementation of bubble sort usable for sorting arbitrary |
| 616 |
data items. Move and comparison procedures are provided by passing |
| 617 |
access-to-procedure values. This is an older version, retained for |
| 618 |
compatibility. Usually ``GNAT.Bubble_Sort`` will be preferable. |
| 619 |
|
| 620 |
.. _`GNAT.Bubble_Sort_G_(g-busorg.ads)`: |
| 621 |
|
| 622 |
``GNAT.Bubble_Sort_G`` (:file:`g-busorg.ads`) |
| 623 |
============================================= |
| 624 |
|
| 625 |
.. index:: GNAT.Bubble_Sort_G (g-busorg.ads) |
| 626 |
|
| 627 |
.. index:: Sorting |
| 628 |
|
| 629 |
.. index:: Bubble sort |
| 630 |
|
| 631 |
Similar to ``Bubble_Sort_A`` except that the move and sorting procedures |
| 632 |
are provided as generic parameters, this improves efficiency, especially |
| 633 |
if the procedures can be inlined, at the expense of duplicating code for |
| 634 |
multiple instantiations. |
| 635 |
|
| 636 |
.. _`GNAT.Byte_Order_Mark_(g-byorma.ads)`: |
| 637 |
|
| 638 |
``GNAT.Byte_Order_Mark`` (:file:`g-byorma.ads`) |
| 639 |
=============================================== |
| 640 |
|
| 641 |
.. index:: GNAT.Byte_Order_Mark (g-byorma.ads) |
| 642 |
|
| 643 |
.. index:: UTF-8 representation |
| 644 |
|
| 645 |
.. index:: Wide characte representations |
| 646 |
|
| 647 |
Provides a routine which given a string, reads the start of the string to |
| 648 |
see whether it is one of the standard byte order marks (BOM's) which signal |
| 649 |
the encoding of the string. The routine includes detection of special XML |
| 650 |
sequences for various UCS input formats. |
| 651 |
|
| 652 |
.. _`GNAT.Byte_Swapping_(g-bytswa.ads)`: |
| 653 |
|
| 654 |
``GNAT.Byte_Swapping`` (:file:`g-bytswa.ads`) |
| 655 |
============================================= |
| 656 |
|
| 657 |
.. index:: GNAT.Byte_Swapping (g-bytswa.ads) |
| 658 |
|
| 659 |
.. index:: Byte swapping |
| 660 |
|
| 661 |
.. index:: Endianness |
| 662 |
|
| 663 |
General routines for swapping the bytes in 2-, 4-, and 8-byte quantities. |
| 664 |
Machine-specific implementations are available in some cases. |
| 665 |
|
| 666 |
.. _`GNAT.Calendar_(g-calend.ads)`: |
| 667 |
|
| 668 |
``GNAT.Calendar`` (:file:`g-calend.ads`) |
| 669 |
======================================== |
| 670 |
|
| 671 |
.. index:: GNAT.Calendar (g-calend.ads) |
| 672 |
|
| 673 |
.. index:: Calendar |
| 674 |
|
| 675 |
Extends the facilities provided by ``Ada.Calendar`` to include handling |
| 676 |
of days of the week, an extended ``Split`` and ``Time_Of`` capability. |
| 677 |
Also provides conversion of ``Ada.Calendar.Time`` values to and from the |
| 678 |
C ``timeval`` format. |
| 679 |
|
| 680 |
.. _`GNAT.Calendar.Time_IO_(g-catiio.ads)`: |
| 681 |
|
| 682 |
``GNAT.Calendar.Time_IO`` (:file:`g-catiio.ads`) |
| 683 |
================================================ |
| 684 |
|
| 685 |
.. index:: Calendar |
| 686 |
|
| 687 |
.. index:: Time |
| 688 |
|
| 689 |
.. index:: GNAT.Calendar.Time_IO (g-catiio.ads) |
| 690 |
|
| 691 |
.. _`GNAT.CRC32_(g-crc32.ads)`: |
| 692 |
|
| 693 |
``GNAT.CRC32`` (:file:`g-crc32.ads`) |
| 694 |
==================================== |
| 695 |
|
| 696 |
.. index:: GNAT.CRC32 (g-crc32.ads) |
| 697 |
|
| 698 |
.. index:: CRC32 |
| 699 |
|
| 700 |
.. index:: Cyclic Redundancy Check |
| 701 |
|
| 702 |
This package implements the CRC-32 algorithm. For a full description |
| 703 |
of this algorithm see |
| 704 |
*Computation of Cyclic Redundancy Checks via Table Look-Up*, |
| 705 |
:title:`Communications of the ACM`, Vol. 31 No. 8, pp. 1008-1013, |
| 706 |
Aug. 1988. Sarwate, D.V. |
| 707 |
|
| 708 |
.. _`GNAT.Case_Util_(g-casuti.ads)`: |
| 709 |
|
| 710 |
``GNAT.Case_Util`` (:file:`g-casuti.ads`) |
| 711 |
========================================= |
| 712 |
|
| 713 |
.. index:: GNAT.Case_Util (g-casuti.ads) |
| 714 |
|
| 715 |
.. index:: Casing utilities |
| 716 |
|
| 717 |
.. index:: Character handling (``GNAT.Case_Util``) |
| 718 |
|
| 719 |
A set of simple routines for handling upper and lower casing of strings |
| 720 |
without the overhead of the full casing tables |
| 721 |
in ``Ada.Characters.Handling``. |
| 722 |
|
| 723 |
.. _`GNAT.CGI_(g-cgi.ads)`: |
| 724 |
|
| 725 |
``GNAT.CGI`` (:file:`g-cgi.ads`) |
| 726 |
================================ |
| 727 |
|
| 728 |
.. index:: GNAT.CGI (g-cgi.ads) |
| 729 |
|
| 730 |
.. index:: CGI (Common Gateway Interface) |
| 731 |
|
| 732 |
This is a package for interfacing a GNAT program with a Web server via the |
| 733 |
Common Gateway Interface (CGI). Basically this package parses the CGI |
| 734 |
parameters, which are a set of key/value pairs sent by the Web server. It |
| 735 |
builds a table whose index is the key and provides some services to deal |
| 736 |
with this table. |
| 737 |
|
| 738 |
.. _`GNAT.CGI.Cookie_(g-cgicoo.ads)`: |
| 739 |
|
| 740 |
``GNAT.CGI.Cookie`` (:file:`g-cgicoo.ads`) |
| 741 |
========================================== |
| 742 |
|
| 743 |
.. index:: GNAT.CGI.Cookie (g-cgicoo.ads) |
| 744 |
|
| 745 |
.. index:: CGI (Common Gateway Interface) cookie support |
| 746 |
|
| 747 |
.. index:: Cookie support in CGI |
| 748 |
|
| 749 |
This is a package to interface a GNAT program with a Web server via the |
| 750 |
Common Gateway Interface (CGI). It exports services to deal with Web |
| 751 |
cookies (piece of information kept in the Web client software). |
| 752 |
|
| 753 |
.. _`GNAT.CGI.Debug_(g-cgideb.ads)`: |
| 754 |
|
| 755 |
``GNAT.CGI.Debug`` (:file:`g-cgideb.ads`) |
| 756 |
========================================= |
| 757 |
|
| 758 |
.. index:: GNAT.CGI.Debug (g-cgideb.ads) |
| 759 |
|
| 760 |
.. index:: CGI (Common Gateway Interface) debugging |
| 761 |
|
| 762 |
This is a package to help debugging CGI (Common Gateway Interface) |
| 763 |
programs written in Ada. |
| 764 |
|
| 765 |
.. _`GNAT.Command_Line_(g-comlin.ads)`: |
| 766 |
|
| 767 |
``GNAT.Command_Line`` (:file:`g-comlin.ads`) |
| 768 |
============================================ |
| 769 |
|
| 770 |
.. index:: GNAT.Command_Line (g-comlin.ads) |
| 771 |
|
| 772 |
.. index:: Command line |
| 773 |
|
| 774 |
Provides a high level interface to ``Ada.Command_Line`` facilities, |
| 775 |
including the ability to scan for named switches with optional parameters |
| 776 |
and expand file names using wildcard notations. |
| 777 |
|
| 778 |
.. _`GNAT.Compiler_Version_(g-comver.ads)`: |
| 779 |
|
| 780 |
``GNAT.Compiler_Version`` (:file:`g-comver.ads`) |
| 781 |
================================================ |
| 782 |
|
| 783 |
.. index:: GNAT.Compiler_Version (g-comver.ads) |
| 784 |
|
| 785 |
.. index:: Compiler Version |
| 786 |
|
| 787 |
.. index:: Version, of compiler |
| 788 |
|
| 789 |
Provides a routine for obtaining the version of the compiler used to |
| 790 |
compile the program. More accurately this is the version of the binder |
| 791 |
used to bind the program (this will normally be the same as the version |
| 792 |
of the compiler if a consistent tool set is used to compile all units |
| 793 |
of a partition). |
| 794 |
|
| 795 |
.. _`GNAT.Ctrl_C_(g-ctrl_c.ads)`: |
| 796 |
|
| 797 |
``GNAT.Ctrl_C`` (:file:`g-ctrl_c.ads`) |
| 798 |
====================================== |
| 799 |
|
| 800 |
.. index:: GNAT.Ctrl_C (g-ctrl_c.ads) |
| 801 |
|
| 802 |
.. index:: Interrupt |
| 803 |
|
| 804 |
Provides a simple interface to handle Ctrl-C keyboard events. |
| 805 |
|
| 806 |
.. _`GNAT.Current_Exception_(g-curexc.ads)`: |
| 807 |
|
| 808 |
``GNAT.Current_Exception`` (:file:`g-curexc.ads`) |
| 809 |
================================================= |
| 810 |
|
| 811 |
.. index:: GNAT.Current_Exception (g-curexc.ads) |
| 812 |
|
| 813 |
.. index:: Current exception |
| 814 |
|
| 815 |
.. index:: Exception retrieval |
| 816 |
|
| 817 |
Provides access to information on the current exception that has been raised |
| 818 |
without the need for using the Ada 95 / Ada 2005 exception choice parameter |
| 819 |
specification syntax. |
| 820 |
This is particularly useful in simulating typical facilities for |
| 821 |
obtaining information about exceptions provided by Ada 83 compilers. |
| 822 |
|
| 823 |
.. _`GNAT.Debug_Pools_(g-debpoo.ads)`: |
| 824 |
|
| 825 |
``GNAT.Debug_Pools`` (:file:`g-debpoo.ads`) |
| 826 |
=========================================== |
| 827 |
|
| 828 |
.. index:: GNAT.Debug_Pools (g-debpoo.ads) |
| 829 |
|
| 830 |
.. index:: Debugging |
| 831 |
|
| 832 |
.. index:: Debug pools |
| 833 |
|
| 834 |
.. index:: Memory corruption debugging |
| 835 |
|
| 836 |
Provides a debugging storage pools that helps tracking memory corruption |
| 837 |
problems. |
| 838 |
See ``The GNAT Debug_Pool Facility`` section in the :title:`GNAT User's Guide`. |
| 839 |
|
| 840 |
.. _`GNAT.Debug_Utilities_(g-debuti.ads)`: |
| 841 |
|
| 842 |
``GNAT.Debug_Utilities`` (:file:`g-debuti.ads`) |
| 843 |
=============================================== |
| 844 |
|
| 845 |
.. index:: GNAT.Debug_Utilities (g-debuti.ads) |
| 846 |
|
| 847 |
.. index:: Debugging |
| 848 |
|
| 849 |
Provides a few useful utilities for debugging purposes, including conversion |
| 850 |
to and from string images of address values. Supports both C and Ada formats |
| 851 |
for hexadecimal literals. |
| 852 |
|
| 853 |
.. _`GNAT.Decode_String_(g-decstr.ads)`: |
| 854 |
|
| 855 |
``GNAT.Decode_String`` (:file:`g-decstr.ads`) |
| 856 |
============================================= |
| 857 |
|
| 858 |
.. index:: GNAT.Decode_String (g-decstr.ads) |
| 859 |
|
| 860 |
.. index:: Decoding strings |
| 861 |
|
| 862 |
.. index:: String decoding |
| 863 |
|
| 864 |
.. index:: Wide character encoding |
| 865 |
|
| 866 |
.. index:: UTF-8 |
| 867 |
|
| 868 |
.. index:: Unicode |
| 869 |
|
| 870 |
A generic package providing routines for decoding wide character and wide wide |
| 871 |
character strings encoded as sequences of 8-bit characters using a specified |
| 872 |
encoding method. Includes validation routines, and also routines for stepping |
| 873 |
to next or previous encoded character in an encoded string. |
| 874 |
Useful in conjunction with Unicode character coding. Note there is a |
| 875 |
preinstantiation for UTF-8. See next entry. |
| 876 |
|
| 877 |
.. _`GNAT.Decode_UTF8_String_(g-deutst.ads)`: |
| 878 |
|
| 879 |
``GNAT.Decode_UTF8_String`` (:file:`g-deutst.ads`) |
| 880 |
================================================== |
| 881 |
|
| 882 |
.. index:: GNAT.Decode_UTF8_String (g-deutst.ads) |
| 883 |
|
| 884 |
.. index:: Decoding strings |
| 885 |
|
| 886 |
.. index:: Decoding UTF-8 strings |
| 887 |
|
| 888 |
.. index:: UTF-8 string decoding |
| 889 |
|
| 890 |
.. index:: Wide character decoding |
| 891 |
|
| 892 |
.. index:: UTF-8 |
| 893 |
|
| 894 |
.. index:: Unicode |
| 895 |
|
| 896 |
A preinstantiation of GNAT.Decode_Strings for UTF-8 encoding. |
| 897 |
|
| 898 |
.. _`GNAT.Directory_Operations_(g-dirope.ads)`: |
| 899 |
|
| 900 |
``GNAT.Directory_Operations`` (:file:`g-dirope.ads`) |
| 901 |
==================================================== |
| 902 |
|
| 903 |
.. index:: GNAT.Directory_Operations (g-dirope.ads) |
| 904 |
|
| 905 |
.. index:: Directory operations |
| 906 |
|
| 907 |
Provides a set of routines for manipulating directories, including changing |
| 908 |
the current directory, making new directories, and scanning the files in a |
| 909 |
directory. |
| 910 |
|
| 911 |
.. _`GNAT.Directory_Operations.Iteration_(g-diopit.ads)`: |
| 912 |
|
| 913 |
``GNAT.Directory_Operations.Iteration`` (:file:`g-diopit.ads`) |
| 914 |
============================================================== |
| 915 |
|
| 916 |
.. index:: GNAT.Directory_Operations.Iteration (g-diopit.ads) |
| 917 |
|
| 918 |
.. index:: Directory operations iteration |
| 919 |
|
| 920 |
A child unit of GNAT.Directory_Operations providing additional operations |
| 921 |
for iterating through directories. |
| 922 |
|
| 923 |
.. _`GNAT.Dynamic_HTables_(g-dynhta.ads)`: |
| 924 |
|
| 925 |
``GNAT.Dynamic_HTables`` (:file:`g-dynhta.ads`) |
| 926 |
=============================================== |
| 927 |
|
| 928 |
.. index:: GNAT.Dynamic_HTables (g-dynhta.ads) |
| 929 |
|
| 930 |
.. index:: Hash tables |
| 931 |
|
| 932 |
A generic implementation of hash tables that can be used to hash arbitrary |
| 933 |
data. Provided in two forms, a simple form with built in hash functions, |
| 934 |
and a more complex form in which the hash function is supplied. |
| 935 |
|
| 936 |
This package provides a facility similar to that of ``GNAT.HTable``, |
| 937 |
except that this package declares a type that can be used to define |
| 938 |
dynamic instances of the hash table, while an instantiation of |
| 939 |
``GNAT.HTable`` creates a single instance of the hash table. |
| 940 |
|
| 941 |
.. _`GNAT.Dynamic_Tables_(g-dyntab.ads)`: |
| 942 |
|
| 943 |
``GNAT.Dynamic_Tables`` (:file:`g-dyntab.ads`) |
| 944 |
============================================== |
| 945 |
|
| 946 |
.. index:: GNAT.Dynamic_Tables (g-dyntab.ads) |
| 947 |
|
| 948 |
.. index:: Table implementation |
| 949 |
|
| 950 |
.. index:: Arrays, extendable |
| 951 |
|
| 952 |
A generic package providing a single dimension array abstraction where the |
| 953 |
length of the array can be dynamically modified. |
| 954 |
|
| 955 |
This package provides a facility similar to that of ``GNAT.Table``, |
| 956 |
except that this package declares a type that can be used to define |
| 957 |
dynamic instances of the table, while an instantiation of |
| 958 |
``GNAT.Table`` creates a single instance of the table type. |
| 959 |
|
| 960 |
.. _`GNAT.Encode_String_(g-encstr.ads)`: |
| 961 |
|
| 962 |
``GNAT.Encode_String`` (:file:`g-encstr.ads`) |
| 963 |
============================================= |
| 964 |
|
| 965 |
.. index:: GNAT.Encode_String (g-encstr.ads) |
| 966 |
|
| 967 |
.. index:: Encoding strings |
| 968 |
|
| 969 |
.. index:: String encoding |
| 970 |
|
| 971 |
.. index:: Wide character encoding |
| 972 |
|
| 973 |
.. index:: UTF-8 |
| 974 |
|
| 975 |
.. index:: Unicode |
| 976 |
|
| 977 |
A generic package providing routines for encoding wide character and wide |
| 978 |
wide character strings as sequences of 8-bit characters using a specified |
| 979 |
encoding method. Useful in conjunction with Unicode character coding. |
| 980 |
Note there is a preinstantiation for UTF-8. See next entry. |
| 981 |
|
| 982 |
.. _`GNAT.Encode_UTF8_String_(g-enutst.ads)`: |
| 983 |
|
| 984 |
``GNAT.Encode_UTF8_String`` (:file:`g-enutst.ads`) |
| 985 |
================================================== |
| 986 |
|
| 987 |
.. index:: GNAT.Encode_UTF8_String (g-enutst.ads) |
| 988 |
|
| 989 |
.. index:: Encoding strings |
| 990 |
|
| 991 |
.. index:: Encoding UTF-8 strings |
| 992 |
|
| 993 |
.. index:: UTF-8 string encoding |
| 994 |
|
| 995 |
.. index:: Wide character encoding |
| 996 |
|
| 997 |
.. index:: UTF-8 |
| 998 |
|
| 999 |
.. index:: Unicode |
| 1000 |
|
| 1001 |
A preinstantiation of GNAT.Encode_Strings for UTF-8 encoding. |
| 1002 |
|
| 1003 |
.. _`GNAT.Exception_Actions_(g-excact.ads)`: |
| 1004 |
|
| 1005 |
``GNAT.Exception_Actions`` (:file:`g-excact.ads`) |
| 1006 |
================================================= |
| 1007 |
|
| 1008 |
.. index:: GNAT.Exception_Actions (g-excact.ads) |
| 1009 |
|
| 1010 |
.. index:: Exception actions |
| 1011 |
|
| 1012 |
Provides callbacks when an exception is raised. Callbacks can be registered |
| 1013 |
for specific exceptions, or when any exception is raised. This |
| 1014 |
can be used for instance to force a core dump to ease debugging. |
| 1015 |
|
| 1016 |
.. _`GNAT.Exception_Traces_(g-exctra.ads)`: |
| 1017 |
|
| 1018 |
``GNAT.Exception_Traces`` (:file:`g-exctra.ads`) |
| 1019 |
================================================ |
| 1020 |
|
| 1021 |
.. index:: GNAT.Exception_Traces (g-exctra.ads) |
| 1022 |
|
| 1023 |
.. index:: Exception traces |
| 1024 |
|
| 1025 |
.. index:: Debugging |
| 1026 |
|
| 1027 |
Provides an interface allowing to control automatic output upon exception |
| 1028 |
occurrences. |
| 1029 |
|
| 1030 |
.. _`GNAT.Exceptions_(g-except.ads)`: |
| 1031 |
|
| 1032 |
``GNAT.Exceptions`` (:file:`g-except.ads`) |
| 1033 |
========================================== |
| 1034 |
|
| 1035 |
.. index:: GNAT.Exceptions (g-except.ads) |
| 1036 |
|
| 1037 |
.. index:: Exceptions, Pure |
| 1038 |
|
| 1039 |
.. index:: Pure packages, exceptions |
| 1040 |
|
| 1041 |
Normally it is not possible to raise an exception with |
| 1042 |
a message from a subprogram in a pure package, since the |
| 1043 |
necessary types and subprograms are in ``Ada.Exceptions`` |
| 1044 |
which is not a pure unit. ``GNAT.Exceptions`` provides a |
| 1045 |
facility for getting around this limitation for a few |
| 1046 |
predefined exceptions, and for example allows raising |
| 1047 |
``Constraint_Error`` with a message from a pure subprogram. |
| 1048 |
|
| 1049 |
.. _`GNAT.Expect_(g-expect.ads)`: |
| 1050 |
|
| 1051 |
``GNAT.Expect`` (:file:`g-expect.ads`) |
| 1052 |
====================================== |
| 1053 |
|
| 1054 |
.. index:: GNAT.Expect (g-expect.ads) |
| 1055 |
|
| 1056 |
Provides a set of subprograms similar to what is available |
| 1057 |
with the standard Tcl Expect tool. |
| 1058 |
It allows you to easily spawn and communicate with an external process. |
| 1059 |
You can send commands or inputs to the process, and compare the output |
| 1060 |
with some expected regular expression. Currently ``GNAT.Expect`` |
| 1061 |
is implemented on all native GNAT ports. |
| 1062 |
It is not implemented for cross ports, and in particular is not |
| 1063 |
implemented for VxWorks or LynxOS. |
| 1064 |
|
| 1065 |
.. _`GNAT.Expect.TTY_(g-exptty.ads)`: |
| 1066 |
|
| 1067 |
``GNAT.Expect.TTY`` (:file:`g-exptty.ads`) |
| 1068 |
========================================== |
| 1069 |
|
| 1070 |
.. index:: GNAT.Expect.TTY (g-exptty.ads) |
| 1071 |
|
| 1072 |
As GNAT.Expect but using pseudo-terminal. |
| 1073 |
Currently ``GNAT.Expect.TTY`` is implemented on all native GNAT |
| 1074 |
ports. It is not implemented for cross ports, and |
| 1075 |
in particular is not implemented for VxWorks or LynxOS. |
| 1076 |
|
| 1077 |
.. _`GNAT.Float_Control_(g-flocon.ads)`: |
| 1078 |
|
| 1079 |
``GNAT.Float_Control`` (:file:`g-flocon.ads`) |
| 1080 |
============================================= |
| 1081 |
|
| 1082 |
.. index:: GNAT.Float_Control (g-flocon.ads) |
| 1083 |
|
| 1084 |
.. index:: Floating-Point Processor |
| 1085 |
|
| 1086 |
Provides an interface for resetting the floating-point processor into the |
| 1087 |
mode required for correct semantic operation in Ada. Some third party |
| 1088 |
library calls may cause this mode to be modified, and the Reset procedure |
| 1089 |
in this package can be used to reestablish the required mode. |
| 1090 |
|
| 1091 |
.. _`GNAT.Formatted_String_(g-forstr.ads)`: |
| 1092 |
|
| 1093 |
``GNAT.Formatted_String`` (:file:`g-forstr.ads`) |
| 1094 |
================================================ |
| 1095 |
|
| 1096 |
.. index:: GNAT.Formatted_String (g-forstr.ads) |
| 1097 |
|
| 1098 |
.. index:: Formatted String |
| 1099 |
|
| 1100 |
Provides support for C/C++ printf() formatted strings. The format is |
| 1101 |
copied from the printf() routine and should therefore give identical |
| 1102 |
output. Some generic routines are provided to be able to use types |
| 1103 |
derived from Integer, Float or enumerations as values for the |
| 1104 |
formatted string. |
| 1105 |
|
| 1106 |
.. _`GNAT.Generic_Fast_Math_Functions_(g-gfmafu.ads)`: |
| 1107 |
|
| 1108 |
``GNAT.Generic_Fast_Math_Functions`` (:file:`g-gfmafu.ads`) |
| 1109 |
=========================================================== |
| 1110 |
|
| 1111 |
.. index:: GNAT.Generic_Fast_Math_Functions (g-gfmafu.ads) |
| 1112 |
|
| 1113 |
.. index:: Mathematical functions |
| 1114 |
|
| 1115 |
Provides direct access to the underlying implementation of the common |
| 1116 |
mathematical functions, generally from the system mathematical library. |
| 1117 |
This differs from ``Ada.Numerics.Generic_Elementary_Functions`` in that |
| 1118 |
the implementation may deviate from the semantics specified for these |
| 1119 |
functions in the Reference Manual, for example ``Numerics.Argument_Error`` |
| 1120 |
is not raised. On selected platforms, some of these functions may also |
| 1121 |
have a vector implementation that can be automatically used by the |
| 1122 |
compiler when auto-vectorization is enabled. |
| 1123 |
|
| 1124 |
.. _`GNAT.Heap_Sort_(g-heasor.ads)`: |
| 1125 |
|
| 1126 |
``GNAT.Heap_Sort`` (:file:`g-heasor.ads`) |
| 1127 |
========================================= |
| 1128 |
|
| 1129 |
.. index:: GNAT.Heap_Sort (g-heasor.ads) |
| 1130 |
|
| 1131 |
.. index:: Sorting |
| 1132 |
|
| 1133 |
Provides a general implementation of heap sort usable for sorting arbitrary |
| 1134 |
data items. Exchange and comparison procedures are provided by passing |
| 1135 |
access-to-procedure values. The algorithm used is a modified heap sort |
| 1136 |
that performs approximately N*log(N) comparisons in the worst case. |
| 1137 |
|
| 1138 |
.. _`GNAT.Heap_Sort_A_(g-hesora.ads)`: |
| 1139 |
|
| 1140 |
``GNAT.Heap_Sort_A`` (:file:`g-hesora.ads`) |
| 1141 |
=========================================== |
| 1142 |
|
| 1143 |
.. index:: GNAT.Heap_Sort_A (g-hesora.ads) |
| 1144 |
|
| 1145 |
.. index:: Sorting |
| 1146 |
|
| 1147 |
Provides a general implementation of heap sort usable for sorting arbitrary |
| 1148 |
data items. Move and comparison procedures are provided by passing |
| 1149 |
access-to-procedure values. The algorithm used is a modified heap sort |
| 1150 |
that performs approximately N*log(N) comparisons in the worst case. |
| 1151 |
This differs from ``GNAT.Heap_Sort`` in having a less convenient |
| 1152 |
interface, but may be slightly more efficient. |
| 1153 |
|
| 1154 |
.. _`GNAT.Heap_Sort_G_(g-hesorg.ads)`: |
| 1155 |
|
| 1156 |
``GNAT.Heap_Sort_G`` (:file:`g-hesorg.ads`) |
| 1157 |
=========================================== |
| 1158 |
|
| 1159 |
.. index:: GNAT.Heap_Sort_G (g-hesorg.ads) |
| 1160 |
|
| 1161 |
.. index:: Sorting |
| 1162 |
|
| 1163 |
Similar to ``Heap_Sort_A`` except that the move and sorting procedures |
| 1164 |
are provided as generic parameters, this improves efficiency, especially |
| 1165 |
if the procedures can be inlined, at the expense of duplicating code for |
| 1166 |
multiple instantiations. |
| 1167 |
|
| 1168 |
.. _`GNAT.HTable_(g-htable.ads)`: |
| 1169 |
|
| 1170 |
``GNAT.HTable`` (:file:`g-htable.ads`) |
| 1171 |
====================================== |
| 1172 |
|
| 1173 |
.. index:: GNAT.HTable (g-htable.ads) |
| 1174 |
|
| 1175 |
.. index:: Hash tables |
| 1176 |
|
| 1177 |
A generic implementation of hash tables that can be used to hash arbitrary |
| 1178 |
data. Provides two approaches, one a simple static approach, and the other |
| 1179 |
allowing arbitrary dynamic hash tables. |
| 1180 |
|
| 1181 |
.. _`GNAT.IO_(g-io.ads)`: |
| 1182 |
|
| 1183 |
``GNAT.IO`` (:file:`g-io.ads`) |
| 1184 |
============================== |
| 1185 |
|
| 1186 |
.. index:: GNAT.IO (g-io.ads) |
| 1187 |
|
| 1188 |
.. index:: Simple I/O |
| 1189 |
|
| 1190 |
.. index:: Input/Output facilities |
| 1191 |
|
| 1192 |
A simple preelaborable input-output package that provides a subset of |
| 1193 |
simple Text_IO functions for reading characters and strings from |
| 1194 |
Standard_Input, and writing characters, strings and integers to either |
| 1195 |
Standard_Output or Standard_Error. |
| 1196 |
|
| 1197 |
.. _`GNAT.IO_Aux_(g-io_aux.ads)`: |
| 1198 |
|
| 1199 |
``GNAT.IO_Aux`` (:file:`g-io_aux.ads`) |
| 1200 |
====================================== |
| 1201 |
|
| 1202 |
.. index:: GNAT.IO_Aux (g-io_aux.ads) |
| 1203 |
|
| 1204 |
.. index:: Text_IO |
| 1205 |
|
| 1206 |
.. index:: Input/Output facilities |
| 1207 |
|
| 1208 |
Provides some auxiliary functions for use with Text_IO, including a test |
| 1209 |
for whether a file exists, and functions for reading a line of text. |
| 1210 |
|
| 1211 |
.. _`GNAT.Lock_Files_(g-locfil.ads)`: |
| 1212 |
|
| 1213 |
``GNAT.Lock_Files`` (:file:`g-locfil.ads`) |
| 1214 |
========================================== |
| 1215 |
|
| 1216 |
.. index:: GNAT.Lock_Files (g-locfil.ads) |
| 1217 |
|
| 1218 |
.. index:: File locking |
| 1219 |
|
| 1220 |
.. index:: Locking using files |
| 1221 |
|
| 1222 |
Provides a general interface for using files as locks. Can be used for |
| 1223 |
providing program level synchronization. |
| 1224 |
|
| 1225 |
.. _`GNAT.MBBS_Discrete_Random_(g-mbdira.ads)`: |
| 1226 |
|
| 1227 |
``GNAT.MBBS_Discrete_Random`` (:file:`g-mbdira.ads`) |
| 1228 |
==================================================== |
| 1229 |
|
| 1230 |
.. index:: GNAT.MBBS_Discrete_Random (g-mbdira.ads) |
| 1231 |
|
| 1232 |
.. index:: Random number generation |
| 1233 |
|
| 1234 |
The original implementation of ``Ada.Numerics.Discrete_Random``. Uses |
| 1235 |
a modified version of the Blum-Blum-Shub generator. |
| 1236 |
|
| 1237 |
.. _`GNAT.MBBS_Float_Random_(g-mbflra.ads)`: |
| 1238 |
|
| 1239 |
``GNAT.MBBS_Float_Random`` (:file:`g-mbflra.ads`) |
| 1240 |
================================================= |
| 1241 |
|
| 1242 |
.. index:: GNAT.MBBS_Float_Random (g-mbflra.ads) |
| 1243 |
|
| 1244 |
.. index:: Random number generation |
| 1245 |
|
| 1246 |
The original implementation of ``Ada.Numerics.Float_Random``. Uses |
| 1247 |
a modified version of the Blum-Blum-Shub generator. |
| 1248 |
|
| 1249 |
.. _`GNAT.MD5_(g-md5.ads)`: |
| 1250 |
|
| 1251 |
``GNAT.MD5`` (:file:`g-md5.ads`) |
| 1252 |
================================ |
| 1253 |
|
| 1254 |
.. index:: GNAT.MD5 (g-md5.ads) |
| 1255 |
|
| 1256 |
.. index:: Message Digest MD5 |
| 1257 |
|
| 1258 |
Implements the MD5 Message-Digest Algorithm as described in RFC 1321, and |
| 1259 |
the HMAC-MD5 message authentication function as described in RFC 2104 and |
| 1260 |
FIPS PUB 198. |
| 1261 |
|
| 1262 |
.. _`GNAT.Memory_Dump_(g-memdum.ads)`: |
| 1263 |
|
| 1264 |
``GNAT.Memory_Dump`` (:file:`g-memdum.ads`) |
| 1265 |
=========================================== |
| 1266 |
|
| 1267 |
.. index:: GNAT.Memory_Dump (g-memdum.ads) |
| 1268 |
|
| 1269 |
.. index:: Dump Memory |
| 1270 |
|
| 1271 |
Provides a convenient routine for dumping raw memory to either the |
| 1272 |
standard output or standard error files. Uses GNAT.IO for actual |
| 1273 |
output. |
| 1274 |
|
| 1275 |
.. _`GNAT.Most_Recent_Exception_(g-moreex.ads)`: |
| 1276 |
|
| 1277 |
``GNAT.Most_Recent_Exception`` (:file:`g-moreex.ads`) |
| 1278 |
===================================================== |
| 1279 |
|
| 1280 |
.. index:: GNAT.Most_Recent_Exception (g-moreex.ads) |
| 1281 |
|
| 1282 |
.. index:: Exception, obtaining most recent |
| 1283 |
|
| 1284 |
Provides access to the most recently raised exception. Can be used for |
| 1285 |
various logging purposes, including duplicating functionality of some |
| 1286 |
Ada 83 implementation dependent extensions. |
| 1287 |
|
| 1288 |
.. _`GNAT.OS_Lib_(g-os_lib.ads)`: |
| 1289 |
|
| 1290 |
``GNAT.OS_Lib`` (:file:`g-os_lib.ads`) |
| 1291 |
====================================== |
| 1292 |
|
| 1293 |
.. index:: GNAT.OS_Lib (g-os_lib.ads) |
| 1294 |
|
| 1295 |
.. index:: Operating System interface |
| 1296 |
|
| 1297 |
.. index:: Spawn capability |
| 1298 |
|
| 1299 |
Provides a range of target independent operating system interface functions, |
| 1300 |
including time/date management, file operations, subprocess management, |
| 1301 |
including a portable spawn procedure, and access to environment variables |
| 1302 |
and error return codes. |
| 1303 |
|
| 1304 |
.. _`GNAT.Perfect_Hash_Generators_(g-pehage.ads)`: |
| 1305 |
|
| 1306 |
``GNAT.Perfect_Hash_Generators`` (:file:`g-pehage.ads`) |
| 1307 |
======================================================= |
| 1308 |
|
| 1309 |
.. index:: GNAT.Perfect_Hash_Generators (g-pehage.ads) |
| 1310 |
|
| 1311 |
.. index:: Hash functions |
| 1312 |
|
| 1313 |
Provides a generator of static minimal perfect hash functions. No |
| 1314 |
collisions occur and each item can be retrieved from the table in one |
| 1315 |
probe (perfect property). The hash table size corresponds to the exact |
| 1316 |
size of the key set and no larger (minimal property). The key set has to |
| 1317 |
be known in advance (static property). The hash functions are also order |
| 1318 |
preserving. If w2 is inserted after w1 in the generator, their |
| 1319 |
hashcode are in the same order. These hashing functions are very |
| 1320 |
convenient for use with realtime applications. |
| 1321 |
|
| 1322 |
.. _`GNAT.Random_Numbers_(g-rannum.ads)`: |
| 1323 |
|
| 1324 |
``GNAT.Random_Numbers`` (:file:`g-rannum.ads`) |
| 1325 |
============================================== |
| 1326 |
|
| 1327 |
.. index:: GNAT.Random_Numbers (g-rannum.ads) |
| 1328 |
|
| 1329 |
.. index:: Random number generation |
| 1330 |
|
| 1331 |
Provides random number capabilities which extend those available in the |
| 1332 |
standard Ada library and are more convenient to use. This package is |
| 1333 |
however NOT suitable for situations requiring cryptographically secure |
| 1334 |
randomness. |
| 1335 |
|
| 1336 |
.. _`GNAT.Regexp_(g-regexp.ads)`: |
| 1337 |
|
| 1338 |
``GNAT.Regexp`` (:file:`g-regexp.ads`) |
| 1339 |
====================================== |
| 1340 |
|
| 1341 |
.. index:: GNAT.Regexp (g-regexp.ads) |
| 1342 |
|
| 1343 |
.. index:: Regular expressions |
| 1344 |
|
| 1345 |
.. index:: Pattern matching |
| 1346 |
|
| 1347 |
A simple implementation of regular expressions, using a subset of regular |
| 1348 |
expression syntax copied from familiar Unix style utilities. This is the |
| 1349 |
simplest of the three pattern matching packages provided, and is particularly |
| 1350 |
suitable for 'file globbing' applications. |
| 1351 |
|
| 1352 |
.. _`GNAT.Registry_(g-regist.ads)`: |
| 1353 |
|
| 1354 |
``GNAT.Registry`` (:file:`g-regist.ads`) |
| 1355 |
======================================== |
| 1356 |
|
| 1357 |
.. index:: GNAT.Registry (g-regist.ads) |
| 1358 |
|
| 1359 |
.. index:: Windows Registry |
| 1360 |
|
| 1361 |
This is a high level binding to the Windows registry. It is possible to |
| 1362 |
do simple things like reading a key value, creating a new key. For full |
| 1363 |
registry API, but at a lower level of abstraction, refer to the Win32.Winreg |
| 1364 |
package provided with the Win32Ada binding |
| 1365 |
|
| 1366 |
.. _`GNAT.Regpat_(g-regpat.ads)`: |
| 1367 |
|
| 1368 |
``GNAT.Regpat`` (:file:`g-regpat.ads`) |
| 1369 |
====================================== |
| 1370 |
|
| 1371 |
.. index:: GNAT.Regpat (g-regpat.ads) |
| 1372 |
|
| 1373 |
.. index:: Regular expressions |
| 1374 |
|
| 1375 |
.. index:: Pattern matching |
| 1376 |
|
| 1377 |
A complete implementation of Unix-style regular expression matching, copied |
| 1378 |
from the original V7 style regular expression library written in C by |
| 1379 |
Henry Spencer (and binary compatible with this C library). |
| 1380 |
|
| 1381 |
.. _`GNAT.Rewrite_Data_(g-rewdat.ads)`: |
| 1382 |
|
| 1383 |
``GNAT.Rewrite_Data`` (:file:`g-rewdat.ads`) |
| 1384 |
============================================ |
| 1385 |
|
| 1386 |
.. index:: GNAT.Rewrite_Data (g-rewdat.ads) |
| 1387 |
|
| 1388 |
.. index:: Rewrite data |
| 1389 |
|
| 1390 |
A unit to rewrite on-the-fly string occurrences in a stream of |
| 1391 |
data. The implementation has a very minimal memory footprint as the |
| 1392 |
full content to be processed is not loaded into memory all at once. This makes |
| 1393 |
this interface usable for large files or socket streams. |
| 1394 |
|
| 1395 |
.. _`GNAT.Secondary_Stack_Info_(g-sestin.ads)`: |
| 1396 |
|
| 1397 |
``GNAT.Secondary_Stack_Info`` (:file:`g-sestin.ads`) |
| 1398 |
==================================================== |
| 1399 |
|
| 1400 |
.. index:: GNAT.Secondary_Stack_Info (g-sestin.ads) |
| 1401 |
|
| 1402 |
.. index:: Secondary Stack Info |
| 1403 |
|
| 1404 |
Provides the capability to query the high water mark of the current task's |
| 1405 |
secondary stack. |
| 1406 |
|
| 1407 |
.. _`GNAT.Semaphores_(g-semaph.ads)`: |
| 1408 |
|
| 1409 |
``GNAT.Semaphores`` (:file:`g-semaph.ads`) |
| 1410 |
========================================== |
| 1411 |
|
| 1412 |
.. index:: GNAT.Semaphores (g-semaph.ads) |
| 1413 |
|
| 1414 |
.. index:: Semaphores |
| 1415 |
|
| 1416 |
Provides classic counting and binary semaphores using protected types. |
| 1417 |
|
| 1418 |
.. _`GNAT.Serial_Communications_(g-sercom.ads)`: |
| 1419 |
|
| 1420 |
``GNAT.Serial_Communications`` (:file:`g-sercom.ads`) |
| 1421 |
===================================================== |
| 1422 |
|
| 1423 |
.. index:: GNAT.Serial_Communications (g-sercom.ads) |
| 1424 |
|
| 1425 |
.. index:: Serial_Communications |
| 1426 |
|
| 1427 |
Provides a simple interface to send and receive data over a serial |
| 1428 |
port. This is only supported on GNU/Linux and Windows. |
| 1429 |
|
| 1430 |
.. _`GNAT.SHA1_(g-sha1.ads)`: |
| 1431 |
|
| 1432 |
``GNAT.SHA1`` (:file:`g-sha1.ads`) |
| 1433 |
================================== |
| 1434 |
|
| 1435 |
.. index:: GNAT.SHA1 (g-sha1.ads) |
| 1436 |
|
| 1437 |
.. index:: Secure Hash Algorithm SHA-1 |
| 1438 |
|
| 1439 |
Implements the SHA-1 Secure Hash Algorithm as described in FIPS PUB 180-3 |
| 1440 |
and RFC 3174, and the HMAC-SHA1 message authentication function as described |
| 1441 |
in RFC 2104 and FIPS PUB 198. |
| 1442 |
|
| 1443 |
.. _`GNAT.SHA224_(g-sha224.ads)`: |
| 1444 |
|
| 1445 |
``GNAT.SHA224`` (:file:`g-sha224.ads`) |
| 1446 |
====================================== |
| 1447 |
|
| 1448 |
.. index:: GNAT.SHA224 (g-sha224.ads) |
| 1449 |
|
| 1450 |
.. index:: Secure Hash Algorithm SHA-224 |
| 1451 |
|
| 1452 |
Implements the SHA-224 Secure Hash Algorithm as described in FIPS PUB 180-3, |
| 1453 |
and the HMAC-SHA224 message authentication function as described |
| 1454 |
in RFC 2104 and FIPS PUB 198. |
| 1455 |
|
| 1456 |
.. _`GNAT.SHA256_(g-sha256.ads)`: |
| 1457 |
|
| 1458 |
``GNAT.SHA256`` (:file:`g-sha256.ads`) |
| 1459 |
====================================== |
| 1460 |
|
| 1461 |
.. index:: GNAT.SHA256 (g-sha256.ads) |
| 1462 |
|
| 1463 |
.. index:: Secure Hash Algorithm SHA-256 |
| 1464 |
|
| 1465 |
Implements the SHA-256 Secure Hash Algorithm as described in FIPS PUB 180-3, |
| 1466 |
and the HMAC-SHA256 message authentication function as described |
| 1467 |
in RFC 2104 and FIPS PUB 198. |
| 1468 |
|
| 1469 |
.. _`GNAT.SHA384_(g-sha384.ads)`: |
| 1470 |
|
| 1471 |
``GNAT.SHA384`` (:file:`g-sha384.ads`) |
| 1472 |
====================================== |
| 1473 |
|
| 1474 |
.. index:: GNAT.SHA384 (g-sha384.ads) |
| 1475 |
|
| 1476 |
.. index:: Secure Hash Algorithm SHA-384 |
| 1477 |
|
| 1478 |
Implements the SHA-384 Secure Hash Algorithm as described in FIPS PUB 180-3, |
| 1479 |
and the HMAC-SHA384 message authentication function as described |
| 1480 |
in RFC 2104 and FIPS PUB 198. |
| 1481 |
|
| 1482 |
.. _`GNAT.SHA512_(g-sha512.ads)`: |
| 1483 |
|
| 1484 |
``GNAT.SHA512`` (:file:`g-sha512.ads`) |
| 1485 |
====================================== |
| 1486 |
|
| 1487 |
.. index:: GNAT.SHA512 (g-sha512.ads) |
| 1488 |
|
| 1489 |
.. index:: Secure Hash Algorithm SHA-512 |
| 1490 |
|
| 1491 |
Implements the SHA-512 Secure Hash Algorithm as described in FIPS PUB 180-3, |
| 1492 |
and the HMAC-SHA512 message authentication function as described |
| 1493 |
in RFC 2104 and FIPS PUB 198. |
| 1494 |
|
| 1495 |
.. _`GNAT.Signals_(g-signal.ads)`: |
| 1496 |
|
| 1497 |
``GNAT.Signals`` (:file:`g-signal.ads`) |
| 1498 |
======================================= |
| 1499 |
|
| 1500 |
.. index:: GNAT.Signals (g-signal.ads) |
| 1501 |
|
| 1502 |
.. index:: Signals |
| 1503 |
|
| 1504 |
Provides the ability to manipulate the blocked status of signals on supported |
| 1505 |
targets. |
| 1506 |
|
| 1507 |
.. _`GNAT.Sockets_(g-socket.ads)`: |
| 1508 |
|
| 1509 |
``GNAT.Sockets`` (:file:`g-socket.ads`) |
| 1510 |
======================================= |
| 1511 |
|
| 1512 |
.. index:: GNAT.Sockets (g-socket.ads) |
| 1513 |
|
| 1514 |
.. index:: Sockets |
| 1515 |
|
| 1516 |
A high level and portable interface to develop sockets based applications. |
| 1517 |
This package is based on the sockets thin binding found in |
| 1518 |
``GNAT.Sockets.Thin``. Currently ``GNAT.Sockets`` is implemented |
| 1519 |
on all native GNAT ports and on VxWorks cross ports. It is not implemented for |
| 1520 |
the LynxOS cross port. |
| 1521 |
|
| 1522 |
.. _`GNAT.Source_Info_(g-souinf.ads)`: |
| 1523 |
|
| 1524 |
``GNAT.Source_Info`` (:file:`g-souinf.ads`) |
| 1525 |
=========================================== |
| 1526 |
|
| 1527 |
.. index:: GNAT.Source_Info (g-souinf.ads) |
| 1528 |
|
| 1529 |
.. index:: Source Information |
| 1530 |
|
| 1531 |
Provides subprograms that give access to source code information known at |
| 1532 |
compile time, such as the current file name and line number. Also provides |
| 1533 |
subprograms yielding the date and time of the current compilation (like the |
| 1534 |
C macros ``__DATE__`` and ``__TIME__``) |
| 1535 |
|
| 1536 |
.. _`GNAT.Spelling_Checker_(g-speche.ads)`: |
| 1537 |
|
| 1538 |
``GNAT.Spelling_Checker`` (:file:`g-speche.ads`) |
| 1539 |
================================================ |
| 1540 |
|
| 1541 |
.. index:: GNAT.Spelling_Checker (g-speche.ads) |
| 1542 |
|
| 1543 |
.. index:: Spell checking |
| 1544 |
|
| 1545 |
Provides a function for determining whether one string is a plausible |
| 1546 |
near misspelling of another string. |
| 1547 |
|
| 1548 |
.. _`GNAT.Spelling_Checker_Generic_(g-spchge.ads)`: |
| 1549 |
|
| 1550 |
``GNAT.Spelling_Checker_Generic`` (:file:`g-spchge.ads`) |
| 1551 |
======================================================== |
| 1552 |
|
| 1553 |
.. index:: GNAT.Spelling_Checker_Generic (g-spchge.ads) |
| 1554 |
|
| 1555 |
.. index:: Spell checking |
| 1556 |
|
| 1557 |
Provides a generic function that can be instantiated with a string type for |
| 1558 |
determining whether one string is a plausible near misspelling of another |
| 1559 |
string. |
| 1560 |
|
| 1561 |
.. _`GNAT.Spitbol.Patterns_(g-spipat.ads)`: |
| 1562 |
|
| 1563 |
``GNAT.Spitbol.Patterns`` (:file:`g-spipat.ads`) |
| 1564 |
================================================ |
| 1565 |
|
| 1566 |
.. index:: GNAT.Spitbol.Patterns (g-spipat.ads) |
| 1567 |
|
| 1568 |
.. index:: SPITBOL pattern matching |
| 1569 |
|
| 1570 |
.. index:: Pattern matching |
| 1571 |
|
| 1572 |
A complete implementation of SNOBOL4 style pattern matching. This is the |
| 1573 |
most elaborate of the pattern matching packages provided. It fully duplicates |
| 1574 |
the SNOBOL4 dynamic pattern construction and matching capabilities, using the |
| 1575 |
efficient algorithm developed by Robert Dewar for the SPITBOL system. |
| 1576 |
|
| 1577 |
.. _`GNAT.Spitbol_(g-spitbo.ads)`: |
| 1578 |
|
| 1579 |
``GNAT.Spitbol`` (:file:`g-spitbo.ads`) |
| 1580 |
======================================= |
| 1581 |
|
| 1582 |
.. index:: GNAT.Spitbol (g-spitbo.ads) |
| 1583 |
|
| 1584 |
.. index:: SPITBOL interface |
| 1585 |
|
| 1586 |
The top level package of the collection of SPITBOL-style functionality, this |
| 1587 |
package provides basic SNOBOL4 string manipulation functions, such as |
| 1588 |
Pad, Reverse, Trim, Substr capability, as well as a generic table function |
| 1589 |
useful for constructing arbitrary mappings from strings in the style of |
| 1590 |
the SNOBOL4 TABLE function. |
| 1591 |
|
| 1592 |
.. _`GNAT.Spitbol.Table_Boolean_(g-sptabo.ads)`: |
| 1593 |
|
| 1594 |
``GNAT.Spitbol.Table_Boolean`` (:file:`g-sptabo.ads`) |
| 1595 |
===================================================== |
| 1596 |
|
| 1597 |
.. index:: GNAT.Spitbol.Table_Boolean (g-sptabo.ads) |
| 1598 |
|
| 1599 |
.. index:: Sets of strings |
| 1600 |
|
| 1601 |
.. index:: SPITBOL Tables |
| 1602 |
|
| 1603 |
A library level of instantiation of ``GNAT.Spitbol.Patterns.Table`` |
| 1604 |
for type ``Standard.Boolean``, giving an implementation of sets of |
| 1605 |
string values. |
| 1606 |
|
| 1607 |
.. _`GNAT.Spitbol.Table_Integer_(g-sptain.ads)`: |
| 1608 |
|
| 1609 |
``GNAT.Spitbol.Table_Integer`` (:file:`g-sptain.ads`) |
| 1610 |
===================================================== |
| 1611 |
|
| 1612 |
.. index:: GNAT.Spitbol.Table_Integer (g-sptain.ads) |
| 1613 |
|
| 1614 |
.. index:: Integer maps |
| 1615 |
|
| 1616 |
.. index:: Maps |
| 1617 |
|
| 1618 |
.. index:: SPITBOL Tables |
| 1619 |
|
| 1620 |
A library level of instantiation of ``GNAT.Spitbol.Patterns.Table`` |
| 1621 |
for type ``Standard.Integer``, giving an implementation of maps |
| 1622 |
from string to integer values. |
| 1623 |
|
| 1624 |
.. _`GNAT.Spitbol.Table_VString_(g-sptavs.ads)`: |
| 1625 |
|
| 1626 |
``GNAT.Spitbol.Table_VString`` (:file:`g-sptavs.ads`) |
| 1627 |
===================================================== |
| 1628 |
|
| 1629 |
.. index:: GNAT.Spitbol.Table_VString (g-sptavs.ads) |
| 1630 |
|
| 1631 |
.. index:: String maps |
| 1632 |
|
| 1633 |
.. index:: Maps |
| 1634 |
|
| 1635 |
.. index:: SPITBOL Tables |
| 1636 |
|
| 1637 |
A library level of instantiation of ``GNAT.Spitbol.Patterns.Table`` for |
| 1638 |
a variable length string type, giving an implementation of general |
| 1639 |
maps from strings to strings. |
| 1640 |
|
| 1641 |
.. _`GNAT.SSE_(g-sse.ads)`: |
| 1642 |
|
| 1643 |
``GNAT.SSE`` (:file:`g-sse.ads`) |
| 1644 |
================================ |
| 1645 |
|
| 1646 |
.. index:: GNAT.SSE (g-sse.ads) |
| 1647 |
|
| 1648 |
Root of a set of units aimed at offering Ada bindings to a subset of |
| 1649 |
the Intel(r) Streaming SIMD Extensions with GNAT on the x86 family of |
| 1650 |
targets. It exposes vector component types together with a general |
| 1651 |
introduction to the binding contents and use. |
| 1652 |
|
| 1653 |
.. _`GNAT.SSE.Vector_Types_(g-ssvety.ads)`: |
| 1654 |
|
| 1655 |
``GNAT.SSE.Vector_Types`` (:file:`g-ssvety.ads`) |
| 1656 |
================================================ |
| 1657 |
|
| 1658 |
.. index:: GNAT.SSE.Vector_Types (g-ssvety.ads) |
| 1659 |
|
| 1660 |
SSE vector types for use with SSE related intrinsics. |
| 1661 |
|
| 1662 |
.. _`GNAT.String_Hash(g-strhas.ads)`: |
| 1663 |
|
| 1664 |
``GNAT.String_Hash`` (:file:`g-strhas.ads`) |
| 1665 |
=========================================== |
| 1666 |
|
| 1667 |
.. index:: GNAT.String_Hash (g-strhas.ads) |
| 1668 |
|
| 1669 |
.. index:: Hash functions |
| 1670 |
|
| 1671 |
Provides a generic hash function working on arrays of scalars. Both the scalar |
| 1672 |
type and the hash result type are parameters. |
| 1673 |
|
| 1674 |
.. _`GNAT.Strings_(g-string.ads)`: |
| 1675 |
|
| 1676 |
``GNAT.Strings`` (:file:`g-string.ads`) |
| 1677 |
======================================= |
| 1678 |
|
| 1679 |
.. index:: GNAT.Strings (g-string.ads) |
| 1680 |
|
| 1681 |
Common String access types and related subprograms. Basically it |
| 1682 |
defines a string access and an array of string access types. |
| 1683 |
|
| 1684 |
.. _`GNAT.String_Split_(g-strspl.ads)`: |
| 1685 |
|
| 1686 |
``GNAT.String_Split`` (:file:`g-strspl.ads`) |
| 1687 |
============================================ |
| 1688 |
|
| 1689 |
.. index:: GNAT.String_Split (g-strspl.ads) |
| 1690 |
|
| 1691 |
.. index:: String splitter |
| 1692 |
|
| 1693 |
Useful string manipulation routines: given a set of separators, split |
| 1694 |
a string wherever the separators appear, and provide direct access |
| 1695 |
to the resulting slices. This package is instantiated from |
| 1696 |
``GNAT.Array_Split``. |
| 1697 |
|
| 1698 |
.. _`GNAT.Table_(g-table.ads)`: |
| 1699 |
|
| 1700 |
``GNAT.Table`` (:file:`g-table.ads`) |
| 1701 |
==================================== |
| 1702 |
|
| 1703 |
.. index:: GNAT.Table (g-table.ads) |
| 1704 |
|
| 1705 |
.. index:: Table implementation |
| 1706 |
|
| 1707 |
.. index:: Arrays, extendable |
| 1708 |
|
| 1709 |
A generic package providing a single dimension array abstraction where the |
| 1710 |
length of the array can be dynamically modified. |
| 1711 |
|
| 1712 |
This package provides a facility similar to that of ``GNAT.Dynamic_Tables``, |
| 1713 |
except that this package declares a single instance of the table type, |
| 1714 |
while an instantiation of ``GNAT.Dynamic_Tables`` creates a type that can be |
| 1715 |
used to define dynamic instances of the table. |
| 1716 |
|
| 1717 |
.. _`GNAT.Task_Lock_(g-tasloc.ads)`: |
| 1718 |
|
| 1719 |
``GNAT.Task_Lock`` (:file:`g-tasloc.ads`) |
| 1720 |
========================================= |
| 1721 |
|
| 1722 |
.. index:: GNAT.Task_Lock (g-tasloc.ads) |
| 1723 |
|
| 1724 |
.. index:: Task synchronization |
| 1725 |
|
| 1726 |
.. index:: Task locking |
| 1727 |
|
| 1728 |
.. index:: Locking |
| 1729 |
|
| 1730 |
A very simple facility for locking and unlocking sections of code using a |
| 1731 |
single global task lock. Appropriate for use in situations where contention |
| 1732 |
between tasks is very rarely expected. |
| 1733 |
|
| 1734 |
.. _`GNAT.Time_Stamp_(g-timsta.ads)`: |
| 1735 |
|
| 1736 |
``GNAT.Time_Stamp`` (:file:`g-timsta.ads`) |
| 1737 |
========================================== |
| 1738 |
|
| 1739 |
.. index:: GNAT.Time_Stamp (g-timsta.ads) |
| 1740 |
|
| 1741 |
.. index:: Time stamp |
| 1742 |
|
| 1743 |
.. index:: Current time |
| 1744 |
|
| 1745 |
Provides a simple function that returns a string YYYY-MM-DD HH:MM:SS.SS that |
| 1746 |
represents the current date and time in ISO 8601 format. This is a very simple |
| 1747 |
routine with minimal code and there are no dependencies on any other unit. |
| 1748 |
|
| 1749 |
.. _`GNAT.Threads_(g-thread.ads)`: |
| 1750 |
|
| 1751 |
``GNAT.Threads`` (:file:`g-thread.ads`) |
| 1752 |
======================================= |
| 1753 |
|
| 1754 |
.. index:: GNAT.Threads (g-thread.ads) |
| 1755 |
|
| 1756 |
.. index:: Foreign threads |
| 1757 |
|
| 1758 |
.. index:: Threads, foreign |
| 1759 |
|
| 1760 |
Provides facilities for dealing with foreign threads which need to be known |
| 1761 |
by the GNAT run-time system. Consult the documentation of this package for |
| 1762 |
further details if your program has threads that are created by a non-Ada |
| 1763 |
environment which then accesses Ada code. |
| 1764 |
|
| 1765 |
.. _`GNAT.Traceback_(g-traceb.ads)`: |
| 1766 |
|
| 1767 |
``GNAT.Traceback`` (:file:`g-traceb.ads`) |
| 1768 |
========================================= |
| 1769 |
|
| 1770 |
.. index:: GNAT.Traceback (g-traceb.ads) |
| 1771 |
|
| 1772 |
.. index:: Trace back facilities |
| 1773 |
|
| 1774 |
Provides a facility for obtaining non-symbolic traceback information, useful |
| 1775 |
in various debugging situations. |
| 1776 |
|
| 1777 |
.. _`GNAT.Traceback.Symbolic_(g-trasym.ads)`: |
| 1778 |
|
| 1779 |
``GNAT.Traceback.Symbolic`` (:file:`g-trasym.ads`) |
| 1780 |
================================================== |
| 1781 |
|
| 1782 |
.. index:: GNAT.Traceback.Symbolic (g-trasym.ads) |
| 1783 |
|
| 1784 |
.. index:: Trace back facilities |
| 1785 |
|
| 1786 |
.. _`GNAT.UTF_32_(g-utf_32.ads)`: |
| 1787 |
|
| 1788 |
``GNAT.UTF_32`` (:file:`g-utf_32.ads`) |
| 1789 |
====================================== |
| 1790 |
|
| 1791 |
.. index:: GNAT.UTF_32 (g-utf_32.ads) |
| 1792 |
|
| 1793 |
.. index:: Wide character codes |
| 1794 |
|
| 1795 |
This is a package intended to be used in conjunction with the |
| 1796 |
``Wide_Character`` type in Ada 95 and the |
| 1797 |
``Wide_Wide_Character`` type in Ada 2005 (available |
| 1798 |
in ``GNAT`` in Ada 2005 mode). This package contains |
| 1799 |
Unicode categorization routines, as well as lexical |
| 1800 |
categorization routines corresponding to the Ada 2005 |
| 1801 |
lexical rules for identifiers and strings, and also a |
| 1802 |
lower case to upper case fold routine corresponding to |
| 1803 |
the Ada 2005 rules for identifier equivalence. |
| 1804 |
|
| 1805 |
.. _`GNAT.UTF_32_Spelling_Checker_(g-u3spch.ads)`: |
| 1806 |
|
| 1807 |
``GNAT.UTF_32_Spelling_Checker`` (:file:`g-u3spch.ads`) |
| 1808 |
======================================================= |
| 1809 |
|
| 1810 |
.. index:: GNAT.UTF_32_Spelling_Checker (g-u3spch.ads) |
| 1811 |
|
| 1812 |
.. index:: Spell checking |
| 1813 |
|
| 1814 |
Provides a function for determining whether one wide wide string is a plausible |
| 1815 |
near misspelling of another wide wide string, where the strings are represented |
| 1816 |
using the UTF_32_String type defined in System.Wch_Cnv. |
| 1817 |
|
| 1818 |
.. _`GNAT.Wide_Spelling_Checker_(g-wispch.ads)`: |
| 1819 |
|
| 1820 |
``GNAT.Wide_Spelling_Checker`` (:file:`g-wispch.ads`) |
| 1821 |
===================================================== |
| 1822 |
|
| 1823 |
.. index:: GNAT.Wide_Spelling_Checker (g-wispch.ads) |
| 1824 |
|
| 1825 |
.. index:: Spell checking |
| 1826 |
|
| 1827 |
Provides a function for determining whether one wide string is a plausible |
| 1828 |
near misspelling of another wide string. |
| 1829 |
|
| 1830 |
.. _`GNAT.Wide_String_Split_(g-wistsp.ads)`: |
| 1831 |
|
| 1832 |
``GNAT.Wide_String_Split`` (:file:`g-wistsp.ads`) |
| 1833 |
================================================= |
| 1834 |
|
| 1835 |
.. index:: GNAT.Wide_String_Split (g-wistsp.ads) |
| 1836 |
|
| 1837 |
.. index:: Wide_String splitter |
| 1838 |
|
| 1839 |
Useful wide string manipulation routines: given a set of separators, split |
| 1840 |
a wide string wherever the separators appear, and provide direct access |
| 1841 |
to the resulting slices. This package is instantiated from |
| 1842 |
``GNAT.Array_Split``. |
| 1843 |
|
| 1844 |
.. _`GNAT.Wide_Wide_Spelling_Checker_(g-zspche.ads)`: |
| 1845 |
|
| 1846 |
``GNAT.Wide_Wide_Spelling_Checker`` (:file:`g-zspche.ads`) |
| 1847 |
========================================================== |
| 1848 |
|
| 1849 |
.. index:: GNAT.Wide_Wide_Spelling_Checker (g-zspche.ads) |
| 1850 |
|
| 1851 |
.. index:: Spell checking |
| 1852 |
|
| 1853 |
Provides a function for determining whether one wide wide string is a plausible |
| 1854 |
near misspelling of another wide wide string. |
| 1855 |
|
| 1856 |
.. _`GNAT.Wide_Wide_String_Split_(g-zistsp.ads)`: |
| 1857 |
|
| 1858 |
``GNAT.Wide_Wide_String_Split`` (:file:`g-zistsp.ads`) |
| 1859 |
====================================================== |
| 1860 |
|
| 1861 |
.. index:: GNAT.Wide_Wide_String_Split (g-zistsp.ads) |
| 1862 |
|
| 1863 |
.. index:: Wide_Wide_String splitter |
| 1864 |
|
| 1865 |
Useful wide wide string manipulation routines: given a set of separators, split |
| 1866 |
a wide wide string wherever the separators appear, and provide direct access |
| 1867 |
to the resulting slices. This package is instantiated from |
| 1868 |
``GNAT.Array_Split``. |
| 1869 |
|
| 1870 |
.. _`Interfaces.C.Extensions_(i-cexten.ads)`: |
| 1871 |
|
| 1872 |
``Interfaces.C.Extensions`` (:file:`i-cexten.ads`) |
| 1873 |
================================================== |
| 1874 |
|
| 1875 |
.. index:: Interfaces.C.Extensions (i-cexten.ads) |
| 1876 |
|
| 1877 |
This package contains additional C-related definitions, intended |
| 1878 |
for use with either manually or automatically generated bindings |
| 1879 |
to C libraries. |
| 1880 |
|
| 1881 |
.. _`Interfaces.C.Streams_(i-cstrea.ads)`: |
| 1882 |
|
| 1883 |
``Interfaces.C.Streams`` (:file:`i-cstrea.ads`) |
| 1884 |
=============================================== |
| 1885 |
|
| 1886 |
.. index:: Interfaces.C.Streams (i-cstrea.ads) |
| 1887 |
|
| 1888 |
.. index:: C streams, interfacing |
| 1889 |
|
| 1890 |
This package is a binding for the most commonly used operations |
| 1891 |
on C streams. |
| 1892 |
|
| 1893 |
.. _`Interfaces.Packed_Decimal_(i-pacdec.ads)`: |
| 1894 |
|
| 1895 |
``Interfaces.Packed_Decimal`` (:file:`i-pacdec.ads`) |
| 1896 |
==================================================== |
| 1897 |
|
| 1898 |
.. index:: Interfaces.Packed_Decimal (i-pacdec.ads) |
| 1899 |
|
| 1900 |
.. index:: IBM Packed Format |
| 1901 |
|
| 1902 |
.. index:: Packed Decimal |
| 1903 |
|
| 1904 |
This package provides a set of routines for conversions to and |
| 1905 |
from a packed decimal format compatible with that used on IBM |
| 1906 |
mainframes. |
| 1907 |
|
| 1908 |
.. _`Interfaces.VxWorks_(i-vxwork.ads)`: |
| 1909 |
|
| 1910 |
``Interfaces.VxWorks`` (:file:`i-vxwork.ads`) |
| 1911 |
============================================= |
| 1912 |
|
| 1913 |
.. index:: Interfaces.VxWorks (i-vxwork.ads) |
| 1914 |
|
| 1915 |
.. index:: Interfacing to VxWorks |
| 1916 |
|
| 1917 |
.. index:: VxWorks, interfacing |
| 1918 |
|
| 1919 |
This package provides a limited binding to the VxWorks API. |
| 1920 |
|
| 1921 |
.. _`Interfaces.VxWorks.IO_(i-vxwoio.ads)`: |
| 1922 |
|
| 1923 |
``Interfaces.VxWorks.IO`` (:file:`i-vxwoio.ads`) |
| 1924 |
================================================ |
| 1925 |
|
| 1926 |
.. index:: Interfaces.VxWorks.IO (i-vxwoio.ads) |
| 1927 |
|
| 1928 |
.. index:: Interfacing to VxWorks' I/O |
| 1929 |
|
| 1930 |
.. index:: VxWorks, I/O interfacing |
| 1931 |
|
| 1932 |
.. index:: VxWorks, Get_Immediate |
| 1933 |
|
| 1934 |
.. index:: Get_Immediate, VxWorks |
| 1935 |
|
| 1936 |
This package provides a binding to the ioctl (IO/Control) |
| 1937 |
function of VxWorks, defining a set of option values and |
| 1938 |
function codes. A particular use of this package is |
| 1939 |
to enable the use of Get_Immediate under VxWorks. |
| 1940 |
|
| 1941 |
.. _`System.Address_Image_(s-addima.ads)`: |
| 1942 |
|
| 1943 |
``System.Address_Image`` (:file:`s-addima.ads`) |
| 1944 |
=============================================== |
| 1945 |
|
| 1946 |
.. index:: System.Address_Image (s-addima.ads) |
| 1947 |
|
| 1948 |
.. index:: Address image |
| 1949 |
|
| 1950 |
.. index:: Image, of an address |
| 1951 |
|
| 1952 |
This function provides a useful debugging |
| 1953 |
function that gives an (implementation dependent) |
| 1954 |
string which identifies an address. |
| 1955 |
|
| 1956 |
.. _`System.Assertions_(s-assert.ads)`: |
| 1957 |
|
| 1958 |
``System.Assertions`` (:file:`s-assert.ads`) |
| 1959 |
============================================ |
| 1960 |
|
| 1961 |
.. index:: System.Assertions (s-assert.ads) |
| 1962 |
|
| 1963 |
.. index:: Assertions |
| 1964 |
|
| 1965 |
.. index:: Assert_Failure, exception |
| 1966 |
|
| 1967 |
This package provides the declaration of the exception raised |
| 1968 |
by an run-time assertion failure, as well as the routine that |
| 1969 |
is used internally to raise this assertion. |
| 1970 |
|
| 1971 |
.. _`System.Atomic_Counters_(s-atocou.ads)`: |
| 1972 |
|
| 1973 |
``System.Atomic_Counters`` (:file:`s-atocou.ads`) |
| 1974 |
================================================= |
| 1975 |
|
| 1976 |
.. index:: System.Atomic_Counters (s-atocou.ads) |
| 1977 |
|
| 1978 |
This package provides the declaration of an atomic counter type, |
| 1979 |
together with efficient routines (using hardware |
| 1980 |
synchronization primitives) for incrementing, decrementing, |
| 1981 |
and testing of these counters. This package is implemented |
| 1982 |
on most targets, including all Alpha, AARCH64, ARM, ia64, PowerPC, SPARC V9, |
| 1983 |
x86, and x86_64 platforms. |
| 1984 |
|
| 1985 |
.. _`System.Memory_(s-memory.ads)`: |
| 1986 |
|
| 1987 |
``System.Memory`` (:file:`s-memory.ads`) |
| 1988 |
======================================== |
| 1989 |
|
| 1990 |
.. index:: System.Memory (s-memory.ads) |
| 1991 |
|
| 1992 |
.. index:: Memory allocation |
| 1993 |
|
| 1994 |
This package provides the interface to the low level routines used |
| 1995 |
by the generated code for allocation and freeing storage for the |
| 1996 |
default storage pool (analogous to the C routines malloc and free). |
| 1997 |
It also provides a reallocation interface analogous to the C routine |
| 1998 |
realloc. The body of this unit may be modified to provide alternative |
| 1999 |
allocation mechanisms for the default pool, and in addition, direct |
| 2000 |
calls to this unit may be made for low level allocation uses (for |
| 2001 |
example see the body of ``GNAT.Tables``). |
| 2002 |
|
| 2003 |
.. _`System.Multiprocessors_(s-multip.ads)`: |
| 2004 |
|
| 2005 |
``System.Multiprocessors`` (:file:`s-multip.ads`) |
| 2006 |
================================================= |
| 2007 |
|
| 2008 |
.. index:: System.Multiprocessors (s-multip.ads) |
| 2009 |
|
| 2010 |
.. index:: Multiprocessor interface |
| 2011 |
|
| 2012 |
This is an Ada 2012 unit defined in the Ada 2012 Reference Manual, but |
| 2013 |
in GNAT we also make it available in Ada 95 and Ada 2005 (where it is |
| 2014 |
technically an implementation-defined addition). |
| 2015 |
|
| 2016 |
.. _`System.Multiprocessors.Dispatching_Domains_(s-mudido.ads)`: |
| 2017 |
|
| 2018 |
``System.Multiprocessors.Dispatching_Domains`` (:file:`s-mudido.ads`) |
| 2019 |
===================================================================== |
| 2020 |
|
| 2021 |
.. index:: System.Multiprocessors.Dispatching_Domains (s-mudido.ads) |
| 2022 |
|
| 2023 |
.. index:: Multiprocessor interface |
| 2024 |
|
| 2025 |
This is an Ada 2012 unit defined in the Ada 2012 Reference Manual, but |
| 2026 |
in GNAT we also make it available in Ada 95 and Ada 2005 (where it is |
| 2027 |
technically an implementation-defined addition). |
| 2028 |
|
| 2029 |
.. _`System.Partition_Interface_(s-parint.ads)`: |
| 2030 |
|
| 2031 |
``System.Partition_Interface`` (:file:`s-parint.ads`) |
| 2032 |
===================================================== |
| 2033 |
|
| 2034 |
.. index:: System.Partition_Interface (s-parint.ads) |
| 2035 |
|
| 2036 |
.. index:: Partition interfacing functions |
| 2037 |
|
| 2038 |
This package provides facilities for partition interfacing. It |
| 2039 |
is used primarily in a distribution context when using Annex E |
| 2040 |
with ``GLADE``. |
| 2041 |
|
| 2042 |
.. _`System.Pool_Global_(s-pooglo.ads)`: |
| 2043 |
|
| 2044 |
``System.Pool_Global`` (:file:`s-pooglo.ads`) |
| 2045 |
============================================= |
| 2046 |
|
| 2047 |
.. index:: System.Pool_Global (s-pooglo.ads) |
| 2048 |
|
| 2049 |
.. index:: Storage pool, global |
| 2050 |
|
| 2051 |
.. index:: Global storage pool |
| 2052 |
|
| 2053 |
This package provides a storage pool that is equivalent to the default |
| 2054 |
storage pool used for access types for which no pool is specifically |
| 2055 |
declared. It uses malloc/free to allocate/free and does not attempt to |
| 2056 |
do any automatic reclamation. |
| 2057 |
|
| 2058 |
.. _`System.Pool_Local_(s-pooloc.ads)`: |
| 2059 |
|
| 2060 |
``System.Pool_Local`` (:file:`s-pooloc.ads`) |
| 2061 |
============================================ |
| 2062 |
|
| 2063 |
.. index:: System.Pool_Local (s-pooloc.ads) |
| 2064 |
|
| 2065 |
.. index:: Storage pool, local |
| 2066 |
|
| 2067 |
.. index:: Local storage pool |
| 2068 |
|
| 2069 |
This package provides a storage pool that is intended for use with locally |
| 2070 |
defined access types. It uses malloc/free for allocate/free, and maintains |
| 2071 |
a list of allocated blocks, so that all storage allocated for the pool can |
| 2072 |
be freed automatically when the pool is finalized. |
| 2073 |
|
| 2074 |
.. _`System.Restrictions_(s-restri.ads)`: |
| 2075 |
|
| 2076 |
``System.Restrictions`` (:file:`s-restri.ads`) |
| 2077 |
============================================== |
| 2078 |
|
| 2079 |
.. index:: System.Restrictions (s-restri.ads) |
| 2080 |
|
| 2081 |
.. index:: Run-time restrictions access |
| 2082 |
|
| 2083 |
This package provides facilities for accessing at run time |
| 2084 |
the status of restrictions specified at compile time for |
| 2085 |
the partition. Information is available both with regard |
| 2086 |
to actual restrictions specified, and with regard to |
| 2087 |
compiler determined information on which restrictions |
| 2088 |
are violated by one or more packages in the partition. |
| 2089 |
|
| 2090 |
.. _`System.Rident_(s-rident.ads)`: |
| 2091 |
|
| 2092 |
``System.Rident`` (:file:`s-rident.ads`) |
| 2093 |
======================================== |
| 2094 |
|
| 2095 |
.. index:: System.Rident (s-rident.ads) |
| 2096 |
|
| 2097 |
.. index:: Restrictions definitions |
| 2098 |
|
| 2099 |
This package provides definitions of the restrictions |
| 2100 |
identifiers supported by GNAT, and also the format of |
| 2101 |
the restrictions provided in package System.Restrictions. |
| 2102 |
It is not normally necessary to ``with`` this generic package |
| 2103 |
since the necessary instantiation is included in |
| 2104 |
package System.Restrictions. |
| 2105 |
|
| 2106 |
.. _`System.Strings.Stream_Ops_(s-ststop.ads)`: |
| 2107 |
|
| 2108 |
``System.Strings.Stream_Ops`` (:file:`s-ststop.ads`) |
| 2109 |
==================================================== |
| 2110 |
|
| 2111 |
.. index:: System.Strings.Stream_Ops (s-ststop.ads) |
| 2112 |
|
| 2113 |
.. index:: Stream operations |
| 2114 |
|
| 2115 |
.. index:: String stream operations |
| 2116 |
|
| 2117 |
This package provides a set of stream subprograms for standard string types. |
| 2118 |
It is intended primarily to support implicit use of such subprograms when |
| 2119 |
stream attributes are applied to string types, but the subprograms in this |
| 2120 |
package can be used directly by application programs. |
| 2121 |
|
| 2122 |
.. _`System.Unsigned_Types_(s-unstyp.ads)`: |
| 2123 |
|
| 2124 |
``System.Unsigned_Types`` (:file:`s-unstyp.ads`) |
| 2125 |
================================================ |
| 2126 |
|
| 2127 |
.. index:: System.Unsigned_Types (s-unstyp.ads) |
| 2128 |
|
| 2129 |
This package contains definitions of standard unsigned types that |
| 2130 |
correspond in size to the standard signed types declared in Standard, |
| 2131 |
and (unlike the types in Interfaces) have corresponding names. It |
| 2132 |
also contains some related definitions for other specialized types |
| 2133 |
used by the compiler in connection with packed array types. |
| 2134 |
|
| 2135 |
.. _`System.Wch_Cnv_(s-wchcnv.ads)`: |
| 2136 |
|
| 2137 |
``System.Wch_Cnv`` (:file:`s-wchcnv.ads`) |
| 2138 |
========================================= |
| 2139 |
|
| 2140 |
.. index:: System.Wch_Cnv (s-wchcnv.ads) |
| 2141 |
|
| 2142 |
.. index:: Wide Character, Representation |
| 2143 |
|
| 2144 |
.. index:: Wide String, Conversion |
| 2145 |
|
| 2146 |
.. index:: Representation of wide characters |
| 2147 |
|
| 2148 |
This package provides routines for converting between |
| 2149 |
wide and wide wide characters and a representation as a value of type |
| 2150 |
``Standard.String``, using a specified wide character |
| 2151 |
encoding method. It uses definitions in |
| 2152 |
package ``System.Wch_Con``. |
| 2153 |
|
| 2154 |
.. _`System.Wch_Con_(s-wchcon.ads)`: |
| 2155 |
|
| 2156 |
``System.Wch_Con`` (:file:`s-wchcon.ads`) |
| 2157 |
========================================= |
| 2158 |
|
| 2159 |
.. index:: System.Wch_Con (s-wchcon.ads) |
| 2160 |
|
| 2161 |
This package provides definitions and descriptions of |
| 2162 |
the various methods used for encoding wide characters |
| 2163 |
in ordinary strings. These definitions are used by |
| 2164 |
the package ``System.Wch_Cnv``. |