gcc/ada/g-debuti.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUNTIME 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 --                            $Revision: 1.5 $                              --
  10 --                                                                          --
  11 --           Copyright (C) 1995-1998 Ada Core Technologies, Inc.            --
  12 --                                                                          --
  13 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  14 -- terms of the  GNU General Public License as published  by the Free Soft- --
  15 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  16 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  17 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  18 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  19 -- for  more details.  You should have  received  a copy of the GNU General --
  20 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  21 -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
  22 -- MA 02111-1307, USA.                                                      --
  23 --                                                                          --
  24 -- As a special exception,  if other files  instantiate  generics from this --
  25 -- unit, or you link  this unit with other files  to produce an executable, --
  26 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  27 -- covered  by the  GNU  General  Public  License.  This exception does not --
  28 -- however invalidate  any other reasons why  the executable file  might be --
  29 -- covered by the  GNU Public License.                                      --
  30 --                                                                          --
  31 -- GNAT is maintained by Ada Core Technologies Inc (http://www.gnat.com).   --
  32 --                                                                          --
  33 ------------------------------------------------------------------------------
  34
  35 --  Debugging utilities
  36
  37 --  This package provides some useful utility subprograms for use in writing
  38 --  routines that generate debugging output.
  39
  40 with System;
  41
  42 package GNAT.Debug_Utilities is
  43 pragma Pure (Debug_Utilities);
  44
  45    function Image (S : String) return String;
  46    --  Returns a string image of S, obtained by prepending and appending
  47    --  quote (") characters and doubling any quote characters in the string.
  48    --  The maximum length of the result is thus 2 ** S'Length + 2.
  49
  50    Address_Image_Length : constant :=
  51                             13 + 10 * Boolean'Pos (Standard'Address_Size > 32);
  52    --  Length of string returned by Image function
  53
  54    function Image (A : System.Address) return String;
  55    --  Returns a string of the form 16#xxxx_xxxx# for 32-bit addresses
  56    --  or 16#xxxx_xxxx_xxxx_xxxx# for 64-bit addresses. Hex characters
  57    --  are in upper case.
  58
  59    function Value (S : String) return System.Address;
  60    --  Given a valid integer literal in any form, including the form returned
  61    --  by the Image function in this package, yields the corresponding address.
  62
  63 end GNAT.Debug_Utilities;