2011-01-05 Michael Snyder <msnyder@vmware.com>

[deliverable/binutils-gdb.git] / gdb / exceptions.h

diff --git a/gdb/exceptions.h b/gdb/exceptions.h
index b6d4e12cdbe5e4eb9c8b734068a99fbc6ea8e28b..3493015751c0d47a51934527fa17ccb6ff2b139d 100644 (file)
--- a/gdb/exceptions.h
+++ b/gdb/exceptions.h
@@ -1,8 +1,8 @@
 /* Exception (throw catch) mechanism, for GDB, the GNU debugger.
 
    Copyright (C) 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
-   1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
-   Free Software Foundation, Inc.
+   1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
+   2009, 2010, 2011 Free Software Foundation, Inc.
 
    This file is part of GDB.
 
@@ -72,6 +72,12 @@ enum errors {
   /* Problem parsing an XML document.  */
   XML_PARSE_ERROR,
 
+  /* Error accessing memory.  */
+  MEMORY_ERROR,
+
+  /* Feature is not supported in this copy of GDB.  */
+  UNSUPPORTED_ERROR,
+
   /* Add more errors here.  */
   NR_ERRORS
 };
@@ -102,8 +108,8 @@ extern const struct gdb_exception exception_none;
 /* 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 gdb_exception *
-                                                exception,
+                                                volatile struct
+                                                gdb_exception *exception,
                                                 return_mask mask);
 int exceptions_state_mc_action_iter (void);
 int exceptions_state_mc_action_iter_1 (void);
@@ -147,7 +153,7 @@ int exceptions_state_mc_action_iter_1 (void);
 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);
+                              ...) ATTRIBUTE_PRINTF (3, 4);
 
 /* Throw an exception (as described by "struct gdb_exception").  Will
    execute a LONG JUMP to the inner most containing exception handler
@@ -160,24 +166,26 @@ extern void exception_fprintf (struct ui_file *file, struct gdb_exception e,
    be a good thing or a dangerous thing.'' -- the Existential
    Wombat.  */
 
-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);
+extern void throw_exception (struct gdb_exception exception)
+     ATTRIBUTE_NORETURN;
+extern void throw_verror (enum errors, const char *fmt, va_list ap)
+     ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (2, 0);
+extern void throw_vfatal (const char *fmt, va_list ap)
+     ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
+extern void throw_error (enum errors error, const char *fmt, ...)
+     ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (2, 3);
 
 /* Instead of deprecated_throw_reason, code should use catch_exception
    and throw_exception.  */
-extern NORETURN void deprecated_throw_reason (enum return_reason reason) ATTR_NORETURN;
+extern void deprecated_throw_reason (enum return_reason reason)
+     ATTRIBUTE_NORETURN;
 
 /* Call FUNC(UIOUT, FUNC_ARGS) but wrapped within an exception
    handler.  If an exception (enum return_reason) is thrown using
    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.
 
@@ -191,10 +199,19 @@ extern NORETURN void deprecated_throw_reason (enum return_reason reason) ATTR_NO
    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().  */
 
@@ -225,7 +242,7 @@ extern struct gdb_exception catch_exception (struct ui_out *uiout,
    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);
@@ -234,6 +251,7 @@ extern int catch_errors (catch_errors_ftype *, void *, char *, return_mask);
    functions. */
 
 typedef void (catch_command_errors_ftype) (char *, int);
-extern int catch_command_errors (catch_command_errors_ftype *func, char *command, int from_tty, return_mask);
+extern int catch_command_errors (catch_command_errors_ftype *func,
+                                char *command, int from_tty, return_mask);
 
 #endif