1 /* Exception (throw catch) mechanism, for GDB, the GNU debugger.
3 Copyright (C) 1986-2016 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 #include "exceptions.h"
22 #include "breakpoint.h"
28 #include "gdbthread.h"
33 struct serial
*gdb_stdout_serial
;
34 struct cleanup
*old_chain
= make_cleanup (null_cleanup
, NULL
);
36 if (deprecated_error_begin_hook
)
37 deprecated_error_begin_hook ();
39 if (target_supports_terminal_ours ())
41 make_cleanup_restore_target_terminal ();
42 target_terminal_ours_for_output ();
45 /* We want all output to appear now, before we print the error. We
46 have 3 levels of buffering we have to flush (it's possible that
47 some of these should be changed to flush the lower-level ones
50 /* 1. The _filtered buffer. */
51 if (filtered_printing_initialized ())
54 /* 2. The stdio buffer. */
55 gdb_flush (gdb_stdout
);
56 gdb_flush (gdb_stderr
);
58 /* 3. The system-level buffer. */
59 gdb_stdout_serial
= serial_fdopen (1);
60 if (gdb_stdout_serial
)
62 serial_drain_output (gdb_stdout_serial
);
63 serial_un_fdopen (gdb_stdout_serial
);
66 annotate_error_begin ();
68 do_cleanups (old_chain
);
72 print_exception (struct ui_file
*file
, struct gdb_exception e
)
74 /* KLUGE: cagney/2005-01-13: Write the string out one line at a time
75 as that way the MI's behavior is preserved. */
79 for (start
= e
.message
; start
!= NULL
; start
= end
)
81 end
= strchr (start
, '\n');
83 fputs_filtered (start
, file
);
87 ui_file_write (file
, start
, end
- start
);
90 fprintf_filtered (file
, "\n");
92 /* Now append the annotation. */
99 /* Assume that these are all errors. */
103 internal_error (__FILE__
, __LINE__
, _("Bad switch."));
108 exception_print (struct ui_file
*file
, struct gdb_exception e
)
110 if (e
.reason
< 0 && e
.message
!= NULL
)
113 print_exception (file
, e
);
118 exception_fprintf (struct ui_file
*file
, struct gdb_exception e
,
119 const char *prefix
, ...)
121 if (e
.reason
< 0 && e
.message
!= NULL
)
127 /* Print the prefix. */
128 va_start (args
, prefix
);
129 vfprintf_filtered (file
, prefix
, args
);
132 print_exception (file
, e
);
136 /* Call FUNC(UIOUT, FUNC_ARGS) but wrapped within an exception
137 handler. If an exception (enum return_reason) is thrown using
138 throw_exception() than all cleanups installed since
139 catch_exceptions() was entered are invoked, the (-ve) exception
140 value is then returned by catch_exceptions. If FUNC() returns
141 normally (with a positive or zero return value) then that value is
142 returned by catch_exceptions(). It is an internal_error() for
143 FUNC() to return a negative value.
145 See exceptions.h for further usage details. */
147 /* MAYBE: cagney/1999-11-05: catch_errors() in conjunction with
148 error() et al. could maintain a set of flags that indicate the
149 current state of each of the longjmp buffers. This would give the
150 longjmp code the chance to detect a longjmp botch (before it gets
151 to longjmperror()). Prior to 1999-11-05 this wasn't possible as
152 code also randomly used a SET_TOP_LEVEL macro that directly
153 initialized the longjmp buffers. */
156 catch_exceptions (struct ui_out
*uiout
,
157 catch_exceptions_ftype
*func
,
161 return catch_exceptions_with_msg (uiout
, func
, func_args
, NULL
, mask
);
165 catch_exceptions_with_msg (struct ui_out
*func_uiout
,
166 catch_exceptions_ftype
*func
,
171 struct gdb_exception exception
= exception_none
;
172 volatile int val
= 0;
173 struct ui_out
*saved_uiout
;
175 /* Save and override the global ``struct ui_out'' builder. */
176 saved_uiout
= current_uiout
;
177 current_uiout
= func_uiout
;
181 val
= (*func
) (current_uiout
, func_args
);
183 CATCH (ex
, RETURN_MASK_ALL
)
189 /* Restore the global builder. */
190 current_uiout
= saved_uiout
;
192 if (exception
.reason
< 0 && (mask
& RETURN_MASK (exception
.reason
)) == 0)
194 /* The caller didn't request that the event be caught.
196 throw_exception (exception
);
199 exception_print (gdb_stderr
, exception
);
200 gdb_assert (val
>= 0);
201 gdb_assert (exception
.reason
<= 0);
202 if (exception
.reason
< 0)
204 /* If caller wants a copy of the low-level error message, make
205 one. This is used in the case of a silent error whereby the
206 caller may optionally want to issue the message. */
207 if (gdberrmsg
!= NULL
)
209 if (exception
.message
!= NULL
)
210 *gdberrmsg
= xstrdup (exception
.message
);
214 return exception
.reason
;
219 /* This function is superseded by catch_exceptions(). */
222 catch_errors (catch_errors_ftype
*func
, void *func_args
, char *errstring
,
225 struct gdb_exception exception
= exception_none
;
226 volatile int val
= 0;
227 struct ui_out
*saved_uiout
;
229 /* Save the global ``struct ui_out'' builder. */
230 saved_uiout
= current_uiout
;
234 val
= func (func_args
);
236 CATCH (ex
, RETURN_MASK_ALL
)
242 /* Restore the global builder. */
243 current_uiout
= saved_uiout
;
245 if (exception
.reason
< 0 && (mask
& RETURN_MASK (exception
.reason
)) == 0)
247 /* The caller didn't request that the event be caught.
249 throw_exception (exception
);
252 exception_fprintf (gdb_stderr
, exception
, "%s", errstring
);
253 if (exception
.reason
!= 0)