Function

Summary

Prints a backtrace of the current stack. For use in exception handling routines.

Package

dbg

Signature

output-backtrace keyword &key stream printer-bindings

Arguments

keyword

Defines how verbose the output should be. It can be one of :quick, :brief, :verbose or :bug-form, in increasing order of verbosity.

stream

An output stream designator.

printer-bindings

A list of conses.

Description

The function output-backtrace prints a backtrace of the current stack.

The output goes to the stream designated by stream.

printer-bindings, if supplied, must be a list of conses, where the car of each cons is a symbol. printer-bindings is ignored if keyword is :quick. Otherwise, around the actual printing it binds each symbol to the value in the cdr of the cons. This is intended to override the bindings that are used in the functions that output-backtrace uses.

output-backtrace should be used by applications in their exception handling routines to log a backtrace whenever an unexpected situation arises. In general, any application that is not intended to be used by Lisp programmers should have error handlers to deal with unexpected situations, and all these handlers should use output-backtrace.

Notes

The symbols that can be bound are not limited to "printer" symbols, so the name printer-bindings is slightly misleading.

See also

log-bug-form