The cl-annot-revisit Reference Manual

4.1.1 cl-annot-revisit/cl-annot-revisit.asd

Source

cl-annot-revisit.asd.

Parent Component

cl-annot-revisit (system).

ASDF Systems

cl-annot-revisit.

---

4.1.2 cl-annot-revisit/package.lisp

Source

cl-annot-revisit.asd.

Parent Component

cl-annot-revisit (system).

Packages

cl-annot-revisit.

---

4.1.3 cl-annot-revisit/at-macro/package.lisp

Source

cl-annot-revisit.asd.

Parent Component

at-macro (module).

Packages

cl-annot-revisit-at-macro.

---

4.1.4 cl-annot-revisit/at-macro/condition.lisp

Dependency

package.lisp (file).

Source

cl-annot-revisit.asd.

Parent Component

at-macro (module).

Public Interface

• *at-macro-verbose* (special variable).
• at-macro-condition (condition).
• at-macro-error (condition).
• at-macro-runtime-error (condition).
• at-macro-style-warning (condition).
• at-macro-syntax-error (condition).

---

4.1.5 cl-annot-revisit/at-macro/util.lisp

Dependency

package.lisp (file).

Source

cl-annot-revisit.asd.

Parent Component

at-macro (module).

Public Interface

lambda-expression-p (function).

Internals

• ensure-list-with (function).
• function-name-p (function).
• macroexpand-convention (macro).
• mv-cond-let-n (macro).
• mv-cond-let2 (macro).
• split-list-at (function).

---

4.1.6 cl-annot-revisit/at-macro/eval-when.lisp

Dependency

package.lisp (file).

Source

cl-annot-revisit.asd.

Parent Component

at-macro (module).

Public Interface

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

---

4.1.7 cl-annot-revisit/at-macro/form-traversal.lisp

Dependency

package.lisp (file).

Source

cl-annot-revisit.asd.

Parent Component

at-macro (module).

Public Interface

• allow-macroexpand-internal-form-p (generic function).
• find-name-to-be-defined (function).
• find-name-to-be-defined-using-head (generic function).
• function-definition-operator-p (generic function).
• variable-definition-operator-p (generic function).

Internals

• +standard-definiton-form-list+ (constant).
• +standard-function-definiton-form-list+ (constant).
• +standard-variable-definiton-form-list+ (constant).
• apply-at-macro-for-each-form (function).
• apply-at-macro-to-multiple-forms (function).
• apply-at-macro-to-special-toplevel-form (function).

---

4.1.8 cl-annot-revisit/at-macro/declaration.lisp

Dependencies

• util.lisp (file).
• form-traversal.lisp (file).

Source

cl-annot-revisit.asd.

Parent Component

at-macro (module).

Public Interface

• dynamic-extent (macro).
• expand-add-declaration (function).
• expand-add-declaration-using-head (generic function).
• ignorable (macro).
• ignore (macro).
• operator-accept-docstring-p (generic function).
• operator-body-location (generic function).
• valid-proclamation-identifier-p (generic function).

Internals

• %expand-at-declaration (function).
• +standard-operators-accept-docstring-in-body+ (constant).
• add-declaration (macro).
• ignore-name-p (function).
• insert-declaration-to-body (function).
• insert-declaration-to-nth-body (function).
• parse-define-method-combination-long-form (function).
• parse-defmethod-form (function).

---

4.1.9 cl-annot-revisit/at-macro/declamation.lisp

Dependency

declaration.lisp (file).

Source

cl-annot-revisit.asd.

Parent Component

at-macro (module).

Public Interface

• declaration (macro).
• expand-incompleted-declamation (function).
• expand-incompleted-declamation-using-head (generic function).
• ftype (macro).
• incompleted-declamation-applicable-p (generic function).
• inline (macro).
• notinline (macro).
• optimize (macro).
• special (macro).
• type (macro).

Internals

• %expand-ambiguous-declamation (function).
• +standard-optimize-quality-symbols+ (constant).
• add-declaim-to-definiton-form (function).
• apply-incompleted-declamation (macro).
• common-lisp-package-p (function).
• complete-declaration-specifier (function).
• declaration-argument-like-p (function).
• expand-to-declaim-form (function).
• optimize-quality-p (function).

---

4.1.10 cl-annot-revisit/at-macro/documentation.lisp

Dependencies

• util.lisp (file).
• form-traversal.lisp (file).

Source

cl-annot-revisit.asd.

Parent Component

at-macro (module).

Public Interface

• doc (macro).
• documentation (macro).
• expand-documentation (function).
• expand-documentation-using-head (generic function).
• operator-doc-type (generic function).

Internals

expand-doc-macro-to-assign (function).

---

4.1.11 cl-annot-revisit/at-macro/export.lisp

Dependencies

• util.lisp (file).
• form-traversal.lisp (file).

Source

cl-annot-revisit.asd.

Parent Component

at-macro (module).

Public Interface

• expand-export-form (function).
• expand-export-form-using-head (generic function).
• export (macro).

Internals

add-export (function).

---

4.1.12 cl-annot-revisit/at-macro/defclass.lisp

Dependency

export.lisp (file).

Source

cl-annot-revisit.asd.

Parent Component

at-macro (module).

Public Interface

• *slot-accessor-option-names* (special variable).
• expand-export-accessors (function).
• expand-export-accessors-using-head (generic function).
• expand-export-slots (function).
• expand-export-slots-using-head (generic function).
• expand-metaclass (function).
• expand-metaclass-using-head (generic function).
• export-accessors (macro).
• export-class (macro).
• export-slots (macro).
• metaclass (macro).

Internals

• expand-export-class (function).
• expand-export-class-using-head (generic function).
• pick-defclass-options (function).
• pick-defclass-slots (function).

---

4.1.13 cl-annot-revisit/at-macro/defstruct.lisp

Dependencies

• defclass.lisp (file).
• documentation.lisp (file).

Source

cl-annot-revisit.asd.

Parent Component

at-macro (module).

Public Interface

• expand-documentation-using-head (method).
• expand-export-accessors-using-head (method).
• expand-export-constructors (function).
• expand-export-constructors-using-head (generic function).
• expand-export-structure (function).
• expand-export-structure-using-head (generic function).
• export-constructors (macro).
• export-structure (macro).
• find-name-to-be-defined-using-head (method).

Internals

• parse-defstruct-form (function).
• parse-defstruct-option (function).
• pick-names-of-defstruct-form (function).

---

4.1.14 cl-annot-revisit/at-macro/slot.lisp

Dependency

package.lisp (file).

Source

cl-annot-revisit.asd.

Parent Component

at-macro (module).

Public Interface

• at-required-precondition-error (condition).
• at-required-precondition-error-slot-name (reader method).
• at-required-runtime-error (condition).
• at-required-runtime-error-initarg (reader method).
• at-required-runtime-error-slot-name (reader method).
• optional (macro).
• required (macro).

Internals

• raise-required-slot-error (function).
• read-new-value (function).
• split-slot-specifier (function).

---

4.1.15 cl-annot-revisit/at-syntax/package.lisp

Source

cl-annot-revisit.asd.

Parent Component

at-syntax (module).

Packages

cl-annot-revisit-at-syntax.

---

4.1.16 cl-annot-revisit/at-syntax/defmethods.lisp

Dependency

package.lisp (file).

Source

cl-annot-revisit.asd.

Parent Component

at-syntax (module).

Public Interface

• count-lambda-list-required-arguments (function).
• expand-at-read-time-p (generic function).
• find-at-syntax-arity (generic function).
• resolve-at-syntax-alias (generic function).

---

4.1.17 cl-annot-revisit/at-syntax/reader.lisp

Dependency

defmethods.lisp (file).

Source

cl-annot-revisit.asd.

Parent Component

at-syntax (module).

Public Interface

*cl-annot-compatibility* (special variable).

Internals

• read-at (function).
• read-at-syntax (function).
• read-delimited-list-no-eof (function).
• read-sharp-at (function).

---

6.1.1 Special variables

Special Variable: *at-macro-verbose* ¶

When true, at-macros raise style-warnings.

Package

cl-annot-revisit.

Source

condition.lisp.

Special Variable: *cl-annot-compatibility* ¶

Package

cl-annot-revisit-at-syntax.

Source

reader.lisp.

Special Variable: *slot-accessor-option-names* ¶

Package

cl-annot-revisit-at-macro.

Source

defclass.lisp.

---

6.1.2 Macros

Macro: declaration ((&rest names)) ¶

Just a shorthand of (declaim (declaration ...))

Package

cl-annot-revisit.

Source

declamation.lisp.

Macro: doc (docstring &body body) ¶

Just an alias of (cl-annot-revisit:documentation ...)

Package

cl-annot-revisit.

Source

documentation.lisp.

Macro: documentation (docstring &body body) ¶

Insert DOCSTRING into FORMS.

Package

cl-annot-revisit.

Source

documentation.lisp.

Macro: dynamic-extent (name-or-names &body body) ¶

Adds ‘dynamic-extent’ declaration into BODY.
If BODY is nil, it is expanded to ’(declare (dynamic-extent ...)), to embed it as a declaration using ’#.’

Package

cl-annot-revisit.

Source

declaration.lisp.

Macro: eval-always (&body body) ¶

Just an alias of (eval-when (:compile-toplevel :load-toplevel :execute) ...)

Package

cl-annot-revisit.

Source

eval-when.lisp.

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

Just an alias of (eval-when (:compile-toplevel) ...)

Package

cl-annot-revisit.

Source

eval-when.lisp.

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

Just an alias of (eval-when (:execute) ...)

Package

cl-annot-revisit.

Source

eval-when.lisp.

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

Just an alias of (eval-when (:load-toplevel) ...)

Package

cl-annot-revisit.

Source

eval-when.lisp.

Macro: export (&body forms) ¶

‘export’ the defined names in FORMS.

Package

cl-annot-revisit.

Source

export.lisp.

Macro: export-accessors (&body forms) ¶

Package

cl-annot-revisit.

Source

defclass.lisp.

Macro: export-class (&body body) ¶

For ‘defclass’ and ‘define-conditions’, just an alias of nested ‘cl-annot-revisit:export-slots’, ‘cl-annot-revisit:export-accessors’ and ‘cl-annot-revisit:export’.

Package

cl-annot-revisit.

Source

defclass.lisp.

Macro: export-constructors (&body forms) ¶

‘Export’ constructors of the structure will be defined in FORMS.

Package

cl-annot-revisit.

Source

defstruct.lisp.

Macro: export-slots (&body forms) ¶

Package

cl-annot-revisit.

Source

defclass.lisp.

Macro: export-structure (&body forms) ¶

‘Export’ the name, constructors, copier, predicate, slot-names and accessors of the structure will be defined in FORMS.

Package

cl-annot-revisit.

Source

defstruct.lisp.

Macro: ftype (typespec &optional function-names-or-form &body body) ¶

Adds ‘ftype’ declaration or proclamation into BODY.
How this is expanded is described in ‘cl-annot-revisit:special’ docstring.

Next example is "2. Adding a proclamation" case:

(cl-annot-revisit:ftype (function (integer integer) integer)
(defun foo (x y) (+ x y)))

It is equivalent to:

(progn (declaim (ftype (function (integer integer) integer) foo)) (defun foo (x y)
(+ x y)))

Package

cl-annot-revisit.

Source

declamation.lisp.

Macro: ignorable (name-or-names &body body) ¶

Adds ‘ignorable’ declaration into BODY.
If BODY is nil, it is expanded to ’(declare (ignorable ...)), to embed it as a declaration using ’#.’

Package

cl-annot-revisit.

Source

declaration.lisp.

Macro: ignore (name-or-names &body body) ¶

Adds ‘ignore’ declaration into BODY.
If BODY is nil, it is expanded to ’(declare (ignore ...)), to embed it as a declaration using ’#.’

Package

cl-annot-revisit.

Source

declaration.lisp.

Macro: inline (&optional function-names-or-form &body body) ¶

Adds ‘inline’ declaration or proclamation into BODY.
How this is expanded is described in ‘cl-annot-revisit:special’ docstring.

Next example is "3. Toplevel declamation" case:

(cl-annot-revisit:inline (foo))

It is equivalent to:

(progn (declaim (inline foo))
’(declare (inline foo)))

Package

cl-annot-revisit.

Source

declamation.lisp.

Macro: metaclass (class-name &body forms) ¶

Package

cl-annot-revisit.

Source

defclass.lisp.

Macro: notinline (&optional function-names-or-form &body body) ¶

Adds ‘notinline’ declaration or proclamation into BODY.
How this is expanded is described in ‘cl-annot-revisit:special’ docstring.

Package

cl-annot-revisit.

Source

declamation.lisp.

Macro: optimize (&optional qualities &body body) ¶

Expands to ‘optimize’ declaration or proclamation.

* If BODY is not null, it add a ‘declare’ into BODY.

(cl-annot-revisit:optimize (speed safety)
(defun foo (x) (1+ x)))

ot is equivalent to

(defun foo (x)
(declare (optimize speed safety))
(1+ x))

* If BODY is null, it is expanded to ‘declaim’ and quoted ‘declare’ form.

(cl-annot-revisit:optimize ((speed 3) (safety 0) (debug 0)))

is expanded to

(progn (declaim (optimize (speed 3) (safety 0) (debug 0))) ’(declare (optimize (speed 3) (safety 0) (debug 0))))

Refer ‘cl-annot-revisit:special’ docstring to see why both ‘declaim’ and ‘declare’ appeared.

Package

cl-annot-revisit.

Source

declamation.lisp.

Macro: optional (initform slot-specifier) ¶

Works like as ’@optional’ of cl-annot. This is intended to used with ’#.’

Package

cl-annot-revisit.

Source

slot.lisp.

Macro: required (slot-specifier) ¶

Works like as ’@required’ of cl-annot. This is intended to used with ’#.’

Package

cl-annot-revisit.

Source

slot.lisp.

Macro: special (&optional vars-or-form &body body) ¶

Adds ‘special’ declaration or proclamation into BODY.

* If the first arg is a variable name or a list of names and BODY is not null, it adds a ‘declare’.

(cl-annot-revisit:special *x*
(defun foo (*x*) 100))

is equivalent to

(defun foo (*x*)
(declare (special *x*))
100)

* If the first arg is not names, it tries to add ‘declaim’:

(cl-annot-revisit:special
(defvar *x* 1)
(defvar *y* 2)
(defun foo (x) 100))

is equivalent to

(progn (declaim (special *x*))
(defvar *x* 1)
(declaim (special *y*))
(defvar *y* 2)
(defun foo (x) 100))

* If the first arg is a name or a list of names and BODY is null, it is expanded to ‘declaim’ and quoted ‘declare’ form.

(cl-annot-revisit:special (*x* *y*))

is expanded to

(progn (declaim (special *x* *y*))
’(declare (special *x* *y*)))

This works as ‘declaim’ at toplevel and can be embed as declarations using ’#.’.

(defun foo (*x*)
#.(cl-annot-revisit:special (*x*))
100)

is equivalent to

(defun foo (*x*)
(declare (special *x*))
100)

Package

cl-annot-revisit.

Source

declamation.lisp.

Macro: type (typespec &optional vars-or-form &body body) ¶

Adds ‘type’ declaration or proclamation into BODY.
How this is expanded is described in ‘cl-annot-revisit:special’ docstring.

Next example is "1. Adding a declaration" case:

(cl-annot-revisit:type integer x
(defun foo (x) 100))

It is equivalent to:

(defun foo (x)
(declare (type integer x))
100)

Package

cl-annot-revisit.

Source

declamation.lisp.

---

6.1.3 Ordinary functions

Function: count-lambda-list-required-arguments (lambda-list) ¶

Counts required arguments in LAMBDA-LIST.

Package

cl-annot-revisit-at-syntax.

Source

defmethods.lisp.

Function: expand-add-declaration (decl-specifier form) ¶

Insert DECL-SPECIFIER into FORM.
If expansion successed, returns (values <expansion> t). If failed, returns (values <original-form> nil).

Package

cl-annot-revisit-at-macro.

Source

declaration.lisp.

Function: expand-documentation (docstring form) ¶

Insert DOCSTRING into FORM.
If insertion successed, returns (values <expansion> t). If failed, returns (values <original-form> nil).

Package

cl-annot-revisit-at-macro.

Source

documentation.lisp.

Function: expand-export-accessors (form) ¶

Package

cl-annot-revisit-at-macro.

Source

defclass.lisp.

Function: expand-export-constructors (form) ¶

Package

cl-annot-revisit-at-macro.

Source

defstruct.lisp.

Function: expand-export-form (form) ¶

Called by ‘cl-annot-revisit:export’ to expand known ones. If expansion successed, returns (values <expansion> t). If failed, returns (values FORM nil).

Package

cl-annot-revisit-at-macro.

Source

export.lisp.

Function: expand-export-slots (form) ¶

Package

cl-annot-revisit-at-macro.

Source

defclass.lisp.

Function: expand-export-structure (form) ¶

Package

cl-annot-revisit-at-macro.

Source

defstruct.lisp.

Function: expand-incompleted-declamation (decl-specifier form) ¶

Package

cl-annot-revisit-at-macro.

Source

declamation.lisp.

Function: expand-metaclass (metaclass form) ¶

Package

cl-annot-revisit-at-macro.

Source

defclass.lisp.

Function: find-name-to-be-defined (form) ¶

If FORM is defining something (like ‘defun’, ‘defpackage’, etc), returns the name to be defined. If not, returns nil.

Package

cl-annot-revisit-at-macro.

Source

form-traversal.lisp.

Function: lambda-expression-p (form) ¶

Package

cl-annot-revisit-at-macro.

Source

util.lisp.

---

6.1.4 Generic functions

Generic Function: allow-macroexpand-internal-form-p (operator) ¶

Determines whether cl-annot-revisit macros
try ‘macroexpand-1’ to forms beginning with OPERATOR.
Default is NIL, because applying ‘macroexpand-1’ change internal forms. This may be a problem when ‘macrolet’ was used for for hooking.

Package

cl-annot-revisit-at-macro.

Source

form-traversal.lisp.

Methods

Method: allow-macroexpand-internal-form-p (_) ¶

Method: allow-macroexpand-internal-form-p ((operator symbol)) ¶

In default, returns T only for our macros.

Generic Reader: at-required-precondition-error-slot-name (condition) ¶

Package

cl-annot-revisit-at-macro.

Methods

Reader Method: at-required-precondition-error-slot-name ((condition at-required-precondition-error)) ¶

Source

slot.lisp.

Target Slot

slot-name.

Generic Reader: at-required-runtime-error-initarg (condition) ¶

Package

cl-annot-revisit-at-macro.

Methods

Reader Method: at-required-runtime-error-initarg ((condition at-required-runtime-error)) ¶

Source

slot.lisp.

Target Slot

initarg.

Generic Reader: at-required-runtime-error-slot-name (condition) ¶

Package

cl-annot-revisit-at-macro.

Methods

Reader Method: at-required-runtime-error-slot-name ((condition at-required-runtime-error)) ¶

Source

slot.lisp.

Target Slot

slot-name.

Generic Function: expand-add-declaration-using-head (operator decl-specifier form) ¶

Called by ‘expand-add-declaration’ to insert DECL-SPECIFIER into FORM. If FORM can be expanded, returns the expansion. If not, returns FORM.

Package

cl-annot-revisit-at-macro.

Source

declaration.lisp.

Methods

Method: expand-add-declaration-using-head (operator decl-specifier form) ¶

Method: expand-add-declaration-using-head ((operator (eql defgeneric)) decl-specifier form) ¶

For ‘defgeneric’. Note: This does not add declarations into methods defined in this form.

Method: expand-add-declaration-using-head ((operator (eql define-method-combination)) decl-specifier form) ¶

Method: expand-add-declaration-using-head ((operator (eql defmethod)) decl-specifier form) ¶

Method: expand-add-declaration-using-head ((operator (eql defsetf)) decl-specifier form) ¶

Method: expand-add-declaration-using-head ((operator (eql declaim)) decl-specifier form) ¶

Generic Function: expand-at-read-time-p (operator cl-annot-compatible-p) ¶

If this returns T, the macro named OPERATOR will be ‘macroexpand’ed at read-time.

This feature is for supporting ’:inline’ feature of the original cl-annot, but it is not needed conceptually because you can use ’#.’ anytime.

Package

cl-annot-revisit-at-syntax.

Source

defmethods.lisp.

Methods

Method: expand-at-read-time-p (operator cl-annot-compatible-p) ¶

Generic Function: expand-documentation-using-head (operator docstring form) ¶

Called by ‘expand-documentation’ to insert DOCSTRING into FORM. If FORM can be expanded, returns its expansion. If not, returns FORM.

Package

cl-annot-revisit-at-macro.

Source

documentation.lisp.

Methods

Method: expand-documentation-using-head ((operator (eql defstruct)) docstring form) ¶

Special handling for ‘defstruct’, which define a new type only when it doesn’t have :type.

Source

defstruct.lisp.

Method: expand-documentation-using-head (operator docstring form) ¶

Method: expand-documentation-using-head ((operator (eql function)) docstring form) ¶

Special handling for #’(lambda ..), adds DOCSTRING to the anonymous function.

Generic Function: expand-export-accessors-using-head (operator form) ¶

Package

cl-annot-revisit-at-macro.

Source

defclass.lisp.

Methods

Method: expand-export-accessors-using-head ((form-op (eql defstruct)) form) ¶

Source

defstruct.lisp.

Method: expand-export-accessors-using-head (operator form) ¶

Method: expand-export-accessors-using-head ((operator (eql defclass)) form) ¶

Method: expand-export-accessors-using-head ((operator (eql define-condition)) form) ¶

Generic Function: expand-export-constructors-using-head (form-op form) ¶

Package

cl-annot-revisit-at-macro.

Source

defstruct.lisp.

Methods

Method: expand-export-constructors-using-head (form-op form) ¶

Method: expand-export-constructors-using-head ((form-op (eql defstruct)) form) ¶

Generic Function: expand-export-form-using-head (form-head form) ¶

Called by ‘expand-export-form’ to compute a result.
If FORM can be expanded, returns its expansion. If not, returns FORM.

Package

cl-annot-revisit-at-macro.

Source

export.lisp.

Methods

Method: expand-export-form-using-head (form-head form) ¶

General case. If FORM found by ‘find-name-to-be-defined’, returns the expansion of FORM. If not, returns FORM.

Method: expand-export-form-using-head ((form-head (eql defpackage)) form) ¶

A special handling for ‘defpackage’. It does not define a name as a symbol.

Generic Function: expand-export-slots-using-head (operator form) ¶

Package

cl-annot-revisit-at-macro.

Source

defclass.lisp.

Methods

Method: expand-export-slots-using-head (operator form) ¶

Method: expand-export-slots-using-head ((operator (eql defclass)) form) ¶

Method: expand-export-slots-using-head ((operator (eql define-condition)) form) ¶

Generic Function: expand-export-structure-using-head (form-op form) ¶

Package

cl-annot-revisit-at-macro.

Source

defstruct.lisp.

Methods

Method: expand-export-structure-using-head (form-op form) ¶

Method: expand-export-structure-using-head ((form-op (eql defstruct)) form) ¶

Generic Function: expand-incompleted-declamation-using-head (operator decl-specifier form) ¶

Called by ‘expand-add-declamation’ to expand FORM.

Package

cl-annot-revisit-at-macro.

Source

declamation.lisp.

Methods

Method: expand-incompleted-declamation-using-head (operator decl-specifier form) ¶

Generic Function: expand-metaclass-using-head (operator metaclass form) ¶

Package

cl-annot-revisit-at-macro.

Source

defclass.lisp.

Methods

Method: expand-metaclass-using-head (operator metaclass form) ¶

Method: expand-metaclass-using-head ((operator (eql defclass)) metaclass form) ¶

Generic Function: find-at-syntax-arity (operator cl-annot-compatible-p) ¶

Returns at-syntax arity of OPERATOR. If this
returns NIL, OPERATOR is considered as not for @-syntax. Default is 1, means OPERATOR takes one argument for ’@’ syntax.

Package

cl-annot-revisit.

Source

defmethods.lisp.

Methods

Method: find-at-syntax-arity ((operator null) cl-annot-compatible-p) ¶

Method: find-at-syntax-arity ((operator symbol) cl-annot-compatible-p) ¶

Method: find-at-syntax-arity ((operator cons) cl-annot-compatible-p) ¶

Method: find-at-syntax-arity (operator cl-annot-compatible-p) ¶

Generic Function: find-name-to-be-defined-using-head (form-head form) ¶

Called by ‘find-name-to-be-defined’ to compute a result.

Package

cl-annot-revisit-at-macro.

Source

form-traversal.lisp.

Methods

Method: find-name-to-be-defined-using-head ((form-head (eql defstruct)) form) ¶

Special handling for ‘defstruct’. Its second form may contain some options.

Source

defstruct.lisp.

Method: find-name-to-be-defined-using-head ((form-head list) form) ¶

Handles lambda forms. It returns nil.

Method: find-name-to-be-defined-using-head ((form-head symbol) form) ¶

Called if FORM-HEAD is symbol.

Generic Function: function-definition-operator-p (operator) ¶

Returns T if OPERATOR naming a definition form and its first argument is a function name to be defined.

Package

cl-annot-revisit-at-macro.

Source

form-traversal.lisp.

Methods

Method: function-definition-operator-p (operator) ¶

Generic Function: incompleted-declamation-applicable-p (declaration-name operator) ¶

Returns true when DECLARATION-NAME is usable for OPERATOR.

Package

cl-annot-revisit-at-macro.

Source

declamation.lisp.

Methods

Method: incompleted-declamation-applicable-p ((declaration-name (eql special)) operator) ¶

Method: incompleted-declamation-applicable-p ((declaration-name (eql type)) operator) ¶

Method: incompleted-declamation-applicable-p ((declaration-name (eql ftype)) operator) ¶

Method: incompleted-declamation-applicable-p ((declaration-name (eql inline)) operator) ¶

Method: incompleted-declamation-applicable-p ((declaration-name (eql notinline)) operator) ¶

Method: incompleted-declamation-applicable-p (declaration-name operator) ¶

Generic Function: operator-accept-docstring-p (operator) ¶

Returns T if OPERATOR accepts docstring in its body.

Package

cl-annot-revisit-at-macro.

Source

declaration.lisp.

Methods

Method: operator-accept-docstring-p (operator) ¶

Generic Function: operator-body-location (operator) ¶

When OPERATOR can be treated by our at-macros for declaration, returns an integer where its body locates.

Package

cl-annot-revisit-at-macro.

Source

declaration.lisp.

Methods

Method: operator-body-location (operator) ¶

See http://www.lispworks.com/documentation/HyperSpec/Body/s_declar.htm

Generic Function: operator-doc-type (operator) ¶

Returns the doc-type (in ‘cl:documentation’) of OPERATOR.

Package

cl-annot-revisit-at-macro.

Source

documentation.lisp.

Methods

Method: operator-doc-type (operator) ¶

Generic Function: resolve-at-syntax-alias (operator cl-annot-compatible-p) ¶

This functions is for supporting ’:alias’ feature
of the original cl-annot. It was used for translating CL symbols to CL-ANNOT symbols implicitly.
(E.g. "@export" -> ‘cl:export’ -> ‘cl-annot.std:export*’)

By default, this function does nothing; returns OPERATOR as-is.

Package

cl-annot-revisit-at-syntax.

Source

defmethods.lisp.

Methods

Method: resolve-at-syntax-alias (operator cl-annot-compatible-p) ¶

Generic Function: valid-proclamation-identifier-p (declaration-identifier) ¶

Returns T if DECLARATION-IDENTIFIER can be used at a proclamation context.

Package

cl-annot-revisit-at-macro.

Source

declaration.lisp.

Methods

Method: valid-proclamation-identifier-p (declaration-identifier) ¶

See http://www.lispworks.com/documentation/HyperSpec/Body/f_procla.htm

Generic Function: variable-definition-operator-p (operator) ¶

Returns T if OPERATOR naming a definition form and its first argument is a variable name to be defined.

Package

cl-annot-revisit-at-macro.

Source

form-traversal.lisp.

Methods

Method: variable-definition-operator-p (operator) ¶

---

6.1.5 Conditions

Condition: at-macro-condition ¶

The root type of at-macro conditions.

Package

cl-annot-revisit.

Source

condition.lisp.

Direct superclasses

condition.

Direct subclasses

• at-macro-error.
• at-macro-style-warning.

Direct slots

Slot: form ¶

Package

cl-annot-revisit-at-macro.

Initargs

:form

Slot: message ¶

Package

cl-annot-revisit-at-macro.

Initform

(quote nil)

Initargs

:message

Condition: at-macro-error ¶

Raised if an error occured.

Package

cl-annot-revisit.

Source

condition.lisp.

Direct superclasses

• at-macro-condition.
• error.

Direct subclasses

• at-macro-runtime-error.
• at-macro-syntax-error.

Condition: at-macro-runtime-error ¶

Some macros embed this to report errors at evaluation time.

Package

cl-annot-revisit.

Source

condition.lisp.

Direct superclasses

at-macro-error.

Direct subclasses

• at-required-precondition-error.
• at-required-runtime-error.

Condition: at-macro-style-warning ¶

Signaled if some bad styles are found.

Package

cl-annot-revisit.

Source

condition.lisp.

Direct superclasses

• at-macro-condition.
• style-warning.

Condition: at-macro-syntax-error ¶

Raised when a syntactic error is found.

Package

cl-annot-revisit.

Source

condition.lisp.

Direct superclasses

at-macro-error.

Condition: at-required-precondition-error ¶

Raised when :initform supplied for ‘cl-annot-revisit:required’ slot.

Package

cl-annot-revisit-at-macro.

Source

slot.lisp.

Direct superclasses

at-macro-runtime-error.

Direct methods

at-required-precondition-error-slot-name.

Direct slots

Slot: slot-name ¶

Initform

(quote nil)

Initargs

:slot-name

Readers

at-required-precondition-error-slot-name.

Writers

This slot is read-only.

Condition: at-required-runtime-error ¶

Raised when no value supplied for ‘cl-annot-revisit:required’ slot.

Package

cl-annot-revisit-at-macro.

Source

slot.lisp.

Direct superclasses

at-macro-runtime-error.

Direct methods

• at-required-runtime-error-initarg.
• at-required-runtime-error-slot-name.

Direct slots

Slot: slot-name ¶

Initform

(quote nil)

Initargs

:slot-name

Readers

at-required-runtime-error-slot-name.

Writers

This slot is read-only.

Slot: initarg ¶

Initform

(quote nil)

Initargs

:initarg

Readers

at-required-runtime-error-initarg.

Writers

This slot is read-only.

---

6.2.1 Constants

Constant: +standard-definiton-form-list+ ¶

Package

cl-annot-revisit-at-macro.

Source

form-traversal.lisp.

Constant: +standard-function-definiton-form-list+ ¶

Package

cl-annot-revisit-at-macro.

Source

form-traversal.lisp.

Constant: +standard-operators-accept-docstring-in-body+ ¶

Package

cl-annot-revisit-at-macro.

Source

declaration.lisp.

Constant: +standard-optimize-quality-symbols+ ¶

Package

cl-annot-revisit-at-macro.

Source

declamation.lisp.

Constant: +standard-variable-definiton-form-list+ ¶

Package

cl-annot-revisit-at-macro.

Source

form-traversal.lisp.

---

6.2.2 Macros

Macro: add-declaration (decl-specifier &body body) ¶

Used by at-macros of declarations for processing recursive expansion. If BODY is a form accepts declarations, adds a DECL-SPECIFIER into it. If not, wraps BODY with ‘locally’ containing DECL-SPECIFIER in it.

Package

cl-annot-revisit-at-macro.

Source

declaration.lisp.

Macro: apply-incompleted-declamation (decl-specifier-head &body body) ¶

Package

cl-annot-revisit-at-macro.

Source

declamation.lisp.

Macro: macroexpand-convention ((original-form) &body body) ¶

Executes BODY as like ‘progn’ and return the result as the first value. As the second value, returns a boolean whether the result is not same with ORIGINAL-FORM or not.
This macro is designed to follow the ‘macroexpand’ convention.

Package

cl-annot-revisit-at-macro.

Source

util.lisp.

Macro: mv-cond-let-n (n (&rest vars) &body clauses) ¶

Multiple value variant of the famous ’COND-LET’. It takes multiple values and see N-th value as a condition.

Package

cl-annot-revisit-at-macro.

Source

util.lisp.

Macro: mv-cond-let2 ((&rest vars) &body clauses) ¶

Uses ‘mv-cond-let-n’ to see the second value.

Package

cl-annot-revisit-at-macro.

Source

util.lisp.

---

6.2.3 Ordinary functions

Function: %expand-ambiguous-declamation (decl-head names-or-form body name-p-function env) ¶

Package

cl-annot-revisit-at-macro.

Source

declamation.lisp.

Function: %expand-at-declaration (declaration-name name-or-names body) ¶

Package

cl-annot-revisit-at-macro.

Source

declaration.lisp.

Function: add-declaim-to-definiton-form (form decl-specifier) ¶

Package

cl-annot-revisit-at-macro.

Source

declamation.lisp.

Function: add-export (names form) ¶

Package

cl-annot-revisit-at-macro.

Source

export.lisp.

Function: apply-at-macro-for-each-form (at-macro-form expander-function forms env) ¶

Package

cl-annot-revisit-at-macro.

Source

form-traversal.lisp.

Function: apply-at-macro-to-multiple-forms (at-macro-form forms) ¶

Package

cl-annot-revisit-at-macro.

Source

form-traversal.lisp.

Function: apply-at-macro-to-special-toplevel-form (at-macro-form form) ¶

If form is a special form treated specially at top level (‘progn’, ‘locally’, ‘macrolet’, ‘symbol-macrolet’ and ‘eval-when’), expand FORM into AT-MACRO-FORM recursively.

Package

cl-annot-revisit-at-macro.

Source

form-traversal.lisp.

Function: common-lisp-package-p (package) ¶

Package

cl-annot-revisit-at-macro.

Source

declamation.lisp.

Function: complete-declaration-specifier (declaration-head first-form name-p-function env) ¶

Package

cl-annot-revisit-at-macro.

Source

declamation.lisp.

Function: declaration-argument-like-p (first-form name-p-function env) ¶

Our macro for declamation is ambiguous when the first value is a list of names. Consider:

(cl-annot-revisit:inline
(defun foo nil) ; defining a function takes zero arguments and returns nil. (defun bar () t))

I think it should expanded to next:

(progn (declaim inline foo) (defun foo nil)
(declaim inline bar) (defun bar () t))

Not like:

(defun bar
(declare (inline defun foo nil))
t)

To distinguish a macro form from a list of names, I check the form is a macro-form or not.

Package

cl-annot-revisit-at-macro.

Source

declamation.lisp.

Function: ensure-list-with (obj test) ¶

Do like ‘ensure-list’, except this function returns (list OBJ) when (funcall TEST OBJ) results true.

Package

cl-annot-revisit-at-macro.

Source

util.lisp.

Function: expand-doc-macro-to-assign (docstring form doc-type) ¶

Package

cl-annot-revisit-at-macro.

Source

documentation.lisp.

Function: expand-export-class (form) ¶

Package

cl-annot-revisit-at-macro.

Source

defclass.lisp.

Function: expand-to-declaim-form (declaration-specifier) ¶

Package

cl-annot-revisit-at-macro.

Source

declamation.lisp.

Function: function-name-p (x) ¶

Return true when it is a function name.

Package

cl-annot-revisit-at-macro.

Source

util.lisp.

Function: ignore-name-p (x) ¶

Package

cl-annot-revisit-at-macro.

Source

declaration.lisp.

Function: insert-declaration-to-body (form-body decl-specifier &key documentation whole) ¶

Package

cl-annot-revisit-at-macro.

Source

declaration.lisp.

Function: insert-declaration-to-nth-body (body-index form decl-specifier &key documentation) ¶

Package

cl-annot-revisit-at-macro.

Source

declaration.lisp.

Function: optimize-quality-p (qual) ¶

Package

cl-annot-revisit-at-macro.

Source

declamation.lisp.

Function: parse-define-method-combination-long-form (define-method-combination-form) ¶

Destructs ‘define-method-combination’ FORM to 5 parts;
1. its name, 2. lambda list, 3. list of method-group-specifiers, 4. options, 5. its body.

Package

cl-annot-revisit-at-macro.

Source

declaration.lisp.

Function: parse-defmethod-form (defmethod-form) ¶

Destructs ‘defmethod’ FORM to 4 parts;
1. its name, 2. list of method-qualifiers, 3. lambda list, 4. its body.

Package

cl-annot-revisit-at-macro.

Source

declaration.lisp.

Function: parse-defstruct-form (form) ¶

Package

cl-annot-revisit-at-macro.

Source

defstruct.lisp.

Function: parse-defstruct-option (name-and-options) ¶

Package

cl-annot-revisit-at-macro.

Source

defstruct.lisp.

Function: pick-defclass-options (defclass-form) ¶

Package

cl-annot-revisit-at-macro.

Source

defclass.lisp.

Function: pick-defclass-slots (defclass-form) ¶

Package

cl-annot-revisit-at-macro.

Source

defclass.lisp.

Function: pick-names-of-defstruct-form (form &optional kinds) ¶

Package

cl-annot-revisit-at-macro.

Source

defstruct.lisp.

Function: raise-required-slot-error (slot-name initarg-name) ¶

Package

cl-annot-revisit-at-macro.

Source

slot.lisp.

Function: read-at (stream char) ¶

The reader-macro function of ’@’ char.

Package

cl-annot-revisit-at-syntax.

Source

reader.lisp.

Function: read-at-syntax (stream at-char arity) ¶

The main reader of at-syntax. It reads the next symbol and collects arguments by ARITY or‘find-at-syntax-arity’, and creates a new form.
If arity is :infinite, this function tries to read until next ’)’ or EOF. This weird feature allows us to effect the whole file.

Package

cl-annot-revisit-at-syntax.

Source

reader.lisp.

Function: read-delimited-list-no-eof (char &optional stream recursive-p) ¶

Reads until CHAR appearance or the end of stream.

Package

cl-annot-revisit-at-syntax.

Source

reader.lisp.

Function: read-new-value () ¶

Package

cl-annot-revisit-at-macro.

Source

slot.lisp.

Function: read-sharp-at (stream char n) ¶

The reader-macro function of ’#@’ syntax.

Package

cl-annot-revisit-at-syntax.

Source

reader.lisp.

Function: split-list-at (n list) ¶

Return first N elements and rests of LIST.

Package

cl-annot-revisit-at-macro.

Source

util.lisp.

Function: split-slot-specifier (slot-specifier) ¶

Returns the slot name and slot options from SLOT-SPECIFIER.

Package

cl-annot-revisit-at-macro.

Source

slot.lisp.

---

6.2.4 Generic functions

Generic Function: expand-export-class-using-head (operator form) ¶

Package

cl-annot-revisit-at-macro.

Source

defclass.lisp.

Methods

Method: expand-export-class-using-head (operator form) ¶

Method: expand-export-class-using-head ((operator (eql defclass)) form) ¶

Method: expand-export-class-using-head ((operator (eql define-condition)) form) ¶

---