The with-user-abort Reference Manual

This is the with-user-abort Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 18:17:53 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 with-user-abort

provides an easy way to catch ctrl+c. useful for making binaries.

Author

ava fox

License

BSD 3-Clause

Version

0.1

Source

with-user-abort.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 with-user-abort/with-user-abort.asd

Source

with-user-abort.asd.

Parent Component

with-user-abort (system).

ASDF Systems

with-user-abort.


3.1.2 with-user-abort/package.lisp

Source

with-user-abort.asd.

Parent Component

with-user-abort (system).

Packages

with-user-abort.


3.1.3 with-user-abort/main.lisp

Dependency

package.lisp (file).

Source

with-user-abort.asd.

Parent Component

with-user-abort (system).

Public Interface
Internals

get-implementation-condition (function).


4 Packages

Packages are listed by definition order.


4.1 with-user-abort

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

get-implementation-condition (function).


5 Definitions

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


5.1 Public Interface


5.1.1 Macros

Macro: with-user-abort (&body body)

execute BODY, signalling user-abort if the interrupt signal is received

Package

with-user-abort.

Source

main.lisp.


5.1.2 Ordinary functions

Function: user-abort (&optional condition)
Package

with-user-abort.

Source

main.lisp.


5.1.3 Conditions

Condition: user-abort

condition that inherits from implementation specific interrupt condition

Package

with-user-abort.

Source

main.lisp.

Direct superclasses

interactive-interrupt.


5.2 Internals


5.2.1 Ordinary functions

Function: get-implementation-condition ()
Package

with-user-abort.

Source

main.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables