The trivial-backtrace Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The trivial-backtrace Reference Manual

This is the trivial-backtrace Reference Manual, version 1.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 06:21:51 2022 GMT+0.

Table of Contents


1 Introduction



2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 trivial-backtrace

trivial-backtrace

Maintainer

Gary Warren King <gwking@metabang.com>

Author

Gary Warren King <gwking@metabang.com>

License

MIT Style license

Version

1.1.0

Source

trivial-backtrace.asd.

Child Components

3 Modules

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


Next: , Previous: , Up: Modules   [Contents][Index]

3.1 trivial-backtrace/setup

Source

trivial-backtrace.asd.

Parent Component

trivial-backtrace (system).

Child Component

packages.lisp (file).


3.2 trivial-backtrace/dev

Dependency

setup (module).

Source

trivial-backtrace.asd.

Parent Component

trivial-backtrace (system).

Child Components

4 Files

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


Next: , Previous: , Up: Files   [Contents][Index]

4.1 Lisp


4.1.1 trivial-backtrace/trivial-backtrace.asd

Source

trivial-backtrace.asd.

Parent Component

trivial-backtrace (system).

ASDF Systems

trivial-backtrace.

Packages

trivial-backtrace-system.


4.1.2 trivial-backtrace/setup/packages.lisp

Source

trivial-backtrace.asd.

Parent Component

setup (module).

Packages

trivial-backtrace.


4.1.3 trivial-backtrace/dev/utilities.lisp

Source

trivial-backtrace.asd.

Parent Component

dev (module).

Public Interface

*date-time-format* (special variable).

Internals

4.1.4 trivial-backtrace/dev/backtrace.lisp

Source

trivial-backtrace.asd.

Parent Component

dev (module).

Public Interface

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

Source

trivial-backtrace.asd.

Parent Component

dev (module).

Public Interface
Internals

4.1.6 trivial-backtrace/dev/fallback.lisp

Dependencies
Source

trivial-backtrace.asd.

Parent Component

dev (module).


Previous: , Up: Files   [Contents][Index]

4.2 Static


Previous: , Up: Static   [Contents][Index]

4.2.1 trivial-backtrace/COPYING

Source

trivial-backtrace.asd.

Parent Component

trivial-backtrace (system).


5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 trivial-backtrace-system

Source

trivial-backtrace.asd.

Use List
  • asdf/interface.
  • common-lisp.

5.2 trivial-backtrace

Source

packages.lisp.

Use List

common-lisp.

Public Interface
Internals

6 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Public Interface


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.


6.1.2 Ordinary functions

Function: backtrace-string (&rest args)
Package

trivial-backtrace.

Source

map-backtrace.lisp.

Function: map-backtrace (function)
Package

trivial-backtrace.

Source

map-backtrace.lisp.

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.

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.

Function: print-condition (condition stream)

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

Package

trivial-backtrace.

Source

backtrace.lisp.


6.1.3 Standalone methods

Method: print-object ((pos-form-number pos-form-number) stream)
Source

map-backtrace.lisp.


6.2 Internals


Next: , Previous: , Up: Internals   [Contents][Index]

6.2.1 Special variables

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

trivial-backtrace.

Source

map-backtrace.lisp.


6.2.2 Macros

Macro: generate-time-part-function (part-name position)
Package

trivial-backtrace.

Source

utilities.lisp.


Next: , Previous: , Up: Internals   [Contents][Index]

6.2.3 Ordinary functions

Function: copy-frame (instance)
Package

trivial-backtrace.

Source

map-backtrace.lisp.

Function: copy-pos-form-number (instance)
Package

trivial-backtrace.

Source

map-backtrace.lisp.

Function: copy-var (instance)
Package

trivial-backtrace.

Source

map-backtrace.lisp.

Function: date-time-string (&key date/time format)
Package

trivial-backtrace.

Source

utilities.lisp.

Function: format-date (format date &optional stream time-zone)
Package

trivial-backtrace.

Source

utilities.lisp.

Reader: frame-func (instance)
Writer: (setf frame-func) (instance)
Package

trivial-backtrace.

Source

map-backtrace.lisp.

Target Slot

func.

Function: frame-p (object)
Package

trivial-backtrace.

Source

map-backtrace.lisp.

Reader: frame-source-filename (instance)
Writer: (setf frame-source-filename) (instance)
Package

trivial-backtrace.

Source

map-backtrace.lisp.

Target Slot

source-filename.

Reader: frame-source-pos (instance)
Writer: (setf frame-source-pos) (instance)
Package

trivial-backtrace.

Source

map-backtrace.lisp.

Target Slot

source-pos.

Reader: frame-vars (instance)
Writer: (setf frame-vars) (instance)
Package

trivial-backtrace.

Source

map-backtrace.lisp.

Target Slot

vars.

Function: impl-map-backtrace (func)
Package

trivial-backtrace.

Source

map-backtrace.lisp.

Function: make-frame (&key func source-filename source-pos vars)
Package

trivial-backtrace.

Source

map-backtrace.lisp.

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

trivial-backtrace.

Source

map-backtrace.lisp.

Function: make-var (&key name value)
Package

trivial-backtrace.

Source

map-backtrace.lisp.

Reader: pos-form-number-number (instance)
Writer: (setf pos-form-number-number) (instance)
Package

trivial-backtrace.

Source

map-backtrace.lisp.

Target Slot

number.

Function: pos-form-number-p (object)
Package

trivial-backtrace.

Source

map-backtrace.lisp.

Function: print-frame (frame stream)
Package

trivial-backtrace.

Source

map-backtrace.lisp.

Function: print-map-backtrace (&optional stream &rest args)
Package

trivial-backtrace.

Source

map-backtrace.lisp.

Function: time-date (&optional universal-time time-zone)

Returns the date part of the given time.

Package

trivial-backtrace.

Source

utilities.lisp.

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.

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.

Function: time-hour (&optional universal-time time-zone)

Returns the hour part of the given time.

Package

trivial-backtrace.

Source

utilities.lisp.

Function: time-minute (&optional universal-time time-zone)

Returns the minute part of the given time.

Package

trivial-backtrace.

Source

utilities.lisp.

Function: time-month (&optional universal-time time-zone)

Returns the month part of the given time.

Package

trivial-backtrace.

Source

utilities.lisp.

Function: time-second (&optional universal-time time-zone)

Returns the second part of the given time.

Package

trivial-backtrace.

Source

utilities.lisp.

Function: time-year (&optional universal-time time-zone)

Returns the year part of the given time.

Package

trivial-backtrace.

Source

utilities.lisp.

Reader: var-name (instance)
Writer: (setf var-name) (instance)
Package

trivial-backtrace.

Source

map-backtrace.lisp.

Target Slot

name.

Function: var-p (object)
Package

trivial-backtrace.

Source

map-backtrace.lisp.

Reader: var-value (instance)
Writer: (setf var-value) (instance)
Package

trivial-backtrace.

Source

map-backtrace.lisp.

Target Slot

value.


6.2.4 Structures

Structure: frame
Package

trivial-backtrace.

Source

map-backtrace.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: func
Readers

frame-func.

Writers

(setf frame-func).

Slot: source-filename
Readers

frame-source-filename.

Writers

(setf frame-source-filename).

Slot: source-pos
Readers

frame-source-pos.

Writers

(setf frame-source-pos).

Slot: vars
Readers

frame-vars.

Writers

(setf frame-vars).

Structure: pos-form-number
Package

trivial-backtrace.

Source

map-backtrace.lisp.

Direct superclasses

structure-object.

Direct methods

print-object.

Direct slots
Slot: number
Package

common-lisp.

Readers

pos-form-number-number.

Writers

(setf pos-form-number-number).

Structure: var
Package

trivial-backtrace.

Source

map-backtrace.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: name
Readers

var-name.

Writers

(setf var-name).

Slot: value
Readers

var-value.

Writers

(setf var-value).


Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
B   C   D   F   G   I   M   P   T   V  
Index Entry  Section

(
(setf frame-func): Private ordinary functions
(setf frame-source-filename): Private ordinary functions
(setf frame-source-pos): Private ordinary functions
(setf frame-vars): Private ordinary functions
(setf pos-form-number-number): Private ordinary functions
(setf var-name): Private ordinary functions
(setf var-value): Private ordinary functions

B
backtrace-string: Public ordinary functions

C
copy-frame: Private ordinary functions
copy-pos-form-number: Private ordinary functions
copy-var: Private ordinary functions

D
date-time-string: Private ordinary functions

F
format-date: Private ordinary functions
frame-func: Private ordinary functions
frame-p: Private ordinary functions
frame-source-filename: Private ordinary functions
frame-source-pos: Private ordinary functions
frame-vars: Private ordinary functions
Function, (setf frame-func): Private ordinary functions
Function, (setf frame-source-filename): Private ordinary functions
Function, (setf frame-source-pos): Private ordinary functions
Function, (setf frame-vars): Private ordinary functions
Function, (setf pos-form-number-number): Private ordinary functions
Function, (setf var-name): Private ordinary functions
Function, (setf var-value): Private ordinary functions
Function, backtrace-string: Public ordinary functions
Function, copy-frame: Private ordinary functions
Function, copy-pos-form-number: Private ordinary functions
Function, copy-var: Private ordinary functions
Function, date-time-string: Private ordinary functions
Function, format-date: Private ordinary functions
Function, frame-func: Private ordinary functions
Function, frame-p: Private ordinary functions
Function, frame-source-filename: Private ordinary functions
Function, frame-source-pos: Private ordinary functions
Function, frame-vars: Private ordinary functions
Function, impl-map-backtrace: Private ordinary functions
Function, make-frame: Private ordinary functions
Function, make-pos-form-number: Private ordinary functions
Function, make-var: Private ordinary functions
Function, map-backtrace: Public ordinary functions
Function, pos-form-number-number: Private ordinary functions
Function, pos-form-number-p: Private ordinary functions
Function, print-backtrace: Public ordinary functions
Function, print-backtrace-to-stream: Public ordinary functions
Function, print-condition: Public ordinary functions
Function, print-frame: Private ordinary functions
Function, print-map-backtrace: Private ordinary functions
Function, time-date: Private ordinary functions
Function, time-day-of-week: Private ordinary functions
Function, time-daylight-savings-time-p: Private ordinary functions
Function, time-hour: Private ordinary functions
Function, time-minute: Private ordinary functions
Function, time-month: Private ordinary functions
Function, time-second: Private ordinary functions
Function, time-year: Private ordinary functions
Function, var-name: Private ordinary functions
Function, var-p: Private ordinary functions
Function, var-value: Private ordinary functions

G
generate-time-part-function: Private macros

I
impl-map-backtrace: Private ordinary functions

M
Macro, generate-time-part-function: Private macros
make-frame: Private ordinary functions
make-pos-form-number: Private ordinary functions
make-var: Private ordinary functions
map-backtrace: Public ordinary functions
Method, print-object: Public standalone methods

P
pos-form-number-number: Private ordinary functions
pos-form-number-p: Private ordinary functions
print-backtrace: Public ordinary functions
print-backtrace-to-stream: Public ordinary functions
print-condition: Public ordinary functions
print-frame: Private ordinary functions
print-map-backtrace: Private ordinary functions
print-object: Public standalone methods

T
time-date: Private ordinary functions
time-day-of-week: Private ordinary functions
time-daylight-savings-time-p: Private ordinary functions
time-hour: Private ordinary functions
time-minute: Private ordinary functions
time-month: Private ordinary functions
time-second: Private ordinary functions
time-year: Private ordinary functions

V
var-name: Private ordinary functions
var-p: Private ordinary functions
var-value: Private ordinary functions

Jump to:   (  
B   C   D   F   G   I   M   P   T   V  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   B   C   D   F   M   P   S   T   U   V  
Index Entry  Section

B
backtrace.lisp: The trivial-backtrace/dev/backtrace․lisp file

C
copying: The trivial-backtrace/copying file

D
dev: The trivial-backtrace/dev module

F
fallback.lisp: The trivial-backtrace/dev/fallback․lisp file
File, backtrace.lisp: The trivial-backtrace/dev/backtrace․lisp file
File, copying: The trivial-backtrace/copying file
File, fallback.lisp: The trivial-backtrace/dev/fallback․lisp file
File, map-backtrace.lisp: The trivial-backtrace/dev/map-backtrace․lisp file
File, packages.lisp: The trivial-backtrace/setup/packages․lisp file
File, trivial-backtrace.asd: The trivial-backtrace/trivial-backtrace․asd file
File, utilities.lisp: The trivial-backtrace/dev/utilities․lisp file
frame: Private structures

M
map-backtrace.lisp: The trivial-backtrace/dev/map-backtrace․lisp file
Module, dev: The trivial-backtrace/dev module
Module, setup: The trivial-backtrace/setup module

P
Package, trivial-backtrace: The trivial-backtrace package
Package, trivial-backtrace-system: The trivial-backtrace-system package
packages.lisp: The trivial-backtrace/setup/packages․lisp file
pos-form-number: Private structures

S
setup: The trivial-backtrace/setup module
Structure, frame: Private structures
Structure, pos-form-number: Private structures
Structure, var: Private structures
System, trivial-backtrace: The trivial-backtrace system

T
trivial-backtrace: The trivial-backtrace system
trivial-backtrace: The trivial-backtrace package
trivial-backtrace-system: The trivial-backtrace-system package
trivial-backtrace.asd: The trivial-backtrace/trivial-backtrace․asd file

U
utilities.lisp: The trivial-backtrace/dev/utilities․lisp file

V
var: Private structures

Jump to:   B   C   D   F   M   P   S   T   U   V