eeeickythump / defstar

Common lisp macros for easy type declaration within definitions of functions and variables.

Clone this repository (size: 74.5 KB): HTTPS / SSH
$ hg clone http://bitbucket.org/eeeickythump/defstar

DEFSTAR

Painless type declaration and value checking for Common Lisp

DEFSTAR is a library of Common Lisp macros that can be used in place of DEFUN, DEFMETHOD, DEFGENERIC, DEFVAR, DEFPARAMETER, FLET, LABELS and LAMBDA. Each macro has the same name as the form it replaces, with a star added at the end (e.g. DEFUN*).

The macros allow:

  • easy inclusion of type declarations within lambda lists
  • easy inclusion of return type declarations in function and method definitions
  • easy inclusion of assertions for each argument and for the function's return value

Documentation

See the file defstar.html in the html/ subdirectory of the repository for full documentation.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

(defun* (sum -> real) ((a real) (b real))
   (+ a b))

(defun* my-find (item (seq sequence) &key (from-end boolean)
                 ((test (or null (function (t)))) nil) ((test-not (or null (function (t)))) nil)
                 ((key (or null (function (t)))) nil) (start fixnum) (end fixnum))
   ...function body...)

(deftype natural () '(integer 0))
(defmethod* (cell-value -> real) :around ((sheet <Sheet>)
                                          ((x natural plusp) integer)
                                          ((y natural plusp) integer))
   ...)

(defparameter* (*file-position* (integer 0)) 0)

This revision is from 2010-02-06 08:31