OSDN Git Service

* Make-lang.in (gnat_ug_unx.info): Add dependency on stmp-docobjdir.
[pf3gnuchains/gcc-fork.git] / 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 --           Copyright (C) 1995-1998 Ada Core Technologies, Inc.            --
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,  59 Temple Place - Suite 330,  Boston, --
20 -- MA 02111-1307, 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 is maintained by Ada Core Technologies Inc (http://www.gnat.com).   --
30 --                                                                          --
31 ------------------------------------------------------------------------------
32
33 --  Debugging utilities
34
35 --  This package provides some useful utility subprograms for use in writing
36 --  routines that generate debugging output.
37
38 with System;
39
40 package GNAT.Debug_Utilities is
41 pragma Pure (Debug_Utilities);
42
43    function Image (S : String) return String;
44    --  Returns a string image of S, obtained by prepending and appending
45    --  quote (") characters and doubling any quote characters in the string.
46    --  The maximum length of the result is thus 2 ** S'Length + 2.
47
48    Address_Image_Length : constant :=
49                             13 + 10 * Boolean'Pos (Standard'Address_Size > 32);
50    --  Length of string returned by Image function
51
52    function Image (A : System.Address) return String;
53    --  Returns a string of the form 16#xxxx_xxxx# for 32-bit addresses
54    --  or 16#xxxx_xxxx_xxxx_xxxx# for 64-bit addresses. Hex characters
55    --  are in upper case.
56
57    function Value (S : String) return System.Address;
58    --  Given a valid integer literal in any form, including the form returned
59    --  by the Image function in this package, yields the corresponding address.
60
61 end GNAT.Debug_Utilities;