The with-user-abort Reference Manual

Table of Contents

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 3.0 "Montgomery Scott" on Mon Dec 02 11:40:28 2019 GMT+0.


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

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


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

2 Systems

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


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

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

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

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 files   [Contents][Index]

3.1.1 with-user-abort.asd

Location

with-user-abort.asd

Systems

with-user-abort (system)


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

3.1.2 with-user-abort/package.lisp

Parent

with-user-abort (system)

Location

package.lisp

Packages

with-user-abort


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

3.1.3 with-user-abort/main.lisp

Dependency

package.lisp (file)

Parent

with-user-abort (system)

Location

main.lisp

Exported Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 with-user-abort

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

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

5 Definitions

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


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

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Functions

Function: user-abort &optional CONDITION
Package

with-user-abort

Source

main.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

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)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   W  
Index Entry  Section

F
File, Lisp, with-user-abort.asd: The with-user-abort․asd file
File, Lisp, with-user-abort/main.lisp: The with-user-abort/main․lisp file
File, Lisp, with-user-abort/package.lisp: The with-user-abort/package․lisp file

L
Lisp File, with-user-abort.asd: The with-user-abort․asd file
Lisp File, with-user-abort/main.lisp: The with-user-abort/main․lisp file
Lisp File, with-user-abort/package.lisp: The with-user-abort/package․lisp file

W
with-user-abort.asd: The with-user-abort․asd file
with-user-abort/main.lisp: The with-user-abort/main․lisp file
with-user-abort/package.lisp: The with-user-abort/package․lisp file

Jump to:   F   L   W  

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

A.2 Functions

Jump to:   F   M   U   W  
Index Entry  Section

F
Function, user-abort: Exported functions

M
Macro, with-user-abort: Exported macros

U
user-abort: Exported functions

W
with-user-abort: Exported macros

Jump to:   F   M   U   W  

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

A.3 Variables


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

A.4 Data types

Jump to:   C   P   S   U   W  
Index Entry  Section

C
Condition, user-abort: Exported conditions

P
Package, with-user-abort: The with-user-abort package

S
System, with-user-abort: The with-user-abort system

U
user-abort: Exported conditions

W
with-user-abort: The with-user-abort system
with-user-abort: The with-user-abort package

Jump to:   C   P   S   U   W