1 ------------------------------------------------------------------------------
3 -- GNAT RUN-TIME COMPONENTS --
5 -- G N A T . E X C E P T I O N _ T R A C E S --
11 -- Copyright (C) 2000 Ada Core Technologies, Inc. --
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. --
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. --
31 -- GNAT is maintained by Ada Core Technologies Inc (http://www.gnat.com). --
33 ------------------------------------------------------------------------------
35 -- This package provides an interface allowing to control *automatic* output
36 -- to standard error upon exception occurrences (as opposed to explicit
37 -- generation of traceback information using GNAT.Traceback).
39 -- This output includes the basic information associated with the exception
40 -- (name, message) as well as a backtrace of the call chain at the point
41 -- where the exception occured. This backtrace is only output if the call
42 -- chain information is available, depending if the binder switch dedicated
43 -- to that purpose has been used or not.
45 -- The default backtrace is in the form of absolute code locations which may
46 -- be converted to corresponding source locations using the addr2line utility
47 -- or from within GDB. Please refer to GNAT.Traceback for information about
48 -- what is necessary to be able to exploit thisg possibility.
50 -- The backtrace output can also be customized by way of a "decorator" which
51 -- may return any string output in association with a provided call chain.
53 with GNAT
.Traceback
; use GNAT
.Traceback
;
55 package GNAT
.Exception_Traces
is
57 -- The following defines the exact situations in which raises will
58 -- cause automatic output of trace information.
62 -- Denotes the initial raise event for any exception occurrence, either
63 -- explicit or due to a specific language rule, within the context of a
67 -- Denotes the raise events corresponding to exceptions for which there
68 -- is no user defined handler, in particular, when a task dies due to an
69 -- unhandled exception.
72 -- The following procedures can be used to activate and deactivate
73 -- traces identified by the above trace kind values.
75 procedure Trace_On
(Kind
: in Trace_Kind
);
76 -- Activate the traces denoted by Kind.
79 -- Stop the tracing requested by the last call to Trace_On.
80 -- Has no effect if no such call has ever occurred.
82 -- The following provide the backtrace decorating facilities
84 type Traceback_Decorator
is access
85 function (Traceback
: Tracebacks_Array
) return String;
86 -- A backtrace decorator is a function which returns the string to be
87 -- output for a call chain provided by way of a tracebacks array.
89 procedure Set_Trace_Decorator
(Decorator
: Traceback_Decorator
);
90 -- Set the decorator to be used for future automatic outputs. Restore
91 -- the default behavior (output of raw addresses) if the provided
92 -- access value is null.
94 end GNAT
.Exception_Traces
;