The trivial-backtrace Reference Manual

Table of Contents

The trivial-backtrace Reference Manual

This is the trivial-backtrace Reference Manual, version 1.1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 18:03:31 2021 GMT+0.

1 Introduction

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 trivial-backtrace

Maintainer

Gary Warren King <gwking@metabang.com>

Author

Gary Warren King <gwking@metabang.com>

License

MIT Style license

Description

trivial-backtrace

Version

1.1.0

Source

trivial-backtrace.asd (file)

Components

• copying (file)
• setup (module)
• dev (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 trivial-backtrace/setup

Parent

trivial-backtrace (system)

Location

dev/

Component

packages.lisp (file)

3.2 trivial-backtrace/dev

Dependency

setup (module)

Parent

trivial-backtrace (system)

Location

dev/

Components

• utilities.lisp (file)
• backtrace.lisp (file)
• map-backtrace.lisp (file)
• fallback.lisp (file)

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

4.1 Lisp

4.1.1 trivial-backtrace.asd

Location

trivial-backtrace.asd

Systems

trivial-backtrace (system)

Packages

trivial-backtrace-system

4.1.2 trivial-backtrace/setup/packages.lisp

Parent

setup (module)

Location

dev/packages.lisp

Packages

trivial-backtrace

4.1.3 trivial-backtrace/dev/utilities.lisp

Parent

dev (module)

Location

dev/utilities.lisp

Exported Definitions

*date-time-format* (special variable)

Internal Definitions

• date-time-string (function)
• format-date (function)
• generate-time-part-function (macro)
• time-date (function)
• time-day-of-week (function)
• time-daylight-savings-time-p (function)
• time-hour (function)
• time-minute (function)
• time-month (function)
• time-second (function)
• time-year (function)

4.1.4 trivial-backtrace/dev/backtrace.lisp

Parent

dev (module)

Location

dev/backtrace.lisp

Exported Definitions

• print-backtrace (function)
• print-backtrace-to-stream (function)
• print-condition (function)

4.1.5 trivial-backtrace/dev/map-backtrace.lisp

Parent

dev (module)

Location

dev/map-backtrace.lisp

Exported Definitions

• backtrace-string (function)
• map-backtrace (function)

Internal Definitions

• *trivial-backtrace-frame-print-specials* (special variable)
• copy-frame (function)
• copy-pos-form-number (function)
• copy-var (function)
• frame (structure)
• frame-func (function)
• (setf frame-func) (function)
• frame-p (function)
• frame-source-filename (function)
• (setf frame-source-filename) (function)
• frame-source-pos (function)
• (setf frame-source-pos) (function)
• frame-vars (function)
• (setf frame-vars) (function)
• impl-map-backtrace (function)
• make-frame (function)
• make-pos-form-number (function)
• make-var (function)
• pos-form-number (structure)
• pos-form-number-number (function)
• (setf pos-form-number-number) (function)
• pos-form-number-p (function)
• print-frame (function)
• print-map-backtrace (function)
• var (structure)
• var-name (function)
• (setf var-name) (function)
• var-p (function)
• var-value (function)
• (setf var-value) (function)

4.1.6 trivial-backtrace/dev/fallback.lisp

Dependencies

• backtrace.lisp (file)
• map-backtrace.lisp (file)

Parent

dev (module)

Location

dev/fallback.lisp

4.2 Static

4.2.1 trivial-backtrace/COPYING

Parent

trivial-backtrace (system)

Location

COPYING

5 Packages

Packages are listed by definition order.

5.1 trivial-backtrace-system

Source

trivial-backtrace.asd

Use List

• common-lisp
• asdf/interface

5.2 trivial-backtrace

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions

• *date-time-format* (special variable)
• backtrace-string (function)
• map-backtrace (function)
• print-backtrace (function)
• print-backtrace-to-stream (function)
• print-condition (function)

Internal Definitions

• *trivial-backtrace-frame-print-specials* (special variable)
• copy-frame (function)
• copy-pos-form-number (function)
• copy-var (function)
• date-time-string (function)
• format-date (function)
• frame (structure)
• frame-func (function)
• (setf frame-func) (function)
• frame-p (function)
• frame-source-filename (function)
• (setf frame-source-filename) (function)
• frame-source-pos (function)
• (setf frame-source-pos) (function)
• frame-vars (function)
• (setf frame-vars) (function)
• generate-time-part-function (macro)
• impl-map-backtrace (function)
• make-frame (function)
• make-pos-form-number (function)
• make-var (function)
• pos-form-number (structure)
• pos-form-number-number (function)
• (setf pos-form-number-number) (function)
• pos-form-number-p (function)
• print-frame (function)
• print-map-backtrace (function)
• time-date (function)
• time-day-of-week (function)
• time-daylight-savings-time-p (function)
• time-hour (function)
• time-minute (function)
• time-month (function)
• time-second (function)
• time-year (function)
• var (structure)
• var-name (function)
• (setf var-name) (function)
• var-p (function)
• var-value (function)
• (setf var-value) (function)

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

6.1 Exported definitions

6.1.1 Special variables

Special Variable: *date-time-format*

The default format to use when printing dates and times.

* %% - A ’%’ character
* %d - Day of the month as a decimal number [01-31]
* %e - Same as %d but does not print the leading 0 for days 1 through 9 [unlike strftime[], does not print a leading space]
* %H - Hour based on a 24-hour clock as a decimal number [00-23]
*%I - Hour based on a 12-hour clock as a decimal number [01-12]
* %m - Month as a decimal number [01-12]
* %M - Minute as a decimal number [00-59]
* %S - Second as a decimal number [00-59]
* %w - Weekday as a decimal number [0-6], where Sunday is 0
* %y - Year without century [00-99]
* %Y - Year with century [such as 1990]

This code is borrowed from the ‘format-date‘ function in [metatilities-base][].

Package

trivial-backtrace

Source

utilities.lisp (file)

6.1.2 Functions

Function: backtrace-string &rest ARGS

Package

trivial-backtrace

Source

map-backtrace.lisp (file)

Function: map-backtrace FUNCTION

Package

trivial-backtrace

Source

map-backtrace.lisp (file)

Function: print-backtrace ERROR &key OUTPUT IF-EXISTS VERBOSE

Send a backtrace for the error ‘error‘ to ‘output‘.

The keywords arguments are:

* :output - where to send the output. This can be:

* a string (which is assumed to designate a pathname)
* an open stream
* nil to indicate that the backtrace information should be returned as a string

* if-exists - what to do if output designates a pathname and the pathname already exists. Defaults to :append.

* verbose - if true, then a message about the backtrace is sent to \*terminal-io\*. Defaults to ‘nil‘.

If the ‘output‘ is nil, the returns the backtrace output as a string. Otherwise, returns nil.

Package

trivial-backtrace

Source

backtrace.lisp (file)

Function: print-backtrace-to-stream STREAM

Send a backtrace of the current error to stream.

Stream is assumed to be an open writable file stream or a string-output-stream. Note that ‘print-backtrace-to-stream‘ will print a backtrace for whatever the Lisp deems to be the *current* error.

Package

trivial-backtrace

Source

backtrace.lisp (file)

Function: print-condition CONDITION STREAM

Print ‘condition‘ to ‘stream‘ using the pretty printer.

Package

trivial-backtrace

Source

backtrace.lisp (file)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *trivial-backtrace-frame-print-specials*

Package

trivial-backtrace

Source

map-backtrace.lisp (file)

6.2.2 Macros

Macro: generate-time-part-function PART-NAME POSITION

Package

trivial-backtrace

Source

utilities.lisp (file)

6.2.3 Functions

Function: copy-frame INSTANCE

Package

trivial-backtrace

Source

map-backtrace.lisp (file)

Function: copy-pos-form-number INSTANCE

Package

trivial-backtrace

Source

map-backtrace.lisp (file)

Function: copy-var INSTANCE

Package

trivial-backtrace

Source

map-backtrace.lisp (file)

Function: date-time-string &key DATE/TIME FORMAT

Package

trivial-backtrace

Source

utilities.lisp (file)

Function: format-date FORMAT DATE &optional STREAM TIME-ZONE

Package

trivial-backtrace

Source

utilities.lisp (file)

Function: frame-func INSTANCE

Function: (setf frame-func) VALUE INSTANCE

Package

trivial-backtrace

Source

map-backtrace.lisp (file)

Function: frame-p OBJECT

Package

trivial-backtrace

Source

map-backtrace.lisp (file)

Function: frame-source-filename INSTANCE

Function: (setf frame-source-filename) VALUE INSTANCE

Package

trivial-backtrace

Source

map-backtrace.lisp (file)

Function: frame-source-pos INSTANCE

Function: (setf frame-source-pos) VALUE INSTANCE

Package

trivial-backtrace

Source

map-backtrace.lisp (file)

Function: frame-vars INSTANCE

Function: (setf frame-vars) VALUE INSTANCE

Package

trivial-backtrace

Source

map-backtrace.lisp (file)

Function: impl-map-backtrace FUNC

Package

trivial-backtrace

Source

map-backtrace.lisp (file)

Function: make-frame &key (FUNC FUNC) (SOURCE-FILENAME SOURCE-FILENAME) (SOURCE-POS SOURCE-POS) (VARS VARS)

Package

trivial-backtrace

Source

map-backtrace.lisp (file)

Function: make-pos-form-number &key (NUMBER NUMBER)

Package

trivial-backtrace

Source

map-backtrace.lisp (file)

Function: make-var &key (NAME NAME) (VALUE VALUE)

Package

trivial-backtrace

Source

map-backtrace.lisp (file)

Function: pos-form-number-number INSTANCE

Function: (setf pos-form-number-number) VALUE INSTANCE

Package

trivial-backtrace

Source

map-backtrace.lisp (file)

Function: pos-form-number-p OBJECT

Package

trivial-backtrace

Source

map-backtrace.lisp (file)

Function: print-frame FRAME STREAM

Package

trivial-backtrace

Source

map-backtrace.lisp (file)

Function: print-map-backtrace &optional STREAM &rest ARGS

Package

trivial-backtrace

Source

map-backtrace.lisp (file)

Function: time-date &optional UNIVERSAL-TIME TIME-ZONE

Returns the date part of the given time.

Package

trivial-backtrace

Source

utilities.lisp (file)

Function: time-day-of-week &optional UNIVERSAL-TIME TIME-ZONE

Returns the day-of-week part of the given time.

Package

trivial-backtrace

Source

utilities.lisp (file)

Function: time-daylight-savings-time-p &optional UNIVERSAL-TIME TIME-ZONE

Returns the daylight-savings-time-p part of the given time.

Package

trivial-backtrace

Source

utilities.lisp (file)

Function: time-hour &optional UNIVERSAL-TIME TIME-ZONE

Returns the hour part of the given time.

Package

trivial-backtrace

Source

utilities.lisp (file)

Function: time-minute &optional UNIVERSAL-TIME TIME-ZONE

Returns the minute part of the given time.

Package

trivial-backtrace

Source

utilities.lisp (file)

Function: time-month &optional UNIVERSAL-TIME TIME-ZONE

Returns the month part of the given time.

Package

trivial-backtrace

Source

utilities.lisp (file)

Function: time-second &optional UNIVERSAL-TIME TIME-ZONE

Returns the second part of the given time.

Package

trivial-backtrace

Source

utilities.lisp (file)

Function: time-year &optional UNIVERSAL-TIME TIME-ZONE

Returns the year part of the given time.

Package

trivial-backtrace

Source

utilities.lisp (file)

Function: var-name INSTANCE

Function: (setf var-name) VALUE INSTANCE

Package

trivial-backtrace

Source

map-backtrace.lisp (file)

Function: var-p OBJECT

Package

trivial-backtrace

Source

map-backtrace.lisp (file)

Function: var-value INSTANCE

Function: (setf var-value) VALUE INSTANCE

Package

trivial-backtrace

Source

map-backtrace.lisp (file)

6.2.4 Structures

Structure: frame ()

Package

trivial-backtrace

Source

map-backtrace.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: func

Readers

frame-func (function)

Writers

(setf frame-func) (function)

Slot: source-filename

Readers

frame-source-filename (function)

Writers

(setf frame-source-filename) (function)

Slot: source-pos

Readers

frame-source-pos (function)

Writers

(setf frame-source-pos) (function)

Slot: vars

Readers

frame-vars (function)

Writers

(setf frame-vars) (function)

Structure: pos-form-number ()

Package

trivial-backtrace

Source

map-backtrace.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

print-object (method)

Direct slots

Slot: number

Readers

pos-form-number-number (function)

Writers

(setf pos-form-number-number) (function)

Structure: var ()

Package

trivial-backtrace

Source

map-backtrace.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: name

Readers

var-name (function)

Writers

(setf var-name) (function)

Slot: value

Readers

var-value (function)

Writers

(setf var-value) (function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types