The defenum Reference Manual

3.1.1 defenum/defenum.asd

Source

defenum.asd.

Parent Component

defenum (system).

ASDF Systems

defenum.

---

3.1.2 defenum/defenum-package.lisp

Source

defenum.asd.

Parent Component

defenum (system).

Packages

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

---

3.1.3 defenum/lambda-list-parsing.lisp

Dependency

defenum-package.lisp (file).

Source

defenum.asd.

Parent Component

defenum (system).

Internals

• copy-destructuring-lambda-list (function).
• copy-generic-function-lambda-list (function).
• copy-lambda-list-item (function).
• copy-lambda-list-var (function).
• copy-macro-lambda-list (function).
• copy-ordinary-lambda-list (function).
• copy-specialized-lambda-list (function).
• destructuring-lambda-list (structure).
• destructuring-lambda-list-allow-other-keys (function).
• destructuring-lambda-list-auxiliary-vars (function).
• destructuring-lambda-list-keyword-vars (function).
• destructuring-lambda-list-optional-vars (function).
• destructuring-lambda-list-ordinary-vars (function).
• destructuring-lambda-list-p (function).
• destructuring-lambda-list-rest-var (function).
• generic-function-lambda-list (structure).
• generic-function-lambda-list-allow-other-keys (function).
• generic-function-lambda-list-auxiliary-vars (function).
• generic-function-lambda-list-keyword-vars (function).
• generic-function-lambda-list-optional-vars (function).
• generic-function-lambda-list-ordinary-vars (function).
• generic-function-lambda-list-p (function).
• generic-function-lambda-list-rest-var (function).
• lambda-list-item (structure).
• lambda-list-item-p (function).
• lambda-list-type (type).
• lambda-list-var (structure).
• lambda-list-var-p (function).
• lambda-list-var-type (type).
• ll-allow-other-keys (reader).
• ll-auxiliary-vars (reader).
• ll-keyword-vars (reader).
• ll-optional-vars (reader).
• ll-ordinary-vars (reader).
• ll-recall (generic function).
• ll-rest-var (reader).
• ll-vars (generic function).
• lli-form (reader).
• lli-item (reader).
• lli-kind (reader).
• lli-name (function).
• llv-form (function).
• llv-item (function).
• llv-kind (function).
• llv-name (function).
• macro-lambda-list (structure).
• macro-lambda-list-allow-other-keys (function).
• macro-lambda-list-auxiliary-vars (function).
• macro-lambda-list-body-var (reader).
• macro-lambda-list-env-var (reader).
• macro-lambda-list-keyword-vars (function).
• macro-lambda-list-optional-vars (function).
• macro-lambda-list-ordinary-vars (function).
• macro-lambda-list-p (function).
• macro-lambda-list-rest-var (function).
• macro-lambda-list-whole-var (reader).
• make-destructuring-lambda-list (function).
• make-generic-function-lambda-list (function).
• make-macro-lambda-list (function).
• make-ordinary-lambda-list (function).
• make-specialized-lambda-list (function).
• mkllitem (function).
• mkllvar (function).
• ordinary-lambda-list (structure).
• ordinary-lambda-list-allow-other-keys (function).
• ordinary-lambda-list-auxiliary-vars (function).
• ordinary-lambda-list-keyword-vars (function).
• ordinary-lambda-list-optional-vars (function).
• ordinary-lambda-list-ordinary-vars (function).
• ordinary-lambda-list-p (function).
• ordinary-lambda-list-rest-var (function).
• parse-ll (generic function).
• pll (function).
• specialized-lambda-list (structure).
• specialized-lambda-list-allow-other-keys (function).
• specialized-lambda-list-auxiliary-vars (function).
• specialized-lambda-list-keyword-vars (function).
• specialized-lambda-list-optional-vars (function).
• specialized-lambda-list-ordinary-vars (function).
• specialized-lambda-list-p (function).
• specialized-lambda-list-rest-var (function).
• t_lambda-list (structure).
• t_lambda-list-p (function).

---

3.1.4 defenum/defenum.lisp

Dependencies

• defenum-package.lisp (file).
• lambda-list-parsing.lisp (file).

Source

defenum.asd.

Parent Component

defenum (system).

Public Interface

• defenum (macro).
• enum (structure).
• enum-name (reader).
• find-enum (function).
• (setf find-enum) (function).
• next-enum-tag (function).
• nth-enum-tag (function).
• previous-enum-tag (function).
• print-object (method).
• print-object (method).
• tag-name (function).
• tag-of (function).
• tag-p (function).
• tags (function).

Internals

• %tag-enum (reader).
• (setf %tag-enum) (writer).
• %tag-name (reader).
• %tag-p (function).
• *enums-namespace* (special variable).
• build-enum-defstruct (function).
• build-enum-deftype (function).
• build-enum-fixnum-method (function).
• build-enum-function (function).
• build-enum-initialization (function).
• build-enum-method (function).
• build-enum-method-body (function).
• build-enum-method-redispatch-body (function).
• build-enum-methods (function).
• build-enum-predicate (function).
• build-enum-tag-defstruct (function).
• build-enum-tag-method (function).
• build-enum-tag-methods (function).
• build-enum-tag-slot-readers (function).
• canonicalize-tags-specs (function).
• enum-constructor-arguments (reader).
• enum-designator (type).
• enum-id-map (reader).
• (setf enum-id-map) (writer).
• enum-length (reader).
• enum-p (function).
• enum-tags (reader).
• get-tag-from-id (function).
• (setf get-tag-from-id) (function).
• make-method-spec (function).
• make-tag-spec (function).
• method-spec-args (function).
• method-spec-body (function).
• method-spec-method-keyword (function).
• method-spec-name (function).
• method-spec-quals (function).
• new-symbol (function).
• parse-method-spec (function).
• tag (structure).
• tag-designator (type).
• tag-enum (function).
• tag-name-internal (function).
• tag-spec-args (function).
• tag-spec-id (function).
• tag-spec-methods (function).
• tag-spec-tag (function).

---

5.1.1 Macros

Macro: defenum (name (&rest tags-specs) &optional slots &rest options-and-methods) ¶

The DEFENUM macro defines an extended enumerated type in the environment.

The extended enumerated types are called ’enums’ and are akin to
both C/C++ and Java (5.0 and later) enums. The main idea is to provide an enumerated type with symbolic tags and auxiliary
functionality in order to make this concept available in Common Lisp.

The DEFENUM macro is the entry point to the enum type’s definition.
The syntax accommodates both simple and sophisticated cases.

NAME names the enum type and eventually also a
function that maps ’tags’ to their ’implementation’. Tags can be
’simple’, i.e., symbolic, or ’structured’, in which case they are
actually structure objects that are themselves the ’range’ of an
implicit ’map’ with symbols in the ’domain’.

TAGS-SPECS is a list of tag specifications (tag-spec). A tag-spec has
the following (Common Lisp) syntax:

<pre>
tag-spec ::= SYMBOL
| (SYMBOL)
| (SYMBOL N)
| (SYMBOL (&rest args) &rest tag-methods)
| (SYMBOL N (&rest args) &rest tag-methods)
</pre>

Each SYMBOL is the symbolic tag. N is an integer constant. The first
three forms are the ’simple’ case, which corresponds to the
traditional C/C++ case. The other two cases correspond to
the ’structured’ case. ’args’ is a list of arguments to be passed
to the structured tag constructor. ’tag-methods’ is a list of method
specs similar to the ’enum methods’ specified in OPTIONS-AND-METHODS (see below) that will be EQL-specialized on the symbolic and associated fixnum
values; these method specifications admit a simplified lambda
argument list, which has an implicit first argument provided by DEFENUM.

SLOTS is a list of ’slot specifications’ like those in DEFSTRUCT.
Specifing any slot ensures that the implementation will generate a
number of specialized functions and methods that will be able to deal
with ’structured tags’. Each slot has a ’slot-name’ and is specified as read-only. Each slot has a reader named NAME-slot-name; all slots are automatically declared ’read only’.

OPTIONS-AND-METHODS is a list of ’options’ and ’enum methods’. The options are lists with a keyword in first position. The only option
recognized at this time is :DOCUMENTATION, with a second argument a
(doc) string, which will be associated to the enum type. The ’enum
methods’ specifications have the following form:

<pre>
enum-meth-spec ::= (:method M-NAME QUAL* ARGS &BODY M-BODY)
</pre>

M-NAME is the method name, QUAL is a method qualifier (zero or more),
ARGS is a specialized lambda-list, whose first argument is treated specially, and M-BODY is a normal method body. The first argument of
the lambda list is treated specially if it is specialized on T (cfr.,
not specialized) or it is specialized on the enum type NAME.
References to slot names in M-BODY are substituted with appropriate
calls to the slot reader functions.

Arguments and Values:

NAME : a SYMBOL.
TAG-SPECS : a list of ’enum tags’ specifications.
SLOTS : a list of ’slot specifications’.
OPTIONS-AND-METHODS : a list of ’options’ and (enum specific) ’methods’.

Examples:

cl-prompt> (defenum seasons (spring summer autumn winter))
#<ENUM SEASONS (SPRING SUMMER AUTUMN WINTER)>

cl-prompt> (seasons ’spring)
SPRING

cl-prompt> winter
3

cl-prompt> (seasons-p ’winter)
T

cl-prompt> (seasons winter) ; No quote.
WINTER

cl-prompt> (defenum operation
((PLUS () (:method evaluate (x y) (+ x y)))
(MINUS () (:method evaluate (x y) (- x y)))
(TIMES () (:method evaluate (x y) (* x y)))
(DIVIDE () (:method evaluate (x y) (/ x y))) ))
#<ENUM OPERATION (PLUS MINUS TIMES DIVIDE)>

cl-prompt> (typep ’divide ’operation)
T

cl-prompt> (evaluate times 2 pi)
6.283185307179586D0

cl-prompt> (evaluate ’plus 40 2)
42

cl-prompt> (defenum (colors (:initargs (r g b)))
((red (255 0 0))
(green (0 255 0))
(blue (0 0 255))
(white (255 255 255))
(black (0 0 0))
)
((r 0 :type (integer 0 255) :read-only t)
(g 0 :type (integer 0 255) :read-only t)
(b 0 :type (integer 0 255) :read-only t) )
(:documentation "The Colors Enum."))
#<ENUM COLORS (RED GREEN BLUE WHITE BLACK)>

cl-prompt> (colors-r red)
255

cl-prompt> (colors-g white)
255

cl-prompt> (documentation ’colors ’type)
"The Colors Enum."

cl-prompt> (previous-enum-tag ’colors ’green)
#<COLORS TAG RED>

cl-prompt> (previous-enum-tag ’colors *)
NIL

Notes:

The DEFENUM macro is inspired by Java ’enum’ classes; it offers
all the facilities of the Java version, while also retaining the C/C++
’enum tags are integers’ feature.

The use of the DEFENUM enumeration types has some limitations, due, of course, to Common Lisp’s slack typing and a few implementation choices.

The slot name references in the enum and tag methods are done via SYMBOL-MACROLET.

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

---

5.1.2 Ordinary functions

Reader: enum-name (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Target Slot

name.

Function: find-enum (name &optional errorp environment) ¶

Finds an enum with name NAME in the system.

FIND-ENUM behaves like FIND-CLASS. If ERRORP is true and no enum is found in the system an error is signaled. ENVIRONMENT is present for symmetry with FIND-CLASS and it is currently unused.

Arguments and Values:

NAME : a SYMBOL
ERRORP : a generalized boolean
ENVIRONMENT : an environment object (or NIL)
result : an ENUM instance or NIL.

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: (setf find-enum) (name &optional errorp environment) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: next-enum-tag (e tag) ¶

Given a tag designator TAG, returns the ’next’ tag in the enum E or NIL.

Arguments and Values:

enum : an enum designator (either an ENUM object or a SYMBOL).
tag : a tag designator (either a TAG object or a SYMBOL) or a FIXNUM. result : a tag designator or NIL.

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: nth-enum-tag (n enum) ¶

Returns the N-th tag in enum ENUM.

Arguments and Values:

N : a FIXNUM
ENUM : an enum designator (either an ENUM object or a SYMBOL). result1 : a tag designator.
result2 : whether a tag was actually found.

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: previous-enum-tag (e tag) ¶

Given a tag designator TAG, returns the ’previous’ tag in the enum E or NIL.

Arguments and Values:

enum : an enum designator (either an ENUM object or a SYMBOL). tag : a tag designator (either a TAG object or a SYMBOL) or a FIXNUM. result : a tag designator or NIL.

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: tag-name (e) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: tag-of (e tag &optional errorp) ¶

Returns the tag object designated by TAG in enum E.

Arguments and Values:

E : an enum designator (either an ENUM object or a SYMBOL).
TAG : a tag designator (either a TAG object or a SYMBOL) or a FIXNUM. ERRORP : a boolean.
RESULT : a tag designator.

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: tag-p (s) ¶

Checks whether the argument is a valid tag for an enum.

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: tags (e) ¶

Returns the tags of an enum.

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

---

5.1.3 Standalone methods

Method: print-object ((e enum) stream) ¶

Source

defenum.lisp.

Method: print-object ((tag tag) stream) ¶

Source

defenum.lisp.

---

5.1.4 Structures

Structure: enum ¶

The (abstract) Enum Structure.

Every enum will be derived from this structure, which cannot be instantiated. All enums will be singletons and stored in an ’enum namespace’.

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Direct superclasses

structure-object.

Direct methods

print-object.

Direct slots

Slot: name ¶

Type

symbol

Readers

enum-name.

Writers

This slot is read-only.

Slot: tags ¶

Type

list

Readers

enum-tags.

Writers

This slot is read-only.

Slot: constructor-arguments ¶

Type

list

Readers

enum-constructor-arguments.

Writers

This slot is read-only.

Slot: length ¶

Package

common-lisp.

Type

fixnum

Initform

0

Readers

enum-length.

Writers

This slot is read-only.

Slot: id-map ¶

Initform

(make-hash-table :test (function eql))

Readers

enum-id-map.

Writers

(setf enum-id-map).

---

5.2.1 Special variables

Special Variable: *enums-namespace* ¶

The ’enum namespace’.

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

---

5.2.2 Ordinary functions

Reader: %tag-enum (instance) ¶

Writer: (setf %tag-enum) (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Target Slot

enum.

Reader: %tag-name (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Target Slot

name.

Function: %tag-p (object) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: build-enum-defstruct (name enum-defstruct-name enum-defstruct-cons-name) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: build-enum-deftype (name tags documentation) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: build-enum-fixnum-method (name m) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: build-enum-function (name) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: build-enum-initialization (name symbolic-tags-p enum-defstruct-cons-name tag-defstruct-cons-name tags-specs) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: build-enum-method (name m tag-defstruct-name slot-names slot-accessors) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: build-enum-method-body (name self-variable slot-names slot-accessors m-body) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: build-enum-method-redispatch-body (name method-name tag-self-var args) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: build-enum-methods (name methods tag-defstruct-name tag-names tag-specs slots) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: build-enum-predicate (name) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: build-enum-tag-defstruct (enum-name tag-defstruct-name tag-defstruct-cons-name symbolic-tags-p initargs slots) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: build-enum-tag-method (name m tag-defstruct-name tag) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: build-enum-tag-methods (name m tag-defstruct-name tags-names tags-methods-table) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: build-enum-tag-slot-readers (name tags tag-defstruct-name slots) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: canonicalize-tags-specs (tags-specs) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: copy-destructuring-lambda-list (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: copy-generic-function-lambda-list (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: copy-lambda-list-item (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: copy-lambda-list-var (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: copy-macro-lambda-list (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: copy-method-spec (sequence) ¶

Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Alias for

copy-seq.

Function: copy-ordinary-lambda-list (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: copy-specialized-lambda-list (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: copy-tag-spec (sequence) ¶

Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Alias for

copy-seq.

Function: destructuring-lambda-list-allow-other-keys (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: destructuring-lambda-list-auxiliary-vars (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: destructuring-lambda-list-keyword-vars (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: destructuring-lambda-list-optional-vars (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: destructuring-lambda-list-ordinary-vars (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: destructuring-lambda-list-p (object) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: destructuring-lambda-list-rest-var (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Reader: enum-constructor-arguments (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Target Slot

constructor-arguments.

Reader: enum-id-map (instance) ¶

Writer: (setf enum-id-map) (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Target Slot

id-map.

Reader: enum-length (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Target Slot

length.

Function: enum-p (object) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Reader: enum-tags (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Target Slot

tags.

Function: generic-function-lambda-list-allow-other-keys (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: generic-function-lambda-list-auxiliary-vars (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: generic-function-lambda-list-keyword-vars (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: generic-function-lambda-list-optional-vars (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: generic-function-lambda-list-ordinary-vars (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: generic-function-lambda-list-p (object) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: generic-function-lambda-list-rest-var (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: get-tag-from-id (enum id) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: (setf get-tag-from-id) (enum id) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: lambda-list-item-p (object) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: lambda-list-var-p (object) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Reader: ll-allow-other-keys (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Target Slot

allow-other-keys.

Reader: ll-auxiliary-vars (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Target Slot

auxiliary-vars.

Reader: ll-keyword-vars (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Target Slot

keyword-vars.

Reader: ll-optional-vars (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Target Slot

optional-vars.

Reader: ll-ordinary-vars (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Target Slot

ordinary-vars.

Reader: ll-rest-var (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Target Slot

rest-var.

Reader: lli-form (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Target Slot

form.

Reader: lli-item (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Target Slot

item.

Reader: lli-kind (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Target Slot

kind.

Function: lli-name (lli) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: llv-form (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: llv-item (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: llv-kind (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: llv-name (lli) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: macro-lambda-list-allow-other-keys (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: macro-lambda-list-auxiliary-vars (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Reader: macro-lambda-list-body-var (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Target Slot

body-var.

Reader: macro-lambda-list-env-var (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Target Slot

env-var.

Function: macro-lambda-list-keyword-vars (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: macro-lambda-list-optional-vars (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: macro-lambda-list-ordinary-vars (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: macro-lambda-list-p (object) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: macro-lambda-list-rest-var (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Reader: macro-lambda-list-whole-var (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Target Slot

whole-var.

Function: make-destructuring-lambda-list (&optional ordinary-vars optional-vars rest-var keyword-vars allow-other-keys auxiliary-vars) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: make-generic-function-lambda-list (&optional ordinary-vars optional-vars rest-var keyword-vars allow-other-keys auxiliary-vars) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: make-macro-lambda-list (&optional whole-var env-var ordinary-vars optional-vars rest-var body-var keyword-vars allow-other-keys auxiliary-vars) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: make-method-spec (name quals args &rest body) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: make-ordinary-lambda-list (&optional ordinary-vars optional-vars rest-var keyword-vars allow-other-keys auxiliary-vars) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: make-specialized-lambda-list (&optional ordinary-vars optional-vars rest-var keyword-vars allow-other-keys auxiliary-vars) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: make-tag-spec (tag id &optional args &rest methods) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: method-spec-args (structure) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: method-spec-body (structure) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: method-spec-method-keyword (structure) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: method-spec-name (structure) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: method-spec-quals (structure) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: mkllitem (item kind &optional form) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: mkllvar (item kind &optional form) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: new-symbol (template &rest args) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: ordinary-lambda-list-allow-other-keys (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: ordinary-lambda-list-auxiliary-vars (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: ordinary-lambda-list-keyword-vars (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: ordinary-lambda-list-optional-vars (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: ordinary-lambda-list-ordinary-vars (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: ordinary-lambda-list-p (object) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: ordinary-lambda-list-rest-var (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: parse-method-spec (ms) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: pll (ll-type ll &optional recur) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: specialized-lambda-list-allow-other-keys (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: specialized-lambda-list-auxiliary-vars (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: specialized-lambda-list-keyword-vars (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: specialized-lambda-list-optional-vars (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: specialized-lambda-list-ordinary-vars (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: specialized-lambda-list-p (object) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: specialized-lambda-list-rest-var (instance) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: t_lambda-list-p (object) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Function: tag-enum (td &optional errorp) ¶

Returns the enum type where the tag designator TD belongs.

If TD is not a tag in an enum and ERRORP is non-NIL, an error is signaled. Otherwise NIL is returned.

Arguments and Values:

TD : a ’tag designator’
ERRORP : a generalized boolean (default NIL).
result : the ENUM object or NULL

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: tag-name-internal (e) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: tag-spec-args (structure) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: tag-spec-id (structure) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: tag-spec-methods (structure) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Function: tag-spec-tag (structure) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

---

5.2.3 Generic functions

Generic Function: ll-recall (ll) ¶

Produces an ’actual’ argument list using the lambda list variables.

This function is useful in order to write code transformers. It
produces a proper argument list suitable for use with APPLY.

Examples:

cl-prompt> (ll-recall (parse-ll :ordinary
’(a b &optional (c 42) &key (baz 42) &aux (foo 123)))) (A B C :BAZ BAZ ())

cl-prompt> (ll-recall (parse-ll :ordinary
’(a b &rest more)))
(A B MORE)

cl-prompt> (ll-recall (parse-ll :ordinary
’(a b &rest keys &key (foo 42))))
(A B :FOO FOO KEYS)

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Methods

Method: ll-recall ((ll t_lambda-list)) ¶

Generic Function: ll-vars (ll) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Methods

Method: ll-vars ((ll macro-lambda-list)) ¶

Method: ll-vars ((ll destructuring-lambda-list)) ¶

Method: ll-vars ((lli lambda-list-item)) ¶

Method: ll-vars ((ll t_lambda-list)) ¶

Generic Function: parse-ll (lltype ll) ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Methods

Method: parse-ll ((lltype (eql :macro)) ll) ¶

Method: parse-ll ((lltype (eql :destructuring)) ll) ¶

Method: parse-ll ((lltype (eql :generic-function)) ll) ¶

Method: parse-ll ((lltype (eql :specialized)) ll) ¶

Method: parse-ll ((lltype (eql :ordinary)) ll) ¶

---

5.2.4 Structures

Structure: destructuring-lambda-list ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Direct superclasses

t_lambda-list.

Direct subclasses

macro-lambda-list.

Direct methods

ll-vars.

Structure: generic-function-lambda-list ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Direct superclasses

t_lambda-list.

Structure: lambda-list-item ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Direct superclasses

structure-object.

Direct subclasses

lambda-list-var.

Direct methods

ll-vars.

Direct slots

Slot: item ¶

Type

(or symbol it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum::t_lambda-list list)

Readers

lli-item.

Writers

This slot is read-only.

Slot: kind ¶

Type

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum::lambda-list-var-type

Initform

(quote it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum::&reqvar)

Readers

lli-kind.

Writers

This slot is read-only.

Slot: form ¶

Type

(or symbol cons)

Readers

lli-form.

Writers

This slot is read-only.

Structure: lambda-list-var ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Direct superclasses

lambda-list-item.

Structure: macro-lambda-list ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Direct superclasses

destructuring-lambda-list.

Direct methods

ll-vars.

Direct slots

Slot: whole-var ¶

Type

list

Readers

macro-lambda-list-whole-var.

Writers

This slot is read-only.

Slot: env-var ¶

Type

list

Readers

macro-lambda-list-env-var.

Writers

This slot is read-only.

Slot: body-var ¶

Type

list

Readers

macro-lambda-list-body-var.

Writers

This slot is read-only.

Structure: ordinary-lambda-list ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Direct superclasses

t_lambda-list.

Structure: specialized-lambda-list ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Direct superclasses

t_lambda-list.

Structure: t_lambda-list ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Direct superclasses

structure-object.

Direct subclasses

• destructuring-lambda-list.
• generic-function-lambda-list.
• ordinary-lambda-list.
• specialized-lambda-list.

Direct methods

• ll-recall.
• ll-vars.

Direct slots

Slot: ordinary-vars ¶

Type

list

Readers

ll-ordinary-vars.

Writers

This slot is read-only.

Slot: optional-vars ¶

Type

list

Readers

ll-optional-vars.

Writers

This slot is read-only.

Slot: keyword-vars ¶

Type

list

Readers

ll-keyword-vars.

Writers

This slot is read-only.

Slot: rest-var ¶

Type

list

Readers

ll-rest-var.

Writers

This slot is read-only.

Slot: auxiliary-vars ¶

Type

list

Readers

ll-auxiliary-vars.

Writers

This slot is read-only.

Slot: allow-other-keys ¶

Type

boolean

Readers

ll-allow-other-keys.

Writers

This slot is read-only.

Structure: tag ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Direct superclasses

structure-object.

Direct methods

print-object.

Direct slots

Slot: enum ¶

Type

symbol

Readers

%tag-enum.

Writers

(setf %tag-enum).

Slot: name ¶

Type

symbol

Readers

%tag-name.

Writers

This slot is read-only.

---

5.2.5 Types

Type: enum-designator () ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

Type: lambda-list-type () ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Type: lambda-list-var-type () ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

lambda-list-parsing.lisp.

Type: tag-designator () ¶

Package

it.unimib.disco.ma.common-lisp.extensions.data-and-control-flow.defenum.

Source

defenum.lisp.

---