gcc/ada/g-debuti.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUN-TIME COMPONENTS                         --
   4 --                                                                          --
   5 --                 G N A T . D E B U G _ U T I L I T I E S                  --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --                     Copyright (C) 1995-2005, AdaCore                     --
  10 --                                                                          --
  11 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  12 -- terms of the  GNU General Public License as published  by the Free Soft- --
  13 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  14 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  15 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  16 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  17 -- for  more details.  You should have  received  a copy of the GNU General --
  18 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  19 -- to  the  Free Software Foundation,  51  Franklin  Street,  Fifth  Floor, --
  20 -- Boston, MA 02110-1301, USA.                                              --
  21 --                                                                          --
  22 -- As a special exception,  if other files  instantiate  generics from this --
  23 -- unit, or you link  this unit with other files  to produce an executable, --
  24 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  25 -- covered  by the  GNU  General  Public  License.  This exception does not --
  26 -- however invalidate  any other reasons why  the executable file  might be --
  27 -- covered by the  GNU Public License.                                      --
  28 --                                                                          --
  29 -- GNAT was originally developed  by the GNAT team at  New York University. --
  30 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  31 --                                                                          --
  32 ------------------------------------------------------------------------------
  33
  34 --  Debugging utilities
  35
  36 --  This package provides some useful utility subprograms for use in writing
  37 --  routines that generate debugging output.
  38
  39 with System;
  40
  41 package GNAT.Debug_Utilities is
  42    pragma Pure;
  43
  44    Address_64 : constant Boolean := Standard'Address_Size = 64;
  45    --  Set true if 64 bit addresses (assumes only 32 and 64 are possible)
  46
  47    Address_Image_Length : constant := 13 + 10 * Boolean'Pos (Address_64);
  48    --  Length of string returned by Image function for an address
  49
  50    subtype Image_String is String (1 .. Address_Image_Length);
  51    --  Subtype returned by Image function for an address
  52
  53    Address_Image_C_Length : constant := 10 + 8 * Boolean'Pos (Address_64);
  54    --  Length of string returned by Image_C function
  55
  56    subtype Image_C_String is String (1 .. Address_Image_C_Length);
  57    --  Subtype returned by Image_C function
  58
  59    function Image (S : String) return String;
  60    --  Returns a string image of S, obtained by prepending and appending
  61    --  quote (") characters and doubling any quote characters in the string.
  62    --  The maximum length of the result is thus 2 ** S'Length + 2.
  63
  64    function Image (A : System.Address) return Image_String;
  65    --  Returns a string of the form 16#hhhh_hhhh# for 32-bit addresses
  66    --  or 16#hhhh_hhhh_hhhh_hhhh# for 64-bit addresses. Hex characters
  67    --  are in upper case.
  68
  69    function Image_C (A : System.Address) return Image_C_String;
  70    --  Returns a string of the form 0xhhhhhhhh for 32 bit addresses or
  71    --  0xhhhhhhhhhhhhhhhh for 64-bit addresses. Hex characters are in
  72    --  upper case.
  73
  74    function Value (S : String) return System.Address;
  75    --  Given a valid integer literal in any form, including the form returned
  76    --  by the Image function in this package, yields the corresponding address.
  77    --  Note that this routine will handle any Ada integer format, and will
  78    --  also handle hex constants in C format (0xhh..hhh). Constraint_Error
  79    --  may be raised for obviously incorrect data, but the routine is fairly
  80    --  permissive, and in particular, all underscores in whatever position
  81    --  are simply ignored completely.
  82
  83 end GNAT.Debug_Utilities;