/[advanced-readtable]/src.lisp
ViewVC logotype

Contents of /src.lisp

Parent Directory Parent Directory | Revision Log Revision Log


Revision 11 - (hide annotations)
Sun Dec 30 14:35:37 2012 UTC (15 months, 2 weeks ago) by rklochkov
File size: 15461 byte(s)
Fix
1 rklochkov 3 (in-package #:advanced-readtable)
2    
3 rklochkov 9 ;;;; Advanced-readtable
4     ;;;;
5     ;;;; per-package aliases for packages
6     ;;;; per-package shortcuts for package hierarchies
7     ;;;; extendable find-package and find-symbol
8     ;;;; local use package in form package:(here form where package used)
9     ;;;; local intern package like in SBCL: package::(symbol1 symbol2) will intern
10     ;;;; package::symbol1 and package::symbol2
11 rklochkov 3
12 rklochkov 4 (defvar *per-package-finders* (make-hash-table :test 'eq)
13 rklochkov 6 "Hash package -> list of handlers. Each handler is a cons (key . function)")
14 rklochkov 4 (defvar *package-finders* nil
15 rklochkov 6 "List of handlers. Each handler is a cons (key . function)
16     function = (lambda (name package) ...) -> package")
17 rklochkov 3
18    
19    
20    
21 rklochkov 4 ;;;
22     ;;; Prepare readtables
23     ;;;
24 rklochkov 3
25    
26    
27     (defvar *advanced-readtable* (copy-readtable nil))
28     (defvar *colon-readtable* (copy-readtable nil)
29     "Support readtable with colon as whitespace")
30    
31     ;;;
32     ;;; Readtable handlers
33     ;;;
34    
35     (defpackage #:advanced-readtable.junk)
36    
37    
38    
39     (defun try-funcall (handlers-list name package)
40     (declare (type list handlers-list)
41     (type string name)
42     (type (or null package) package))
43     (when handlers-list
44 rklochkov 6 (or (funcall (cdr (car handlers-list)) name package)
45 rklochkov 3 (try-funcall (cdr handlers-list) name package))))
46    
47     (defun find-package (name &optional (current-package *package*))
48 rklochkov 6 "We try to find package.
49     1. By full name with CL:FIND-PACKAGE.
50     2. By per-package handlers. Here we wil try local-nicknames and so on.
51     3. By global handlers. Here we may use, for example, hierarchical packages."
52 rklochkov 3 (declare (type (or null package) current-package))
53     (if (typep name 'package) name
54     (let ((sname (string name)))
55 rklochkov 6 (or
56     (cl:find-package name)
57 rklochkov 3 (when current-package
58     (try-funcall (package-finders current-package) sname current-package))
59 rklochkov 6 (try-funcall *package-finders* sname current-package)))))
60 rklochkov 3
61     (defvar *package-symbol-finders* (make-hash-table :test 'eq)
62 rklochkov 6 "Hash package -> list of handlers. Each handler is a cons (key . function)")
63 rklochkov 3 (defvar *symbol-finders* nil
64 rklochkov 6 "List of handlers. Each handler is a cons (key . function)
65     function = (lambda (name package) ...) -> symbol")
66 rklochkov 3 (defvar *extra-finders* (make-hash-table :test 'eq)
67 rklochkov 6 "Hash symbol -> list of handlers. Each handler is a cons (key . function)
68     function = (lambda (name package) ...) -> symbol
69 rklochkov 3 These will be used before CL:FIND-SYMBOL")
70    
71     (defvar *symbol-readmacros* (make-hash-table :test 'eq))
72     (defvar *disable-symbol-readmacro* nil
73     "Disables processing of symbol-readmacro.")
74    
75     (defun def-symbol-readmacro (symbol func)
76     (setf (gethash symbol *symbol-readmacros*) func))
77    
78     (defun set-macro-symbol (symbol func)
79     "Syntax is like set-macro-character,
80     except that FUNC is binded to SYMBOL, not character"
81     (setf (gethash symbol *symbol-readmacros*) func))
82    
83     (defun get-macro-symbol (symbol)
84     "Syntax is like get-macro-character.
85     Returns function, assigned by set-macro-symbol"
86     (gethash symbol *symbol-readmacros*))
87    
88     (defun process-symbol-readmacro (symbol stream)
89     (let ((func (gethash symbol *symbol-readmacros*)))
90     (if func (funcall func stream symbol) symbol)))
91    
92 rklochkov 4 ;;; Internal special variables. Do not export
93 rklochkov 3
94 rklochkov 4 (defvar *extra-symbol-finders* nil
95     "List of handlers: handlers for symbol, car of list")
96     (defvar *car-list* nil "Boolean: iff reader in list and car is not read")
97     (defvar *local-packages* nil "List of packages: for pack:( ... pack2:(...))")
98    
99     (defun try-local-packages (packages name)
100     (when packages
101     (multiple-value-bind (symbol status) (cl:find-symbol name (car packages))
102     (if symbol
103     (values symbol status)
104     (try-local-packages (cdr packages) name)))))
105    
106     (defun try-mv-funcall (handlers-list name package)
107     "Returns symbol, status"
108     (declare (type list handlers-list)
109     (type string name)
110     (type (or null package) package))
111     (when handlers-list
112     (multiple-value-bind (symbol status)
113 rklochkov 6 (funcall (cdr (car handlers-list)) name package)
114 rklochkov 4 (if symbol
115     (values symbol status)
116     (try-funcall (cdr handlers-list) name package)))))
117    
118    
119 rklochkov 3 (defun find-symbol (name &optional dpackage)
120 rklochkov 6 "We try to find symbol
121 rklochkov 9 1. In package set with car of list, for example, PUSH-LOCAL-PACKAGE
122     2. By CL-FIND-SYMBOL, when package explicitly given
123 rklochkov 6 3. By packages added with package:(...)
124     4. By per-package finders
125 rklochkov 9 5. By global finders
126     6. By CL-FIND-SYMBOL"
127 rklochkov 3 (declare (type string name))
128 rklochkov 6 (let ((package (if dpackage (find-package dpackage) *package*)))
129 rklochkov 3 (macrolet ((mv-or (&rest clauses)
130     (if clauses
131     `(multiple-value-bind (symbol status) ,(car clauses)
132     (if symbol (values symbol status)
133 rklochkov 4 (mv-or . ,(cdr clauses))))
134 rklochkov 3 `(values nil nil))))
135    
136     (mv-or
137 rklochkov 4 (try-mv-funcall *extra-symbol-finders* name package)
138 rklochkov 9 (when dpackage (cl:find-symbol name package))
139 rklochkov 6 (unless dpackage (try-local-packages *local-packages* name))
140     (try-mv-funcall (symbol-finders package) name package)
141 rklochkov 9 (try-mv-funcall *symbol-finders* name package)
142     (unless dpackage (cl:find-symbol name package))))))
143 rklochkov 3
144 rklochkov 4 (defun read-token (stream)
145     "
146     DO: Reads from STREAM a symbol or number up to whitespace or colon
147     RETURN: symbols name or numbers value"
148     (let ((*readtable* *colon-readtable*)
149     (*package* (cl:find-package '#:advanced-readtable.junk)))
150     (read-preserving-whitespace stream nil)))
151 rklochkov 3
152 rklochkov 4 (defun count-colons (stream)
153     "
154     DO: Reads colons from STREAM
155     RETURN: number of the colons"
156     (let ((c (read-char stream nil)))
157     (if (eql c #\:)
158     (+ 1 (count-colons stream))
159     (progn (unread-char c stream) 0))))
160    
161     (defun read-after-colon (stream maybe-package colons)
162     "Read symbol package:sym or list package:(...)"
163 rklochkov 11 (declare (type stream stream)
164 rklochkov 10 (type fixnum colons))
165 rklochkov 9 (when (= colons 0) ; no colon: this is a symbol or an atom
166 rklochkov 4 (return-from read-after-colon
167     (if (symbolp maybe-package)
168 rklochkov 10 (prog1
169     (let ((name (symbol-name maybe-package)))
170     (or (find-symbol name) (intern name)))
171     (unintern maybe-package))
172 rklochkov 4 maybe-package)))
173    
174     (let ((package (find-package maybe-package)))
175     (assert package (package) "No package ~a" maybe-package)
176     (unintern maybe-package)
177     (when (eql (peek-char t stream) #\()
178     ;; package:(...) or package::(...)
179     (ecase colons
180     (1 (let ((*local-packages* (cons package *local-packages*)))
181     (return-from read-after-colon
182     (read stream nil))))
183     (2 (let ((*package* package))
184     (return-from read-after-colon
185     (read stream nil))))))
186    
187     (let ((token (read-token stream)))
188 rklochkov 5 (check-type token symbol)
189 rklochkov 4 (multiple-value-bind (symbol status)
190 rklochkov 5 (find-symbol (symbol-name token) package)
191 rklochkov 4 (unintern token)
192     (when (and (= colons 1) (not (eq status :external)))
193     (cerror "Use anyway"
194     "Symbol ~A not external" symbol))
195     symbol))))
196    
197    
198    
199 rklochkov 3 (defun read-token-with-colons (stream char)
200     "Reads token, then analize package part if needed"
201     (unread-char char stream)
202 rklochkov 4 (when *read-suppress*
203     (let ((*readtable* (copy-readtable nil)))
204     (read stream))
205     (return-from read-token-with-colons))
206     (let* ((token (read-token stream))
207     ;; We have read something.
208     ;; It may represent either symbol or package designator.
209     ;; Looking after it: do we have a colon?
210     (colons (count-colons stream))
211     (object (read-after-colon stream token colons)))
212    
213     (when (or *disable-symbol-readmacro*
214     (not (symbolp object))
215     (eql char #\|))
216     (return-from read-token-with-colons object))
217 rklochkov 3
218 rklochkov 4 (let ((object (process-symbol-readmacro object stream)))
219     (when *car-list*
220     (setf *car-list* nil
221     *extra-symbol-finders*
222     (append (extra-finders object) *extra-symbol-finders*)))
223     object)))
224    
225     (let ((default-open-paren-reader
226     (get-macro-character #\( (copy-readtable nil))))
227 rklochkov 3 (defun open-paren-reader (stream char)
228 rklochkov 4 (let ((*car-list* t) (*extra-symbol-finders* *extra-symbol-finders*))
229 rklochkov 3 (funcall default-open-paren-reader stream char))))
230    
231    
232    
233     (defun (setf package-finders) (value &optional (package *package*))
234     (setf (gethash (find-package package) *per-package-finders*) value))
235    
236     (defun package-finders (&optional (package *package*))
237     (gethash (find-package package) *per-package-finders*))
238    
239     (defun (setf symbol-finders) (value &optional (package *package*))
240     (setf (gethash (find-package package) *package-symbol-finders*) value))
241    
242     (defun symbol-finders (&optional (package *package*))
243     (gethash (find-package package) *package-symbol-finders*))
244    
245     (defun (setf extra-finders) (value symbol)
246     (setf (gethash symbol *extra-finders*) value))
247    
248     (defun extra-finders (symbol)
249     (gethash symbol *extra-finders*))
250    
251 rklochkov 6 (defmacro set-handler (handler-list key function)
252 rklochkov 9 "This is middle-level public API for changing handlers for
253     find-symbol and find-package. There are five lists:
254     *package-finders* -- global for find-package
255     *symbol-finders* -- global for find-symbol
256     (package-finders package) -- per-package for find-package
257     (symbol-finders package) -- per-package for find-symbol
258     (extra-finders symbol) -- per-symbol for (symbol ....) package substitution
259    
260     Key should be uniq in the sense of EQUAL in the list. SET-HANDLER adds
261     new handler if it is not already there.
262     "
263 rklochkov 6 (let ((key-var (gensym "key")))
264     `(let ((,key-var ,key))
265 rklochkov 8 (unless (assoc ,key-var ,handler-list :test #'equal)
266 rklochkov 6 (push (cons ,key-var ,function)
267     ,handler-list)))))
268    
269     (defmacro %set-handler (handler-list key name &body handler-body)
270     "Local macros for push-* functions. No gensyms intended."
271 rklochkov 7 `(set-handler ,handler-list ,key
272     (lambda (,name package)
273     (declare (ignore package)) . ,handler-body)))
274 rklochkov 6
275 rklochkov 3 (defun push-import-prefix (prefix &optional (package *package*))
276     "Enables using package name omitting prefix.
277     For example, you have packages com.clearly-useful.iterator-protocol, com.clearly-useful.reducers, ...
278     You may use them as
279     (push-import-prefix :com.clearly-useful)
280     (iterator-protocol:do-iterator ...)
281     (reducers:r/map #'1+ data)
282     and so on.
283     Package prefix is enabled per package so it is safe to use it in your package.
284    
285     If there is package, which name coincides with shortcut, package name has priority.
286    
287     So, if you make
288     (defpackage :reducers ...)
289    
290     after that reducers:... will refer to new package, not com.clearly-useful.reducers.
291     "
292 rklochkov 8 (%set-handler (package-finders package) `(:prefix ,prefix) name
293 rklochkov 10 (cl:find-package (concatenate 'string (string prefix) "." name))))
294 rklochkov 3
295     (defun push-local-nickname (long-package nick
296     &optional (current-package *package*))
297     "Enables package nickname in CURRENT-PACKAGE.
298     For example, you found COM.INFORMATIMAGO.COMMON-LISP.CESARUM.LIST package and want to use
299     it. But don't want to USE-PACKAGE them, because some exported symbols from it are clashing
300     with yours.
301    
302     You may do it right:
303     (push-local-nickname :com.informatimago.common-lisp.cesarum.list :ilist)
304     (ilist:circular-length l)
305    
306     Local-nicknames are local, so you may use it freely.
307    
308 rklochkov 9 If package A wants package LIB version 1, and package B wants package
309     LIB version 2, one can simply rename LIB version 1 to LIB1 and rename LIB
310     version 2 to LIB2 and make
311 rklochkov 3 (push-local-nickname :lib1 :lib :a)
312 rklochkov 9 (push-local-nickname :lib2 :lib :b)
313 rklochkov 3 "
314     (let ((dpackage (find-package long-package)))
315 rklochkov 8 (%set-handler (package-finders current-package) `(:nick ,long-package ,nick) name
316 rklochkov 7 (when (string= name (string nick)) dpackage))))
317 rklochkov 3
318     (defun push-local-package (symbol local-package)
319 rklochkov 6 "Sets local-package for a symbol. Many macroses use there own clauses.
320 rklochkov 3 For example, ITERATE uses FOR, COLLECT and so on.
321     If you don't want to USE-PACKAGE iterate, this function will help.
322     (push-local-package 'iter:iter :iterate)
323     (iter:iter (for i from 1 to 10) (collect i))
324    
325     Caution: this function enables package substitution in all cases,
326     where SYMBOL is the car of a list.
327     For example, this will be error:
328     (let (iter:iter for) (list iter:iter for))
329     , because first for is in ITERATE package, but second -- is not.
330     "
331     (let ((dpackage (find-package local-package)))
332 rklochkov 8 (%set-handler (extra-finders symbol) `(:local ,symbol ,local-package) name
333 rklochkov 7 (multiple-value-bind (symbol status) (cl:find-symbol name dpackage)
334     (when (eq status :external) symbol)))))
335 rklochkov 4
336     ;;;
337     ;;; Readtable analysis and change
338     ;;;
339    
340     (defmacro with-case (case &body body)
341     (let ((save (gensym)))
342     `(let ((,save (readtable-case *readtable*)))
343     (setf (readtable-case *readtable*) ,case)
344     (unwind-protect
345     (progn ,@body)
346     (setf (readtable-case *readtable*) ,save)))))
347    
348     (defun does-not-terminate-token-p (c)
349     (ignore-errors
350     (let ((str (format nil "a~Ab" c)))
351     (string= str (symbol-name
352     (with-case :preserve
353     (read-from-string (format nil "#:~A" str))))))))
354    
355    
356     (defun whitespace-p (c)
357     (ignore-errors
358     (= 2 (length (read-from-string (format nil "(#:a~A#:b)" c))))))
359    
360     (defun multiple-escape-p (c)
361     (ignore-errors
362     (string= "qQ" (symbol-name
363     (with-case :upcase
364     (read-from-string (format nil "#:~AqQ~A" c c)))))))
365    
366     (defun single-escape-p (c)
367     (ignore-errors
368     (string= (symbol-name '#:\ ) (symbol-name
369     (read-from-string (format nil "#:~A'" c))))))
370    
371    
372    
373     (defun macro-char-p (c)
374     "If C is macro-char, return GET-MACRO-CHARACTER"
375     #+allegro (unless
376     (eql (get-macro-character c) #'excl::read-token)
377     (get-macro-character c))
378     #-allegro (get-macro-character c))
379    
380     (defun fill-char-table ()
381     "Returns simple-vector with character syntax classes"
382     (let ((*readtable* (copy-readtable nil))
383     (char-table (make-array 127)))
384     (dotimes (i (length char-table))
385     (let ((c (code-char i)))
386     (setf
387     (svref char-table i)
388     (cond
389     ((eql c #\:) :colon)
390     ((macro-char-p c) :macro)
391     ((does-not-terminate-token-p c) :does-not-terminate-token)
392     ((whitespace-p c) :whitespace)
393     ((multiple-escape-p c) :multiple-escape)
394     ((single-escape-p c) :single-escape)))))
395     char-table))
396    
397     (let (initialized)
398     (defun activate (&optional force)
399     "Inits *advanced-readtable* and *colon-readtable*."
400     (when (or force (not initialized))
401     (setq initialized t)
402     (let ((char-table (fill-char-table)))
403     (dotimes (i (length char-table))
404     (let ((b (svref char-table i))
405     (c (code-char i)))
406     (unless (char= #\# c)
407     (when (member b '(:does-not-terminate-token
408     :multiple-escape :single-escape))
409     ;; will make it non-terminating macro character
410     ;; = potentially beginning of the package-name
411     (set-macro-character c #'read-token-with-colons
412     t *advanced-readtable*))))))
413    
414     (set-syntax-from-char #\: #\Space *colon-readtable* *colon-readtable*)
415 rklochkov 10 (set-macro-character #\( #'open-paren-reader nil *advanced-readtable*))
416 rklochkov 4 (setf *readtable* *advanced-readtable*)))
417    
418     (defun ! () (activate))

Properties

Name Value
svn:executable

  ViewVC Help
Powered by ViewVC 1.1.5