The package-renaming Reference Manual

This is the package-renaming Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 22:47:45 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 package-renaming

locally renaming packages

License

MIT

Dependency

alexandria (system).

Source

package-renaming.asd.

Child Component

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

Source

package-renaming.asd.

Parent Component

package-renaming (system).

ASDF Systems

package-renaming.


3.1.2 package-renaming/package-renaming.lisp

Source

package-renaming.asd.

Parent Component

package-renaming (system).

Packages

package-renaming.

Public Interface

4 Packages

Packages are listed by definition order.


4.1 package-renaming

Source

package-renaming.lisp.

Use List
  • alexandria.
  • 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-effective-package-renamings (package-renamings &body body)

Evaluate the BODY in an dynamic environment where
the PACKAGE-RENAMINGS have been effected by effect-package-renamings,
and are undone in the end by the same
using the reverse renamings returned by the first call.
PACKAGE-RENAMINGS is a compile-time constant;
for runtime-computed renamings, use the call-with-effective-package-renamings function.

Package

package-renaming.

Source

package-renaming.lisp.


5.1.2 Ordinary functions

Function: call-with-effective-package-renamings (package-renamings thunk &key if-does-not-exist)

Call the THUNK in an dynamic environment where
the PACKAGE-RENAMINGS have been effected by effect-package-renamings, and are undone in the end by the same
using the reverse renamings returned by the first call.

Package

package-renaming.

Source

package-renaming.lisp.

Function: check-package-candidate-names (package-designator names)

Check that each of the NAMES either designates the package specified by PACKAGE-DESIGNATOR or no package at all

Package

package-renaming.

Source

package-renaming.lisp.

Function: check-same-package-names (names)

Check that the NAMES all designate the same package

Package

package-renaming.

Source

package-renaming.lisp.

Function: effect-package-renaming (old new &key if-does-not-exist)

Effect the renaming of a package with OLD names (designator or list of designators) to NEW names (a designator or list of designators).
Return the list of actual names that the package had.
IF-DOES-NOT-EXIST may be NIL or ERROR.

Package

package-renaming.

Source

package-renaming.lisp.

Function: effect-package-renamings (package-renamings &key if-does-not-exist)

Call effect-package-renaming on each renaming. Return a list of reverse renamings to undo the thing. IF-DOES-NOT-EXIST may be NIL or ERROR;
in the former case, the reverse renaming will rename the possibly newly created package to the "old" name.

Package

package-renaming.

Source

package-renaming.lisp.

Function: find-package-from-names (names &key if-does-not-exist)

Find the first package designated by one of the NAMES. IF-DOES-NOT-EXIST may be NIL or ERROR.

Package

package-renaming.

Source

package-renaming.lisp.

Function: package-names (package-designator)

List of the designated package’s name and nicknames

Package

package-renaming.

Source

package-renaming.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables