The pseudonyms Reference Manual

This is the pseudonyms Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 06:35:39 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 pseudonyms

Relative package nicknames through macros

Author

Michal "phoe" Herda

License

FreeBSD (BSD 2-clause)

Dependencies
  • trivial-garbage (system).
  • named-readtables (system).
Source

pseudonyms.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 pseudonyms/pseudonyms.asd

Source

pseudonyms.asd.

Parent Component

pseudonyms (system).

ASDF Systems

pseudonyms.


3.1.2 pseudonyms/package.lisp

Source

pseudonyms.asd.

Parent Component

pseudonyms (system).

Packages

pseudonyms.


3.1.3 pseudonyms/pseudonyms.lisp

Dependency

package.lisp (file).

Source

pseudonyms.asd.

Parent Component

pseudonyms (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 pseudonyms

=== PSEUDONYMS by phoe ===

See attached README.md for documentation.

Source

package.lisp.

Use List
  • common-lisp.
  • editor-hints.named-readtables.
  • trivial-garbage.
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 Special variables

Special Variable: *pseudonym-table*

This is a global package-name-indexed hashtable holding package-name-and-pseudonym plists.

Package

pseudonyms.

Source

pseudonyms.lisp.


5.1.2 Ordinary functions

Function: defpseudonym (package pseudonym &key inside-package)

This, given a package name and a pseudonym for it, allows you to use a local pseudonym in form $pseudonym:symbol instead of name:symbol within your code. This pseudonym is local to the package you called defpseudonym in (as shown by the global variable *PACKAGE*).

Arguments must be a pair of non-empty non-equal string designators, although I suggest using a lowercase string for the second argument.
An optional third argument allows you to set a pseudonym for a different package.

This will signal an error whenever a nickname or pseudonym is already taken.

Package

pseudonyms.

Source

pseudonyms.lisp.

Function: pmakunbound (datum &key inside-package)

This, given either a pseudonym-bound package name or a package name-bound pseudonym, clears any name-pseudonym pair bound to it.

Argument must be a string designator.
An optional second argument allows you to clear a pseudonym for a different package.

Package

pseudonyms.

Source

pseudonyms.lisp.

Function: print-pseudonyms (&key inside-package)

This prints all pseudonyms in a fancy manner.
Optional argument designates the package name, from inside which pseudonyms should be printed.

Package

pseudonyms.

Source

pseudonyms.lisp.

Function: pseudonym-reader (stream char)

This is the reader macro for local pseudonyms.

This function is not meant to be called explicitly, unless you know what you’re doing.

Package

pseudonyms.

Source

pseudonyms.lisp.

Function: set-pseudonym-macro-character (char)

Sets the macro character for nickname resolution. By default, it is set to #$.

Package

pseudonyms.

Source

pseudonyms.lisp.


5.2 Internals


5.2.1 Ordinary functions

Function: pseudonyms-on ()

Gimme some sugar, baby.

Package

pseudonyms.

Source

pseudonyms.lisp.

Function: string=-getf (plist indicator)

This is a version of getf utilizing string= for comparison. Given a plist and a key, returns a value.

Package

pseudonyms.

Source

pseudonyms.lisp.

Function: string=-getf-key (plist indicator)

This is a version of getf utilizing string= for comparison. Given a plist and a value, returns a key.

Package

pseudonyms.

Source

pseudonyms.lisp.


5.2.2 Types

Type: string-designator ()
Package

pseudonyms.

Source

pseudonyms.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*pseudonym-table*: Public special variables

S
Special Variable, *pseudonym-table*: Public special variables