Handling Errors - Guile Reference Manual

Previous: Dynamic Wind, Up: Control Mechanisms

5.11.10 How to Handle Errors

Error handling is based on catch and throw. Errors are always thrown with a key and four arguments:

key: a symbol which indicates the type of error. The symbols used by libguile are listed below.
subr: the name of the procedure from which the error is thrown, or #f.
message: a string (possibly language and system dependent) describing the error. The tokens ~A and ~S can be embedded within the message: they will be replaced with members of the args list when the message is printed. ~A indicates an argument printed using display, while ~S indicates an argument printed using write. message can also be #f, to allow it to be derived from the key by the error handler (may be useful if the key is to be thrown from both C and Scheme).
args: a list of arguments to be used to expand ~A and ~S tokens in message. Can also be #f if no arguments are required.
rest: a list of any additional objects required. e.g., when the key is 'system-error, this contains the C errno value. Can also be #f if no additional objects are required.

In addition to catch and throw, the following Scheme facilities are available:

— Scheme Procedure: display-error stack port subr message args rest
— C Function: scm_display_error (stack, port, subr, message, args, rest)

Display an error message to the output port port. stack is the saved stack for the error, subr is the name of the procedure in which the error occurred and message is the actual error message, which may contain formatting instructions. These will format the arguments in the list args accordingly. rest is currently ignored.

The following are the error keys defined by libguile and the situations in which they are used:

error-signal: thrown after receiving an unhandled fatal signal such as SIGSEGV, SIGBUS, SIGFPE etc. The rest argument in the throw contains the coded signal number (at present this is not the same as the usual Unix signal number).
system-error: thrown after the operating system indicates an error condition. The rest argument in the throw contains the errno value.
numerical-overflow: numerical overflow.
out-of-range: the arguments to a procedure do not fall within the accepted domain.
wrong-type-arg: an argument to a procedure has the wrong type.
wrong-number-of-args: a procedure was called with the wrong number of arguments.
memory-allocation-error: memory allocation error.
stack-overflow: stack overflow error.
regular-expression-syntax: errors generated by the regular expression library.
misc-error: other errors.

5.11.10.1 C Support

In the following C functions, SUBR and MESSAGE parameters can be NULL to give the effect of #f described above.

— C Function: SCM scm_error (SCM key, char *subr, char *message, SCM args, SCM rest)

Throw an error, as per scm-error above.

— C Function: void scm_syserror (char *subr)
— C Function: void scm_syserror_msg (char *subr, char *message, SCM args)

Throw an error with key system-error and supply errno in the rest argument. For scm_syserror the message is generated using strerror.
Care should be taken that any code in between the failing operation and the call to these routines doesn't change errno.

— C Function: void scm_num_overflow (char *subr)
— C Function: void scm_out_of_range (char *subr, SCM bad_value)
— C Function: void scm_wrong_num_args (SCM proc)
— C Function: void scm_wrong_type_arg (char *subr, int argnum, SCM bad_value)
— C Function: void scm_memory_error (char *subr)

Throw an error with the various keys described above.
For scm_wrong_num_args, proc should be a Scheme symbol which is the name of the procedure incorrectly invoked.