/* Exception (throw catch) mechanism, for GDB, the GNU debugger.
- Copyright 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
- 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free
- Software Foundation, Inc.
+ Copyright (C) 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
+ 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
+ 2009 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
+ the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA. */
+ along with this program. If not, see <http://www.gnu.org/licenses/>. */
#ifndef EXCEPTIONS_H
#define EXCEPTIONS_H
-struct ui_out;
-
+#include "ui-out.h"
#include <setjmp.h>
/* Reasons for calling throw_exceptions(). NOTE: all reason values
/* Describe all exceptions. */
enum errors {
- NO_ERROR,
+ GDB_NO_ERROR,
/* Any generic error, the corresponding text is in
exception.message. */
GENERIC_ERROR,
TLS_NOT_ALLOCATED_YET_ERROR,
/* Something else went wrong while attempting to find thread local
- storage. The ``struct exception'' message field provides more
- detail. */
+ storage. The ``struct gdb_exception'' message field provides
+ more detail. */
TLS_GENERIC_ERROR,
+ /* Problem parsing an XML document. */
+ XML_PARSE_ERROR,
+
+ /* Error accessing memory. */
+ MEMORY_ERROR,
+
/* Add more errors here. */
NR_ERRORS
};
-struct exception
+struct gdb_exception
{
enum return_reason reason;
enum errors error;
};
/* A pre-defined non-exception. */
-extern const struct exception exception_none;
+extern const struct gdb_exception exception_none;
/* Wrap set/long jmp so that it's more portable (internal to
exceptions). */
/* Functions to drive the exceptions state m/c (internal to
exceptions). */
EXCEPTIONS_SIGJMP_BUF *exceptions_state_mc_init (struct ui_out *func_uiout,
- volatile struct exception *
+ volatile struct gdb_exception *
exception,
return_mask mask);
int exceptions_state_mc_action_iter (void);
*INDENT-OFF*
- volatile struct exception e;
+ volatile struct gdb_exception e;
TRY_CATCH (e, RETURN_MASK_ERROR)
{
}
/* If E is an exception, print it's error message on the specified
stream. for _fprintf, prefix the message with PREFIX... */
-extern void exception_print (struct ui_file *file, struct exception e);
-extern void exception_fprintf (struct ui_file *file, struct exception e,
+extern void exception_print (struct ui_file *file, struct gdb_exception e);
+extern void exception_fprintf (struct ui_file *file, struct gdb_exception e,
const char *prefix,
...) ATTR_FORMAT (printf, 3, 4);
-/* Throw an exception (as described by "struct exception"). Will
+/* Throw an exception (as described by "struct gdb_exception"). Will
execute a LONG JUMP to the inner most containing exception handler
established using catch_exceptions() (or similar).
be a good thing or a dangerous thing.'' -- the Existential
Wombat. */
-extern NORETURN void throw_exception (struct exception exception) ATTR_NORETURN;
-extern NORETURN void throw_verror (enum errors, const char *fmt,
- va_list ap) ATTR_NORETURN;
-extern NORETURN void throw_vfatal (const char *fmt, va_list ap) ATTR_NORETURN;
+extern NORETURN void throw_exception (struct gdb_exception exception) ATTR_NORETURN;
+extern NORETURN void throw_verror (enum errors, const char *fmt, va_list ap)
+ ATTR_NORETURN ATTR_FORMAT (printf, 2, 0);
+extern NORETURN void throw_vfatal (const char *fmt, va_list ap)
+ ATTR_NORETURN ATTR_FORMAT (printf, 1, 0);
extern NORETURN void throw_error (enum errors error, const char *fmt,
...) ATTR_NORETURN ATTR_FORMAT (printf, 2, 3);
throw_exception() than all cleanups installed since
catch_exceptions() was entered are invoked, the (-ve) exception
value is then returned by catch_exceptions. If FUNC() returns
- normally (with a postive or zero return value) then that value is
+ normally (with a positive or zero return value) then that value is
returned by catch_exceptions(). It is an internal_error() for
FUNC() to return a negative value.
copy of the gdb error message. This is used when a silent error is
issued and the caller wants to manually issue the error message.
+ MASK specifies what to catch; it is normally set to
+ RETURN_MASK_ALL, if for no other reason than that the code which
+ calls catch_errors might not be set up to deal with a quit which
+ isn't caught. But if the code can deal with it, it generally
+ should be RETURN_MASK_ERROR, unless for some reason it is more
+ useful to abort only the portion of the operation inside the
+ catch_errors. Note that quit should return to the command line
+ fairly quickly, even if some further processing is being done.
+
FIXME; cagney/2001-08-13: The need to override the global UIOUT
builder variable should just go away.
- This function superseeds catch_errors().
+ This function supersedes catch_errors().
This function uses SETJMP() and LONGJUMP(). */
/* This function, in addition, suppresses the printing of the captured
error message. It's up to the client to print it. */
-extern struct exception catch_exception (struct ui_out *uiout,
- catch_exception_ftype *func,
- void *func_args,
- return_mask mask);
+extern struct gdb_exception catch_exception (struct ui_out *uiout,
+ catch_exception_ftype *func,
+ void *func_args,
+ return_mask mask);
/* If CATCH_ERRORS_FTYPE throws an error, catch_errors() returns zero
otherwize the result from CATCH_ERRORS_FTYPE is returned. It is
indication of the exact exception that it caught - quit_flag might
help.
- This function is superseeded by catch_exceptions(). */
+ This function is superseded by catch_exceptions(). */
typedef int (catch_errors_ftype) (void *);
extern int catch_errors (catch_errors_ftype *, void *, char *, return_mask);
projects / external / binutils.git / blobdiff