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