conditions               package:base               R Documentation

_C_o_n_d_i_t_i_o_n _H_a_n_d_l_i_n_g _a_n_d _R_e_c_o_v_e_r_y

_D_e_s_c_r_i_p_t_i_o_n:

     These functions provide a mechanism for handling unusual
     conditions, including errors and warnings.

_U_s_a_g_e:

     tryCatch(expr, ..., finally)
     withCallingHandlers(expr, ...)

     signalCondition(cond)

     simpleCondition(message, call = NULL)
     simpleError    (message, call = NULL)
     simpleWarning  (message, call = NULL)

     ## S3 method for class 'condition':
     as.character(x, ...)
     ## S3 method for class 'error':
     as.character(x, ...)
     ## S3 method for class 'condition':
     print(x, ...)
     ## S3 method for class 'restart':
     print(x, ...)

     conditionCall(c)
     ## S3 method for class 'condition':
     conditionCall(c)
     conditionMessage(c)
     ## S3 method for class 'condition':
     conditionMessage(c)

     withRestarts(expr, ...)

     computeRestarts(cond = NULL)
     findRestart(name, cond = NULL)
     invokeRestart(r, ...)
     invokeRestartInteractively(r)

     isRestart(x)
     restartDescription(r)
     restartFormals(r)

     .signalSimpleWarning(msg, call)
     .handleSimpleError(h, msg, call)

_A_r_g_u_m_e_n_t_s:

       c: a condition object.

    call: call expression.

    cond: a condition object.

    expr: expression to be evaluated.

 finally: expression to be evaluated before returning or exiting.

       h: function.

 message: character string.

     msg: character string.

    name: character string naming a restart.

       r: restart object.

       x: object.

     ...: additional arguments; see details below.

_D_e_t_a_i_l_s:

     The condition system provides a mechanism for signaling and
     handling unusual conditions, including errors and warnings.
     Conditions are represented as objects that contain information
     about the condition that occurred, such as a message and the call
     in which the condition occurred.  Currently conditions are
     S3-style objects, though this may eventually change.

     Conditions are objects inheriting from the abstract class
     'condition'.  Errors and warnings are objects inheriting from the
     abstract subclasses 'error' and 'warning'. The class 'simpleError'
     is the class used by 'stop' and all internal error signals. 
     Similarly, 'simpleWarning' is used by 'warning'.  The constructors
     by the same names take a string describing the condition as
     argument and an optional call. The functions 'conditionMessage'
     and 'conditionCall' ae generic functions that return the message
     and call of a condition.

     Conditions are signaled by 'signalCondition'.  In addition, the
     'stop' and 'warning' functions have been modified to also accept
     condition arguments.

     The function 'tryCatch' evaluates its expression argument in a
     context where the handlers provided in the '...' argument are
     available.  The 'finally' expression is then evaluated in the
     context in which 'tryCatch' was called; that is, the handlers
     supplied to the current 'tryCatch' call are not active when the
     'finally' expression is evaluated.

     Handlers provided in the '...' argument to 'tryCatch' are
     established for the duration of the evaluation of 'expr'. If no
     condition is signaled when evaluating 'expr' then 'tryCatch'
     returns the value of the expression.

     If a condition is signaled while evaluating 'expr' then
     established handlers are checked, starting with the most recently
     established ones, for one matching the class of the condition.
     When several handlers are supplied in a single 'tryCatch' then the
     first one is considered more recent than the second.  If a handler
     is found then control is transferred to the 'tryCatch' call that
     established the handler, the handler found and all more recent
     handlers are disestablished, the handler is called with the
     condition as its argument, and the result returned by the handler
     is returned as the value of the 'tryCatch' call.

     Calling handlers are established by 'withCallingHandlers'.  If a
     condition is signaled and the applicable handler is a calling
     handler, then the handler is called by 'signalCondition' in the
     context where the condition was signaled but with the available
     handlers restricted to those below the handler called in the
     handler stack.  If the handler returns, then the next handler is
     tried; once the last handler has been tried, 'signalCondition'
     returns 'NULL'.

     User interrupts signal a condition of class 'interrupt' that
     inherits directly from class 'condition' before executing the
     default interrupt action.

     Restarts are used for establishing recovery protocols.  They can
     be established using 'withRestarts'.  One pre-established restart
     is an 'abort' restart that represents a jump to top level.

     'findRestart' and 'computeRestarts' find the available restarts. 
     'findRestart' returns the most recently established restart of the
     specified name.  'computeRestarts' returns a list of all restarts.
      Both can be given a condition argument and will then ignore
     restarts that do not apply to the condition.

     'invokeRestart' transfers control to the point where the specified
     restart was established and calls the restart's handler with the
     arguments, if any, given as additional arguments to
     'invokeRestart'.  The restart argument to 'invokeRestart' can be a
     character string, in which case 'findRestart' is used to find the
     restart.

     New restarts for 'withRestarts' can be specified in several ways.
     The simplest is in 'name=function' form where the function is the
     handler to call when the restart is invoked.  Another simple
     variant is as 'name=string' where the string is stored in the
     'description' field of the restart object returned by
     'findRestart'; in this case the handler ignores its arguments and
     returns 'NULL'.  The most flexible form of a restart specification
     is as a list that can include several fields, including 'hander',
     'description', and 'test'.  The 'test' field should contain a
     function of one argument, a condition, that returns 'TRUE' if the
     restart applies to the condition and 'FALSE' if it does not; the
     default function returns 'TRUE' for all conditions.

     One additional field that can be specified for a restart is
     'interactive'.  This should be a function of no arguments that
     returns a list of arguments to pass to the restart handler.  The
     list could be obtained by interacting with the user if necessary. 
     The function 'invokeRestartInteractively' calls this function to
     obtain the arguments to use when invoking the restart.  The
     default 'interactive' method queries the user for values for the
     formal arguments of the handler function.

     '.signalSimpleWarning' and '.handleSimpleError' are used
     internally and should not be called directly.

_R_e_f_e_r_e_n_c_e_s:

     The 'tryCatch' mechanism is similar to Java error handling. 
     Calling handlers are based on Common Lisp and Dylan.  Restarts are
     based on the Common Lisp restart mechanism.

_S_e_e _A_l_s_o:

     'stop' and 'warning' signal conditions, and 'try' is essentially a
     simplified version of 'tryCatch'.

_E_x_a_m_p_l_e_s:

     tryCatch(1, finally=print("Hello"))
     e <- simpleError("test error")
     ## Not run: stop(e)
     ## Not run: tryCatch(stop(e), finally=print("Hello"))
     ## Not run: tryCatch(stop("fred"), finally=print("Hello"))
     tryCatch(stop(e), error = function(e) e, finally=print("Hello"))
     tryCatch(stop("fred"),  error = function(e) e, finally=print("Hello"))
     withCallingHandlers({ warning("A"); 1+2 }, warning = function(w) {})
     { try(invokeRestart("tryRestart")); 1}
     ## Not run: { withRestarts(stop("A"), abort = function() {}); 1}
     withRestarts(invokeRestart("foo", 1, 2), foo = function(x, y) {x + y})

