autoload compile-file in (guile-user)
[bpt/guile.git] / module / ice-9 / boot-9.scm
1 ;;; -*- mode: scheme; coding: utf-8; -*-
2
3 ;;;; Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003,2004,2005,2006,2007,2008,2009,2010
4 ;;;; Free Software Foundation, Inc.
5 ;;;;
6 ;;;; This library is free software; you can redistribute it and/or
7 ;;;; modify it under the terms of the GNU Lesser General Public
8 ;;;; License as published by the Free Software Foundation; either
9 ;;;; version 3 of the License, or (at your option) any later version.
10 ;;;;
11 ;;;; This library is distributed in the hope that it will be useful,
12 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
13 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 ;;;; Lesser General Public License for more details.
15 ;;;;
16 ;;;; You should have received a copy of the GNU Lesser General Public
17 ;;;; License along with this library; if not, write to the Free Software
18 ;;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 ;;;;
20
21 \f
22
23 ;;; Commentary:
24
25 ;;; This file is the first thing loaded into Guile. It adds many mundane
26 ;;; definitions and a few that are interesting.
27 ;;;
28 ;;; The module system (hence the hierarchical namespace) are defined in this
29 ;;; file.
30 ;;;
31
32 ;;; Code:
33
34 \f
35
36 ;; Before compiling, make sure any symbols are resolved in the (guile)
37 ;; module, the primary location of those symbols, rather than in
38 ;; (guile-user), the default module that we compile in.
39
40 (eval-when (compile)
41 (set-current-module (resolve-module '(guile))))
42
43 \f
44
45 ;;; {Error handling}
46 ;;;
47
48 ;; Define delimited continuation operators, and implement catch and throw in
49 ;; terms of them.
50
51 (define make-prompt-tag
52 (lambda* (#:optional (stem "prompt"))
53 (gensym stem)))
54
55 (define default-prompt-tag
56 ;; not sure if we should expose this to the user as a fluid
57 (let ((%default-prompt-tag (make-prompt-tag)))
58 (lambda ()
59 %default-prompt-tag)))
60
61 (define (call-with-prompt tag thunk handler)
62 (@prompt tag (thunk) handler))
63 (define (abort-to-prompt tag . args)
64 (@abort tag args))
65
66
67 ;; Define catch and with-throw-handler, using some common helper routines and a
68 ;; shared fluid. Hide the helpers in a lexical contour.
69
70 (define with-throw-handler #f)
71 (let ()
72 ;; Ideally we'd like to be able to give these default values for all threads,
73 ;; even threads not created by Guile; but alack, that does not currently seem
74 ;; possible. So wrap the getters in thunks.
75 (define %running-exception-handlers (make-fluid))
76 (define %exception-handler (make-fluid))
77
78 (define (running-exception-handlers)
79 (or (fluid-ref %running-exception-handlers)
80 (begin
81 (fluid-set! %running-exception-handlers '())
82 '())))
83 (define (exception-handler)
84 (or (fluid-ref %exception-handler)
85 (begin
86 (fluid-set! %exception-handler default-exception-handler)
87 default-exception-handler)))
88
89 (define (default-exception-handler k . args)
90 (cond
91 ((eq? k 'quit)
92 (primitive-exit (cond
93 ((not (pair? args)) 0)
94 ((integer? (car args)) (car args))
95 ((not (car args)) 1)
96 (else 0))))
97 (else
98 (format (current-error-port) "guile: uncaught throw to ~a: ~a\n" k args)
99 (primitive-exit 1))))
100
101 (define (default-throw-handler prompt-tag catch-k)
102 (let ((prev (exception-handler)))
103 (lambda (thrown-k . args)
104 (if (or (eq? thrown-k catch-k) (eqv? catch-k #t))
105 (apply abort-to-prompt prompt-tag thrown-k args)
106 (apply prev thrown-k args)))))
107
108 (define (custom-throw-handler prompt-tag catch-k pre)
109 (let ((prev (exception-handler)))
110 (lambda (thrown-k . args)
111 (if (or (eq? thrown-k catch-k) (eqv? catch-k #t))
112 (let ((running (running-exception-handlers)))
113 (with-fluids ((%running-exception-handlers (cons pre running)))
114 (if (not (memq pre running))
115 (apply pre thrown-k args))
116 ;; fall through
117 (if prompt-tag
118 (apply abort-to-prompt prompt-tag thrown-k args)
119 (apply prev thrown-k args))))
120 (apply prev thrown-k args)))))
121
122 (set! catch
123 (lambda* (k thunk handler #:optional pre-unwind-handler)
124 "Invoke @var{thunk} in the dynamic context of @var{handler} for
125 exceptions matching @var{key}. If thunk throws to the symbol
126 @var{key}, then @var{handler} is invoked this way:
127 @lisp
128 (handler key args ...)
129 @end lisp
130
131 @var{key} is a symbol or @code{#t}.
132
133 @var{thunk} takes no arguments. If @var{thunk} returns
134 normally, that is the return value of @code{catch}.
135
136 Handler is invoked outside the scope of its own @code{catch}.
137 If @var{handler} again throws to the same key, a new handler
138 from further up the call chain is invoked.
139
140 If the key is @code{#t}, then a throw to @emph{any} symbol will
141 match this call to @code{catch}.
142
143 If a @var{pre-unwind-handler} is given and @var{thunk} throws
144 an exception that matches @var{key}, Guile calls the
145 @var{pre-unwind-handler} before unwinding the dynamic state and
146 invoking the main @var{handler}. @var{pre-unwind-handler} should
147 be a procedure with the same signature as @var{handler}, that
148 is @code{(lambda (key . args))}. It is typically used to save
149 the stack at the point where the exception occurred, but can also
150 query other parts of the dynamic state at that point, such as
151 fluid values.
152
153 A @var{pre-unwind-handler} can exit either normally or non-locally.
154 If it exits normally, Guile unwinds the stack and dynamic context
155 and then calls the normal (third argument) handler. If it exits
156 non-locally, that exit determines the continuation."
157 (if (not (or (symbol? k) (eqv? k #t)))
158 (scm-error "catch" 'wrong-type-arg
159 "Wrong type argument in position ~a: ~a"
160 (list 1 k) (list k)))
161 (let ((tag (make-prompt-tag "catch")))
162 (call-with-prompt
163 tag
164 (lambda ()
165 (with-fluids
166 ((%exception-handler
167 (if pre-unwind-handler
168 (custom-throw-handler tag k pre-unwind-handler)
169 (default-throw-handler tag k))))
170 (thunk)))
171 (lambda (cont k . args)
172 (apply handler k args))))))
173
174 (set! with-throw-handler
175 (lambda (k thunk pre-unwind-handler)
176 "Add @var{handler} to the dynamic context as a throw handler
177 for key @var{key}, then invoke @var{thunk}."
178 (if (not (or (symbol? k) (eqv? k #t)))
179 (scm-error "with-throw-handler" 'wrong-type-arg
180 "Wrong type argument in position ~a: ~a"
181 (list 1 k) (list k)))
182 (with-fluids ((%exception-handler
183 (custom-throw-handler #f k pre-unwind-handler)))
184 (thunk))))
185
186 (set! throw
187 (lambda (key . args)
188 "Invoke the catch form matching @var{key}, passing @var{args} to the
189 @var{handler}.
190
191 @var{key} is a symbol. It will match catches of the same symbol or of @code{#t}.
192
193 If there is no handler at all, Guile prints an error and then exits."
194 (if (not (symbol? key))
195 ((exception-handler) 'wrong-type-arg "throw"
196 "Wrong type argument in position ~a: ~a" (list 1 key) (list key))
197 (apply (exception-handler) key args)))))
198
199
200 \f
201
202 ;;; {R4RS compliance}
203 ;;;
204
205 (primitive-load-path "ice-9/r4rs")
206
207 \f
208
209 ;;; {Simple Debugging Tools}
210 ;;;
211
212 ;; peek takes any number of arguments, writes them to the
213 ;; current ouput port, and returns the last argument.
214 ;; It is handy to wrap around an expression to look at
215 ;; a value each time is evaluated, e.g.:
216 ;;
217 ;; (+ 10 (troublesome-fn))
218 ;; => (+ 10 (pk 'troublesome-fn-returned (troublesome-fn)))
219 ;;
220
221 (define (peek . stuff)
222 (newline)
223 (display ";;; ")
224 (write stuff)
225 (newline)
226 (car (last-pair stuff)))
227
228 (define pk peek)
229
230
231 (define (warn . stuff)
232 (with-output-to-port (current-error-port)
233 (lambda ()
234 (newline)
235 (display ";;; WARNING ")
236 (display stuff)
237 (newline)
238 (car (last-pair stuff)))))
239
240 \f
241
242 ;;; {Features}
243 ;;;
244
245 (define (provide sym)
246 (if (not (memq sym *features*))
247 (set! *features* (cons sym *features*))))
248
249 ;; Return #t iff FEATURE is available to this Guile interpreter. In SLIB,
250 ;; provided? also checks to see if the module is available. We should do that
251 ;; too, but don't.
252
253 (define (provided? feature)
254 (and (memq feature *features*) #t))
255
256 \f
257
258 ;;; {Structs}
259 ;;;
260
261 (define (make-struct/no-tail vtable . args)
262 (apply make-struct vtable 0 args))
263
264 \f
265
266 ;;; {and-map and or-map}
267 ;;;
268 ;;; (and-map fn lst) is like (and (fn (car lst)) (fn (cadr lst)) (fn...) ...)
269 ;;; (or-map fn lst) is like (or (fn (car lst)) (fn (cadr lst)) (fn...) ...)
270 ;;;
271
272 ;; and-map f l
273 ;;
274 ;; Apply f to successive elements of l until exhaustion or f returns #f.
275 ;; If returning early, return #f. Otherwise, return the last value returned
276 ;; by f. If f has never been called because l is empty, return #t.
277 ;;
278 (define (and-map f lst)
279 (let loop ((result #t)
280 (l lst))
281 (and result
282 (or (and (null? l)
283 result)
284 (loop (f (car l)) (cdr l))))))
285
286 ;; or-map f l
287 ;;
288 ;; Apply f to successive elements of l until exhaustion or while f returns #f.
289 ;; If returning early, return the return value of f.
290 ;;
291 (define (or-map f lst)
292 (let loop ((result #f)
293 (l lst))
294 (or result
295 (and (not (null? l))
296 (loop (f (car l)) (cdr l))))))
297
298 \f
299
300 ;; let format alias simple-format until the more complete version is loaded
301
302 (define format simple-format)
303
304 ;; this is scheme wrapping the C code so the final pred call is a tail call,
305 ;; per SRFI-13 spec
306 (define string-any
307 (lambda* (char_pred s #:optional (start 0) (end (string-length s)))
308 (if (and (procedure? char_pred)
309 (> end start)
310 (<= end (string-length s))) ;; let c-code handle range error
311 (or (string-any-c-code char_pred s start (1- end))
312 (char_pred (string-ref s (1- end))))
313 (string-any-c-code char_pred s start end))))
314
315 ;; this is scheme wrapping the C code so the final pred call is a tail call,
316 ;; per SRFI-13 spec
317 (define string-every
318 (lambda* (char_pred s #:optional (start 0) (end (string-length s)))
319 (if (and (procedure? char_pred)
320 (> end start)
321 (<= end (string-length s))) ;; let c-code handle range error
322 (and (string-every-c-code char_pred s start (1- end))
323 (char_pred (string-ref s (1- end))))
324 (string-every-c-code char_pred s start end))))
325
326 ;; A variant of string-fill! that we keep for compatability
327 ;;
328 (define (substring-fill! str start end fill)
329 (string-fill! str fill start end))
330
331 \f
332
333 ;; Define a minimal stub of the module API for psyntax, before modules
334 ;; have booted.
335 (define (module-name x)
336 '(guile))
337 (define (module-define! module sym val)
338 (let ((v (hashq-ref (%get-pre-modules-obarray) sym)))
339 (if v
340 (variable-set! v val)
341 (hashq-set! (%get-pre-modules-obarray) sym
342 (make-variable val)))))
343 (define (module-ref module sym)
344 (let ((v (module-variable module sym)))
345 (if v (variable-ref v) (error "badness!" (pk module) (pk sym)))))
346 (define (resolve-module . args)
347 #f)
348
349 ;; API provided by psyntax
350 (define syntax-violation #f)
351 (define datum->syntax #f)
352 (define syntax->datum #f)
353 (define syntax-source #f)
354 (define identifier? #f)
355 (define generate-temporaries #f)
356 (define bound-identifier=? #f)
357 (define free-identifier=? #f)
358
359 ;; $sc-dispatch is an implementation detail of psyntax. It is used by
360 ;; expanded macros, to dispatch an input against a set of patterns.
361 (define $sc-dispatch #f)
362
363 ;; Load it up!
364 (primitive-load-path "ice-9/psyntax-pp")
365 ;; The binding for `macroexpand' has now been overridden, making psyntax the
366 ;; expander now.
367
368 (define-syntax and
369 (syntax-rules ()
370 ((_) #t)
371 ((_ x) x)
372 ((_ x y ...) (if x (and y ...) #f))))
373
374 (define-syntax or
375 (syntax-rules ()
376 ((_) #f)
377 ((_ x) x)
378 ((_ x y ...) (let ((t x)) (if t t (or y ...))))))
379
380 ;; The "maybe-more" bits are something of a hack, so that we can support
381 ;; SRFI-61. Rewrites into a standalone syntax-case macro would be
382 ;; appreciated.
383 (define-syntax cond
384 (syntax-rules (=> else)
385 ((_ "maybe-more" test consequent)
386 (if test consequent))
387
388 ((_ "maybe-more" test consequent clause ...)
389 (if test consequent (cond clause ...)))
390
391 ((_ (else else1 else2 ...))
392 (begin else1 else2 ...))
393
394 ((_ (test => receiver) more-clause ...)
395 (let ((t test))
396 (cond "maybe-more" t (receiver t) more-clause ...)))
397
398 ((_ (generator guard => receiver) more-clause ...)
399 (call-with-values (lambda () generator)
400 (lambda t
401 (cond "maybe-more"
402 (apply guard t) (apply receiver t) more-clause ...))))
403
404 ((_ (test => receiver ...) more-clause ...)
405 (syntax-violation 'cond "wrong number of receiver expressions"
406 '(test => receiver ...)))
407 ((_ (generator guard => receiver ...) more-clause ...)
408 (syntax-violation 'cond "wrong number of receiver expressions"
409 '(generator guard => receiver ...)))
410
411 ((_ (test) more-clause ...)
412 (let ((t test))
413 (cond "maybe-more" t t more-clause ...)))
414
415 ((_ (test body1 body2 ...) more-clause ...)
416 (cond "maybe-more"
417 test (begin body1 body2 ...) more-clause ...))))
418
419 (define-syntax case
420 (syntax-rules (else)
421 ((case (key ...)
422 clauses ...)
423 (let ((atom-key (key ...)))
424 (case atom-key clauses ...)))
425 ((case key
426 (else result1 result2 ...))
427 (begin result1 result2 ...))
428 ((case key
429 ((atoms ...) result1 result2 ...))
430 (if (memv key '(atoms ...))
431 (begin result1 result2 ...)))
432 ((case key
433 ((atoms ...) result1 result2 ...)
434 clause clauses ...)
435 (if (memv key '(atoms ...))
436 (begin result1 result2 ...)
437 (case key clause clauses ...)))))
438
439 (define-syntax do
440 (syntax-rules ()
441 ((do ((var init step ...) ...)
442 (test expr ...)
443 command ...)
444 (letrec
445 ((loop
446 (lambda (var ...)
447 (if test
448 (begin
449 (if #f #f)
450 expr ...)
451 (begin
452 command
453 ...
454 (loop (do "step" var step ...)
455 ...))))))
456 (loop init ...)))
457 ((do "step" x)
458 x)
459 ((do "step" x y)
460 y)))
461
462 (define-syntax delay
463 (syntax-rules ()
464 ((_ exp) (make-promise (lambda () exp)))))
465
466 (include-from-path "ice-9/quasisyntax")
467
468 (define-syntax current-source-location
469 (lambda (x)
470 (syntax-case x ()
471 ((_)
472 (with-syntax ((s (datum->syntax x (syntax-source x))))
473 #''s)))))
474
475
476 \f
477
478 ;;; {Defmacros}
479 ;;;
480
481 (define-syntax define-macro
482 (lambda (x)
483 "Define a defmacro."
484 (syntax-case x ()
485 ((_ (macro . args) doc body1 body ...)
486 (string? (syntax->datum #'doc))
487 #'(define-macro macro doc (lambda args body1 body ...)))
488 ((_ (macro . args) body ...)
489 #'(define-macro macro #f (lambda args body ...)))
490 ((_ macro doc transformer)
491 (or (string? (syntax->datum #'doc))
492 (not (syntax->datum #'doc)))
493 #'(define-syntax macro
494 (lambda (y)
495 doc
496 #((macro-type . defmacro)
497 (defmacro-args args))
498 (syntax-case y ()
499 ((_ . args)
500 (let ((v (syntax->datum #'args)))
501 (datum->syntax y (apply transformer v)))))))))))
502
503 (define-syntax defmacro
504 (lambda (x)
505 "Define a defmacro, with the old lispy defun syntax."
506 (syntax-case x ()
507 ((_ macro args doc body1 body ...)
508 (string? (syntax->datum #'doc))
509 #'(define-macro macro doc (lambda args body1 body ...)))
510 ((_ macro args body ...)
511 #'(define-macro macro #f (lambda args body ...))))))
512
513 (provide 'defmacro)
514
515 \f
516
517 ;;; {Deprecation}
518 ;;;
519
520 (define-syntax begin-deprecated
521 (lambda (x)
522 (syntax-case x ()
523 ((_ form form* ...)
524 (if (include-deprecated-features)
525 #'(begin form form* ...)
526 #'(begin))))))
527
528 \f
529
530 ;;; {Trivial Functions}
531 ;;;
532
533 (define (identity x) x)
534 (define (and=> value procedure) (and value (procedure value)))
535 (define call/cc call-with-current-continuation)
536
537 (define-syntax false-if-exception
538 (syntax-rules ()
539 ((_ expr)
540 (catch #t
541 (lambda () expr)
542 (lambda (k . args) #f)))))
543
544 \f
545
546 ;;; {General Properties}
547 ;;;
548
549 ;; Properties are a lispy way to associate random info with random objects.
550 ;; Traditionally properties are implemented as an alist or a plist actually
551 ;; pertaining to the object in question.
552 ;;
553 ;; These "object properties" have the advantage that they can be associated with
554 ;; any object, even if the object has no plist. Object properties are good when
555 ;; you are extending pre-existing objects in unexpected ways. They also present
556 ;; a pleasing, uniform procedure-with-setter interface. But if you have a data
557 ;; type that always has properties, it's often still best to store those
558 ;; properties within the object itself.
559
560 (define (make-object-property)
561 (let ((prop (primitive-make-property #f)))
562 (make-procedure-with-setter
563 (lambda (obj) (primitive-property-ref prop obj))
564 (lambda (obj val) (primitive-property-set! prop obj val)))))
565
566 \f
567
568 ;;; {Symbol Properties}
569 ;;;
570
571 ;;; Symbol properties are something you see in old Lisp code. In most current
572 ;;; Guile code, symbols are not used as a data structure -- they are used as
573 ;;; keys into other data structures.
574
575 (define (symbol-property sym prop)
576 (let ((pair (assoc prop (symbol-pref sym))))
577 (and pair (cdr pair))))
578
579 (define (set-symbol-property! sym prop val)
580 (let ((pair (assoc prop (symbol-pref sym))))
581 (if pair
582 (set-cdr! pair val)
583 (symbol-pset! sym (acons prop val (symbol-pref sym))))))
584
585 (define (symbol-property-remove! sym prop)
586 (let ((pair (assoc prop (symbol-pref sym))))
587 (if pair
588 (symbol-pset! sym (delq! pair (symbol-pref sym))))))
589
590 \f
591
592 ;;; {Arrays}
593 ;;;
594
595 (define (array-shape a)
596 (map (lambda (ind) (if (number? ind) (list 0 (+ -1 ind)) ind))
597 (array-dimensions a)))
598
599 \f
600
601 ;;; {Keywords}
602 ;;;
603
604 ;;; It's much better if you can use lambda* / define*, of course.
605
606 (define (kw-arg-ref args kw)
607 (let ((rem (member kw args)))
608 (and rem (pair? (cdr rem)) (cadr rem))))
609
610 \f
611
612 ;;; {Structs}
613 ;;;
614
615 (define (struct-layout s)
616 (struct-ref (struct-vtable s) vtable-index-layout))
617
618 \f
619
620 ;;; {Records}
621 ;;;
622
623 ;; Printing records: by default, records are printed as
624 ;;
625 ;; #<type-name field1: val1 field2: val2 ...>
626 ;;
627 ;; You can change that by giving a custom printing function to
628 ;; MAKE-RECORD-TYPE (after the list of field symbols). This function
629 ;; will be called like
630 ;;
631 ;; (<printer> object port)
632 ;;
633 ;; It should print OBJECT to PORT.
634
635 (define (inherit-print-state old-port new-port)
636 (if (get-print-state old-port)
637 (port-with-print-state new-port (get-print-state old-port))
638 new-port))
639
640 ;; 0: type-name, 1: fields, 2: constructor
641 (define record-type-vtable
642 ;; FIXME: This should just call make-vtable, not make-vtable-vtable; but for
643 ;; that we need to expose the bare vtable-vtable to Scheme.
644 (make-vtable-vtable "prprpw" 0
645 (lambda (s p)
646 (cond ((eq? s record-type-vtable)
647 (display "#<record-type-vtable>" p))
648 (else
649 (display "#<record-type " p)
650 (display (record-type-name s) p)
651 (display ">" p))))))
652
653 (define (record-type? obj)
654 (and (struct? obj) (eq? record-type-vtable (struct-vtable obj))))
655
656 (define* (make-record-type type-name fields #:optional printer)
657 ;; Pre-generate constructors for nfields < 20.
658 (define-syntax make-constructor
659 (lambda (x)
660 (define *max-static-argument-count* 20)
661 (define (make-formals n)
662 (let lp ((i 0))
663 (if (< i n)
664 (cons (datum->syntax
665 x
666 (string->symbol
667 (string (integer->char (+ (char->integer #\a) i)))))
668 (lp (1+ i)))
669 '())))
670 (syntax-case x ()
671 ((_ rtd exp) (not (identifier? #'exp))
672 #'(let ((n exp))
673 (make-constructor rtd n)))
674 ((_ rtd nfields)
675 #`(case nfields
676 #,@(let lp ((n 0))
677 (if (< n *max-static-argument-count*)
678 (cons (with-syntax (((formal ...) (make-formals n))
679 (n n))
680 #'((n)
681 (lambda (formal ...)
682 (make-struct rtd 0 formal ...))))
683 (lp (1+ n)))
684 '()))
685 (else
686 (lambda args
687 (if (= (length args) nfields)
688 (apply make-struct rtd 0 args)
689 (scm-error 'wrong-number-of-args
690 (format #f "make-~a" type-name)
691 "Wrong number of arguments" '() #f)))))))))
692
693 (define (default-record-printer s p)
694 (display "#<" p)
695 (display (record-type-name (record-type-descriptor s)) p)
696 (let loop ((fields (record-type-fields (record-type-descriptor s)))
697 (off 0))
698 (cond
699 ((not (null? fields))
700 (display " " p)
701 (display (car fields) p)
702 (display ": " p)
703 (display (struct-ref s off) p)
704 (loop (cdr fields) (+ 1 off)))))
705 (display ">" p))
706
707 (let ((rtd (make-struct record-type-vtable 0
708 (make-struct-layout
709 (apply string-append
710 (map (lambda (f) "pw") fields)))
711 (or printer default-record-printer)
712 type-name
713 (copy-tree fields))))
714 (struct-set! rtd (+ vtable-offset-user 2)
715 (make-constructor rtd (length fields)))
716 ;; Temporary solution: Associate a name to the record type descriptor
717 ;; so that the object system can create a wrapper class for it.
718 (set-struct-vtable-name! rtd (if (symbol? type-name)
719 type-name
720 (string->symbol type-name)))
721 rtd))
722
723 (define (record-type-name obj)
724 (if (record-type? obj)
725 (struct-ref obj vtable-offset-user)
726 (error 'not-a-record-type obj)))
727
728 (define (record-type-fields obj)
729 (if (record-type? obj)
730 (struct-ref obj (+ 1 vtable-offset-user))
731 (error 'not-a-record-type obj)))
732
733 (define* (record-constructor rtd #:optional field-names)
734 (if (not field-names)
735 (struct-ref rtd (+ 2 vtable-offset-user))
736 (primitive-eval
737 `(lambda ,field-names
738 (make-struct ',rtd 0 ,@(map (lambda (f)
739 (if (memq f field-names)
740 f
741 #f))
742 (record-type-fields rtd)))))))
743
744 (define (record-predicate rtd)
745 (lambda (obj) (and (struct? obj) (eq? rtd (struct-vtable obj)))))
746
747 (define (%record-type-error rtd obj) ;; private helper
748 (or (eq? rtd (record-type-descriptor obj))
749 (scm-error 'wrong-type-arg "%record-type-check"
750 "Wrong type record (want `~S'): ~S"
751 (list (record-type-name rtd) obj)
752 #f)))
753
754 (define (record-accessor rtd field-name)
755 (let ((pos (list-index (record-type-fields rtd) field-name)))
756 (if (not pos)
757 (error 'no-such-field field-name))
758 (lambda (obj)
759 (if (eq? (struct-vtable obj) rtd)
760 (struct-ref obj pos)
761 (%record-type-error rtd obj)))))
762
763 (define (record-modifier rtd field-name)
764 (let ((pos (list-index (record-type-fields rtd) field-name)))
765 (if (not pos)
766 (error 'no-such-field field-name))
767 (lambda (obj val)
768 (if (eq? (struct-vtable obj) rtd)
769 (struct-set! obj pos val)
770 (%record-type-error rtd obj)))))
771
772 (define (record? obj)
773 (and (struct? obj) (record-type? (struct-vtable obj))))
774
775 (define (record-type-descriptor obj)
776 (if (struct? obj)
777 (struct-vtable obj)
778 (error 'not-a-record obj)))
779
780 (provide 'record)
781
782 \f
783
784 ;;; {Booleans}
785 ;;;
786
787 (define (->bool x) (not (not x)))
788
789 \f
790
791 ;;; {Symbols}
792 ;;;
793
794 (define (symbol-append . args)
795 (string->symbol (apply string-append (map symbol->string args))))
796
797 (define (list->symbol . args)
798 (string->symbol (apply list->string args)))
799
800 (define (symbol . args)
801 (string->symbol (apply string args)))
802
803 \f
804
805 ;;; {Lists}
806 ;;;
807
808 (define (list-index l k)
809 (let loop ((n 0)
810 (l l))
811 (and (not (null? l))
812 (if (eq? (car l) k)
813 n
814 (loop (+ n 1) (cdr l))))))
815
816 \f
817
818 (if (provided? 'posix)
819 (primitive-load-path "ice-9/posix"))
820
821 (if (provided? 'socket)
822 (primitive-load-path "ice-9/networking"))
823
824 ;; For reference, Emacs file-exists-p uses stat in this same way.
825 (define file-exists?
826 (if (provided? 'posix)
827 (lambda (str)
828 (->bool (stat str #f)))
829 (lambda (str)
830 (let ((port (catch 'system-error (lambda () (open-file str OPEN_READ))
831 (lambda args #f))))
832 (if port (begin (close-port port) #t)
833 #f)))))
834
835 (define file-is-directory?
836 (if (provided? 'posix)
837 (lambda (str)
838 (eq? (stat:type (stat str)) 'directory))
839 (lambda (str)
840 (let ((port (catch 'system-error
841 (lambda () (open-file (string-append str "/.")
842 OPEN_READ))
843 (lambda args #f))))
844 (if port (begin (close-port port) #t)
845 #f)))))
846
847 (define (system-error-errno args)
848 (if (eq? (car args) 'system-error)
849 (car (list-ref args 4))
850 #f))
851
852 \f
853
854 ;;; {Error Handling}
855 ;;;
856
857 (define error
858 (case-lambda
859 (()
860 (scm-error 'misc-error #f "?" #f #f))
861 ((message . args)
862 (let ((msg (string-join (cons "~A" (make-list (length args) "~S")))))
863 (scm-error 'misc-error #f msg (cons message args) #f)))))
864
865 \f
866
867 ;;; {Time Structures}
868 ;;;
869
870 (define (tm:sec obj) (vector-ref obj 0))
871 (define (tm:min obj) (vector-ref obj 1))
872 (define (tm:hour obj) (vector-ref obj 2))
873 (define (tm:mday obj) (vector-ref obj 3))
874 (define (tm:mon obj) (vector-ref obj 4))
875 (define (tm:year obj) (vector-ref obj 5))
876 (define (tm:wday obj) (vector-ref obj 6))
877 (define (tm:yday obj) (vector-ref obj 7))
878 (define (tm:isdst obj) (vector-ref obj 8))
879 (define (tm:gmtoff obj) (vector-ref obj 9))
880 (define (tm:zone obj) (vector-ref obj 10))
881
882 (define (set-tm:sec obj val) (vector-set! obj 0 val))
883 (define (set-tm:min obj val) (vector-set! obj 1 val))
884 (define (set-tm:hour obj val) (vector-set! obj 2 val))
885 (define (set-tm:mday obj val) (vector-set! obj 3 val))
886 (define (set-tm:mon obj val) (vector-set! obj 4 val))
887 (define (set-tm:year obj val) (vector-set! obj 5 val))
888 (define (set-tm:wday obj val) (vector-set! obj 6 val))
889 (define (set-tm:yday obj val) (vector-set! obj 7 val))
890 (define (set-tm:isdst obj val) (vector-set! obj 8 val))
891 (define (set-tm:gmtoff obj val) (vector-set! obj 9 val))
892 (define (set-tm:zone obj val) (vector-set! obj 10 val))
893
894 (define (tms:clock obj) (vector-ref obj 0))
895 (define (tms:utime obj) (vector-ref obj 1))
896 (define (tms:stime obj) (vector-ref obj 2))
897 (define (tms:cutime obj) (vector-ref obj 3))
898 (define (tms:cstime obj) (vector-ref obj 4))
899
900 \f
901
902 ;;; {File Descriptors and Ports}
903 ;;;
904
905 (define file-position ftell)
906 (define* (file-set-position port offset #:optional (whence SEEK_SET))
907 (seek port offset whence))
908
909 (define (move->fdes fd/port fd)
910 (cond ((integer? fd/port)
911 (dup->fdes fd/port fd)
912 (close fd/port)
913 fd)
914 (else
915 (primitive-move->fdes fd/port fd)
916 (set-port-revealed! fd/port 1)
917 fd/port)))
918
919 (define (release-port-handle port)
920 (let ((revealed (port-revealed port)))
921 (if (> revealed 0)
922 (set-port-revealed! port (- revealed 1)))))
923
924 (define dup->port
925 (case-lambda
926 ((port/fd mode)
927 (fdopen (dup->fdes port/fd) mode))
928 ((port/fd mode new-fd)
929 (let ((port (fdopen (dup->fdes port/fd new-fd) mode)))
930 (set-port-revealed! port 1)
931 port))))
932
933 (define dup->inport
934 (case-lambda
935 ((port/fd)
936 (dup->port port/fd "r"))
937 ((port/fd new-fd)
938 (dup->port port/fd "r" new-fd))))
939
940 (define dup->outport
941 (case-lambda
942 ((port/fd)
943 (dup->port port/fd "w"))
944 ((port/fd new-fd)
945 (dup->port port/fd "w" new-fd))))
946
947 (define dup
948 (case-lambda
949 ((port/fd)
950 (if (integer? port/fd)
951 (dup->fdes port/fd)
952 (dup->port port/fd (port-mode port/fd))))
953 ((port/fd new-fd)
954 (if (integer? port/fd)
955 (dup->fdes port/fd new-fd)
956 (dup->port port/fd (port-mode port/fd) new-fd)))))
957
958 (define (duplicate-port port modes)
959 (dup->port port modes))
960
961 (define (fdes->inport fdes)
962 (let loop ((rest-ports (fdes->ports fdes)))
963 (cond ((null? rest-ports)
964 (let ((result (fdopen fdes "r")))
965 (set-port-revealed! result 1)
966 result))
967 ((input-port? (car rest-ports))
968 (set-port-revealed! (car rest-ports)
969 (+ (port-revealed (car rest-ports)) 1))
970 (car rest-ports))
971 (else
972 (loop (cdr rest-ports))))))
973
974 (define (fdes->outport fdes)
975 (let loop ((rest-ports (fdes->ports fdes)))
976 (cond ((null? rest-ports)
977 (let ((result (fdopen fdes "w")))
978 (set-port-revealed! result 1)
979 result))
980 ((output-port? (car rest-ports))
981 (set-port-revealed! (car rest-ports)
982 (+ (port-revealed (car rest-ports)) 1))
983 (car rest-ports))
984 (else
985 (loop (cdr rest-ports))))))
986
987 (define (port->fdes port)
988 (set-port-revealed! port (+ (port-revealed port) 1))
989 (fileno port))
990
991 (define (setenv name value)
992 (if value
993 (putenv (string-append name "=" value))
994 (putenv name)))
995
996 (define (unsetenv name)
997 "Remove the entry for NAME from the environment."
998 (putenv name))
999
1000 \f
1001
1002 ;;; {Load Paths}
1003 ;;;
1004
1005 (define (in-vicinity vicinity file)
1006 (let ((tail (let ((len (string-length vicinity)))
1007 (if (zero? len)
1008 #f
1009 (string-ref vicinity (- len 1))))))
1010 (string-append vicinity
1011 (if (or (not tail)
1012 (eq? tail #\/))
1013 ""
1014 "/")
1015 file)))
1016
1017 \f
1018
1019 ;;; {Help for scm_shell}
1020 ;;;
1021 ;;; The argument-processing code used by Guile-based shells generates
1022 ;;; Scheme code based on the argument list. This page contains help
1023 ;;; functions for the code it generates.
1024 ;;;
1025
1026 (define (command-line) (program-arguments))
1027
1028 ;; This is mostly for the internal use of the code generated by
1029 ;; scm_compile_shell_switches.
1030
1031 (define (load-user-init)
1032 (let* ((home (or (getenv "HOME")
1033 (false-if-exception (passwd:dir (getpwuid (getuid))))
1034 "/")) ;; fallback for cygwin etc.
1035 (init-file (in-vicinity home ".guile")))
1036 (if (file-exists? init-file)
1037 (primitive-load init-file))))
1038
1039 \f
1040
1041 ;;; {The interpreter stack}
1042 ;;;
1043
1044 ;; %stacks defined in stacks.c
1045 (define (%start-stack tag thunk)
1046 (let ((prompt-tag (make-prompt-tag "start-stack")))
1047 (call-with-prompt
1048 prompt-tag
1049 (lambda ()
1050 (with-fluids ((%stacks (acons tag prompt-tag
1051 (or (fluid-ref %stacks) '()))))
1052 (thunk)))
1053 (lambda (k . args)
1054 (%start-stack tag (lambda () (apply k args)))))))
1055 (define-syntax start-stack
1056 (syntax-rules ()
1057 ((_ tag exp)
1058 (%start-stack tag (lambda () exp)))))
1059
1060 \f
1061
1062 ;;; {Loading by paths}
1063 ;;;
1064
1065 ;;; Load a Scheme source file named NAME, searching for it in the
1066 ;;; directories listed in %load-path, and applying each of the file
1067 ;;; name extensions listed in %load-extensions.
1068 (define (load-from-path name)
1069 (start-stack 'load-stack
1070 (primitive-load-path name)))
1071
1072 (define %load-verbosely #f)
1073 (define (assert-load-verbosity v) (set! %load-verbosely v))
1074
1075 (define (%load-announce file)
1076 (if %load-verbosely
1077 (with-output-to-port (current-error-port)
1078 (lambda ()
1079 (display ";;; ")
1080 (display "loading ")
1081 (display file)
1082 (newline)
1083 (force-output)))))
1084
1085 (set! %load-hook %load-announce)
1086
1087 (define* (load name #:optional reader)
1088 ;; Returns the .go file corresponding to `name'. Does not search load
1089 ;; paths, only the fallback path. If the .go file is missing or out of
1090 ;; date, and autocompilation is enabled, will try autocompilation, just
1091 ;; as primitive-load-path does internally. primitive-load is
1092 ;; unaffected. Returns #f if autocompilation failed or was disabled.
1093 ;;
1094 ;; NB: Unless we need to compile the file, this function should not cause
1095 ;; (system base compile) to be loaded up. For that reason compiled-file-name
1096 ;; partially duplicates functionality from (system base compile).
1097 (define (compiled-file-name canon-path)
1098 (and %compile-fallback-path
1099 (string-append
1100 %compile-fallback-path
1101 ;; no need for '/' separator here, canon-path is absolute
1102 canon-path
1103 (cond ((or (null? %load-compiled-extensions)
1104 (string-null? (car %load-compiled-extensions)))
1105 (warn "invalid %load-compiled-extensions"
1106 %load-compiled-extensions)
1107 ".go")
1108 (else (car %load-compiled-extensions))))))
1109 (define (fresh-compiled-file-name go-path)
1110 (catch #t
1111 (lambda ()
1112 (let* ((scmstat (stat name))
1113 (gostat (stat go-path #f)))
1114 (if (and gostat
1115 (or (> (stat:mtime gostat) (stat:mtime scmstat))
1116 (and (= (stat:mtime gostat) (stat:mtime scmstat))
1117 (>= (stat:mtimensec gostat)
1118 (stat:mtimensec scmstat)))))
1119 go-path
1120 (begin
1121 (if gostat
1122 (format (current-error-port)
1123 ";;; note: source file ~a\n;;; newer than compiled ~a\n"
1124 name go-path))
1125 (cond
1126 (%load-should-autocompile
1127 (%warn-autocompilation-enabled)
1128 (format (current-error-port) ";;; compiling ~a\n" name)
1129 ;; This use of @ is (ironically?) boot-safe, as modules have
1130 ;; not been booted yet, so the resolve-module call in psyntax
1131 ;; doesn't try to load a module, and compile-file will be
1132 ;; treated as a function, not a macro.
1133 (let ((cfn ((@ (system base compile) compile-file) name
1134 #:env (current-module))))
1135 (format (current-error-port) ";;; compiled ~a\n" cfn)
1136 cfn))
1137 (else #f))))))
1138 (lambda (k . args)
1139 (format (current-error-port)
1140 ";;; WARNING: compilation of ~a failed:\n;;; key ~a, throw_args ~s\n"
1141 name k args)
1142 #f)))
1143 (with-fluids ((current-reader reader))
1144 (let ((cfn (and=> (and=> (false-if-exception (canonicalize-path name))
1145 compiled-file-name)
1146 fresh-compiled-file-name)))
1147 (if cfn
1148 (load-compiled cfn)
1149 (start-stack 'load-stack
1150 (primitive-load name))))))
1151
1152 \f
1153
1154 ;;; {Reader Extensions}
1155 ;;;
1156 ;;; Reader code for various "#c" forms.
1157 ;;;
1158
1159 (define read-eval? (make-fluid))
1160 (fluid-set! read-eval? #f)
1161 (read-hash-extend #\.
1162 (lambda (c port)
1163 (if (fluid-ref read-eval?)
1164 (eval (read port) (interaction-environment))
1165 (error
1166 "#. read expansion found and read-eval? is #f."))))
1167
1168 \f
1169
1170 ;;; {Low Level Modules}
1171 ;;;
1172 ;;; These are the low level data structures for modules.
1173 ;;;
1174 ;;; Every module object is of the type 'module-type', which is a record
1175 ;;; consisting of the following members:
1176 ;;;
1177 ;;; - eval-closure: the function that defines for its module the strategy that
1178 ;;; shall be followed when looking up symbols in the module.
1179 ;;;
1180 ;;; An eval-closure is a function taking two arguments: the symbol to be
1181 ;;; looked up and a boolean value telling whether a binding for the symbol
1182 ;;; should be created if it does not exist yet. If the symbol lookup
1183 ;;; succeeded (either because an existing binding was found or because a new
1184 ;;; binding was created), a variable object representing the binding is
1185 ;;; returned. Otherwise, the value #f is returned. Note that the eval
1186 ;;; closure does not take the module to be searched as an argument: During
1187 ;;; construction of the eval-closure, the eval-closure has to store the
1188 ;;; module it belongs to in its environment. This means, that any
1189 ;;; eval-closure can belong to only one module.
1190 ;;;
1191 ;;; The eval-closure of a module can be defined arbitrarily. However, three
1192 ;;; special cases of eval-closures are to be distinguished: During startup
1193 ;;; the module system is not yet activated. In this phase, no modules are
1194 ;;; defined and all bindings are automatically stored by the system in the
1195 ;;; pre-modules-obarray. Since no eval-closures exist at this time, the
1196 ;;; functions which require an eval-closure as their argument need to be
1197 ;;; passed the value #f.
1198 ;;;
1199 ;;; The other two special cases of eval-closures are the
1200 ;;; standard-eval-closure and the standard-interface-eval-closure. Both
1201 ;;; behave equally for the case that no new binding is to be created. The
1202 ;;; difference between the two comes in, when the boolean argument to the
1203 ;;; eval-closure indicates that a new binding shall be created if it is not
1204 ;;; found.
1205 ;;;
1206 ;;; Given that no new binding shall be created, both standard eval-closures
1207 ;;; define the following standard strategy of searching bindings in the
1208 ;;; module: First, the module's obarray is searched for the symbol. Second,
1209 ;;; if no binding for the symbol was found in the module's obarray, the
1210 ;;; module's binder procedure is exececuted. If this procedure did not
1211 ;;; return a binding for the symbol, the modules referenced in the module's
1212 ;;; uses list are recursively searched for a binding of the symbol. If the
1213 ;;; binding can not be found in these modules also, the symbol lookup has
1214 ;;; failed.
1215 ;;;
1216 ;;; If a new binding shall be created, the standard-interface-eval-closure
1217 ;;; immediately returns indicating failure. That is, it does not even try
1218 ;;; to look up the symbol. In contrast, the standard-eval-closure would
1219 ;;; first search the obarray, and if no binding was found there, would
1220 ;;; create a new binding in the obarray, therefore not calling the binder
1221 ;;; procedure or searching the modules in the uses list.
1222 ;;;
1223 ;;; The explanation of the following members obarray, binder and uses
1224 ;;; assumes that the symbol lookup follows the strategy that is defined in
1225 ;;; the standard-eval-closure and the standard-interface-eval-closure.
1226 ;;;
1227 ;;; - obarray: a hash table that maps symbols to variable objects. In this
1228 ;;; hash table, the definitions are found that are local to the module (that
1229 ;;; is, not imported from other modules). When looking up bindings in the
1230 ;;; module, this hash table is searched first.
1231 ;;;
1232 ;;; - binder: either #f or a function taking a module and a symbol argument.
1233 ;;; If it is a function it is called after the obarray has been
1234 ;;; unsuccessfully searched for a binding. It then can provide bindings
1235 ;;; that would otherwise not be found locally in the module.
1236 ;;;
1237 ;;; - uses: a list of modules from which non-local bindings can be inherited.
1238 ;;; These modules are the third place queried for bindings after the obarray
1239 ;;; has been unsuccessfully searched and the binder function did not deliver
1240 ;;; a result either.
1241 ;;;
1242 ;;; - transformer: either #f or a function taking a scheme expression as
1243 ;;; delivered by read. If it is a function, it will be called to perform
1244 ;;; syntax transformations (e. g. makro expansion) on the given scheme
1245 ;;; expression. The output of the transformer function will then be passed
1246 ;;; to Guile's internal memoizer. This means that the output must be valid
1247 ;;; scheme code. The only exception is, that the output may make use of the
1248 ;;; syntax extensions provided to identify the modules that a binding
1249 ;;; belongs to.
1250 ;;;
1251 ;;; - name: the name of the module. This is used for all kinds of printing
1252 ;;; outputs. In certain places the module name also serves as a way of
1253 ;;; identification. When adding a module to the uses list of another
1254 ;;; module, it is made sure that the new uses list will not contain two
1255 ;;; modules of the same name.
1256 ;;;
1257 ;;; - kind: classification of the kind of module. The value is (currently?)
1258 ;;; only used for printing. It has no influence on how a module is treated.
1259 ;;; Currently the following values are used when setting the module kind:
1260 ;;; 'module, 'directory, 'interface, 'custom-interface. If no explicit kind
1261 ;;; is set, it defaults to 'module.
1262 ;;;
1263 ;;; - duplicates-handlers: a list of procedures that get called to make a
1264 ;;; choice between two duplicate bindings when name clashes occur. See the
1265 ;;; `duplicate-handlers' global variable below.
1266 ;;;
1267 ;;; - observers: a list of procedures that get called when the module is
1268 ;;; modified.
1269 ;;;
1270 ;;; - weak-observers: a weak-key hash table of procedures that get called
1271 ;;; when the module is modified. See `module-observe-weak' for details.
1272 ;;;
1273 ;;; In addition, the module may (must?) contain a binding for
1274 ;;; `%module-public-interface'. This variable should be bound to a module
1275 ;;; representing the exported interface of a module. See the
1276 ;;; `module-public-interface' and `module-export!' procedures.
1277 ;;;
1278 ;;; !!! warning: The interface to lazy binder procedures is going
1279 ;;; to be changed in an incompatible way to permit all the basic
1280 ;;; module ops to be virtualized.
1281 ;;;
1282 ;;; (make-module size use-list lazy-binding-proc) => module
1283 ;;; module-{obarray,uses,binder}[|-set!]
1284 ;;; (module? obj) => [#t|#f]
1285 ;;; (module-locally-bound? module symbol) => [#t|#f]
1286 ;;; (module-bound? module symbol) => [#t|#f]
1287 ;;; (module-symbol-locally-interned? module symbol) => [#t|#f]
1288 ;;; (module-symbol-interned? module symbol) => [#t|#f]
1289 ;;; (module-local-variable module symbol) => [#<variable ...> | #f]
1290 ;;; (module-variable module symbol) => [#<variable ...> | #f]
1291 ;;; (module-symbol-binding module symbol opt-value)
1292 ;;; => [ <obj> | opt-value | an error occurs ]
1293 ;;; (module-make-local-var! module symbol) => #<variable...>
1294 ;;; (module-add! module symbol var) => unspecified
1295 ;;; (module-remove! module symbol) => unspecified
1296 ;;; (module-for-each proc module) => unspecified
1297 ;;; (make-scm-module) => module ; a lazy copy of the symhash module
1298 ;;; (set-current-module module) => unspecified
1299 ;;; (current-module) => #<module...>
1300 ;;;
1301 ;;;
1302
1303 \f
1304
1305 ;;; {Printing Modules}
1306 ;;;
1307
1308 ;; This is how modules are printed. You can re-define it.
1309 (define (%print-module mod port)
1310 (display "#<" port)
1311 (display (or (module-kind mod) "module") port)
1312 (display " " port)
1313 (display (module-name mod) port)
1314 (display " " port)
1315 (display (number->string (object-address mod) 16) port)
1316 (display ">" port))
1317
1318 (letrec-syntax
1319 ;; Locally extend the syntax to allow record accessors to be defined at
1320 ;; compile-time. Cache the rtd locally to the constructor, the getters and
1321 ;; the setters, in order to allow for redefinition of the record type; not
1322 ;; relevant in the case of modules, but perhaps if we make this public, it
1323 ;; could matter.
1324
1325 ((define-record-type
1326 (lambda (x)
1327 (define (make-id scope . fragments)
1328 (datum->syntax #'scope
1329 (apply symbol-append
1330 (map (lambda (x)
1331 (if (symbol? x) x (syntax->datum x)))
1332 fragments))))
1333
1334 (define (getter rtd type-name field slot)
1335 #`(define #,(make-id rtd type-name '- field)
1336 (let ((rtd #,rtd))
1337 (lambda (#,type-name)
1338 (if (eq? (struct-vtable #,type-name) rtd)
1339 (struct-ref #,type-name #,slot)
1340 (%record-type-error rtd #,type-name))))))
1341
1342 (define (setter rtd type-name field slot)
1343 #`(define #,(make-id rtd 'set- type-name '- field '!)
1344 (let ((rtd #,rtd))
1345 (lambda (#,type-name val)
1346 (if (eq? (struct-vtable #,type-name) rtd)
1347 (struct-set! #,type-name #,slot val)
1348 (%record-type-error rtd #,type-name))))))
1349
1350 (define (accessors rtd type-name fields n exp)
1351 (syntax-case fields ()
1352 (() exp)
1353 (((field #:no-accessors) field* ...) (identifier? #'field)
1354 (accessors rtd type-name #'(field* ...) (1+ n)
1355 exp))
1356 (((field #:no-setter) field* ...) (identifier? #'field)
1357 (accessors rtd type-name #'(field* ...) (1+ n)
1358 #`(begin #,exp
1359 #,(getter rtd type-name #'field n))))
1360 (((field #:no-getter) field* ...) (identifier? #'field)
1361 (accessors rtd type-name #'(field* ...) (1+ n)
1362 #`(begin #,exp
1363 #,(setter rtd type-name #'field n))))
1364 ((field field* ...) (identifier? #'field)
1365 (accessors rtd type-name #'(field* ...) (1+ n)
1366 #`(begin #,exp
1367 #,(getter rtd type-name #'field n)
1368 #,(setter rtd type-name #'field n))))))
1369
1370 (define (predicate rtd type-name fields exp)
1371 (accessors
1372 rtd type-name fields 0
1373 #`(begin
1374 #,exp
1375 (define (#,(make-id rtd type-name '?) obj)
1376 (and (struct? obj) (eq? (struct-vtable obj) #,rtd))))))
1377
1378 (define (field-list fields)
1379 (syntax-case fields ()
1380 (() '())
1381 (((f . opts) . rest) (identifier? #'f)
1382 (cons #'f (field-list #'rest)))
1383 ((f . rest) (identifier? #'f)
1384 (cons #'f (field-list #'rest)))))
1385
1386 (define (constructor rtd type-name fields exp)
1387 (let ((ctor (make-id rtd type-name '-constructor))
1388 (args (field-list fields)))
1389 (predicate rtd type-name fields
1390 #`(begin #,exp
1391 (define #,ctor
1392 (let ((rtd #,rtd))
1393 (lambda #,args
1394 (make-struct rtd 0 #,@args))))
1395 (struct-set! #,rtd (+ vtable-offset-user 2)
1396 #,ctor)))))
1397
1398 (define (type type-name printer fields)
1399 (define (make-layout)
1400 (let lp ((fields fields) (slots '()))
1401 (syntax-case fields ()
1402 (() (datum->syntax #'here
1403 (make-struct-layout
1404 (apply string-append slots))))
1405 ((_ . rest) (lp #'rest (cons "pw" slots))))))
1406
1407 (let ((rtd (make-id type-name type-name '-type)))
1408 (constructor rtd type-name fields
1409 #`(begin
1410 (define #,rtd
1411 (make-struct record-type-vtable 0
1412 '#,(make-layout)
1413 #,printer
1414 '#,type-name
1415 '#,(field-list fields)))
1416 (set-struct-vtable-name! #,rtd '#,type-name)))))
1417
1418 (syntax-case x ()
1419 ((_ type-name printer (field ...))
1420 (type #'type-name #'printer #'(field ...)))))))
1421
1422 ;; module-type
1423 ;;
1424 ;; A module is characterized by an obarray in which local symbols
1425 ;; are interned, a list of modules, "uses", from which non-local
1426 ;; bindings can be inherited, and an optional lazy-binder which
1427 ;; is a (CLOSURE module symbol) which, as a last resort, can provide
1428 ;; bindings that would otherwise not be found locally in the module.
1429 ;;
1430 ;; NOTE: If you change the set of fields or their order, you also need to
1431 ;; change the constants in libguile/modules.h.
1432 ;;
1433 ;; NOTE: The getter `module-eval-closure' is used in libguile/modules.c.
1434 ;; NOTE: The getter `module-transfomer' is defined libguile/modules.c.
1435 ;; NOTE: The getter `module-name' is defined later, due to boot reasons.
1436 ;; NOTE: The getter `module-public-interface' is used in libguile/modules.c.
1437 ;;
1438 (define-record-type module
1439 (lambda (obj port) (%print-module obj port))
1440 (obarray
1441 uses
1442 binder
1443 eval-closure
1444 (transformer #:no-getter)
1445 (name #:no-getter)
1446 kind
1447 duplicates-handlers
1448 (import-obarray #:no-setter)
1449 observers
1450 (weak-observers #:no-setter)
1451 version
1452 submodules
1453 submodule-binder
1454 public-interface
1455 filename)))
1456
1457
1458 ;; make-module &opt size uses binder
1459 ;;
1460 ;; Create a new module, perhaps with a particular size of obarray,
1461 ;; initial uses list, or binding procedure.
1462 ;;
1463 (define* (make-module #:optional (size 31) (uses '()) (binder #f))
1464 (define %default-import-size
1465 ;; Typical number of imported bindings actually used by a module.
1466 600)
1467
1468 (if (not (integer? size))
1469 (error "Illegal size to make-module." size))
1470 (if (not (and (list? uses)
1471 (and-map module? uses)))
1472 (error "Incorrect use list." uses))
1473 (if (and binder (not (procedure? binder)))
1474 (error
1475 "Lazy-binder expected to be a procedure or #f." binder))
1476
1477 (let ((module (module-constructor (make-hash-table size)
1478 uses binder #f macroexpand
1479 #f #f #f
1480 (make-hash-table %default-import-size)
1481 '()
1482 (make-weak-key-hash-table 31) #f
1483 (make-hash-table 7) #f #f #f)))
1484
1485 ;; We can't pass this as an argument to module-constructor,
1486 ;; because we need it to close over a pointer to the module
1487 ;; itself.
1488 (set-module-eval-closure! module (standard-eval-closure module))
1489
1490 module))
1491
1492
1493 \f
1494
1495 ;;; {Observer protocol}
1496 ;;;
1497
1498 (define (module-observe module proc)
1499 (set-module-observers! module (cons proc (module-observers module)))
1500 (cons module proc))
1501
1502 (define* (module-observe-weak module observer-id #:optional (proc observer-id))
1503 ;; Register PROC as an observer of MODULE under name OBSERVER-ID (which can
1504 ;; be any Scheme object). PROC is invoked and passed MODULE any time
1505 ;; MODULE is modified. PROC gets unregistered when OBSERVER-ID gets GC'd
1506 ;; (thus, it is never unregistered if OBSERVER-ID is an immediate value,
1507 ;; for instance).
1508
1509 ;; The two-argument version is kept for backward compatibility: when called
1510 ;; with two arguments, the observer gets unregistered when closure PROC
1511 ;; gets GC'd (making it impossible to use an anonymous lambda for PROC).
1512 (hashq-set! (module-weak-observers module) observer-id proc))
1513
1514 (define (module-unobserve token)
1515 (let ((module (car token))
1516 (id (cdr token)))
1517 (if (integer? id)
1518 (hash-remove! (module-weak-observers module) id)
1519 (set-module-observers! module (delq1! id (module-observers module)))))
1520 *unspecified*)
1521
1522 (define module-defer-observers #f)
1523 (define module-defer-observers-mutex (make-mutex 'recursive))
1524 (define module-defer-observers-table (make-hash-table))
1525
1526 (define (module-modified m)
1527 (if module-defer-observers
1528 (hash-set! module-defer-observers-table m #t)
1529 (module-call-observers m)))
1530
1531 ;;; This function can be used to delay calls to observers so that they
1532 ;;; can be called once only in the face of massive updating of modules.
1533 ;;;
1534 (define (call-with-deferred-observers thunk)
1535 (dynamic-wind
1536 (lambda ()
1537 (lock-mutex module-defer-observers-mutex)
1538 (set! module-defer-observers #t))
1539 thunk
1540 (lambda ()
1541 (set! module-defer-observers #f)
1542 (hash-for-each (lambda (m dummy)
1543 (module-call-observers m))
1544 module-defer-observers-table)
1545 (hash-clear! module-defer-observers-table)
1546 (unlock-mutex module-defer-observers-mutex))))
1547
1548 (define (module-call-observers m)
1549 (for-each (lambda (proc) (proc m)) (module-observers m))
1550
1551 ;; We assume that weak observers don't (un)register themselves as they are
1552 ;; called since this would preclude proper iteration over the hash table
1553 ;; elements.
1554 (hash-for-each (lambda (id proc) (proc m)) (module-weak-observers m)))
1555
1556 \f
1557
1558 ;;; {Module Searching in General}
1559 ;;;
1560 ;;; We sometimes want to look for properties of a symbol
1561 ;;; just within the obarray of one module. If the property
1562 ;;; holds, then it is said to hold ``locally'' as in, ``The symbol
1563 ;;; DISPLAY is locally rebound in the module `safe-guile'.''
1564 ;;;
1565 ;;;
1566 ;;; Other times, we want to test for a symbol property in the obarray
1567 ;;; of M and, if it is not found there, try each of the modules in the
1568 ;;; uses list of M. This is the normal way of testing for some
1569 ;;; property, so we state these properties without qualification as
1570 ;;; in: ``The symbol 'fnord is interned in module M because it is
1571 ;;; interned locally in module M2 which is a member of the uses list
1572 ;;; of M.''
1573 ;;;
1574
1575 ;; module-search fn m
1576 ;;
1577 ;; return the first non-#f result of FN applied to M and then to
1578 ;; the modules in the uses of m, and so on recursively. If all applications
1579 ;; return #f, then so does this function.
1580 ;;
1581 (define (module-search fn m v)
1582 (define (loop pos)
1583 (and (pair? pos)
1584 (or (module-search fn (car pos) v)
1585 (loop (cdr pos)))))
1586 (or (fn m v)
1587 (loop (module-uses m))))
1588
1589
1590 ;;; {Is a symbol bound in a module?}
1591 ;;;
1592 ;;; Symbol S in Module M is bound if S is interned in M and if the binding
1593 ;;; of S in M has been set to some well-defined value.
1594 ;;;
1595
1596 ;; module-locally-bound? module symbol
1597 ;;
1598 ;; Is a symbol bound (interned and defined) locally in a given module?
1599 ;;
1600 (define (module-locally-bound? m v)
1601 (let ((var (module-local-variable m v)))
1602 (and var
1603 (variable-bound? var))))
1604
1605 ;; module-bound? module symbol
1606 ;;
1607 ;; Is a symbol bound (interned and defined) anywhere in a given module
1608 ;; or its uses?
1609 ;;
1610 (define (module-bound? m v)
1611 (let ((var (module-variable m v)))
1612 (and var
1613 (variable-bound? var))))
1614
1615 ;;; {Is a symbol interned in a module?}
1616 ;;;
1617 ;;; Symbol S in Module M is interned if S occurs in
1618 ;;; of S in M has been set to some well-defined value.
1619 ;;;
1620 ;;; It is possible to intern a symbol in a module without providing
1621 ;;; an initial binding for the corresponding variable. This is done
1622 ;;; with:
1623 ;;; (module-add! module symbol (make-undefined-variable))
1624 ;;;
1625 ;;; In that case, the symbol is interned in the module, but not
1626 ;;; bound there. The unbound symbol shadows any binding for that
1627 ;;; symbol that might otherwise be inherited from a member of the uses list.
1628 ;;;
1629
1630 (define (module-obarray-get-handle ob key)
1631 ((if (symbol? key) hashq-get-handle hash-get-handle) ob key))
1632
1633 (define (module-obarray-ref ob key)
1634 ((if (symbol? key) hashq-ref hash-ref) ob key))
1635
1636 (define (module-obarray-set! ob key val)
1637 ((if (symbol? key) hashq-set! hash-set!) ob key val))
1638
1639 (define (module-obarray-remove! ob key)
1640 ((if (symbol? key) hashq-remove! hash-remove!) ob key))
1641
1642 ;; module-symbol-locally-interned? module symbol
1643 ;;
1644 ;; is a symbol interned (not neccessarily defined) locally in a given module
1645 ;; or its uses? Interned symbols shadow inherited bindings even if
1646 ;; they are not themselves bound to a defined value.
1647 ;;
1648 (define (module-symbol-locally-interned? m v)
1649 (not (not (module-obarray-get-handle (module-obarray m) v))))
1650
1651 ;; module-symbol-interned? module symbol
1652 ;;
1653 ;; is a symbol interned (not neccessarily defined) anywhere in a given module
1654 ;; or its uses? Interned symbols shadow inherited bindings even if
1655 ;; they are not themselves bound to a defined value.
1656 ;;
1657 (define (module-symbol-interned? m v)
1658 (module-search module-symbol-locally-interned? m v))
1659
1660
1661 ;;; {Mapping modules x symbols --> variables}
1662 ;;;
1663
1664 ;; module-local-variable module symbol
1665 ;; return the local variable associated with a MODULE and SYMBOL.
1666 ;;
1667 ;;; This function is very important. It is the only function that can
1668 ;;; return a variable from a module other than the mutators that store
1669 ;;; new variables in modules. Therefore, this function is the location
1670 ;;; of the "lazy binder" hack.
1671 ;;;
1672 ;;; If symbol is defined in MODULE, and if the definition binds symbol
1673 ;;; to a variable, return that variable object.
1674 ;;;
1675 ;;; If the symbols is not found at first, but the module has a lazy binder,
1676 ;;; then try the binder.
1677 ;;;
1678 ;;; If the symbol is not found at all, return #f.
1679 ;;;
1680 ;;; (This is now written in C, see `modules.c'.)
1681 ;;;
1682
1683 ;;; {Mapping modules x symbols --> bindings}
1684 ;;;
1685 ;;; These are similar to the mapping to variables, except that the
1686 ;;; variable is dereferenced.
1687 ;;;
1688
1689 ;; module-symbol-binding module symbol opt-value
1690 ;;
1691 ;; return the binding of a variable specified by name within
1692 ;; a given module, signalling an error if the variable is unbound.
1693 ;; If the OPT-VALUE is passed, then instead of signalling an error,
1694 ;; return OPT-VALUE.
1695 ;;
1696 (define (module-symbol-local-binding m v . opt-val)
1697 (let ((var (module-local-variable m v)))
1698 (if (and var (variable-bound? var))
1699 (variable-ref var)
1700 (if (not (null? opt-val))
1701 (car opt-val)
1702 (error "Locally unbound variable." v)))))
1703
1704 ;; module-symbol-binding module symbol opt-value
1705 ;;
1706 ;; return the binding of a variable specified by name within
1707 ;; a given module, signalling an error if the variable is unbound.
1708 ;; If the OPT-VALUE is passed, then instead of signalling an error,
1709 ;; return OPT-VALUE.
1710 ;;
1711 (define (module-symbol-binding m v . opt-val)
1712 (let ((var (module-variable m v)))
1713 (if (and var (variable-bound? var))
1714 (variable-ref var)
1715 (if (not (null? opt-val))
1716 (car opt-val)
1717 (error "Unbound variable." v)))))
1718
1719
1720 \f
1721
1722 ;;; {Adding Variables to Modules}
1723 ;;;
1724
1725 ;; module-make-local-var! module symbol
1726 ;;
1727 ;; ensure a variable for V in the local namespace of M.
1728 ;; If no variable was already there, then create a new and uninitialzied
1729 ;; variable.
1730 ;;
1731 ;; This function is used in modules.c.
1732 ;;
1733 (define (module-make-local-var! m v)
1734 (or (let ((b (module-obarray-ref (module-obarray m) v)))
1735 (and (variable? b)
1736 (begin
1737 ;; Mark as modified since this function is called when
1738 ;; the standard eval closure defines a binding
1739 (module-modified m)
1740 b)))
1741
1742 ;; Create a new local variable.
1743 (let ((local-var (make-undefined-variable)))
1744 (module-add! m v local-var)
1745 local-var)))
1746
1747 ;; module-ensure-local-variable! module symbol
1748 ;;
1749 ;; Ensure that there is a local variable in MODULE for SYMBOL. If
1750 ;; there is no binding for SYMBOL, create a new uninitialized
1751 ;; variable. Return the local variable.
1752 ;;
1753 (define (module-ensure-local-variable! module symbol)
1754 (or (module-local-variable module symbol)
1755 (let ((var (make-undefined-variable)))
1756 (module-add! module symbol var)
1757 var)))
1758
1759 ;; module-add! module symbol var
1760 ;;
1761 ;; ensure a particular variable for V in the local namespace of M.
1762 ;;
1763 (define (module-add! m v var)
1764 (if (not (variable? var))
1765 (error "Bad variable to module-add!" var))
1766 (module-obarray-set! (module-obarray m) v var)
1767 (module-modified m))
1768
1769 ;; module-remove!
1770 ;;
1771 ;; make sure that a symbol is undefined in the local namespace of M.
1772 ;;
1773 (define (module-remove! m v)
1774 (module-obarray-remove! (module-obarray m) v)
1775 (module-modified m))
1776
1777 (define (module-clear! m)
1778 (hash-clear! (module-obarray m))
1779 (module-modified m))
1780
1781 ;; MODULE-FOR-EACH -- exported
1782 ;;
1783 ;; Call PROC on each symbol in MODULE, with arguments of (SYMBOL VARIABLE).
1784 ;;
1785 (define (module-for-each proc module)
1786 (hash-for-each proc (module-obarray module)))
1787
1788 (define (module-map proc module)
1789 (hash-map->list proc (module-obarray module)))
1790
1791 ;; Submodules
1792 ;;
1793 ;; Modules exist in a separate namespace from values, because you generally do
1794 ;; not want the name of a submodule, which you might not even use, to collide
1795 ;; with local variables that happen to be named the same as the submodule.
1796 ;;
1797 (define (module-ref-submodule module name)
1798 (or (hashq-ref (module-submodules module) name)
1799 (and (module-submodule-binder module)
1800 ((module-submodule-binder module) module name))))
1801
1802 (define (module-define-submodule! module name submodule)
1803 (hashq-set! (module-submodules module) name submodule))
1804
1805 ;; It used to be, however, that module names were also present in the
1806 ;; value namespace. When we enable deprecated code, we preserve this
1807 ;; legacy behavior.
1808 ;;
1809 ;; These shims are defined here instead of in deprecated.scm because we
1810 ;; need their definitions before loading other modules.
1811 ;;
1812 (begin-deprecated
1813 (define (module-ref-submodule module name)
1814 (or (hashq-ref (module-submodules module) name)
1815 (and (module-submodule-binder module)
1816 ((module-submodule-binder module) module name))
1817 (let ((var (module-local-variable module name)))
1818 (and var (variable-bound? var) (module? (variable-ref var))
1819 (begin
1820 (warn "module" module "not in submodules table")
1821 (variable-ref var))))))
1822
1823 (define (module-define-submodule! module name submodule)
1824 (let ((var (module-local-variable module name)))
1825 (if (and var
1826 (or (not (variable-bound? var))
1827 (not (module? (variable-ref var)))))
1828 (warn "defining module" module ": not overriding local definition" var)
1829 (module-define! module name submodule)))
1830 (hashq-set! (module-submodules module) name submodule)))
1831
1832 \f
1833
1834 ;;; {Module-based Loading}
1835 ;;;
1836
1837 (define (save-module-excursion thunk)
1838 (let ((inner-module (current-module))
1839 (outer-module #f))
1840 (dynamic-wind (lambda ()
1841 (set! outer-module (current-module))
1842 (set-current-module inner-module)
1843 (set! inner-module #f))
1844 thunk
1845 (lambda ()
1846 (set! inner-module (current-module))
1847 (set-current-module outer-module)
1848 (set! outer-module #f)))))
1849
1850 (define basic-load load)
1851
1852 (define* (load-module filename #:optional reader)
1853 (save-module-excursion
1854 (lambda ()
1855 (let ((oldname (and (current-load-port)
1856 (port-filename (current-load-port)))))
1857 (basic-load (if (and oldname
1858 (> (string-length filename) 0)
1859 (not (char=? (string-ref filename 0) #\/))
1860 (not (string=? (dirname oldname) ".")))
1861 (string-append (dirname oldname) "/" filename)
1862 filename)
1863 reader)))))
1864
1865
1866 \f
1867
1868 ;;; {MODULE-REF -- exported}
1869 ;;;
1870
1871 ;; Returns the value of a variable called NAME in MODULE or any of its
1872 ;; used modules. If there is no such variable, then if the optional third
1873 ;; argument DEFAULT is present, it is returned; otherwise an error is signaled.
1874 ;;
1875 (define (module-ref module name . rest)
1876 (let ((variable (module-variable module name)))
1877 (if (and variable (variable-bound? variable))
1878 (variable-ref variable)
1879 (if (null? rest)
1880 (error "No variable named" name 'in module)
1881 (car rest) ; default value
1882 ))))
1883
1884 ;; MODULE-SET! -- exported
1885 ;;
1886 ;; Sets the variable called NAME in MODULE (or in a module that MODULE uses)
1887 ;; to VALUE; if there is no such variable, an error is signaled.
1888 ;;
1889 (define (module-set! module name value)
1890 (let ((variable (module-variable module name)))
1891 (if variable
1892 (variable-set! variable value)
1893 (error "No variable named" name 'in module))))
1894
1895 ;; MODULE-DEFINE! -- exported
1896 ;;
1897 ;; Sets the variable called NAME in MODULE to VALUE; if there is no such
1898 ;; variable, it is added first.
1899 ;;
1900 (define (module-define! module name value)
1901 (let ((variable (module-local-variable module name)))
1902 (if variable
1903 (begin
1904 (variable-set! variable value)
1905 (module-modified module))
1906 (let ((variable (make-variable value)))
1907 (module-add! module name variable)))))
1908
1909 ;; MODULE-DEFINED? -- exported
1910 ;;
1911 ;; Return #t iff NAME is defined in MODULE (or in a module that MODULE
1912 ;; uses)
1913 ;;
1914 (define (module-defined? module name)
1915 (let ((variable (module-variable module name)))
1916 (and variable (variable-bound? variable))))
1917
1918 ;; MODULE-USE! module interface
1919 ;;
1920 ;; Add INTERFACE to the list of interfaces used by MODULE.
1921 ;;
1922 (define (module-use! module interface)
1923 (if (not (or (eq? module interface)
1924 (memq interface (module-uses module))))
1925 (begin
1926 ;; Newly used modules must be appended rather than consed, so that
1927 ;; `module-variable' traverses the use list starting from the first
1928 ;; used module.
1929 (set-module-uses! module
1930 (append (filter (lambda (m)
1931 (not
1932 (equal? (module-name m)
1933 (module-name interface))))
1934 (module-uses module))
1935 (list interface)))
1936 (hash-clear! (module-import-obarray module))
1937 (module-modified module))))
1938
1939 ;; MODULE-USE-INTERFACES! module interfaces
1940 ;;
1941 ;; Same as MODULE-USE! but add multiple interfaces and check for duplicates
1942 ;;
1943 (define (module-use-interfaces! module interfaces)
1944 (set-module-uses! module
1945 (append (module-uses module) interfaces))
1946 (hash-clear! (module-import-obarray module))
1947 (module-modified module))
1948
1949 \f
1950
1951 ;;; {Recursive Namespaces}
1952 ;;;
1953 ;;; A hierarchical namespace emerges if we consider some module to be
1954 ;;; root, and submodules of that module to be nested namespaces.
1955 ;;;
1956 ;;; The routines here manage variable names in hierarchical namespace.
1957 ;;; Each variable name is a list of elements, looked up in successively nested
1958 ;;; modules.
1959 ;;;
1960 ;;; (nested-ref some-root-module '(foo bar baz))
1961 ;;; => <value of a variable named baz in the submodule bar of
1962 ;;; the submodule foo of some-root-module>
1963 ;;;
1964 ;;;
1965 ;;; There are:
1966 ;;;
1967 ;;; ;; a-root is a module
1968 ;;; ;; name is a list of symbols
1969 ;;;
1970 ;;; nested-ref a-root name
1971 ;;; nested-set! a-root name val
1972 ;;; nested-define! a-root name val
1973 ;;; nested-remove! a-root name
1974 ;;;
1975 ;;; These functions manipulate values in namespaces. For referencing the
1976 ;;; namespaces themselves, use the following:
1977 ;;;
1978 ;;; nested-ref-module a-root name
1979 ;;; nested-define-module! a-root name mod
1980 ;;;
1981 ;;; (current-module) is a natural choice for a root so for convenience there are
1982 ;;; also:
1983 ;;;
1984 ;;; local-ref name == nested-ref (current-module) name
1985 ;;; local-set! name val == nested-set! (current-module) name val
1986 ;;; local-define name val == nested-define! (current-module) name val
1987 ;;; local-remove name == nested-remove! (current-module) name
1988 ;;; local-ref-module name == nested-ref-module (current-module) name
1989 ;;; local-define-module! name m == nested-define-module! (current-module) name m
1990 ;;;
1991
1992
1993 (define (nested-ref root names)
1994 (if (null? names)
1995 root
1996 (let loop ((cur root)
1997 (head (car names))
1998 (tail (cdr names)))
1999 (if (null? tail)
2000 (module-ref cur head #f)
2001 (let ((cur (module-ref-submodule cur head)))
2002 (and cur
2003 (loop cur (car tail) (cdr tail))))))))
2004
2005 (define (nested-set! root names val)
2006 (let loop ((cur root)
2007 (head (car names))
2008 (tail (cdr names)))
2009 (if (null? tail)
2010 (module-set! cur head val)
2011 (let ((cur (module-ref-submodule cur head)))
2012 (if (not cur)
2013 (error "failed to resolve module" names)
2014 (loop cur (car tail) (cdr tail)))))))
2015
2016 (define (nested-define! root names val)
2017 (let loop ((cur root)
2018 (head (car names))
2019 (tail (cdr names)))
2020 (if (null? tail)
2021 (module-define! cur head val)
2022 (let ((cur (module-ref-submodule cur head)))
2023 (if (not cur)
2024 (error "failed to resolve module" names)
2025 (loop cur (car tail) (cdr tail)))))))
2026
2027 (define (nested-remove! root names)
2028 (let loop ((cur root)
2029 (head (car names))
2030 (tail (cdr names)))
2031 (if (null? tail)
2032 (module-remove! cur head)
2033 (let ((cur (module-ref-submodule cur head)))
2034 (if (not cur)
2035 (error "failed to resolve module" names)
2036 (loop cur (car tail) (cdr tail)))))))
2037
2038
2039 (define (nested-ref-module root names)
2040 (let loop ((cur root)
2041 (names names))
2042 (if (null? names)
2043 cur
2044 (let ((cur (module-ref-submodule cur (car names))))
2045 (and cur
2046 (loop cur (cdr names)))))))
2047
2048 (define (nested-define-module! root names module)
2049 (if (null? names)
2050 (error "can't redefine root module" root module)
2051 (let loop ((cur root)
2052 (head (car names))
2053 (tail (cdr names)))
2054 (if (null? tail)
2055 (module-define-submodule! cur head module)
2056 (let ((cur (or (module-ref-submodule cur head)
2057 (let ((m (make-module 31)))
2058 (set-module-kind! m 'directory)
2059 (set-module-name! m (append (module-name cur)
2060 (list head)))
2061 (module-define-submodule! cur head m)
2062 m))))
2063 (loop cur (car tail) (cdr tail)))))))
2064
2065
2066 (define (local-ref names)
2067 (nested-ref (current-module) names))
2068
2069 (define (local-set! names val)
2070 (nested-set! (current-module) names val))
2071
2072 (define (local-define names val)
2073 (nested-define! (current-module) names val))
2074
2075 (define (local-remove names)
2076 (nested-remove! (current-module) names))
2077
2078 (define (local-ref-module names)
2079 (nested-ref-module (current-module) names))
2080
2081 (define (local-define-module names mod)
2082 (nested-define-module! (current-module) names mod))
2083
2084
2085
2086 \f
2087
2088 ;;; {The (guile) module}
2089 ;;;
2090 ;;; The standard module, which has the core Guile bindings. Also called the
2091 ;;; "root module", as it is imported by many other modules, but it is not
2092 ;;; necessarily the root of anything; and indeed, the module named '() might be
2093 ;;; better thought of as a root.
2094 ;;;
2095
2096 (define (set-system-module! m s)
2097 (set-procedure-property! (module-eval-closure m) 'system-module s))
2098
2099 ;; The root module uses the pre-modules-obarray as its obarray. This
2100 ;; special obarray accumulates all bindings that have been established
2101 ;; before the module system is fully booted.
2102 ;;
2103 ;; (The obarray continues to be used by code that has been closed over
2104 ;; before the module system has been booted.)
2105 ;;
2106 (define the-root-module
2107 (let ((m (make-module 0)))
2108 (set-module-obarray! m (%get-pre-modules-obarray))
2109 (set-module-name! m '(guile))
2110 (set-system-module! m #t)
2111 m))
2112
2113 ;; The root interface is a module that uses the same obarray as the
2114 ;; root module. It does not allow new definitions, tho.
2115 ;;
2116 (define the-scm-module
2117 (let ((m (make-module 0)))
2118 (set-module-obarray! m (%get-pre-modules-obarray))
2119 (set-module-eval-closure! m (standard-interface-eval-closure m))
2120 (set-module-name! m '(guile))
2121 (set-module-kind! m 'interface)
2122 (set-system-module! m #t)
2123 m))
2124
2125 (set-module-public-interface! the-root-module the-scm-module)
2126
2127 \f
2128
2129 ;; Now that we have a root module, even though modules aren't fully booted,
2130 ;; expand the definition of resolve-module.
2131 ;;
2132 (define (resolve-module name . args)
2133 (if (equal? name '(guile))
2134 the-root-module
2135 (error "unexpected module to resolve during module boot" name)))
2136
2137 ;; Cheat. These bindings are needed by modules.c, but we don't want
2138 ;; to move their real definition here because that would be unnatural.
2139 ;;
2140 (define define-module* #f)
2141 (define process-use-modules #f)
2142 (define module-export! #f)
2143 (define default-duplicate-binding-procedures #f)
2144
2145 ;; This boots the module system. All bindings needed by modules.c
2146 ;; must have been defined by now.
2147 ;;
2148 (set-current-module the-root-module)
2149
2150
2151 \f
2152
2153 ;; Now that modules are booted, give module-name its final definition.
2154 ;;
2155 (define module-name
2156 (let ((accessor (record-accessor module-type 'name)))
2157 (lambda (mod)
2158 (or (accessor mod)
2159 (let ((name (list (gensym))))
2160 ;; Name MOD and bind it in the module root so that it's visible to
2161 ;; `resolve-module'. This is important as `psyntax' stores module
2162 ;; names and relies on being able to `resolve-module' them.
2163 (set-module-name! mod name)
2164 (nested-define-module! (resolve-module '() #f) name mod)
2165 (accessor mod))))))
2166
2167 (define (make-modules-in module name)
2168 (or (nested-ref-module module name)
2169 (let ((m (make-module 31)))
2170 (set-module-kind! m 'directory)
2171 (set-module-name! m (append (module-name module) name))
2172 (nested-define-module! module name m)
2173 m)))
2174
2175 (define (beautify-user-module! module)
2176 (let ((interface (module-public-interface module)))
2177 (if (or (not interface)
2178 (eq? interface module))
2179 (let ((interface (make-module 31)))
2180 (set-module-name! interface (module-name module))
2181 (set-module-version! interface (module-version module))
2182 (set-module-kind! interface 'interface)
2183 (set-module-public-interface! module interface))))
2184 (if (and (not (memq the-scm-module (module-uses module)))
2185 (not (eq? module the-root-module)))
2186 ;; Import the default set of bindings (from the SCM module) in MODULE.
2187 (module-use! module the-scm-module)))
2188
2189 (define (version-matches? version-ref target)
2190 (define (sub-versions-match? v-refs t)
2191 (define (sub-version-matches? v-ref t)
2192 (let ((matches? (lambda (v) (sub-version-matches? v t))))
2193 (cond
2194 ((number? v-ref) (eqv? v-ref t))
2195 ((list? v-ref)
2196 (case (car v-ref)
2197 ((>=) (>= t (cadr v-ref)))
2198 ((<=) (<= t (cadr v-ref)))
2199 ((and) (and-map matches? (cdr v-ref)))
2200 ((or) (or-map matches? (cdr v-ref)))
2201 ((not) (not (matches? (cadr v-ref))))
2202 (else (error "Invalid sub-version reference" v-ref))))
2203 (else (error "Invalid sub-version reference" v-ref)))))
2204 (or (null? v-refs)
2205 (and (not (null? t))
2206 (sub-version-matches? (car v-refs) (car t))
2207 (sub-versions-match? (cdr v-refs) (cdr t)))))
2208
2209 (let ((matches? (lambda (v) (version-matches? v target))))
2210 (or (null? version-ref)
2211 (case (car version-ref)
2212 ((and) (and-map matches? (cdr version-ref)))
2213 ((or) (or-map matches? (cdr version-ref)))
2214 ((not) (not (matches? (cadr version-ref))))
2215 (else (sub-versions-match? version-ref target))))))
2216
2217 (define (make-fresh-user-module)
2218 (let ((m (make-module)))
2219 (beautify-user-module! m)
2220 m))
2221
2222 ;; NOTE: This binding is used in libguile/modules.c.
2223 ;;
2224 (define resolve-module
2225 (let ((root (make-module)))
2226 (set-module-name! root '())
2227 ;; Define the-root-module as '(guile).
2228 (module-define-submodule! root 'guile the-root-module)
2229
2230 (lambda* (name #:optional (autoload #t) (version #f) #:key (ensure #t))
2231 (let ((already (nested-ref-module root name)))
2232 (cond
2233 ((and already
2234 (or (not autoload) (module-public-interface already)))
2235 ;; A hit, a palpable hit.
2236 (if (and version
2237 (not (version-matches? version (module-version already))))
2238 (error "incompatible module version already loaded" name))
2239 already)
2240 (autoload
2241 ;; Try to autoload the module, and recurse.
2242 (try-load-module name version)
2243 (resolve-module name #f #:ensure ensure))
2244 (else
2245 ;; No module found (or if one was, it had no public interface), and
2246 ;; we're not autoloading. Make an empty module if #:ensure is true.
2247 (or already
2248 (and ensure
2249 (make-modules-in root name)))))))))
2250
2251
2252 (define (try-load-module name version)
2253 (try-module-autoload name version))
2254
2255 (define (reload-module m)
2256 (let ((f (module-filename m)))
2257 (if f
2258 (save-module-excursion
2259 (lambda ()
2260 ;; Re-set the initial environment, as in try-module-autoload.
2261 (set-current-module (make-fresh-user-module))
2262 (primitive-load-path f)
2263 m))
2264 ;; Though we could guess, we *should* know it.
2265 (error "unknown file name for module" m))))
2266
2267 (define (purify-module! module)
2268 "Removes bindings in MODULE which are inherited from the (guile) module."
2269 (let ((use-list (module-uses module)))
2270 (if (and (pair? use-list)
2271 (eq? (car (last-pair use-list)) the-scm-module))
2272 (set-module-uses! module (reverse (cdr (reverse use-list)))))))
2273
2274 ;; Return a module that is an interface to the module designated by
2275 ;; NAME.
2276 ;;
2277 ;; `resolve-interface' takes four keyword arguments:
2278 ;;
2279 ;; #:select SELECTION
2280 ;;
2281 ;; SELECTION is a list of binding-specs to be imported; A binding-spec
2282 ;; is either a symbol or a pair of symbols (ORIG . SEEN), where ORIG
2283 ;; is the name in the used module and SEEN is the name in the using
2284 ;; module. Note that SEEN is also passed through RENAMER, below. The
2285 ;; default is to select all bindings. If you specify no selection but
2286 ;; a renamer, only the bindings that already exist in the used module
2287 ;; are made available in the interface. Bindings that are added later
2288 ;; are not picked up.
2289 ;;
2290 ;; #:hide BINDINGS
2291 ;;
2292 ;; BINDINGS is a list of bindings which should not be imported.
2293 ;;
2294 ;; #:prefix PREFIX
2295 ;;
2296 ;; PREFIX is a symbol that will be appended to each exported name.
2297 ;; The default is to not perform any renaming.
2298 ;;
2299 ;; #:renamer RENAMER
2300 ;;
2301 ;; RENAMER is a procedure that takes a symbol and returns its new
2302 ;; name. The default is not perform any renaming.
2303 ;;
2304 ;; Signal "no code for module" error if module name is not resolvable
2305 ;; or its public interface is not available. Signal "no binding"
2306 ;; error if selected binding does not exist in the used module.
2307 ;;
2308 (define* (resolve-interface name #:key
2309 (select #f)
2310 (hide '())
2311 (prefix #f)
2312 (renamer (if prefix
2313 (symbol-prefix-proc prefix)
2314 identity))
2315 version)
2316 (let* ((module (resolve-module name #t version #:ensure #f))
2317 (public-i (and module (module-public-interface module))))
2318 (and (or (not module) (not public-i))
2319 (error "no code for module" name))
2320 (if (and (not select) (null? hide) (eq? renamer identity))
2321 public-i
2322 (let ((selection (or select (module-map (lambda (sym var) sym)
2323 public-i)))
2324 (custom-i (make-module 31)))
2325 (set-module-kind! custom-i 'custom-interface)
2326 (set-module-name! custom-i name)
2327 ;; XXX - should use a lazy binder so that changes to the
2328 ;; used module are picked up automatically.
2329 (for-each (lambda (bspec)
2330 (let* ((direct? (symbol? bspec))
2331 (orig (if direct? bspec (car bspec)))
2332 (seen (if direct? bspec (cdr bspec)))
2333 (var (or (module-local-variable public-i orig)
2334 (module-local-variable module orig)
2335 (error
2336 ;; fixme: format manually for now
2337 (simple-format
2338 #f "no binding `~A' in module ~A"
2339 orig name)))))
2340 (if (memq orig hide)
2341 (set! hide (delq! orig hide))
2342 (module-add! custom-i
2343 (renamer seen)
2344 var))))
2345 selection)
2346 ;; Check that we are not hiding bindings which don't exist
2347 (for-each (lambda (binding)
2348 (if (not (module-local-variable public-i binding))
2349 (error
2350 (simple-format
2351 #f "no binding `~A' to hide in module ~A"
2352 binding name))))
2353 hide)
2354 custom-i))))
2355
2356 (define (symbol-prefix-proc prefix)
2357 (lambda (symbol)
2358 (symbol-append prefix symbol)))
2359
2360 ;; This function is called from "modules.c". If you change it, be
2361 ;; sure to update "modules.c" as well.
2362
2363 (define* (define-module* name
2364 #:key filename pure version (duplicates '())
2365 (imports '()) (exports '()) (replacements '())
2366 (re-exports '()) (autoloads '()) transformer)
2367 (define (list-of pred l)
2368 (or (null? l)
2369 (and (pair? l) (pred (car l)) (list-of pred (cdr l)))))
2370 (define (valid-export? x)
2371 (or (symbol? x) (and (pair? x) (symbol? (car x)) (symbol? (cdr x)))))
2372 (define (valid-autoload? x)
2373 (and (pair? x) (list-of symbol? (car x)) (list-of symbol? (cdr x))))
2374
2375 (define (resolve-imports imports)
2376 (define (resolve-import import-spec)
2377 (if (list? import-spec)
2378 (apply resolve-interface import-spec)
2379 (error "unexpected use-module specification" import-spec)))
2380 (let lp ((imports imports) (out '()))
2381 (cond
2382 ((null? imports) (reverse! out))
2383 ((pair? imports)
2384 (lp (cdr imports)
2385 (cons (resolve-import (car imports)) out)))
2386 (else (error "unexpected tail of imports list" imports)))))
2387
2388 ;; We could add a #:no-check arg, set by the define-module macro, if
2389 ;; these checks are taking too much time.
2390 ;;
2391 (let ((module (resolve-module name #f)))
2392 (beautify-user-module! module)
2393 (if filename
2394 (set-module-filename! module filename))
2395 (if pure
2396 (purify-module! module))
2397 (if version
2398 (begin
2399 (if (not (list-of integer? version))
2400 (error "expected list of integers for version"))
2401 (set-module-version! module version)
2402 (set-module-version! (module-public-interface module) version)))
2403 (if (pair? duplicates)
2404 (let ((handlers (lookup-duplicates-handlers duplicates)))
2405 (set-module-duplicates-handlers! module handlers)))
2406
2407 (let ((imports (resolve-imports imports)))
2408 (call-with-deferred-observers
2409 (lambda ()
2410 (if (pair? imports)
2411 (module-use-interfaces! module imports))
2412 (if (list-of valid-export? exports)
2413 (if (pair? exports)
2414 (module-export! module exports))
2415 (error "expected exports to be a list of symbols or symbol pairs"))
2416 (if (list-of valid-export? replacements)
2417 (if (pair? replacements)
2418 (module-replace! module replacements))
2419 (error "expected replacements to be a list of symbols or symbol pairs"))
2420 (if (list-of valid-export? re-exports)
2421 (if (pair? re-exports)
2422 (module-re-export! module re-exports))
2423 (error "expected re-exports to be a list of symbols or symbol pairs"))
2424 ;; FIXME
2425 (if (not (null? autoloads))
2426 (apply module-autoload! module autoloads)))))
2427
2428 (if transformer
2429 (if (and (pair? transformer) (list-of symbol? transformer))
2430 (let ((iface (resolve-interface transformer))
2431 (sym (car (last-pair transformer))))
2432 (set-module-transformer! module (module-ref iface sym)))
2433 (error "expected transformer to be a module name" transformer)))
2434
2435 (run-hook module-defined-hook module)
2436 module))
2437
2438 ;; `module-defined-hook' is a hook that is run whenever a new module
2439 ;; is defined. Its members are called with one argument, the new
2440 ;; module.
2441 (define module-defined-hook (make-hook 1))
2442
2443 \f
2444
2445 ;;; {Autoload}
2446 ;;;
2447
2448 (define (make-autoload-interface module name bindings)
2449 (let ((b (lambda (a sym definep)
2450 (and (memq sym bindings)
2451 (let ((i (module-public-interface (resolve-module name))))
2452 (if (not i)
2453 (error "missing interface for module" name))
2454 (let ((autoload (memq a (module-uses module))))
2455 ;; Replace autoload-interface with actual interface if
2456 ;; that has not happened yet.
2457 (if (pair? autoload)
2458 (set-car! autoload i)))
2459 (module-local-variable i sym))))))
2460 (module-constructor (make-hash-table 0) '() b #f #f name 'autoload #f
2461 (make-hash-table 0) '() (make-weak-value-hash-table 31) #f
2462 (make-hash-table 0) #f #f #f)))
2463
2464 (define (module-autoload! module . args)
2465 "Have @var{module} automatically load the module named @var{name} when one
2466 of the symbols listed in @var{bindings} is looked up. @var{args} should be a
2467 list of module-name/binding-list pairs, e.g., as in @code{(module-autoload!
2468 module '(ice-9 q) '(make-q q-length))}."
2469 (let loop ((args args))
2470 (cond ((null? args)
2471 #t)
2472 ((null? (cdr args))
2473 (error "invalid name+binding autoload list" args))
2474 (else
2475 (let ((name (car args))
2476 (bindings (cadr args)))
2477 (module-use! module (make-autoload-interface module
2478 name bindings))
2479 (loop (cddr args)))))))
2480
2481
2482 \f
2483
2484 ;;; {Autoloading modules}
2485 ;;;
2486
2487 (define autoloads-in-progress '())
2488
2489 ;; This function is called from "modules.c". If you change it, be
2490 ;; sure to update "modules.c" as well.
2491
2492 (define* (try-module-autoload module-name #:optional version)
2493 (let* ((reverse-name (reverse module-name))
2494 (name (symbol->string (car reverse-name)))
2495 (dir-hint-module-name (reverse (cdr reverse-name)))
2496 (dir-hint (apply string-append
2497 (map (lambda (elt)
2498 (string-append (symbol->string elt) "/"))
2499 dir-hint-module-name))))
2500 (resolve-module dir-hint-module-name #f)
2501 (and (not (autoload-done-or-in-progress? dir-hint name))
2502 (let ((didit #f))
2503 (dynamic-wind
2504 (lambda () (autoload-in-progress! dir-hint name))
2505 (lambda ()
2506 (with-fluids ((current-reader #f))
2507 (save-module-excursion
2508 (lambda ()
2509 ;; The initial environment when loading a module is a fresh
2510 ;; user module.
2511 (set-current-module (make-fresh-user-module))
2512 ;; Here we could allow some other search strategy (other than
2513 ;; primitive-load-path), for example using versions encoded
2514 ;; into the file system -- but then we would have to figure
2515 ;; out how to locate the compiled file, do autocompilation,
2516 ;; etc. Punt for now, and don't use versions when locating
2517 ;; the file.
2518 (primitive-load-path (in-vicinity dir-hint name) #f)
2519 (set! didit #t)))))
2520 (lambda () (set-autoloaded! dir-hint name didit)))
2521 didit))))
2522
2523 \f
2524
2525 ;;; {Dynamic linking of modules}
2526 ;;;
2527
2528 (define autoloads-done '((guile . guile)))
2529
2530 (define (autoload-done-or-in-progress? p m)
2531 (let ((n (cons p m)))
2532 (->bool (or (member n autoloads-done)
2533 (member n autoloads-in-progress)))))
2534
2535 (define (autoload-done! p m)
2536 (let ((n (cons p m)))
2537 (set! autoloads-in-progress
2538 (delete! n autoloads-in-progress))
2539 (or (member n autoloads-done)
2540 (set! autoloads-done (cons n autoloads-done)))))
2541
2542 (define (autoload-in-progress! p m)
2543 (let ((n (cons p m)))
2544 (set! autoloads-done
2545 (delete! n autoloads-done))
2546 (set! autoloads-in-progress (cons n autoloads-in-progress))))
2547
2548 (define (set-autoloaded! p m done?)
2549 (if done?
2550 (autoload-done! p m)
2551 (let ((n (cons p m)))
2552 (set! autoloads-done (delete! n autoloads-done))
2553 (set! autoloads-in-progress (delete! n autoloads-in-progress)))))
2554
2555 \f
2556
2557 ;;; {Run-time options}
2558 ;;;
2559
2560 (define-syntax define-option-interface
2561 (syntax-rules ()
2562 ((_ (interface (options enable disable) (option-set!)))
2563 (begin
2564 (define options
2565 (case-lambda
2566 (() (interface))
2567 ((arg)
2568 (if (list? arg)
2569 (begin (interface arg) (interface))
2570 (for-each
2571 (lambda (option)
2572 (apply (lambda (name value documentation)
2573 (display name)
2574 (if (< (string-length (symbol->string name)) 8)
2575 (display #\tab))
2576 (display #\tab)
2577 (display value)
2578 (display #\tab)
2579 (display documentation)
2580 (newline))
2581 option))
2582 (interface #t))))))
2583 (define (enable . flags)
2584 (interface (append flags (interface)))
2585 (interface))
2586 (define (disable . flags)
2587 (let ((options (interface)))
2588 (for-each (lambda (flag) (set! options (delq! flag options)))
2589 flags)
2590 (interface options)
2591 (interface)))
2592 (define-syntax option-set!
2593 (syntax-rules ()
2594 ((_ opt val)
2595 (eval-when (eval load compile expand)
2596 (options (append (options) (list 'opt val)))))))))))
2597
2598 (define-option-interface
2599 (debug-options-interface
2600 (debug-options debug-enable debug-disable)
2601 (debug-set!)))
2602
2603 (define-option-interface
2604 (read-options-interface
2605 (read-options read-enable read-disable)
2606 (read-set!)))
2607
2608 (define-option-interface
2609 (print-options-interface
2610 (print-options print-enable print-disable)
2611 (print-set!)))
2612
2613 \f
2614
2615 ;;; {The Unspecified Value}
2616 ;;;
2617 ;;; Currently Guile represents unspecified values via one particular value,
2618 ;;; which may be obtained by evaluating (if #f #f). It would be nice in the
2619 ;;; future if we could replace this with a return of 0 values, though.
2620 ;;;
2621
2622 (define-syntax *unspecified*
2623 (identifier-syntax (if #f #f)))
2624
2625 (define (unspecified? v) (eq? v *unspecified*))
2626
2627
2628 \f
2629
2630 ;;; {Running Repls}
2631 ;;;
2632
2633 (define *repl-stack* (make-fluid))
2634
2635 ;; Programs can call `batch-mode?' to see if they are running as part of a
2636 ;; script or if they are running interactively. REPL implementations ensure that
2637 ;; `batch-mode?' returns #f during their extent.
2638 ;;
2639 (define (batch-mode?)
2640 (null? (or (fluid-ref *repl-stack*) '())))
2641
2642 ;; Programs can re-enter batch mode, for example after a fork, by calling
2643 ;; `ensure-batch-mode!'. It's not a great interface, though; it would be better
2644 ;; to abort to the outermost prompt, and call a thunk there.
2645 ;;
2646 (define (ensure-batch-mode!)
2647 (set! batch-mode? (lambda () #t)))
2648
2649 (define (quit . args)
2650 (apply throw 'quit args))
2651
2652 (define exit quit)
2653
2654 (define (gc-run-time)
2655 (cdr (assq 'gc-time-taken (gc-stats))))
2656
2657 (define abort-hook (make-hook))
2658 (define before-error-hook (make-hook))
2659 (define after-error-hook (make-hook))
2660 (define before-backtrace-hook (make-hook))
2661 (define after-backtrace-hook (make-hook))
2662
2663 (define before-read-hook (make-hook))
2664 (define after-read-hook (make-hook))
2665 (define before-eval-hook (make-hook 1))
2666 (define after-eval-hook (make-hook 1))
2667 (define before-print-hook (make-hook 1))
2668 (define after-print-hook (make-hook 1))
2669
2670 ;;; This hook is run at the very end of an interactive session.
2671 ;;;
2672 (define exit-hook (make-hook))
2673
2674 ;;; The default repl-reader function. We may override this if we've
2675 ;;; the readline library.
2676 (define repl-reader
2677 (lambda* (prompt #:optional (reader (fluid-ref current-reader)))
2678 (if (not (char-ready?))
2679 (display (if (string? prompt) prompt (prompt))))
2680 (force-output)
2681 (run-hook before-read-hook)
2682 ((or reader read) (current-input-port))))
2683
2684
2685 \f
2686
2687 ;;; {IOTA functions: generating lists of numbers}
2688 ;;;
2689
2690 (define (iota n)
2691 (let loop ((count (1- n)) (result '()))
2692 (if (< count 0) result
2693 (loop (1- count) (cons count result)))))
2694
2695 \f
2696
2697 ;;; {While}
2698 ;;;
2699 ;;; with `continue' and `break'.
2700 ;;;
2701
2702 ;; The inliner will remove the prompts at compile-time if it finds that
2703 ;; `continue' or `break' are not used.
2704 ;;
2705 (define-syntax while
2706 (lambda (x)
2707 (syntax-case x ()
2708 ((while cond body ...)
2709 #`(let ((break-tag (make-prompt-tag "break"))
2710 (continue-tag (make-prompt-tag "continue")))
2711 (call-with-prompt
2712 break-tag
2713 (lambda ()
2714 (define-syntax #,(datum->syntax #'while 'break)
2715 (lambda (x)
2716 (syntax-case x ()
2717 ((_)
2718 #'(abort-to-prompt break-tag))
2719 ((_ . args)
2720 (syntax-violation 'break "too many arguments" x))
2721 (_
2722 #'(lambda ()
2723 (abort-to-prompt break-tag))))))
2724 (let lp ()
2725 (call-with-prompt
2726 continue-tag
2727 (lambda ()
2728 (define-syntax #,(datum->syntax #'while 'continue)
2729 (lambda (x)
2730 (syntax-case x ()
2731 ((_)
2732 #'(abort-to-prompt continue-tag))
2733 ((_ . args)
2734 (syntax-violation 'continue "too many arguments" x))
2735 (_
2736 #'(lambda args
2737 (apply abort-to-prompt continue-tag args))))))
2738 (do () ((not cond)) body ...))
2739 (lambda (k) (lp)))))
2740 (lambda (k)
2741 #t)))))))
2742
2743
2744 \f
2745
2746 ;;; {Module System Macros}
2747 ;;;
2748
2749 ;; Return a list of expressions that evaluate to the appropriate
2750 ;; arguments for resolve-interface according to SPEC.
2751
2752 (eval-when (compile)
2753 (if (memq 'prefix (read-options))
2754 (error "boot-9 must be compiled with #:kw, not :kw")))
2755
2756 (define (keyword-like-symbol->keyword sym)
2757 (symbol->keyword (string->symbol (substring (symbol->string sym) 1))))
2758
2759 (define-syntax define-module
2760 (lambda (x)
2761 (define (keyword-like? stx)
2762 (let ((dat (syntax->datum stx)))
2763 (and (symbol? dat)
2764 (eqv? (string-ref (symbol->string dat) 0) #\:))))
2765 (define (->keyword sym)
2766 (symbol->keyword (string->symbol (substring (symbol->string sym) 1))))
2767
2768 (define (parse-iface args)
2769 (let loop ((in args) (out '()))
2770 (syntax-case in ()
2771 (() (reverse! out))
2772 ;; The user wanted #:foo, but wrote :foo. Fix it.
2773 ((sym . in) (keyword-like? #'sym)
2774 (loop #`(#,(->keyword (syntax->datum #'sym)) . in) out))
2775 ((kw . in) (not (keyword? (syntax->datum #'kw)))
2776 (syntax-violation 'define-module "expected keyword arg" x #'kw))
2777 ((#:renamer renamer . in)
2778 (loop #'in (cons* #',renamer #:renamer out)))
2779 ((kw val . in)
2780 (loop #'in (cons* #'val #'kw out))))))
2781
2782 (define (parse args imp exp rex rep aut)
2783 ;; Just quote everything except #:use-module and #:use-syntax. We
2784 ;; need to know about all arguments regardless since we want to turn
2785 ;; symbols that look like keywords into real keywords, and the
2786 ;; keyword args in a define-module form are not regular
2787 ;; (i.e. no-backtrace doesn't take a value).
2788 (syntax-case args ()
2789 (()
2790 (let ((imp (if (null? imp) '() #`(#:imports `#,imp)))
2791 (exp (if (null? exp) '() #`(#:exports '#,exp)))
2792 (rex (if (null? rex) '() #`(#:re-exports '#,rex)))
2793 (rep (if (null? rep) '() #`(#:replacements '#,rep)))
2794 (aut (if (null? aut) '() #`(#:autoloads '#,aut))))
2795 #`(#,@imp #,@exp #,@rex #,@rep #,@aut)))
2796 ;; The user wanted #:foo, but wrote :foo. Fix it.
2797 ((sym . args) (keyword-like? #'sym)
2798 (parse #`(#,(->keyword (syntax->datum #'sym)) . args)
2799 imp exp rex rep aut))
2800 ((kw . args) (not (keyword? (syntax->datum #'kw)))
2801 (syntax-violation 'define-module "expected keyword arg" x #'kw))
2802 ((#:no-backtrace . args)
2803 ;; Ignore this one.
2804 (parse #'args imp exp rex rep aut))
2805 ((#:pure . args)
2806 #`(#:pure #t . #,(parse #'args imp exp rex rep aut)))
2807 ((kw)
2808 (syntax-violation 'define-module "keyword arg without value" x #'kw))
2809 ((#:version (v ...) . args)
2810 #`(#:version '(v ...) . #,(parse #'args imp exp rex rep aut)))
2811 ((#:duplicates (d ...) . args)
2812 #`(#:duplicates '(d ...) . #,(parse #'args imp exp rex rep aut)))
2813 ((#:filename f . args)
2814 #`(#:filename 'f . #,(parse #'args imp exp rex rep aut)))
2815 ((#:use-module (name name* ...) . args)
2816 (and (and-map symbol? (syntax->datum #'(name name* ...))))
2817 (parse #'args (cons #'((name name* ...)) imp) exp rex rep aut))
2818 ((#:use-syntax (name name* ...) . args)
2819 (and (and-map symbol? (syntax->datum #'(name name* ...))))
2820 #`(#:transformer '(name name* ...)
2821 . #,(parse #'args (cons #'((name name* ...)) imp) exp rex rep aut)))
2822 ((#:use-module ((name name* ...) arg ...) . args)
2823 (and (and-map symbol? (syntax->datum #'(name name* ...))))
2824 (parse #'args
2825 (cons #`((name name* ...) #,@(parse-iface #'(arg ...))) imp)
2826 exp rex rep aut))
2827 ((#:export (ex ...) . args)
2828 (parse #'args imp #`(#,@exp ex ...) rex rep aut))
2829 ((#:export-syntax (ex ...) . args)
2830 (parse #'args imp #`(#,@exp ex ...) rex rep aut))
2831 ((#:re-export (re ...) . args)
2832 (parse #'args imp exp #`(#,@rex re ...) rep aut))
2833 ((#:re-export-syntax (re ...) . args)
2834 (parse #'args imp exp #`(#,@rex re ...) rep aut))
2835 ((#:replace (r ...) . args)
2836 (parse #'args imp exp rex #`(#,@rep r ...) aut))
2837 ((#:replace-syntax (r ...) . args)
2838 (parse #'args imp exp rex #`(#,@rep r ...) aut))
2839 ((#:autoload name bindings . args)
2840 (parse #'args imp exp rex rep #`(#,@aut name bindings)))
2841 ((kw val . args)
2842 (syntax-violation 'define-module "unknown keyword or bad argument"
2843 #'kw #'val))))
2844
2845 (syntax-case x ()
2846 ((_ (name name* ...) arg ...)
2847 (and-map symbol? (syntax->datum #'(name name* ...)))
2848 (with-syntax (((quoted-arg ...)
2849 (parse #'(arg ...) '() '() '() '() '()))
2850 (filename (assq-ref (or (syntax-source x) '())
2851 'filename)))
2852 #'(eval-when (eval load compile expand)
2853 (let ((m (define-module* '(name name* ...)
2854 #:filename filename quoted-arg ...)))
2855 (set-current-module m)
2856 m)))))))
2857
2858 ;; The guts of the use-modules macro. Add the interfaces of the named
2859 ;; modules to the use-list of the current module, in order.
2860
2861 ;; This function is called by "modules.c". If you change it, be sure
2862 ;; to change scm_c_use_module as well.
2863
2864 (define (process-use-modules module-interface-args)
2865 (let ((interfaces (map (lambda (mif-args)
2866 (or (apply resolve-interface mif-args)
2867 (error "no such module" mif-args)))
2868 module-interface-args)))
2869 (call-with-deferred-observers
2870 (lambda ()
2871 (module-use-interfaces! (current-module) interfaces)))))
2872
2873 (define-syntax use-modules
2874 (lambda (x)
2875 (define (keyword-like? stx)
2876 (let ((dat (syntax->datum stx)))
2877 (and (symbol? dat)
2878 (eqv? (string-ref (symbol->string dat) 0) #\:))))
2879 (define (->keyword sym)
2880 (symbol->keyword (string->symbol (substring (symbol->string sym) 1))))
2881
2882 (define (quotify-iface args)
2883 (let loop ((in args) (out '()))
2884 (syntax-case in ()
2885 (() (reverse! out))
2886 ;; The user wanted #:foo, but wrote :foo. Fix it.
2887 ((sym . in) (keyword-like? #'sym)
2888 (loop #`(#,(->keyword (syntax->datum #'sym)) . in) out))
2889 ((kw . in) (not (keyword? (syntax->datum #'kw)))
2890 (syntax-violation 'define-module "expected keyword arg" x #'kw))
2891 ((#:renamer renamer . in)
2892 (loop #'in (cons* #'renamer #:renamer out)))
2893 ((kw val . in)
2894 (loop #'in (cons* #''val #'kw out))))))
2895
2896 (define (quotify specs)
2897 (let lp ((in specs) (out '()))
2898 (syntax-case in ()
2899 (() (reverse out))
2900 (((name name* ...) . in)
2901 (and-map symbol? (syntax->datum #'(name name* ...)))
2902 (lp #'in (cons #''((name name* ...)) out)))
2903 ((((name name* ...) arg ...) . in)
2904 (and-map symbol? (syntax->datum #'(name name* ...)))
2905 (with-syntax (((quoted-arg ...) (quotify-iface #'(arg ...))))
2906 (lp #'in (cons #`(list '(name name* ...) quoted-arg ...)
2907 out)))))))
2908
2909 (syntax-case x ()
2910 ((_ spec ...)
2911 (with-syntax (((quoted-args ...) (quotify #'(spec ...))))
2912 #'(eval-when (eval load compile expand)
2913 (process-use-modules (list quoted-args ...))
2914 *unspecified*))))))
2915
2916 (define-syntax use-syntax
2917 (syntax-rules ()
2918 ((_ spec ...)
2919 (begin
2920 (eval-when (eval load compile expand)
2921 (issue-deprecation-warning
2922 "`use-syntax' is deprecated. Please contact guile-devel for more info."))
2923 (use-modules spec ...)))))
2924
2925 (include-from-path "ice-9/r6rs-libraries")
2926
2927 (define-syntax define-private
2928 (syntax-rules ()
2929 ((_ foo bar)
2930 (define foo bar))))
2931
2932 (define-syntax define-public
2933 (syntax-rules ()
2934 ((_ (name . args) . body)
2935 (define-public name (lambda args . body)))
2936 ((_ name val)
2937 (begin
2938 (define name val)
2939 (export name)))))
2940
2941 (define-syntax defmacro-public
2942 (syntax-rules ()
2943 ((_ name args . body)
2944 (begin
2945 (defmacro name args . body)
2946 (export-syntax name)))))
2947
2948 ;; And now for the most important macro.
2949 (define-syntax λ
2950 (syntax-rules ()
2951 ((_ formals body ...)
2952 (lambda formals body ...))))
2953
2954 \f
2955 ;; Export a local variable
2956
2957 ;; This function is called from "modules.c". If you change it, be
2958 ;; sure to update "modules.c" as well.
2959
2960 (define (module-export! m names)
2961 (let ((public-i (module-public-interface m)))
2962 (for-each (lambda (name)
2963 (let* ((internal-name (if (pair? name) (car name) name))
2964 (external-name (if (pair? name) (cdr name) name))
2965 (var (module-ensure-local-variable! m internal-name)))
2966 (module-add! public-i external-name var)))
2967 names)))
2968
2969 (define (module-replace! m names)
2970 (let ((public-i (module-public-interface m)))
2971 (for-each (lambda (name)
2972 (let* ((internal-name (if (pair? name) (car name) name))
2973 (external-name (if (pair? name) (cdr name) name))
2974 (var (module-ensure-local-variable! m internal-name)))
2975 (set-object-property! var 'replace #t)
2976 (module-add! public-i external-name var)))
2977 names)))
2978
2979 ;; Export all local variables from a module
2980 ;;
2981 (define (module-export-all! mod)
2982 (define (fresh-interface!)
2983 (let ((iface (make-module)))
2984 (set-module-name! iface (module-name mod))
2985 (set-module-version! iface (module-version mod))
2986 (set-module-kind! iface 'interface)
2987 (set-module-public-interface! mod iface)
2988 iface))
2989 (let ((iface (or (module-public-interface mod)
2990 (fresh-interface!))))
2991 (set-module-obarray! iface (module-obarray mod))))
2992
2993 ;; Re-export a imported variable
2994 ;;
2995 (define (module-re-export! m names)
2996 (let ((public-i (module-public-interface m)))
2997 (for-each (lambda (name)
2998 (let* ((internal-name (if (pair? name) (car name) name))
2999 (external-name (if (pair? name) (cdr name) name))
3000 (var (module-variable m internal-name)))
3001 (cond ((not var)
3002 (error "Undefined variable:" internal-name))
3003 ((eq? var (module-local-variable m internal-name))
3004 (error "re-exporting local variable:" internal-name))
3005 (else
3006 (module-add! public-i external-name var)))))
3007 names)))
3008
3009 (define-syntax export
3010 (syntax-rules ()
3011 ((_ name ...)
3012 (eval-when (eval load compile expand)
3013 (call-with-deferred-observers
3014 (lambda ()
3015 (module-export! (current-module) '(name ...))))))))
3016
3017 (define-syntax re-export
3018 (syntax-rules ()
3019 ((_ name ...)
3020 (eval-when (eval load compile expand)
3021 (call-with-deferred-observers
3022 (lambda ()
3023 (module-re-export! (current-module) '(name ...))))))))
3024
3025 (define-syntax export!
3026 (syntax-rules ()
3027 ((_ name ...)
3028 (eval-when (eval load compile expand)
3029 (call-with-deferred-observers
3030 (lambda ()
3031 (module-replace! (current-module) '(name ...))))))))
3032
3033 (define-syntax export-syntax
3034 (syntax-rules ()
3035 ((_ name ...)
3036 (export name ...))))
3037
3038 (define-syntax re-export-syntax
3039 (syntax-rules ()
3040 ((_ name ...)
3041 (re-export name ...))))
3042
3043 (define load load-module)
3044
3045 \f
3046
3047 ;;; {Parameters}
3048 ;;;
3049
3050 (define* (make-mutable-parameter init #:optional (converter identity))
3051 (let ((fluid (make-fluid)))
3052 (fluid-set! fluid (converter init))
3053 (case-lambda
3054 (() (fluid-ref fluid))
3055 ((val) (fluid-set! fluid (converter val))))))
3056
3057
3058 \f
3059
3060 ;;; {Handling of duplicate imported bindings}
3061 ;;;
3062
3063 ;; Duplicate handlers take the following arguments:
3064 ;;
3065 ;; module importing module
3066 ;; name conflicting name
3067 ;; int1 old interface where name occurs
3068 ;; val1 value of binding in old interface
3069 ;; int2 new interface where name occurs
3070 ;; val2 value of binding in new interface
3071 ;; var previous resolution or #f
3072 ;; val value of previous resolution
3073 ;;
3074 ;; A duplicate handler can take three alternative actions:
3075 ;;
3076 ;; 1. return #f => leave responsibility to next handler
3077 ;; 2. exit with an error
3078 ;; 3. return a variable resolving the conflict
3079 ;;
3080
3081 (define duplicate-handlers
3082 (let ((m (make-module 7)))
3083
3084 (define (check module name int1 val1 int2 val2 var val)
3085 (scm-error 'misc-error
3086 #f
3087 "~A: `~A' imported from both ~A and ~A"
3088 (list (module-name module)
3089 name
3090 (module-name int1)
3091 (module-name int2))
3092 #f))
3093
3094 (define (warn module name int1 val1 int2 val2 var val)
3095 (format (current-error-port)
3096 "WARNING: ~A: `~A' imported from both ~A and ~A\n"
3097 (module-name module)
3098 name
3099 (module-name int1)
3100 (module-name int2))
3101 #f)
3102
3103 (define (replace module name int1 val1 int2 val2 var val)
3104 (let ((old (or (and var (object-property var 'replace) var)
3105 (module-variable int1 name)))
3106 (new (module-variable int2 name)))
3107 (if (object-property old 'replace)
3108 (and (or (eq? old new)
3109 (not (object-property new 'replace)))
3110 old)
3111 (and (object-property new 'replace)
3112 new))))
3113
3114 (define (warn-override-core module name int1 val1 int2 val2 var val)
3115 (and (eq? int1 the-scm-module)
3116 (begin
3117 (format (current-error-port)
3118 "WARNING: ~A: imported module ~A overrides core binding `~A'\n"
3119 (module-name module)
3120 (module-name int2)
3121 name)
3122 (module-local-variable int2 name))))
3123
3124 (define (first module name int1 val1 int2 val2 var val)
3125 (or var (module-local-variable int1 name)))
3126
3127 (define (last module name int1 val1 int2 val2 var val)
3128 (module-local-variable int2 name))
3129
3130 (define (noop module name int1 val1 int2 val2 var val)
3131 #f)
3132
3133 (set-module-name! m 'duplicate-handlers)
3134 (set-module-kind! m 'interface)
3135 (module-define! m 'check check)
3136 (module-define! m 'warn warn)
3137 (module-define! m 'replace replace)
3138 (module-define! m 'warn-override-core warn-override-core)
3139 (module-define! m 'first first)
3140 (module-define! m 'last last)
3141 (module-define! m 'merge-generics noop)
3142 (module-define! m 'merge-accessors noop)
3143 m))
3144
3145 (define (lookup-duplicates-handlers handler-names)
3146 (and handler-names
3147 (map (lambda (handler-name)
3148 (or (module-symbol-local-binding
3149 duplicate-handlers handler-name #f)
3150 (error "invalid duplicate handler name:"
3151 handler-name)))
3152 (if (list? handler-names)
3153 handler-names
3154 (list handler-names)))))
3155
3156 (define default-duplicate-binding-procedures
3157 (make-mutable-parameter #f))
3158
3159 (define default-duplicate-binding-handler
3160 (make-mutable-parameter '(replace warn-override-core warn last)
3161 (lambda (handler-names)
3162 (default-duplicate-binding-procedures
3163 (lookup-duplicates-handlers handler-names))
3164 handler-names)))
3165
3166 \f
3167
3168 ;;; {`cond-expand' for SRFI-0 support.}
3169 ;;;
3170 ;;; This syntactic form expands into different commands or
3171 ;;; definitions, depending on the features provided by the Scheme
3172 ;;; implementation.
3173 ;;;
3174 ;;; Syntax:
3175 ;;;
3176 ;;; <cond-expand>
3177 ;;; --> (cond-expand <cond-expand-clause>+)
3178 ;;; | (cond-expand <cond-expand-clause>* (else <command-or-definition>))
3179 ;;; <cond-expand-clause>
3180 ;;; --> (<feature-requirement> <command-or-definition>*)
3181 ;;; <feature-requirement>
3182 ;;; --> <feature-identifier>
3183 ;;; | (and <feature-requirement>*)
3184 ;;; | (or <feature-requirement>*)
3185 ;;; | (not <feature-requirement>)
3186 ;;; <feature-identifier>
3187 ;;; --> <a symbol which is the name or alias of a SRFI>
3188 ;;;
3189 ;;; Additionally, this implementation provides the
3190 ;;; <feature-identifier>s `guile' and `r5rs', so that programs can
3191 ;;; determine the implementation type and the supported standard.
3192 ;;;
3193 ;;; Currently, the following feature identifiers are supported:
3194 ;;;
3195 ;;; guile r5rs srfi-0 srfi-4 srfi-6 srfi-13 srfi-14 srfi-55 srfi-61
3196 ;;;
3197 ;;; Remember to update the features list when adding more SRFIs.
3198 ;;;
3199
3200 (define %cond-expand-features
3201 ;; Adjust the above comment when changing this.
3202 '(guile
3203 guile-2
3204 r5rs
3205 srfi-0 ;; cond-expand itself
3206 srfi-4 ;; homogenous numeric vectors
3207 srfi-6 ;; open-input-string etc, in the guile core
3208 srfi-13 ;; string library
3209 srfi-14 ;; character sets
3210 srfi-55 ;; require-extension
3211 srfi-61 ;; general cond clause
3212 ))
3213
3214 ;; This table maps module public interfaces to the list of features.
3215 ;;
3216 (define %cond-expand-table (make-hash-table 31))
3217
3218 ;; Add one or more features to the `cond-expand' feature list of the
3219 ;; module `module'.
3220 ;;
3221 (define (cond-expand-provide module features)
3222 (let ((mod (module-public-interface module)))
3223 (and mod
3224 (hashq-set! %cond-expand-table mod
3225 (append (hashq-ref %cond-expand-table mod '())
3226 features)))))
3227
3228 (define-syntax cond-expand
3229 (lambda (x)
3230 (define (module-has-feature? mod sym)
3231 (or-map (lambda (mod)
3232 (memq sym (hashq-ref %cond-expand-table mod '())))
3233 (module-uses mod)))
3234
3235 (define (condition-matches? condition)
3236 (syntax-case condition (and or not)
3237 ((and c ...)
3238 (and-map condition-matches? #'(c ...)))
3239 ((or c ...)
3240 (or-map condition-matches? #'(c ...)))
3241 ((not c)
3242 (if (condition-matches? #'c) #f #t))
3243 (c
3244 (identifier? #'c)
3245 (let ((sym (syntax->datum #'c)))
3246 (if (memq sym %cond-expand-features)
3247 #t
3248 (module-has-feature? (current-module) sym))))))
3249
3250 (define (match clauses alternate)
3251 (syntax-case clauses ()
3252 (((condition form ...) . rest)
3253 (if (condition-matches? #'condition)
3254 #'(begin form ...)
3255 (match #'rest alternate)))
3256 (() (alternate))))
3257
3258 (syntax-case x (else)
3259 ((_ clause ... (else form ...))
3260 (match #'(clause ...)
3261 (lambda ()
3262 #'(begin form ...))))
3263 ((_ clause ...)
3264 (match #'(clause ...)
3265 (lambda ()
3266 (syntax-violation 'cond-expand "unfulfilled cond-expand" x)))))))
3267
3268 ;; This procedure gets called from the startup code with a list of
3269 ;; numbers, which are the numbers of the SRFIs to be loaded on startup.
3270 ;;
3271 (define (use-srfis srfis)
3272 (process-use-modules
3273 (map (lambda (num)
3274 (list (list 'srfi (string->symbol
3275 (string-append "srfi-" (number->string num))))))
3276 srfis)))
3277
3278 \f
3279
3280 ;;; srfi-55: require-extension
3281 ;;;
3282
3283 (define-syntax require-extension
3284 (lambda (x)
3285 (syntax-case x (srfi)
3286 ((_ (srfi n ...))
3287 (and-map integer? (syntax->datum #'(n ...)))
3288 (with-syntax
3289 (((srfi-n ...)
3290 (map (lambda (n)
3291 (datum->syntax x (symbol-append 'srfi- n)))
3292 (map string->symbol
3293 (map number->string (syntax->datum #'(n ...)))))))
3294 #'(use-modules (srfi srfi-n) ...)))
3295 ((_ (type arg ...))
3296 (identifier? #'type)
3297 (syntax-violation 'require-extension "Not a recognized extension type"
3298 x)))))
3299
3300 \f
3301
3302 (define using-readline?
3303 (let ((using-readline? (make-fluid)))
3304 (make-procedure-with-setter
3305 (lambda () (fluid-ref using-readline?))
3306 (lambda (v) (fluid-set! using-readline? v)))))
3307
3308 \f
3309
3310 ;;; {Deprecated stuff}
3311 ;;;
3312
3313 (begin-deprecated
3314 (module-use! the-scm-module (resolve-interface '(ice-9 deprecated))))
3315
3316 \f
3317
3318 ;;; Place the user in the guile-user module.
3319 ;;;
3320
3321 ;; FIXME:
3322 (module-use! the-scm-module (resolve-interface '(srfi srfi-4)))
3323
3324 (define-module (guile-user)
3325 #:autoload (system base compile) (compile compile-file))
3326
3327 ;; Remain in the `(guile)' module at compilation-time so that the
3328 ;; `-Wunused-toplevel' warning works as expected.
3329 (eval-when (compile) (set-current-module the-root-module))
3330
3331 ;;; boot-9.scm ends here