The with-user-abort Reference Manual

Table of Contents

The with-user-abort Reference Manual

This is the with-user-abort Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 06:28:03 2022 GMT+0.

1 Introduction

with-user-abort

ava fox

provides a portable way to capture control-c in your lisp programs

Exports

Macro with-user-abort &body body

executes BODY and captures a user-interrupt (control-c) and signals user-abort condition

Condition user-abort

a simple condition that inherits from your implementation's user-interrupt.

Example

(handler-case
	(with-user-abort (long-running-call))
  (user-abort ()
	(print "Quitting gracefully")
	(uiop:quit 1)))

License

BSD 3-Clause

2 Systems

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

2.1 with-user-abort

Author

ava fox

License

BSD 3-Clause

Description

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

Version

0.1

Source

with-user-abort.asd (file)

Components

• package.lisp (file)
• main.lisp (file)

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.asd

Location

with-user-abort.asd

Systems

with-user-abort (system)

3.1.2 with-user-abort/package.lisp

Parent

with-user-abort (system)

Location

package.lisp

Packages

with-user-abort

3.1.3 with-user-abort/main.lisp

Dependency

package.lisp (file)

Parent

with-user-abort (system)

Location

main.lisp

Exported Definitions

• user-abort (function)
• user-abort (condition)
• with-user-abort (macro)

4 Packages

Packages are listed by definition order.

4.1 with-user-abort

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• user-abort (function)
• user-abort (condition)
• with-user-abort (macro)

5 Definitions

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

5.1 Exported definitions

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 (file)

5.1.2 Functions

Function: user-abort &optional CONDITION

Package

with-user-abort

Source

main.lisp (file)

5.1.3 Conditions

Condition: user-abort ()

condition that inherits from implementation specific interrupt condition

Package

with-user-abort

Source

main.lisp (file)

Direct superclasses

interactive-interrupt (condition)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types