The with-user-abort Reference Manual

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

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 Thu Sep 15 06:32:17 2022 GMT+0.

Table of Contents


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.


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

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.


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

3.1 Lisp


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

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

4 Packages

Packages are listed by definition order.


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

4.1 with-user-abort

Source

package.lisp.

Use List

common-lisp.

Public Interface

5 Definitions

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


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

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.


Next: , Previous: , Up: Public Interface   [Contents][Index]

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.


Appendix A Indexes


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

A.1 Concepts


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

A.2 Functions

Jump to:   F   M   U   W  
Index Entry  Section

F
Function, user-abort: Public ordinary functions

M
Macro, with-user-abort: Public macros

U
user-abort: Public ordinary functions

W
with-user-abort: Public macros

Jump to:   F   M   U   W  

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

A.3 Variables