src/code/readtable.lisp

   1 ;;;; READTABLEs
   2
   3 ;;;; This software is part of the SBCL system. See the README file for
   4 ;;;; more information.
   5 ;;;;
   6 ;;;; This software is derived from the CMU CL system, which was
   7 ;;;; written at Carnegie Mellon University and released into the
   8 ;;;; public domain. The software is in the public domain and is
   9 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
  10 ;;;; files for more information.
  11
  12 (in-package "SB!IMPL")
  13
  14 (sb!xc:deftype attribute-table ()
  15   '(simple-array (unsigned-byte 8) (#.sb!xc:char-code-limit)))
  16
  17 ;;; constants for readtable character attributes. These are all as in
  18 ;;; the manual.
  19 (def!constant +char-attr-whitespace+ 0)
  20 (def!constant +char-attr-terminating-macro+ 1)
  21 (def!constant +char-attr-escape+ 2)
  22 (def!constant +char-attr-constituent+ 3)
  23 (def!constant +char-attr-constituent-dot+ 4)
  24 (def!constant +char-attr-constituent-expt+ 5)
  25 (def!constant +char-attr-constituent-slash+ 6)
  26 (def!constant +char-attr-constituent-digit+ 7)
  27 (def!constant +char-attr-constituent-sign+ 8)
  28 ;; the "9" entry intentionally left blank for some reason -- WHN 19990806
  29 (def!constant +char-attr-multiple-escape+ 10)
  30 (def!constant +char-attr-package-delimiter+ 11)
  31 (def!constant +char-attr-delimiter+ 12) ; (a fake for READ-UNQUALIFIED-TOKEN)
  32
  33 (sb!xc:defstruct (readtable (:conc-name nil)
  34                             (:predicate readtablep)
  35                             ;; ANSI requires a CL:COPY-READTABLE to do
  36                             ;; a deep copy, so the DEFSTRUCT-generated
  37                             ;; default is not suitable.
  38                             (:copier nil))
  39   #!+sb-doc
  40   "A READTABLE is a data structure that maps characters into syntax
  41    types for the Common Lisp expression reader."
  42   ;; The CHARACTER-ATTRIBUTE-TABLE is a vector of CHAR-CODE-LIMIT
  43   ;; integers for describing the character type. Conceptually, there
  44   ;; are 4 distinct "primary" character attributes:
  45   ;; +CHAR-ATTR-WHITESPACE+, +CHAR-ATTR-TERMINATING-MACRO+,
  46   ;; +CHAR-ATTR-ESCAPE+, and +CHAR-ATTR-CONSTITUENT+. Non-terminating
  47   ;; macros (such as the symbol reader) have the attribute
  48   ;; +CHAR-ATTR-CONSTITUENT+.
  49   ;;
  50   ;; In order to make READ-TOKEN fast, all this information is stored
  51   ;; in the character attribute table by having different varieties of
  52   ;; constituents.
  53   (character-attribute-table
  54    (make-array sb!xc:char-code-limit
  55                :element-type '(unsigned-byte 8)
  56                :initial-element +char-attr-constituent+)
  57    :type attribute-table)
  58   ;; The CHARACTER-MACRO-TABLE is a vector of CHAR-CODE-LIMIT
  59   ;; functions. One of these functions called with appropriate
  60   ;; arguments whenever any non-WHITESPACE character is encountered
  61   ;; inside READ-PRESERVING-WHITESPACE. These functions are used to
  62   ;; implement user-defined read-macros, system read-macros, and the
  63   ;; number-symbol reader.
  64   (character-macro-table
  65    (make-array sb!xc:char-code-limit :initial-element #'undefined-macro-char)
  66    :type (simple-vector #.sb!xc:char-code-limit))
  67   ;; an alist from dispatch characters to vectors of CHAR-CODE-LIMIT
  68   ;; functions, for use in defining dispatching macros (like #-macro)
  69   (dispatch-tables () :type list)
  70   (readtable-case :upcase :type (member :upcase :downcase :preserve :invert)))