The local-package-aliases Reference Manual

This is the local-package-aliases Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 22:17:30 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 local-package-aliases

Allows to define inside of a package aliases to refer other packages. Provides a reader macro $ to use the aliases (active only in packages having alias mapping, and does not affect other code).
Portable.

Author

Anton Vodonosov <>

License

MIT

Version

0.0.1

Source

local-package-aliases.asd.

Child Component

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

Source

local-package-aliases.asd.

Parent Component

local-package-aliases (system).

ASDF Systems

local-package-aliases.


3.1.2 local-package-aliases/local-package-aliases.lisp

Source

local-package-aliases.asd.

Parent Component

local-package-aliases (system).

Packages

local-package-aliases.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 local-package-aliases

Source

local-package-aliases.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Macros

Macro: set (&rest package-alias-pairs)
Package

local-package-aliases.

Source

local-package-aliases.lisp.


5.1.2 Ordinary functions

Function: call-with-aliasing-readtable (thunk)

Convenience function to use in ASDF’s :around-compile argument.

Package

local-package-aliases.

Source

local-package-aliases.lisp.

Function: hook-into-swank ()
Package

local-package-aliases.

Source

local-package-aliases.lisp.

Function: set-aliasing-reader (to-readtable &optional macro-char default-readtable)

Modifies TO-READTABLE so that MACRO-CHAR at the beginning a token in
form $ALIAS:SYMBOL or $ALIAS::SYMBOL is used to refere other packages, according to the aliases set in the current packges by LOCAL-PACKAGE-ALIASES:SET.
The DEFAULT-READTABLE is used when the current package has no aliases.
In this case the hangler for MACRO-CHAR is retrieved from DEFAULT-READTABLE and temporary applied to the current readtable using CL:SET-SYNTAX-FROM-CHAR.
The default value for DEFAULT-READTABLE is copy of TO-READTABLE before
it’s syntax is modified.

Package

local-package-aliases.

Source

local-package-aliases.lisp.

Function: unhook-from-swank ()

Returns T if the hook handler was uninstalled, and NIL otherwize.

Package

local-package-aliases.

Source

local-package-aliases.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *package-to-aliases-map*

Mapping from package object to a hash-table of local aliases active in this package. The hash-table of local aliases maps string alias to a package designator.

Package

local-package-aliases.

Source

local-package-aliases.lisp.


5.2.2 Ordinary functions

Function: alias-table-for (package)
Package

local-package-aliases.

Source

local-package-aliases.lisp.

Function: aliases-of (package in-package)
Package

local-package-aliases.

Source

local-package-aliases.lisp.

Function: aliasing-readtable (&optional prototype-readtable macro-char)
Package

local-package-aliases.

Source

local-package-aliases.lisp.

Function: apply-case-mode (readtable-case-mode str)
Package

local-package-aliases.

Source

local-package-aliases.lisp.

Function: call-with-nicknames (alias-table fn)

Helper function useful to hook into SLIME
in order to provide completion, go-to-definition, function parameters help and other SLIME support.

Package

local-package-aliases.

Source

local-package-aliases.lisp.

Function: err (format-control &rest format-arguments)
Package

local-package-aliases.

Source

local-package-aliases.lisp.

Function: find-aliased-package (alias)
Package

local-package-aliases.

Source

local-package-aliases.lisp.

Function: find-aliased-symbol (token)

TOEKN is a string in the form alias:symbol or alias::symbol.

Package

local-package-aliases.

Source

local-package-aliases.lisp.

Function: has-local-aliases-p (package)
Package

local-package-aliases.

Source

local-package-aliases.lisp.

Function: read-package-aliased-symbol (stream char original-readtable)
Package

local-package-aliases.

Source

local-package-aliases.lisp.

Function: read-token (stream)
Package

local-package-aliases.

Source

local-package-aliases.lisp.

Function: set-alias-table-for (for-package &rest package-alias-pairs)

PACKAGE-ALIAS-PAIRS is a list in the form (package-designator alias-string package-designator alias-string ...)

Package

local-package-aliases.

Source

local-package-aliases.lisp.

Function: swank-buffer-package ()
Package

local-package-aliases.

Source

local-package-aliases.lisp.

Function: terminating-macro-char-p (char)
Package

local-package-aliases.

Source

local-package-aliases.lisp.

Function: terminator-p (char)
Package

local-package-aliases.

Source

local-package-aliases.lisp.

Function: whitespace-p (char)
Package

local-package-aliases.

Source

local-package-aliases.lisp.

Function: with-aliases-as-nicknames-hook (next-fn)
Package

local-package-aliases.

Source

local-package-aliases.lisp.


5.2.3 Conditions

Condition: aliased-ref-error
Package

local-package-aliases.

Source

local-package-aliases.lisp.

Direct superclasses
  • reader-error.
  • simple-error.

Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   A   C   E   F   H   M   R   S   T   U   W  
Index Entry  Section

A
alias-table-for: Private ordinary functions
aliases-of: Private ordinary functions
aliasing-readtable: Private ordinary functions
apply-case-mode: Private ordinary functions

C
call-with-aliasing-readtable: Public ordinary functions
call-with-nicknames: Private ordinary functions

E
err: Private ordinary functions

F
find-aliased-package: Private ordinary functions
find-aliased-symbol: Private ordinary functions
Function, alias-table-for: Private ordinary functions
Function, aliases-of: Private ordinary functions
Function, aliasing-readtable: Private ordinary functions
Function, apply-case-mode: Private ordinary functions
Function, call-with-aliasing-readtable: Public ordinary functions
Function, call-with-nicknames: Private ordinary functions
Function, err: Private ordinary functions
Function, find-aliased-package: Private ordinary functions
Function, find-aliased-symbol: Private ordinary functions
Function, has-local-aliases-p: Private ordinary functions
Function, hook-into-swank: Public ordinary functions
Function, read-package-aliased-symbol: Private ordinary functions
Function, read-token: Private ordinary functions
Function, set-alias-table-for: Private ordinary functions
Function, set-aliasing-reader: Public ordinary functions
Function, swank-buffer-package: Private ordinary functions
Function, terminating-macro-char-p: Private ordinary functions
Function, terminator-p: Private ordinary functions
Function, unhook-from-swank: Public ordinary functions
Function, whitespace-p: Private ordinary functions
Function, with-aliases-as-nicknames-hook: Private ordinary functions

H
has-local-aliases-p: Private ordinary functions
hook-into-swank: Public ordinary functions

M
Macro, set: Public macros

R
read-package-aliased-symbol: Private ordinary functions
read-token: Private ordinary functions

S
set: Public macros
set-alias-table-for: Private ordinary functions
set-aliasing-reader: Public ordinary functions
swank-buffer-package: Private ordinary functions

T
terminating-macro-char-p: Private ordinary functions
terminator-p: Private ordinary functions

U
unhook-from-swank: Public ordinary functions

W
whitespace-p: Private ordinary functions
with-aliases-as-nicknames-hook: Private ordinary functions


A.3 Variables