The conduit-packages Reference Manual

Table of Contents

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

The conduit-packages Reference Manual

This is the conduit-packages Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 08:31:27 2018 GMT+0.


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

1 Systems

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


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

1.1 conduit-packages

Source

conduit-packages.asd (file)

Component

conduit-packages.lisp (file)


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

2 Files

Files are sorted by type and then listed depth-first from the systems components trees.


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

2.1 Lisp


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

2.1.1 conduit-packages.asd

Location

conduit-packages.asd

Systems

conduit-packages (system)


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

2.1.2 conduit-packages/conduit-packages.lisp

Parent

conduit-packages (system)

Location

conduit-packages.lisp

Packages
Exported Definitions
Internal Definitions

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

3 Packages

Packages are listed by definition order.


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

3.1 org.tfeb.cl-user/conduits

Source

conduit-packages.lisp (file)

Nickname

org.tfeb.clc-user

Use List

org.tfeb.cl/conduits


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

3.2 org.tfeb.cl/conduits

Source

conduit-packages.lisp (file)

Nickname

org.tfeb.clc

Used By List

org.tfeb.cl-user/conduits


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

3.3 org.tfeb.conduit-packages

Source

conduit-packages.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

4 Definitions

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


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

4.1 Exported definitions


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

4.1.1 Macros

Macro: defpackage NAME &body CLAUSES

Define a package. See CL:DEFPACKAGE for tha basics.
In addition, this version of DEFPACKAGE can define a ‘conduit package’: that you can use as a conduit to extend existing packages.
This works by importing symbols from the existing packages and
then reexporting them. The syntax is as DEFPACKAGE, wiht the addition
of three new clauses:
(:EXTENDS package) takes package and reexports all its symbols; (:EXTENDS/INCLUDING package . syms/names) reexports only syms/names; (:EXTENDS/EXCLUDING package . syms/names) reexports all *but* syms/names. When defining a conduit package you almost certainly will want to say (:USE) to prevent the CL package being used.

If hierarchical packages are loaded when conduits is built (yes, I know) Then you can also say
(:ALIASES (name realname) ...)
Which will cause name to be a shorthand for realname when the package Being defined is the current package. Aliases are not inherited from conduits.

This version of DEFPACKAGE also support ‘cloning’ packages: making another package which is ‘just like’ an existing package. This means that all the internal, exported and shadowing symbols in the clone will be the same as those in the cloned package, but any additional things defined by DEFPACKAGE will also take effect. This allows you to essentially make a copy of
a package which you can then use to define new functionality without interning a lot of things in the original package. Cloning is a static operation - packages do not know who their clones are, and no attempt is made to keep clones up to date. Cloning is done by the clause
(:CLONES package)
Cloning is not compatible with extending (this is checked).
As with extending you probably want to specify (:USE) when cloning.

Package

org.tfeb.conduit-packages

Source

conduit-packages.lisp (file)


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

4.1.2 Functions

Function: delete-package PACK/NAME
Package

org.tfeb.conduit-packages

Source

conduit-packages.lisp (file)

Function: export SYMBOL/S &optional PACKAGE
Package

org.tfeb.conduit-packages

Source

conduit-packages.lisp (file)

Function: recompute-conduits ()

Clean up the lists of conduits, and recompute all conduit packages to make them consistent

Package

org.tfeb.conduit-packages

Source

conduit-packages.lisp (file)

Function: rename-package PACK/NAME NEW-NAME &optional NICKNAMES
Package

org.tfeb.conduit-packages

Source

conduit-packages.lisp (file)

Function: unexport SYMBOL/S &optional PACKAGE
Package

org.tfeb.conduit-packages

Source

conduit-packages.lisp (file)


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

4.2 Internal definitions


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

4.2.1 Special variables

Special Variable: *conduit-package-descriptions*
Package

org.tfeb.conduit-packages

Source

conduit-packages.lisp (file)

Special Variable: *conduit-packages*
Package

org.tfeb.conduit-packages

Source

conduit-packages.lisp (file)

Special Variable: *package-conduits*
Package

org.tfeb.conduit-packages

Source

conduit-packages.lisp (file)


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

4.2.2 Functions

Function: canonicalise-package-name PACKAGE/NAME
Package

org.tfeb.conduit-packages

Source

conduit-packages.lisp (file)

Function: clean-package-alist PA
Package

org.tfeb.conduit-packages

Source

conduit-packages.lisp (file)

Function: clone-packages-to-package FROMS TO
Package

org.tfeb.conduit-packages

Source

conduit-packages.lisp (file)

Function: delete-hp-alias-map P
Package

org.tfeb.conduit-packages

Source

conduit-packages.lisp (file)

Function: hp-alias-map P
Function: (setf hp-alias-map) NEW P
Package

org.tfeb.conduit-packages

Source

conduit-packages.lisp (file)

Function: make-package-conduit-package PACKAGE/NAME &key EXTENDS EXTENDS/INCLUDING EXTENDS/EXCLUDING
Package

org.tfeb.conduit-packages

Source

conduit-packages.lisp (file)

Function: note-conduit PACK CONDUIT
Package

org.tfeb.conduit-packages

Source

conduit-packages.lisp (file)

Function: recompute-conduits-for PACK &optional CHAIN
Package

org.tfeb.conduit-packages

Source

conduit-packages.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
conduit-packages.asd: The conduit-packages<dot>asd file
conduit-packages/conduit-packages.lisp: The conduit-packages/conduit-packages<dot>lisp file

F
File, Lisp, conduit-packages.asd: The conduit-packages<dot>asd file
File, Lisp, conduit-packages/conduit-packages.lisp: The conduit-packages/conduit-packages<dot>lisp file

L
Lisp File, conduit-packages.asd: The conduit-packages<dot>asd file
Lisp File, conduit-packages/conduit-packages.lisp: The conduit-packages/conduit-packages<dot>lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   (  
C   D   E   F   H   M   N   R   U  
Index Entry  Section

(
(setf hp-alias-map): Internal functions

C
canonicalise-package-name: Internal functions
clean-package-alist: Internal functions
clone-packages-to-package: Internal functions

D
defpackage: Exported macros
delete-hp-alias-map: Internal functions
delete-package: Exported functions

E
export: Exported functions

F
Function, (setf hp-alias-map): Internal functions
Function, canonicalise-package-name: Internal functions
Function, clean-package-alist: Internal functions
Function, clone-packages-to-package: Internal functions
Function, delete-hp-alias-map: Internal functions
Function, delete-package: Exported functions
Function, export: Exported functions
Function, hp-alias-map: Internal functions
Function, make-package-conduit-package: Internal functions
Function, note-conduit: Internal functions
Function, recompute-conduits: Exported functions
Function, recompute-conduits-for: Internal functions
Function, rename-package: Exported functions
Function, unexport: Exported functions

H
hp-alias-map: Internal functions

M
Macro, defpackage: Exported macros
make-package-conduit-package: Internal functions

N
note-conduit: Internal functions

R
recompute-conduits: Exported functions
recompute-conduits-for: Internal functions
rename-package: Exported functions

U
unexport: Exported functions

Jump to:   (  
C   D   E   F   H   M   N   R   U  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*conduit-package-descriptions*: Internal special variables
*conduit-packages*: Internal special variables
*package-conduits*: Internal special variables

S
Special Variable, *conduit-package-descriptions*: Internal special variables
Special Variable, *conduit-packages*: Internal special variables
Special Variable, *package-conduits*: Internal special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   C   O   P   S  
Index Entry  Section

C
conduit-packages: The conduit-packages system

O
org.tfeb.cl-user/conduits: The org<dot>tfeb<dot>cl-user/conduits package
org.tfeb.cl/conduits: The org<dot>tfeb<dot>cl/conduits package
org.tfeb.conduit-packages: The org<dot>tfeb<dot>conduit-packages package

P
Package, org.tfeb.cl-user/conduits: The org<dot>tfeb<dot>cl-user/conduits package
Package, org.tfeb.cl/conduits: The org<dot>tfeb<dot>cl/conduits package
Package, org.tfeb.conduit-packages: The org<dot>tfeb<dot>conduit-packages package

S
System, conduit-packages: The conduit-packages system

Jump to:   C   O   P   S