The exit-hooks Reference Manual

Table of Contents

The exit-hooks Reference Manual

This is the exit-hooks Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Dec 02 10:12:39 2019 GMT+0.

1 Introduction

* exit-hooks
exit-hooks provide a portable way to automatically call some user defined function when exit Common Lisp (Both ~(quit)~ from REPL or kill in shell). Like ~atexit~ in C and Python or Java's ~Runtime.addShutdownHook()~. It currently support SBCL, CCL, ECL, ABCL, Allegro CL, clisp and CMUCL. Before exit-hooks, there is no portable way to doing so and no staightforward way to use an exit hook on ABCL. It can be used for tasks like parmenantly save something when exit Lisp.

** Installation
#+BEGIN_SRC lisp
(ql:quickload :exit-hooks)

#+END_SRC

** Usage
To add a function FUNC called when Common Lisp exits:
#+BEGIN_SRC lisp
(exit-hooks:add-exit-hook #'func)
#+END_SRC
The function FUNC must be of zero arguments. If several functions are added this way, their calling sequence is not specified. If you want to call them in a specific sequence, you can simply wrap them into a single function and add it.

To visit current exit hooks or delete one, you can visit or delete elements from variable ~exit-hooks:*exit-hooks*~, it's a list contains current exit hooks. But you should not add exit hooks by adding elements to ~*exit-hooks*~, use ~add-exit-hook~ only, because elements in ~*exit-hooks*~ is implementation specific. 

** Acknowledgements
Thanks to Vibhu Mohindra from ABCL mail list and R. Matthew Emerson from OpenMCL mail list. They provide methods for exit-hooks for ABCL and CCL. And Jocelyn Fréchot gives many useful suggestions and support for clisp, Allegro CL and CMUCL. 

** Limitations
For some implementation, for example SBCL, when you are using SLIME, you need to exit Lisp in ~*inferior-lisp*~, not ~*slime-repl*~. If you directly run Lisp from shell, not in SLIME, there is no problem. Currently exit-hooks support most of popular Lisp implementations, but not all. If your implementation is not supported and you know how to do that, please tell me. Your work maybe helpful to other fellow Lispers. And this Library only provide a calling function when exit Lisp. Previous version of exit-hooks provide ability to add exit hooks with calling priority, but this can be easily done by wrap several functions into a single one and most people only want a portable layer so this is removed. If you want something to deal all kinds of OS signal handling capability you may have a look at [[https://github.com/guicho271828/trivial-signal][trivial-signal]].

2 Systems

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

2.1 exit-hooks

Author

Bo Yao <icerove@gmail.com>

License

BSD

Description

Call registered function when Common Lisp Exits.

Source

exit-hooks.asd (file)

Components

• package.lisp (file)
• exit-hooks.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 exit-hooks.asd

Location

exit-hooks.asd

Systems

exit-hooks (system)

3.1.2 exit-hooks/package.lisp

Parent

exit-hooks (system)

Location

package.lisp

Packages

exit-hooks

3.1.3 exit-hooks/exit-hooks.lisp

Dependency

package.lisp (file)

Parent

exit-hooks (system)

Location

exit-hooks.lisp

Exported Definitions

• *exit-hooks* (symbol macro)
• add-exit-hook (function)

4 Packages

Packages are listed by definition order.

4.1 exit-hooks

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• *exit-hooks* (symbol macro)
• add-exit-hook (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Symbol macros

Symbol Macro: *exit-hooks*

Package

exit-hooks

Source

exit-hooks.lisp (file)

Expansion

*exit-hooks*

5.1.2 Functions

Function: add-exit-hook FUNC

Package

exit-hooks

Source

exit-hooks.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types