Commit | Line | Data |
---|---|---|
60250e8b AC |
1 | /* Exception (throw catch) mechanism, for GDB, the GNU debugger. |
2 | ||
ecd75fc8 | 3 | Copyright (C) 1986-2014 Free Software Foundation, Inc. |
60250e8b AC |
4 | |
5 | This file is part of GDB. | |
6 | ||
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 | |
a9762ec7 | 9 | the Free Software Foundation; either version 3 of the License, or |
60250e8b AC |
10 | (at your option) any later version. |
11 | ||
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. | |
16 | ||
17 | You should have received a copy of the GNU General Public License | |
a9762ec7 | 18 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
60250e8b AC |
19 | |
20 | #ifndef EXCEPTIONS_H | |
21 | #define EXCEPTIONS_H | |
22 | ||
e74e72b4 | 23 | #include "ui-out.h" |
2a78bfb5 | 24 | |
c1043fc2 | 25 | /* A pre-defined non-exception. */ |
71fff37b | 26 | extern const struct gdb_exception exception_none; |
c1043fc2 | 27 | |
8a076db9 | 28 | /* If E is an exception, print it's error message on the specified |
0963b4bd | 29 | stream. For _fprintf, prefix the message with PREFIX... */ |
71fff37b AC |
30 | extern void exception_print (struct ui_file *file, struct gdb_exception e); |
31 | extern void exception_fprintf (struct ui_file *file, struct gdb_exception e, | |
9cbc821d | 32 | const char *prefix, |
a0b31db1 | 33 | ...) ATTRIBUTE_PRINTF (3, 4); |
8a076db9 | 34 | |
60250e8b AC |
35 | /* Call FUNC(UIOUT, FUNC_ARGS) but wrapped within an exception |
36 | handler. If an exception (enum return_reason) is thrown using | |
37 | throw_exception() than all cleanups installed since | |
38 | catch_exceptions() was entered are invoked, the (-ve) exception | |
39 | value is then returned by catch_exceptions. If FUNC() returns | |
787274f0 | 40 | normally (with a positive or zero return value) then that value is |
60250e8b AC |
41 | returned by catch_exceptions(). It is an internal_error() for |
42 | FUNC() to return a negative value. | |
43 | ||
44 | For the period of the FUNC() call: UIOUT is installed as the output | |
45 | builder; ERRSTRING is installed as the error/quit message; and a | |
46 | new cleanup_chain is established. The old values are restored | |
47 | before catch_exceptions() returns. | |
48 | ||
49 | The variant catch_exceptions_with_msg() is the same as | |
50 | catch_exceptions() but adds the ability to return an allocated | |
51 | copy of the gdb error message. This is used when a silent error is | |
52 | issued and the caller wants to manually issue the error message. | |
53 | ||
787274f0 DE |
54 | MASK specifies what to catch; it is normally set to |
55 | RETURN_MASK_ALL, if for no other reason than that the code which | |
56 | calls catch_errors might not be set up to deal with a quit which | |
57 | isn't caught. But if the code can deal with it, it generally | |
58 | should be RETURN_MASK_ERROR, unless for some reason it is more | |
59 | useful to abort only the portion of the operation inside the | |
60 | catch_errors. Note that quit should return to the command line | |
61 | fairly quickly, even if some further processing is being done. | |
62 | ||
60250e8b AC |
63 | FIXME; cagney/2001-08-13: The need to override the global UIOUT |
64 | builder variable should just go away. | |
65 | ||
787274f0 | 66 | This function supersedes catch_errors(). |
60250e8b AC |
67 | |
68 | This function uses SETJMP() and LONGJUMP(). */ | |
69 | ||
70 | struct ui_out; | |
71 | typedef int (catch_exceptions_ftype) (struct ui_out *ui_out, void *args); | |
72 | extern int catch_exceptions (struct ui_out *uiout, | |
73 | catch_exceptions_ftype *func, void *func_args, | |
1c3c7ee7 | 74 | return_mask mask); |
2a78bfb5 | 75 | typedef void (catch_exception_ftype) (struct ui_out *ui_out, void *args); |
60250e8b AC |
76 | extern int catch_exceptions_with_msg (struct ui_out *uiout, |
77 | catch_exceptions_ftype *func, | |
78 | void *func_args, | |
1c3c7ee7 | 79 | char **gdberrmsg, |
60250e8b | 80 | return_mask mask); |
8a076db9 | 81 | |
60250e8b | 82 | /* If CATCH_ERRORS_FTYPE throws an error, catch_errors() returns zero |
0963b4bd | 83 | otherwize the result from CATCH_ERRORS_FTYPE is returned. It is |
60250e8b | 84 | probably useful for CATCH_ERRORS_FTYPE to always return a non-zero |
0963b4bd | 85 | value. It's unfortunate that, catch_errors() does not return an |
60250e8b AC |
86 | indication of the exact exception that it caught - quit_flag might |
87 | help. | |
88 | ||
787274f0 | 89 | This function is superseded by catch_exceptions(). */ |
60250e8b AC |
90 | |
91 | typedef int (catch_errors_ftype) (void *); | |
92 | extern int catch_errors (catch_errors_ftype *, void *, char *, return_mask); | |
93 | ||
60250e8b | 94 | #endif |