The cl-annot Reference Manual

4.1.1 cl-annot/cl-annot.asd

Source

cl-annot.asd.

Parent Component

cl-annot (system).

ASDF Systems

cl-annot.

Packages

cl-annot-asd.

---

4.1.2 cl-annot/src/main/utils.lisp

Source

cl-annot.asd.

Parent Component

main (module).

Packages

cl-annot.util.

Public Interface

• class-options (function).
• definition-form-symbol (function).
• definition-form-type (function).
• get-class-option (function).
• macroexpand-some (function).
• macroexpand-until-normal-form (function).
• macrop (function).
• plist-get-all (function).
• plist-member (function).
• progn-form-last (function).
• progn-form-replace-last (function).
• replace-function-body (function).
• replace-slot-specifiers (function).
• slot-specifiers (function).

---

4.1.3 cl-annot/src/main/core.lisp

Dependency

utils.lisp (file).

Source

cl-annot.asd.

Parent Component

main (module).

Packages

cl-annot.core.

Public Interface

• annotation-arity (function).
• (setf annotation-arity) (function).
• annotation-form (function).
• annotation-form-p (function).
• annotation-inline-p (function).
• (setf annotation-inline-p) (function).
• annotation-real (function).
• (setf annotation-real) (function).

---

4.1.4 cl-annot/src/main/expand.lisp

Dependency

core.lisp (file).

Source

cl-annot.asd.

Parent Component

main (module).

Packages

cl-annot.expand.

Public Interface

• %annotation (macro).
• expand-annotation (function).

Internals

expand-annotation-form (function).

---

4.1.5 cl-annot/src/main/syntax.lisp

Dependency

expand.lisp (file).

Source

cl-annot.asd.

Parent Component

main (module).

Packages

cl-annot.syntax.

Public Interface

• annotation-syntax-reader (function).
• enable-annot-syntax (macro).

Internals

• %enable-annot-syntax (function).
• read-annotation (function).
• read-annotation-arguments (function).

---

4.1.6 cl-annot/src/main/helper.lisp

Dependency

syntax.lisp (file).

Source

cl-annot.asd.

Parent Component

main (module).

Packages

cl-annot.helper.

Public Interface

• annotation (macro).
• defannotation (macro).

Internals

set-annotation-options (function).

---

4.1.7 cl-annot/src/main/annot.lisp

Dependency

helper.lisp (file).

Source

cl-annot.asd.

Parent Component

main (module).

Packages

cl-annot.

---

4.1.8 cl-annot/src/lib/std.lisp

Source

cl-annot.asd.

Parent Component

lib (module).

Packages

cl-annot.std.

Public Interface

• declaration* (macro).
• dynamic-extent* (macro).
• export* (macro).
• ftype* (macro).
• ignorable* (macro).
• ignore* (macro).
• inline* (macro).
• notinline* (macro).
• optimize* (macro).
• special* (macro).
• type* (macro).

Internals

%declare-list-or-symbol (function).

---

4.1.9 cl-annot/src/lib/eval-when.lisp

Dependency

std.lisp (file).

Source

cl-annot.asd.

Parent Component

lib (module).

Packages

cl-annot.eval-when.

Public Interface

• eval-always (macro).
• eval-when-compile (macro).
• eval-when-execute (macro).
• eval-when-load (macro).

---

4.1.10 cl-annot/src/lib/doc.lisp

Dependency

eval-when.lisp (file).

Source

cl-annot.asd.

Parent Component

lib (module).

Packages

cl-annot.doc.

Public Interface

doc (macro).

---

4.1.11 cl-annot/src/lib/class.lisp

Dependency

doc.lisp (file).

Source

cl-annot.asd.

Parent Component

lib (module).

Packages

cl-annot.class.

Public Interface

• export-accessors (macro).
• export-class (macro).
• export-constructors (macro).
• export-slots (macro).
• export-structure (macro).
• metaclass (macro).

Internals

• get-accessors-in-defclass (function).
• get-accessors-in-defstruct (function).
• get-conc-name (function).

---

4.1.12 cl-annot/src/lib/slot.lisp

Dependency

class.lisp (file).

Source

cl-annot.asd.

Parent Component

lib (module).

Packages

cl-annot.slot.

Public Interface

• optional (macro).
• required (macro).

Internals

• def-slot-annotation (macro).
• required-argument (function).

---

6.1.1 Macros

Macro: %annotation (annot &rest args) ¶

Annotation Expansion Engine.

Package

cl-annot.core.

Source

expand.lisp.

Macro: annotation (options function-definition-form) ¶

Package

cl-annot.helper.

Source

helper.lisp.

Macro: declaration* (vars) ¶

Shorthand for (DECLARE (DECLARATION ...)).

Package

cl-annot.std.

Source

std.lisp.

Macro: defannotation (name lambda-list options &body body) ¶

Package

cl-annot.helper.

Source

helper.lisp.

Macro: doc (docstring definition-form) ¶

Add DOCSTRING documentation for DEFINITION-FORM.

Package

cl-annot.doc.

Source

doc.lisp.

Macro: dynamic-extent* (vars) ¶

Shorthand for (DECLARE (DYNAMIC-EXTENT ...)).

Package

cl-annot.std.

Source

std.lisp.

Macro: enable-annot-syntax () ¶

Package

cl-annot.syntax.

Source

syntax.lisp.

Macro: eval-always (&body body) ¶

Package

cl-annot.eval-when.

Source

eval-when.lisp.

Macro: eval-when-compile (&body body) ¶

Package

cl-annot.eval-when.

Source

eval-when.lisp.

Macro: eval-when-execute (&body body) ¶

Package

cl-annot.eval-when.

Source

eval-when.lisp.

Macro: eval-when-load (&body body) ¶

Package

cl-annot.eval-when.

Source

eval-when.lisp.

Macro: export* (definition-form) ¶

Export the definition symbol of DEFINITION-FORM.

Package

cl-annot.std.

Source

std.lisp.

Macro: export-accessors (class-definition-form) ¶

Package

cl-annot.class.

Source

class.lisp.

Macro: export-class (class-definition-form) ¶

Package

cl-annot.class.

Source

class.lisp.

Macro: export-constructors (class-definition-form) ¶

Package

cl-annot.class.

Source

class.lisp.

Macro: export-slots (class-definition-form) ¶

Package

cl-annot.class.

Source

class.lisp.

Macro: export-structure (class-definition-form) ¶

Package

cl-annot.class.

Source

class.lisp.

Macro: ftype* (typespec name) ¶

Shorthand for (DECLARE (FTYPE ...)).

Package

cl-annot.std.

Source

std.lisp.

Macro: ignorable* (vars) ¶

Shorthand for (DECLARE (IGNORABLE ...)).

Package

cl-annot.std.

Source

std.lisp.

Macro: ignore* (vars) ¶

Shorthand for (DECLARE (IGNORE ...)).

Package

cl-annot.std.

Source

std.lisp.

Macro: inline* (name) ¶

Shorthand for (DECLARE (INLINE ...)).

Package

cl-annot.std.

Source

std.lisp.

Macro: metaclass (metaclass class-definition-form) ¶

Package

cl-annot.class.

Source

class.lisp.

Macro: notinline* (name) ¶

Shorthand for (DECLARE (NOTINLINE ...)).

Package

cl-annot.std.

Source

std.lisp.

Macro: optimize* (quality) ¶

Shorthand for (DECLARE (OPTIMIZE ...)).

Package

cl-annot.std.

Source

std.lisp.

Macro: optional (init-form slot-specifier0) ¶

Package

cl-annot.slot.

Source

slot.lisp.

Macro: required (slot-specifier0) ¶

Package

cl-annot.slot.

Source

slot.lisp.

Macro: special* (vars) ¶

Shorthand for (DECLARE (SPECIAL ...)).

Package

cl-annot.std.

Source

std.lisp.

Macro: type* (typespec name) ¶

Shorthand for (DECLARE (TYPE ...)).

Package

cl-annot.std.

Source

std.lisp.

---

6.1.2 Ordinary functions

Function: annotation-arity (annot) ¶

Return the number of arguments of ANNOT.

Package

cl-annot.core.

Source

core.lisp.

Function: (setf annotation-arity) (annot) ¶

Package

cl-annot.core.

Source

core.lisp.

Function: annotation-form (annot args) ¶

Make an annotation-form with ANNOT and ARGS.

Package

cl-annot.core.

Source

core.lisp.

Function: annotation-form-p (form) ¶

Return non-nil if FORM is an annotation-form.

Package

cl-annot.core.

Source

core.lisp.

Function: annotation-inline-p (annot) ¶

Return non-nil if ANNOT should be expanded on read-time.

Package

cl-annot.core.

Source

core.lisp.

Function: (setf annotation-inline-p) (annot) ¶

Package

cl-annot.core.

Source

core.lisp.

Function: annotation-real (annot) ¶

Return the real annotation of ANNOT.

Package

cl-annot.core.

Source

core.lisp.

Function: (setf annotation-real) (annot) ¶

Package

cl-annot.core.

Source

core.lisp.

Function: annotation-syntax-reader (stream char) ¶

Package

cl-annot.syntax.

Source

syntax.lisp.

Function: class-options (class-definition-form) ¶

Return class-options of CLASS-DEFINITION-FORM.

Package

cl-annot.util.

Source

utils.lisp.

Function: definition-form-symbol (definition-form) ¶

Return the symbol of DEFINITION-FORM.

Package

cl-annot.util.

Source

utils.lisp.

Function: definition-form-type (definition-form) ¶

Return the type of DEFINITION-FORM.

Package

cl-annot.util.

Source

utils.lisp.

Function: expand-annotation (annot args) ¶

Expand ANNOT. ARGS will be expanded prior to this form (call-by-value).

Package

cl-annot.expand.

Source

expand.lisp.

Function: get-class-option (name class-definition-form) ¶

Return a value of NAME class-option of CLASS-DEFINITION-FORM.

Package

cl-annot.util.

Source

utils.lisp.

Function: macroexpand-some (form) ¶

Expand FORM once. The result form won’t be nil.

Package

cl-annot.util.

Source

utils.lisp.

Function: macroexpand-until-normal-form (form) ¶

Expand FORM until it brecomes normal-form.

Package

cl-annot.util.

Source

utils.lisp.

Function: macrop (symbol) ¶

Return non-nil if SYMBOL is a macro.

Package

cl-annot.util.

Source

utils.lisp.

Function: plist-get-all (plist prop) ¶

Return all values in PLIST named PROP.

Package

cl-annot.util.

Source

utils.lisp.

Function: plist-member (plist prop) ¶

Return t if PLIST contains PROP as a property.

Package

cl-annot.util.

Source

utils.lisp.

Function: progn-form-last (progn-form) ¶

Return the last form of PROGN-FORM which should be evaluated at last. If macro forms seen, the macro forms will be expanded using MACROEXPAND-UNTIL-NORMAL-FORM.

Package

cl-annot.util.

Source

utils.lisp.

Function: progn-form-replace-last (last progn-form) ¶

Replace the last form of PROGN-FORM with LAST. If LAST is a function, the function will be called with the last form and used for replacing. If macro forms seen, the macro forms will be expanded using MACROEXPAND-UNTIL-NORMAL-FORM.

Package

cl-annot.util.

Source

utils.lisp.

Function: replace-function-body (function function-definition-form) ¶

Replace the body of FUNCTION-DEFINITION-FORM by calling FUNCTION with name, lambda-list and the body as arguments.

Package

cl-annot.util.

Source

utils.lisp.

Function: replace-slot-specifiers (function class-definition-form) ¶

Replace slot-specifiers of CLASS-DEFINITION-FORM with FUNCTION. The result value will be a class definition form also.

Package

cl-annot.util.

Source

utils.lisp.

Function: slot-specifiers (class-definition-form) ¶

Return class-specifiers of CLASS-DEFINITION-FORM.

Package

cl-annot.util.

Source

utils.lisp.

---

6.2.1 Macros

Macro: def-slot-annotation (name args &body body) ¶

Package

cl-annot.slot.

Source

slot.lisp.

---

6.2.2 Ordinary functions

Function: %declare-list-or-symbol (vars sym) ¶

Package

cl-annot.std.

Source

std.lisp.

Function: %enable-annot-syntax () ¶

Package

cl-annot.syntax.

Source

syntax.lisp.

Function: expand-annotation-form (form) ¶

Expand annotation FORM if possible.

Package

cl-annot.expand.

Source

expand.lisp.

Function: get-accessors-in-defclass (class-definition-form) ¶

Package

cl-annot.class.

Source

class.lisp.

Function: get-accessors-in-defstruct (class-definition-form) ¶

Package

cl-annot.class.

Source

class.lisp.

Function: get-conc-name (class-definition-form) ¶

Package

cl-annot.class.

Source

class.lisp.

Function: read-annotation (stream) ¶

Package

cl-annot.syntax.

Source

syntax.lisp.

Function: read-annotation-arguments (stream arity) ¶

Package

cl-annot.syntax.

Source

syntax.lisp.

Function: required-argument (name) ¶

Package

cl-annot.slot.

Source

slot.lisp.

Function: set-annotation-options (name options) ¶

Package

cl-annot.helper.

Source

helper.lisp.

---