EDITOR-HINTS - Facilities to help editors handle Lisp code


 

Abstract

The Editor-hints system was written by Tobias C. Rittweiler and Robert P. Goldman.

The code comes with a BSD-style license so you can basically do with it whatever you want.

Download shortcut: http://rpgoldman.real-time.com/lisp/editor-hints_0_01.tar.gz.


 

Contents

  1. Download
  2. The EDITOR-HINTS dictionary
    1. defreadtable
    2. ensure-readtable
    3. find-readtable
    4. in-readtable
    5. register-readtable
    6. unregister-readtable
  3. Acknowledgements

 

Download

EDITOR-HINTS together with this documentation can be downloaded from http://rpgoldman.real-time.com/lisp/editor-hints_0_01.tar.gz. The current version is 0.01.
 

The EDITOR-HINTS dictionary


[Macro]
defreadtable string-designator &rest options => result


Define a new named readtable, whose name is given by STRING-DESIGNATOR. The readtable can be populated using the OPTIONS &rest argument, as follows: (:use &rest readtable-designators) -- merge the readtables designated into the new readtable, using merge-readtables. It is mandatory to supply at least one :use option naming a readtable to incorporate. Defreadtable accepts some special readtable designators, including NIL or :standard for the standard readtable and :current for the current readtable, as well as the names of programmer-defined readtables. Note that the process of merging readtables is NOT commutative, so that macros in later entries will overwrite earlier ones, left to right in a single :use directive, and one after another across multiple :use directives. (:dispatch-macro-char macro-char sub-char function) -- define a new dispatch macro character in the readtable, per SET-DISPATCH-MACRO-CHARACTER. (:macro-char macro-char function &optional non-terminating-p) -- define a new macro character in the readtable, per SET-MACRO-CHARACTER. Any number of option clauses may appear. The :use directives are evaluated first, and then the local macro definitions in :dispatch-macro-char and :macro-char are evaluated in the order they appear.


[Function]
ensure-readtable named-readtable-designator &optional default => result


Looks up the readtable specified by NAMED-READTABLE-DESIGNATOR and returns it if it is found. If it is not found, returns DEFAULT or, if DEFAULT is not provided, raises an error.


[Function]
find-readtable named-readtable-designator => result


Looks for the readtable specified by NAMED-READTABLE-DESIGNATOR and returns it if it is found. Returns NIL otherwise.


[Macro]
in-readtable string-designator => result


Bind the *readtable* to the readtable referred to by STRING-DESIGNATOR, raising an error if no such readtable can be found.


[Function]
register-readtable string-designator read-table => result


Associate READ-TABLE as the readtable associated with STRING-DESIGNATOR.


[Function]
unregister-readtable string-designator => result


Remove the readtable association with STRING-DESIGNATOR.

 

Acknowledgements

This documentation was prepared with DOCUMENTATION-TEMPLATE.

$Header: /usr/local/cvsrep/documentation-template/output.lisp,v 1.13 2007/04/17 19:29:52 edi Exp $

BACK TO MY HOMEPAGE