The cl-package-locks Reference Manual

This is the cl-package-locks Reference Manual, version 0.0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:20:47 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-package-locks

A library to provide a unified way to work with package locks across supported common lisp implementations.

Author

Elliott Johnson <>

License

Copyright 2011 Elliott Johnson

Version

0.0.2

Source

cl-package-locks.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 cl-package-locks/cl-package-locks.asd

Source

cl-package-locks.asd.

Parent Component

cl-package-locks (system).

ASDF Systems

cl-package-locks.


3.1.2 cl-package-locks/package.lisp

Source

cl-package-locks.asd.

Parent Component

cl-package-locks (system).

Packages

cl-package-locks.


3.1.3 cl-package-locks/cl-package-locks.lisp

Dependency

package.lisp (file).

Source

cl-package-locks.asd.

Parent Component

cl-package-locks (system).

Public Interface

4 Packages

Packages are listed by definition order.


4.1 cl-package-locks

Source

package.lisp.

Use List

common-lisp.

Public Interface

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-packages-unlocked (packages &body body)

Accepts a list of packages that be unlocked for the duration of BODY and locked upon return.

Package

cl-package-locks.

Source

cl-package-locks.lisp.

Macro: without-package-locks (&body body)

Unlocks all packages for the duration of body.

Package

cl-package-locks.

Source

cl-package-locks.lisp.


5.1.2 Ordinary functions

Function: all-locked-packages ()

Returns a list of all locked packages.

Package

cl-package-locks.

Source

cl-package-locks.lisp.

Function: all-unlocked-packages ()

Returns a list of all unlocked packages.

Package

cl-package-locks.

Source

cl-package-locks.lisp.

Function: lock-package (package)

Locks a provided package.

Package

cl-package-locks.

Source

cl-package-locks.lisp.

Function: lock-packages (packages)

Locks the provided packages.

Package

cl-package-locks.

Source

cl-package-locks.lisp.

Function: locked-packages (packages)

Accepts a list of packages and returns those that are locked.

Package

cl-package-locks.

Source

cl-package-locks.lisp.

Function: package-locked-p (package)

Returns true if a given resolveable PACKAGE is locked.

Package

cl-package-locks.

Source

cl-package-locks.lisp.

Function: resolve-package (package)

Resolves a descriptor to a package object.

Package

cl-package-locks.

Source

cl-package-locks.lisp.

Function: resolve-packages (packages)

Resolves a list of packages.

Package

cl-package-locks.

Source

cl-package-locks.lisp.

Function: unlock-package (package)

Unlocks a provided package.

Package

cl-package-locks.

Source

cl-package-locks.lisp.

Function: unlock-packages (packages)

Unlocks the provided packages.

Package

cl-package-locks.

Source

cl-package-locks.lisp.

Function: unlocked-packages (packages)

Accepts a list of packages and returns those that are unlocked.

Package

cl-package-locks.

Source

cl-package-locks.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables