Skip to main content

package-nicknames

package-nicknames Function

Syntax:

package-nicknames package → nicknames

Arguments and Values:

package—a package designator .

nicknames—a list of strings.

Description:

Returns the list of nickname strings for package, not including the name of package.

Examples:

(package-nicknames (make-package ’temporary 
				  :nicknames ’("TEMP" "temp"))) 
→ ("temp" "TEMP")

Exceptional Situations:

Should signal an error of type type-error if package is not a package designator .

Expanded Reference: package-nicknames​

Basic Usage: Retrieving Package Nicknames​

package-nicknames returns a list of nickname strings for a package. The primary name is not included.

(defpackage "GRAPHICS-LIBRARY"
  (:use "COMMON-LISP")
  (:nicknames "GLIB" "GL"))

(package-nicknames "GRAPHICS-LIBRARY")
=> ("GLIB" "GL")

Package with No Nicknames​

A package without nicknames returns an empty list.

(package-nicknames "COMMON-LISP-USER")
=> ("CL-USER")

(make-package "NO-NICKS" :use '())
(package-nicknames "NO-NICKS")
=> ()

Using make-package with Nicknames​

(make-package "NETWORKING" :nicknames '("NET" "NW") :use '())
==> #<PACKAGE "NETWORKING">

(package-nicknames "NETWORKING")
=> ("NET" "NW")

Nicknames After rename-package​

rename-package replaces all nicknames.

(make-package "OLD-NAME" :nicknames '("ON") :use '())
(package-nicknames "OLD-NAME")
=> ("ON")

(rename-package "OLD-NAME" "NEW-NAME" '("NN" "N"))
(package-nicknames "NEW-NAME")
=> ("NN" "N")