cl-annot

API Reference

cl-annot

Python-like Annotation Syntax for Common Lisp

CL-ANNOT.UTIL

  • Function PLIST-MEMBER (plist prop)
    Return t if PLIST contains PROP as a property.
  • Function PLIST-GET-ALL (plist prop)
    Return all values in PLIST named PROP.
  • Function MACROP (symbol)
    Return non-nil if SYMBOL is a macro.
  • Function MACROEXPAND-SOME (form)
    Expand FORM once. The result form won't be nil.
  • Function MACROEXPAND-UNTIL-NORMAL-FORM (form)
    Expand FORM until it brecomes normal-form.
  • 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.
  • 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.
  • Function DEFINITION-FORM-SYMBOL (definition-form)
    Return the symbol of DEFINITION-FORM.
  • Function DEFINITION-FORM-TYPE (definition-form)
    Return the type of DEFINITION-FORM.
  • 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.
  • Function SLOT-SPECIFIERS (class-definition-form)
    Return class-specifiers of CLASS-DEFINITION-FORM.
  • 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.
  • Function CLASS-OPTIONS (class-definition-form)
    Return class-options of CLASS-DEFINITION-FORM.
  • Function GET-CLASS-OPTION (name class-definition-form)
    Return a value of NAME class-option of CLASS-DEFINITION-FORM.

CL-ANNOT.CORE

  • Function ANNOTATION-REAL (annot)
    Return the real annotation of ANNOT.
  • Function (setf ANNOTATION-REAL) (real annot)
  • Function ANNOTATION-ARITY (annot)
    Return the number of arguments of ANNOT.
  • Function (setf ANNOTATION-ARITY) (arity annot)
  • Function ANNOTATION-INLINE-P (annot)
    Return non-nil if ANNOT should be expanded on read-time.
  • Function (setf ANNOTATION-INLINE-P) (inline-p annot)
  • Function ANNOTATION-FORM (annot args)
    Make an annotation-form with ANNOT and ARGS.
  • Function ANNOTATION-FORM-P (form)
    Return non-nil if FORM is an annotation-form.
  • Macro %ANNOTATION (annot &rest args)
    Annotation Expansion Engine.

CL-ANNOT.EXPAND

  • Function EXPAND-ANNOTATION (annot args)
    Expand ANNOT. ARGS will be expanded prior to this form (call-by-value).

CL-ANNOT.SYNTAX

  • Function ANNOTATION-SYNTAX-READER (stream char)
  • Macro ENABLE-ANNOT-SYNTAX

CL-ANNOT.HELPER

  • Macro DEFANNOTATION (name lambda-list options &body body)
  • Macro ANNOTATION (options function-definition-form)

CL-ANNOT

No exported symbols.

Also exports

  • CL-ANNOT.HELPER:ANNOTATION
  • CL-ANNOT.HELPER:DEFANNOTATION
  • CL-ANNOT.SYNTAX:ENABLE-ANNOT-SYNTAX

CL-ANNOT.STD

  • Macro EXPORT* (definition-form)
    Export the definition symbol of DEFINITION-FORM.
  • Macro IGNORE* (vars)
    Shorthand for (DECLARE (IGNORE ...)).
  • Macro IGNORABLE* (vars)
    Shorthand for (DECLARE (IGNORABLE ...)).
  • Macro DYNAMIC-EXTENT* (vars)
    Shorthand for (DECLARE (DYNAMIC-EXTENT ...)).
  • Macro DECLARATION* (vars)
    Shorthand for (DECLARE (DECLARATION ...)).
  • Macro SPECIAL* (vars)
    Shorthand for (DECLARE (SPECIAL ...)).
  • Macro TYPE* (typespec name)
    Shorthand for (DECLARE (TYPE ...)).
  • Macro FTYPE* (typespec name)
    Shorthand for (DECLARE (FTYPE ...)).
  • Macro OPTIMIZE* (quality)
    Shorthand for (DECLARE (OPTIMIZE ...)).
  • Macro INLINE* (name)
    Shorthand for (DECLARE (INLINE ...)).
  • Macro NOTINLINE* (name)
    Shorthand for (DECLARE (NOTINLINE ...)).

CL-ANNOT.EVAL-WHEN

  • Macro EVAL-WHEN-COMPILE (&body body)
  • Macro EVAL-WHEN-LOAD (&body body)
  • Macro EVAL-WHEN-EXECUTE (&body body)
  • Macro EVAL-ALWAYS (&body body)

CL-ANNOT.DOC

  • Macro DOC (docstring definition-form)
    Add DOCSTRING documentation for DEFINITION-FORM.

CL-ANNOT.CLASS

  • Macro METACLASS (metaclass class-definition-form)
  • Macro EXPORT-SLOTS (class-definition-form)
  • Macro EXPORT-ACCESSORS (class-definition-form)
  • Macro EXPORT-CONSTRUCTORS (class-definition-form)
  • Macro EXPORT-CLASS (class-definition-form)
  • Macro EXPORT-STRUCTURE (class-definition-form)

CL-ANNOT.SLOT

  • Macro OPTIONAL (init-form slot-specifier30)
  • Macro REQUIRED (slot-specifier43)