add submodule binders
[bpt/guile.git] / module / ice-9 / boot-9.scm
CommitLineData
87e00370 1;;; -*- mode: scheme; coding: utf-8; -*-
0f2d19dd 2
41131340 3;;;; Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003,2004,2005,2006,2007,2008,2009,2010
3d2ada2f 4;;;; Free Software Foundation, Inc.
20edfbbd 5;;;;
73be1d9e
MV
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
53befeb7 9;;;; version 3 of the License, or (at your option) any later version.
73be1d9e
MV
10;;;;
11;;;; This library is distributed in the hope that it will be useful,
0f2d19dd 12;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
73be1d9e
MV
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
92205699 18;;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
a482f2cc 19;;;;
3d2ada2f 20
0f2d19dd
JB
21\f
22
20edfbbd
TTN
23;;; Commentary:
24
0f2d19dd
JB
25;;; This file is the first thing loaded into Guile. It adds many mundane
26;;; definitions and a few that are interesting.
27;;;
20edfbbd 28;;; The module system (hence the hierarchical namespace) are defined in this
0f2d19dd
JB
29;;; file.
30;;;
31
20edfbbd
TTN
32;;; Code:
33
0f2d19dd 34\f
9fb41cea 35
9c35c579
AW
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
416f26c7
AW
43\f
44
45;;; {Error handling}
46;;;
47
48;; Define delimited continuation operators, and implement catch and throw in
49;; terms of them.
50
8fc43b12
AW
51(define (make-prompt-tag . stem)
52 (gensym (if (pair? stem) (car stem) "prompt")))
c6a32a2c
AW
53(define default-prompt-tag
54 ;; not sure if we should expose this to the user as a fluid
55 (let ((%default-prompt-tag (make-prompt-tag)))
56 (lambda ()
57 %default-prompt-tag)))
8fc43b12
AW
58
59(define (call-with-prompt tag thunk handler)
416f26c7 60 (@prompt tag (thunk) handler))
8fc43b12 61(define (abort-to-prompt tag . args)
416f26c7
AW
62 (@abort tag args))
63
64
416f26c7
AW
65;; Define catch and with-throw-handler, using some common helper routines and a
66;; shared fluid. Hide the helpers in a lexical contour.
67
68(let ()
69 ;; Ideally we'd like to be able to give these default values for all threads,
70 ;; even threads not created by Guile; but alack, that does not currently seem
71 ;; possible. So wrap the getters in thunks.
72 (define %running-exception-handlers (make-fluid))
73 (define %exception-handler (make-fluid))
74
75 (define (running-exception-handlers)
76 (or (fluid-ref %running-exception-handlers)
77 (begin
78 (fluid-set! %running-exception-handlers '())
79 '())))
80 (define (exception-handler)
81 (or (fluid-ref %exception-handler)
82 (begin
83 (fluid-set! %exception-handler default-exception-handler)
84 default-exception-handler)))
85
86 (define (default-exception-handler k . args)
87 (cond
88 ((eq? k 'quit)
89 (primitive-exit (cond
90 ((not (pair? args)) 0)
91 ((integer? (car args)) (car args))
92 ((not (car args)) 1)
93 (else 0))))
94 (else
95 (format (current-error-port) "guile: uncaught throw to ~a: ~a\n" k args)
96 (primitive-exit 1))))
97
98 (define (default-throw-handler prompt-tag catch-k)
99 (let ((prev (exception-handler)))
100 (lambda (thrown-k . args)
101 (if (or (eq? thrown-k catch-k) (eqv? catch-k #t))
8fc43b12 102 (apply abort-to-prompt prompt-tag thrown-k args)
416f26c7
AW
103 (apply prev thrown-k args)))))
104
105 (define (custom-throw-handler prompt-tag catch-k pre)
106 (let ((prev (exception-handler)))
107 (lambda (thrown-k . args)
108 (if (or (eq? thrown-k catch-k) (eqv? catch-k #t))
109 (let ((running (running-exception-handlers)))
110 (with-fluids ((%running-exception-handlers (cons pre running)))
111 (if (not (memq pre running))
112 (apply pre thrown-k args))
113 ;; fall through
114 (if prompt-tag
8fc43b12 115 (apply abort-to-prompt prompt-tag thrown-k args)
416f26c7
AW
116 (apply prev thrown-k args))))
117 (apply prev thrown-k args)))))
118
119 (define! 'catch
120 ;; Until we get optargs support into Guile's C evaluator, we have to fake it
121 ;; here.
122 (lambda (k thunk handler . pre-unwind-handler)
123 "Invoke @var{thunk} in the dynamic context of @var{handler} for
124exceptions 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
133normally, that is the return value of @code{catch}.
134
135Handler is invoked outside the scope of its own @code{catch}.
136If @var{handler} again throws to the same key, a new handler
137from further up the call chain is invoked.
138
139If the key is @code{#t}, then a throw to @emph{any} symbol will
140match this call to @code{catch}.
141
142If a @var{pre-unwind-handler} is given and @var{thunk} throws
143an exception that matches @var{key}, Guile calls the
144@var{pre-unwind-handler} before unwinding the dynamic state and
145invoking the main @var{handler}. @var{pre-unwind-handler} should
146be a procedure with the same signature as @var{handler}, that
147is @code{(lambda (key . args))}. It is typically used to save
148the stack at the point where the exception occurred, but can also
149query other parts of the dynamic state at that point, such as
150fluid values.
151
152A @var{pre-unwind-handler} can exit either normally or non-locally.
153If it exits normally, Guile unwinds the stack and dynamic context
154and then calls the normal (third argument) handler. If it exits
155non-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)))
8fc43b12
AW
160 (let ((tag (make-prompt-tag "catch")))
161 (call-with-prompt
162 tag
163 (lambda ()
164 (with-fluids
165 ((%exception-handler
166 (if (null? pre-unwind-handler)
167 (default-throw-handler tag k)
168 (custom-throw-handler tag k
169 (car pre-unwind-handler)))))
170 (thunk)))
171 (lambda (cont k . args)
172 (apply handler k args))))))
416f26c7
AW
173
174 (define! 'with-throw-handler
175 (lambda (k thunk pre-unwind-handler)
176 "Add @var{handler} to the dynamic context as a throw handler
177for key @var{key}, then invoke @var{thunk}."
178 (if (not (or (symbol? k) (eqv? k #t)))
179 (scm-error "with-throw-handler" 'wrong-type-arg
180 "Wrong type argument in position ~a: ~a"
181 (list 1 k) (list k)))
182 (with-fluids ((%exception-handler
183 (custom-throw-handler #f k pre-unwind-handler)))
184 (thunk))))
185
186 (define! 'throw
187 (lambda (key . args)
188 "Invoke the catch form matching @var{key}, passing @var{args} to the
189@var{handler}.
190
191@var{key} is a symbol. It will match catches of the same symbol or of @code{#t}.
192
193If there is no handler at all, Guile prints an error and then exits."
194 (if (not (symbol? key))
195 ((exception-handler) 'wrong-type-arg "throw"
196 "Wrong type argument in position ~a: ~a" (list 1 key) (list key))
197 (apply (exception-handler) key args)))))
198
199
200\f
201
928258fb
AW
202;;; {R4RS compliance}
203;;;
204
205(primitive-load-path "ice-9/r4rs")
206
207\f
208
eb5d1f88
AW
209;;; {Simple Debugging Tools}
210;;;
211
212;; peek takes any number of arguments, writes them to the
213;; current ouput port, and returns the last argument.
214;; It is handy to wrap around an expression to look at
215;; a value each time is evaluated, e.g.:
216;;
9b5a0d84
AW
217;; (+ 10 (troublesome-fn))
218;; => (+ 10 (pk 'troublesome-fn-returned (troublesome-fn)))
eb5d1f88
AW
219;;
220
221(define (peek . stuff)
222 (newline)
223 (display ";;; ")
224 (write stuff)
225 (newline)
226 (car (last-pair stuff)))
227
228(define pk peek)
229
b7742c6b 230
eb5d1f88
AW
231(define (warn . stuff)
232 (with-output-to-port (current-error-port)
233 (lambda ()
234 (newline)
235 (display ";;; WARNING ")
236 (display stuff)
237 (newline)
238 (car (last-pair stuff)))))
239
240\f
241
21ed9efe 242;;; {Features}
3d2ada2f 243;;;
21ed9efe
MD
244
245(define (provide sym)
246 (if (not (memq sym *features*))
247 (set! *features* (cons sym *features*))))
248
3d2ada2f
DH
249;; Return #t iff FEATURE is available to this Guile interpreter. In SLIB,
250;; provided? also checks to see if the module is available. We should do that
251;; too, but don't.
252
50706e94
JB
253(define (provided? feature)
254 (and (memq feature *features*) #t))
255
4d248541
AW
256\f
257
258;;; {and-map and or-map}
259;;;
260;;; (and-map fn lst) is like (and (fn (car lst)) (fn (cadr lst)) (fn...) ...)
261;;; (or-map fn lst) is like (or (fn (car lst)) (fn (cadr lst)) (fn...) ...)
262;;;
263
264;; and-map f l
265;;
266;; Apply f to successive elements of l until exhaustion or f returns #f.
267;; If returning early, return #f. Otherwise, return the last value returned
268;; by f. If f has never been called because l is empty, return #t.
269;;
270(define (and-map f lst)
271 (let loop ((result #t)
9b5a0d84 272 (l lst))
4d248541 273 (and result
9b5a0d84
AW
274 (or (and (null? l)
275 result)
276 (loop (f (car l)) (cdr l))))))
4d248541
AW
277
278;; or-map f l
279;;
280;; Apply f to successive elements of l until exhaustion or while f returns #f.
281;; If returning early, return the return value of f.
282;;
283(define (or-map f lst)
284 (let loop ((result #f)
9b5a0d84 285 (l lst))
4d248541 286 (or result
9b5a0d84
AW
287 (and (not (null? l))
288 (loop (f (car l)) (cdr l))))))
4d248541
AW
289
290\f
291
3d2ada2f 292;; let format alias simple-format until the more complete version is loaded
52cfc69b 293
8641dd9e
GB
294(define format simple-format)
295
fdc6aebf
KR
296;; this is scheme wrapping the C code so the final pred call is a tail call,
297;; per SRFI-13 spec
298(define (string-any char_pred s . rest)
299 (let ((start (if (null? rest)
9b5a0d84
AW
300 0 (car rest)))
301 (end (if (or (null? rest) (null? (cdr rest)))
302 (string-length s) (cadr rest))))
fdc6aebf 303 (if (and (procedure? char_pred)
9b5a0d84
AW
304 (> end start)
305 (<= end (string-length s))) ;; let c-code handle range error
306 (or (string-any-c-code char_pred s start (1- end))
307 (char_pred (string-ref s (1- end))))
308 (string-any-c-code char_pred s start end))))
fdc6aebf
KR
309
310;; this is scheme wrapping the C code so the final pred call is a tail call,
311;; per SRFI-13 spec
312(define (string-every char_pred s . rest)
313 (let ((start (if (null? rest)
9b5a0d84
AW
314 0 (car rest)))
315 (end (if (or (null? rest) (null? (cdr rest)))
316 (string-length s) (cadr rest))))
fdc6aebf 317 (if (and (procedure? char_pred)
9b5a0d84
AW
318 (> end start)
319 (<= end (string-length s))) ;; let c-code handle range error
320 (and (string-every-c-code char_pred s start (1- end))
321 (char_pred (string-ref s (1- end))))
322 (string-every-c-code char_pred s start end))))
fdc6aebf 323
1b05b324
MV
324;; A variant of string-fill! that we keep for compatability
325;;
326(define (substring-fill! str start end fill)
327 (string-fill! str fill start end))
328
21ed9efe 329\f
79451588 330
12eae603
AW
331;; Define a minimal stub of the module API for psyntax, before modules
332;; have booted.
efa6f9d9 333(define (module-name x)
a26934a8 334 '(guile))
3d5f3091
AW
335(define (module-define! module sym val)
336 (let ((v (hashq-ref (%get-pre-modules-obarray) sym)))
337 (if v
338 (variable-set! v val)
339 (hashq-set! (%get-pre-modules-obarray) sym
340 (make-variable val)))))
341(define (module-ref module sym)
342 (let ((v (module-variable module sym)))
343 (if v (variable-ref v) (error "badness!" (pk module) (pk sym)))))
12eae603
AW
344(define (resolve-module . args)
345 #f)
3d5f3091 346
6a952e0e
AW
347;; Input hook to syncase -- so that we might be able to pass annotated
348;; expressions in. Currently disabled. Maybe we should just use
349;; source-properties directly.
350(define (annotation? x) #f)
351
352;; API provided by psyntax
e4721dde 353(define syntax-violation #f)
22225fc1
AW
354(define datum->syntax #f)
355(define syntax->datum #f)
22225fc1
AW
356(define identifier? #f)
357(define generate-temporaries #f)
13182603 358(define bound-identifier=? #f)
13182603 359(define free-identifier=? #f)
8a73a6d2 360(define macroexpand #f)
5a0132b3 361
8a73a6d2 362;; $sc-dispatch is an implementation detail of psyntax. It is used by
6a952e0e 363;; expanded macros, to dispatch an input against a set of patterns.
5a0132b3
AW
364(define $sc-dispatch #f)
365
6a952e0e 366;; Load it up!
13182603
AW
367(primitive-load-path "ice-9/psyntax-pp")
368
6a952e0e
AW
369;; %pre-modules-transformer is the Scheme expander from now until the
370;; module system has booted up.
8a73a6d2 371(define %pre-modules-transformer macroexpand)
79451588 372
a1a482e0
AW
373(define-syntax and
374 (syntax-rules ()
375 ((_) #t)
376 ((_ x) x)
377 ((_ x y ...) (if x (and y ...) #f))))
378
379(define-syntax or
380 (syntax-rules ()
381 ((_) #f)
382 ((_ x) x)
383 ((_ x y ...) (let ((t x)) (if t t (or y ...))))))
384
dc1eed52
AW
385;; The "maybe-more" bits are something of a hack, so that we can support
386;; SRFI-61. Rewrites into a standalone syntax-case macro would be
387;; appreciated.
a1a482e0 388(define-syntax cond
dc1eed52
AW
389 (syntax-rules (=> else)
390 ((_ "maybe-more" test consequent)
391 (if test consequent))
392
393 ((_ "maybe-more" test consequent clause ...)
394 (if test consequent (cond clause ...)))
395
396 ((_ (else else1 else2 ...))
397 (begin else1 else2 ...))
398
399 ((_ (test => receiver) more-clause ...)
400 (let ((t test))
401 (cond "maybe-more" t (receiver t) more-clause ...)))
402
403 ((_ (generator guard => receiver) more-clause ...)
404 (call-with-values (lambda () generator)
405 (lambda t
406 (cond "maybe-more"
407 (apply guard t) (apply receiver t) more-clause ...))))
408
409 ((_ (test => receiver ...) more-clause ...)
410 (syntax-violation 'cond "wrong number of receiver expressions"
411 '(test => receiver ...)))
412 ((_ (generator guard => receiver ...) more-clause ...)
413 (syntax-violation 'cond "wrong number of receiver expressions"
414 '(generator guard => receiver ...)))
415
416 ((_ (test) more-clause ...)
417 (let ((t test))
418 (cond "maybe-more" t t more-clause ...)))
419
420 ((_ (test body1 body2 ...) more-clause ...)
421 (cond "maybe-more"
422 test (begin body1 body2 ...) more-clause ...))))
a1a482e0
AW
423
424(define-syntax case
425 (syntax-rules (else)
426 ((case (key ...)
427 clauses ...)
428 (let ((atom-key (key ...)))
429 (case atom-key clauses ...)))
430 ((case key
431 (else result1 result2 ...))
432 (begin result1 result2 ...))
433 ((case key
434 ((atoms ...) result1 result2 ...))
435 (if (memv key '(atoms ...))
436 (begin result1 result2 ...)))
437 ((case key
438 ((atoms ...) result1 result2 ...)
439 clause clauses ...)
440 (if (memv key '(atoms ...))
441 (begin result1 result2 ...)
442 (case key clause clauses ...)))))
443
444(define-syntax do
445 (syntax-rules ()
446 ((do ((var init step ...) ...)
447 (test expr ...)
448 command ...)
449 (letrec
450 ((loop
451 (lambda (var ...)
452 (if test
453 (begin
454 (if #f #f)
455 expr ...)
456 (begin
457 command
458 ...
459 (loop (do "step" var step ...)
460 ...))))))
461 (loop init ...)))
462 ((do "step" x)
463 x)
464 ((do "step" x y)
465 y)))
466
1eec95f8
AW
467(define-syntax delay
468 (syntax-rules ()
469 ((_ exp) (make-promise (lambda () exp)))))
79451588 470
cb65f76c
AR
471(include-from-path "ice-9/quasisyntax")
472
79451588 473\f
48fdec21 474
3d2ada2f
DH
475;;; {Defmacros}
476;;;
3d2ada2f 477
13182603
AW
478(define-syntax define-macro
479 (lambda (x)
97ce9dbf 480 "Define a defmacro."
13182603 481 (syntax-case x ()
97ce9dbf 482 ((_ (macro . args) doc body1 body ...)
a927454d
AW
483 (string? (syntax->datum #'doc))
484 #'(define-macro macro doc (lambda args body1 body ...)))
97ce9dbf 485 ((_ (macro . args) body ...)
a927454d 486 #'(define-macro macro #f (lambda args body ...)))
97ce9dbf 487 ((_ macro doc transformer)
a927454d
AW
488 (or (string? (syntax->datum #'doc))
489 (not (syntax->datum #'doc)))
490 #'(define-syntax macro
491 (lambda (y)
492 doc
a5e95abe
AW
493 #((macro-type . defmacro)
494 (defmacro-args args))
a927454d
AW
495 (syntax-case y ()
496 ((_ . args)
497 (let ((v (syntax->datum #'args)))
498 (datum->syntax y (apply transformer v)))))))))))
13182603
AW
499
500(define-syntax defmacro
501 (lambda (x)
97ce9dbf 502 "Define a defmacro, with the old lispy defun syntax."
13182603 503 (syntax-case x ()
97ce9dbf 504 ((_ macro args doc body1 body ...)
a927454d
AW
505 (string? (syntax->datum #'doc))
506 #'(define-macro macro doc (lambda args body1 body ...)))
97ce9dbf 507 ((_ macro args body ...)
a927454d 508 #'(define-macro macro #f (lambda args body ...))))))
3d2ada2f
DH
509
510(provide 'defmacro)
48fdec21
MV
511
512\f
513
3d2ada2f
DH
514;;; {Deprecation}
515;;;
516;;; Depends on: defmacro
517;;;
518
519(defmacro begin-deprecated forms
520 (if (include-deprecated-features)
1b68d041 521 `(begin ,@forms)
b1e93821 522 `(begin)))
0f2d19dd
JB
523
524\f
3d2ada2f 525
79451588 526;;; {Trivial Functions}
0f2d19dd 527;;;
79451588 528
6b08d75b 529(define (identity x) x)
132e5fac 530(define (and=> value procedure) (and value (procedure value)))
e8ed460e 531(define call/cc call-with-current-continuation)
79451588 532
5cd06d5e 533;;; apply-to-args is functionally redundant with apply and, worse,
0f2d19dd
JB
534;;; is less general than apply since it only takes two arguments.
535;;;
20edfbbd 536;;; On the other hand, apply-to-args is a syntacticly convenient way to
0f2d19dd
JB
537;;; perform binding in many circumstances when the "let" family of
538;;; of forms don't cut it. E.g.:
539;;;
9b5a0d84
AW
540;;; (apply-to-args (return-3d-mouse-coords)
541;;; (lambda (x y z)
542;;; ...))
0f2d19dd
JB
543;;;
544
545(define (apply-to-args args fn) (apply fn args))
546
3d2ada2f 547(defmacro false-if-exception (expr)
8f9b9683
AW
548 `(catch #t
549 (lambda ()
550 ;; avoid saving backtraces inside false-if-exception
eddd16d7
AW
551 (with-fluids ((the-last-stack (fluid-ref the-last-stack)))
552 ,expr))
8f9b9683 553 (lambda args #f)))
3d2ada2f
DH
554
555\f
556
557;;; {General Properties}
558;;;
559
560;; This is a more modern interface to properties. It will replace all
561;; other property-like things eventually.
562
563(define (make-object-property)
564 (let ((prop (primitive-make-property #f)))
565 (make-procedure-with-setter
566 (lambda (obj) (primitive-property-ref prop obj))
567 (lambda (obj val) (primitive-property-set! prop obj val)))))
568
0f2d19dd 569\f
6b08d75b 570
0f2d19dd
JB
571;;; {Symbol Properties}
572;;;
573
574(define (symbol-property sym prop)
575 (let ((pair (assoc prop (symbol-pref sym))))
576 (and pair (cdr pair))))
577
578(define (set-symbol-property! sym prop val)
579 (let ((pair (assoc prop (symbol-pref sym))))
580 (if pair
9b5a0d84
AW
581 (set-cdr! pair val)
582 (symbol-pset! sym (acons prop val (symbol-pref sym))))))
0f2d19dd
JB
583
584(define (symbol-property-remove! sym prop)
585 (let ((pair (assoc prop (symbol-pref sym))))
586 (if pair
9b5a0d84 587 (symbol-pset! sym (delq! pair (symbol-pref sym))))))
0f2d19dd
JB
588
589\f
1e531c3a 590
0f2d19dd
JB
591;;; {Arrays}
592;;;
593
2042e178
MV
594(define (array-shape a)
595 (map (lambda (ind) (if (number? ind) (list 0 (+ -1 ind)) ind))
596 (array-dimensions a)))
0f2d19dd
JB
597
598\f
3d2ada2f 599
0f2d19dd
JB
600;;; {Keywords}
601;;;
602
0f2d19dd
JB
603(define (kw-arg-ref args kw)
604 (let ((rem (member kw args)))
605 (and rem (pair? (cdr rem)) (cadr rem))))
606
607\f
fa7e9274 608
9f9aa47b 609;;; {Structs}
3d2ada2f 610;;;
fa7e9274
MV
611
612(define (struct-layout s)
9f9aa47b 613 (struct-ref (struct-vtable s) vtable-index-layout))
fa7e9274
MV
614
615\f
d7faeb2e 616
0f2d19dd
JB
617;;; {Records}
618;;;
619
fa7e9274
MV
620;; Printing records: by default, records are printed as
621;;
622;; #<type-name field1: val1 field2: val2 ...>
623;;
624;; You can change that by giving a custom printing function to
625;; MAKE-RECORD-TYPE (after the list of field symbols). This function
626;; will be called like
627;;
628;; (<printer> object port)
629;;
630;; It should print OBJECT to PORT.
631
cf8f1a90 632(define (inherit-print-state old-port new-port)
8a30733e
MD
633 (if (get-print-state old-port)
634 (port-with-print-state new-port (get-print-state old-port))
cf8f1a90
MV
635 new-port))
636
e31f22eb 637;; 0: type-name, 1: fields, 2: constructor
20edfbbd 638(define record-type-vtable
e31f22eb
AW
639 ;; FIXME: This should just call make-vtable, not make-vtable-vtable; but for
640 ;; that we need to expose the bare vtable-vtable to Scheme.
641 (make-vtable-vtable "prprpw" 0
9b5a0d84
AW
642 (lambda (s p)
643 (cond ((eq? s record-type-vtable)
644 (display "#<record-type-vtable>" p))
645 (else
646 (display "#<record-type " p)
647 (display (record-type-name s) p)
648 (display ">" p))))))
0f2d19dd
JB
649
650(define (record-type? obj)
651 (and (struct? obj) (eq? record-type-vtable (struct-vtable obj))))
652
653(define (make-record-type type-name fields . opt)
31ac29b6 654 ;; Pre-generate constructors for nfields < 20.
e31f22eb
AW
655 (define-syntax make-constructor
656 (lambda (x)
657 (define *max-static-argument-count* 20)
658 (define (make-formals n)
659 (let lp ((i 0))
660 (if (< i n)
661 (cons (datum->syntax
662 x
663 (string->symbol
664 (string (integer->char (+ (char->integer #\a) i)))))
665 (lp (1+ i)))
666 '())))
667 (syntax-case x ()
668 ((_ rtd exp) (not (identifier? #'exp))
669 #'(let ((n exp))
670 (make-constructor rtd n)))
671 ((_ rtd nfields)
672 #`(case nfields
673 #,@(let lp ((n 0))
674 (if (< n *max-static-argument-count*)
675 (cons (with-syntax (((formal ...) (make-formals n))
676 (n n))
677 #'((n)
678 (lambda (formal ...)
679 (make-struct rtd 0 formal ...))))
680 (lp (1+ n)))
681 '()))
682 (else
683 (lambda args
684 (if (= (length args) nfields)
685 (apply make-struct rtd 0 args)
686 (scm-error 'wrong-number-of-args
687 (format #f "make-~a" type-name)
688 "Wrong number of arguments" '() #f)))))))))
689
51797cec
AW
690 (define (default-record-printer s p)
691 (display "#<" p)
692 (display (record-type-name (record-type-descriptor s)) p)
693 (let loop ((fields (record-type-fields (record-type-descriptor s)))
694 (off 0))
695 (cond
696 ((not (null? fields))
697 (display " " p)
698 (display (car fields) p)
699 (display ": " p)
700 (display (struct-ref s off) p)
701 (loop (cdr fields) (+ 1 off)))))
702 (display ">" p))
703
e31f22eb
AW
704 (let ((rtd (make-struct record-type-vtable 0
705 (make-struct-layout
706 (apply string-append
707 (map (lambda (f) "pw") fields)))
708 (or (and (pair? opt) (car opt))
709 default-record-printer)
710 type-name
711 (copy-tree fields))))
712 (struct-set! rtd (+ vtable-offset-user 2)
713 (make-constructor rtd (length fields)))
51797cec
AW
714 ;; Temporary solution: Associate a name to the record type descriptor
715 ;; so that the object system can create a wrapper class for it.
e31f22eb
AW
716 (set-struct-vtable-name! rtd (if (symbol? type-name)
717 type-name
718 (string->symbol type-name)))
719 rtd))
0f2d19dd
JB
720
721(define (record-type-name obj)
722 (if (record-type? obj)
9f9aa47b 723 (struct-ref obj vtable-offset-user)
0f2d19dd
JB
724 (error 'not-a-record-type obj)))
725
726(define (record-type-fields obj)
727 (if (record-type? obj)
9f9aa47b 728 (struct-ref obj (+ 1 vtable-offset-user))
0f2d19dd
JB
729 (error 'not-a-record-type obj)))
730
731(define (record-constructor rtd . opt)
e31f22eb
AW
732 (if (null? opt)
733 (struct-ref rtd (+ 2 vtable-offset-user))
734 (let ((field-names (car opt)))
735 (primitive-eval
736 `(lambda ,field-names
737 (make-struct ',rtd 0 ,@(map (lambda (f)
738 (if (memq f field-names)
739 f
740 #f))
741 (record-type-fields rtd))))))))
3bf27608 742
0f2d19dd
JB
743(define (record-predicate rtd)
744 (lambda (obj) (and (struct? obj) (eq? rtd (struct-vtable obj)))))
745
3ba9acb1 746(define (%record-type-error rtd obj) ;; private helper
afc4ccd4
KR
747 (or (eq? rtd (record-type-descriptor obj))
748 (scm-error 'wrong-type-arg "%record-type-check"
9b5a0d84
AW
749 "Wrong type record (want `~S'): ~S"
750 (list (record-type-name rtd) obj)
751 #f)))
afc4ccd4 752
0f2d19dd 753(define (record-accessor rtd field-name)
3bf27608 754 (let ((pos (list-index (record-type-fields rtd) field-name)))
0f2d19dd 755 (if (not pos)
9b5a0d84 756 (error 'no-such-field field-name))
3bf27608
AW
757 (lambda (obj)
758 (if (eq? (struct-vtable obj) rtd)
759 (struct-ref obj pos)
760 (%record-type-error rtd obj)))))
0f2d19dd
JB
761
762(define (record-modifier rtd field-name)
3bf27608 763 (let ((pos (list-index (record-type-fields rtd) field-name)))
0f2d19dd 764 (if (not pos)
9b5a0d84 765 (error 'no-such-field field-name))
3bf27608
AW
766 (lambda (obj val)
767 (if (eq? (struct-vtable obj) rtd)
768 (struct-set! obj pos val)
769 (%record-type-error rtd obj)))))
0f2d19dd
JB
770
771(define (record? obj)
772 (and (struct? obj) (record-type? (struct-vtable obj))))
773
774(define (record-type-descriptor obj)
775 (if (struct? obj)
776 (struct-vtable obj)
777 (error 'not-a-record obj)))
778
21ed9efe
MD
779(provide 'record)
780
0f2d19dd 781\f
3d2ada2f 782
0f2d19dd
JB
783;;; {Booleans}
784;;;
785
786(define (->bool x) (not (not x)))
787
788\f
3d2ada2f 789
0f2d19dd
JB
790;;; {Symbols}
791;;;
792
793(define (symbol-append . args)
06f0414c 794 (string->symbol (apply string-append (map symbol->string args))))
0f2d19dd
JB
795
796(define (list->symbol . args)
797 (string->symbol (apply list->string args)))
798
799(define (symbol . args)
800 (string->symbol (apply string args)))
801
0f2d19dd 802\f
3d2ada2f 803
0f2d19dd
JB
804;;; {Lists}
805;;;
806
807(define (list-index l k)
808 (let loop ((n 0)
9b5a0d84 809 (l l))
0f2d19dd 810 (and (not (null? l))
9b5a0d84
AW
811 (if (eq? (car l) k)
812 n
813 (loop (+ n 1) (cdr l))))))
0f2d19dd 814
1729d8ff 815\f
3d2ada2f 816
52cfc69b 817(if (provided? 'posix)
1e6ebf54 818 (primitive-load-path "ice-9/posix"))
6fa8995c 819
52cfc69b 820(if (provided? 'socket)
1e6ebf54 821 (primitive-load-path "ice-9/networking"))
3afb28ce 822
f3197274 823;; For reference, Emacs file-exists-p uses stat in this same way.
6fa8995c 824(define file-exists?
52cfc69b 825 (if (provided? 'posix)
6fa8995c 826 (lambda (str)
9b5a0d84 827 (->bool (stat str #f)))
6fa8995c 828 (lambda (str)
9b5a0d84
AW
829 (let ((port (catch 'system-error (lambda () (open-file str OPEN_READ))
830 (lambda args #f))))
831 (if port (begin (close-port port) #t)
832 #f)))))
6fa8995c
GH
833
834(define file-is-directory?
52cfc69b 835 (if (provided? 'posix)
6fa8995c 836 (lambda (str)
9b5a0d84 837 (eq? (stat:type (stat str)) 'directory))
6fa8995c 838 (lambda (str)
9b5a0d84
AW
839 (let ((port (catch 'system-error
840 (lambda () (open-file (string-append str "/.")
841 OPEN_READ))
842 (lambda args #f))))
843 (if port (begin (close-port port) #t)
844 #f)))))
0f2d19dd
JB
845
846(define (has-suffix? str suffix)
99f20fb6 847 (string-suffix? suffix str))
0f2d19dd 848
019ac1c9
MV
849(define (system-error-errno args)
850 (if (eq? (car args) 'system-error)
851 (car (list-ref args 4))
852 #f))
853
0f2d19dd 854\f
3d2ada2f 855
0f2d19dd
JB
856;;; {Error Handling}
857;;;
858
0f2d19dd 859(define (error . args)
21ed9efe 860 (save-stack)
2194b6f0 861 (if (null? args)
5552355a 862 (scm-error 'misc-error #f "?" #f #f)
8641dd9e 863 (let loop ((msg "~A")
9b5a0d84
AW
864 (rest (cdr args)))
865 (if (not (null? rest))
866 (loop (string-append msg " ~S")
867 (cdr rest))
868 (scm-error 'misc-error #f msg args #f)))))
be2d2c70 869
1349bd53 870;; bad-throw is the hook that is called upon a throw to a an unhandled
9a0d70e2
GH
871;; key (unless the throw has four arguments, in which case
872;; it's usually interpreted as an error throw.)
873;; If the key has a default handler (a throw-handler-default property),
0f2d19dd
JB
874;; it is applied to the throw.
875;;
1349bd53 876(define (bad-throw key . args)
0f2d19dd
JB
877 (let ((default (symbol-property key 'throw-handler-default)))
878 (or (and default (apply default key args))
9b5a0d84 879 (apply error "unhandled-exception:" key args))))
0f2d19dd 880
0f2d19dd 881\f
bce074ee 882
708bf0f3
GH
883(define (tm:sec obj) (vector-ref obj 0))
884(define (tm:min obj) (vector-ref obj 1))
885(define (tm:hour obj) (vector-ref obj 2))
886(define (tm:mday obj) (vector-ref obj 3))
887(define (tm:mon obj) (vector-ref obj 4))
888(define (tm:year obj) (vector-ref obj 5))
889(define (tm:wday obj) (vector-ref obj 6))
890(define (tm:yday obj) (vector-ref obj 7))
891(define (tm:isdst obj) (vector-ref obj 8))
892(define (tm:gmtoff obj) (vector-ref obj 9))
893(define (tm:zone obj) (vector-ref obj 10))
894
895(define (set-tm:sec obj val) (vector-set! obj 0 val))
896(define (set-tm:min obj val) (vector-set! obj 1 val))
897(define (set-tm:hour obj val) (vector-set! obj 2 val))
898(define (set-tm:mday obj val) (vector-set! obj 3 val))
899(define (set-tm:mon obj val) (vector-set! obj 4 val))
900(define (set-tm:year obj val) (vector-set! obj 5 val))
901(define (set-tm:wday obj val) (vector-set! obj 6 val))
902(define (set-tm:yday obj val) (vector-set! obj 7 val))
903(define (set-tm:isdst obj val) (vector-set! obj 8 val))
904(define (set-tm:gmtoff obj val) (vector-set! obj 9 val))
905(define (set-tm:zone obj val) (vector-set! obj 10 val))
906
6afcd3b2
GH
907(define (tms:clock obj) (vector-ref obj 0))
908(define (tms:utime obj) (vector-ref obj 1))
909(define (tms:stime obj) (vector-ref obj 2))
910(define (tms:cutime obj) (vector-ref obj 3))
911(define (tms:cstime obj) (vector-ref obj 4))
912
1334c61a
GH
913(define file-position ftell)
914(define (file-set-position port offset . whence)
915 (let ((whence (if (eq? whence '()) SEEK_SET (car whence))))
916 (seek port offset whence)))
8b13c6b3 917
e38303a2
GH
918(define (move->fdes fd/port fd)
919 (cond ((integer? fd/port)
9b5a0d84
AW
920 (dup->fdes fd/port fd)
921 (close fd/port)
922 fd)
923 (else
924 (primitive-move->fdes fd/port fd)
925 (set-port-revealed! fd/port 1)
926 fd/port)))
8b13c6b3
GH
927
928(define (release-port-handle port)
929 (let ((revealed (port-revealed port)))
930 (if (> revealed 0)
9b5a0d84 931 (set-port-revealed! port (- revealed 1)))))
0f2d19dd 932
e38303a2 933(define (dup->port port/fd mode . maybe-fd)
7a6f1ffa 934 (let ((port (fdopen (apply dup->fdes port/fd maybe-fd)
9b5a0d84 935 mode)))
e38303a2 936 (if (pair? maybe-fd)
9b5a0d84 937 (set-port-revealed! port 1))
e38303a2 938 port))
20edfbbd 939
e38303a2
GH
940(define (dup->inport port/fd . maybe-fd)
941 (apply dup->port port/fd "r" maybe-fd))
942
943(define (dup->outport port/fd . maybe-fd)
944 (apply dup->port port/fd "w" maybe-fd))
945
e38303a2
GH
946(define (dup port/fd . maybe-fd)
947 (if (integer? port/fd)
948 (apply dup->fdes port/fd maybe-fd)
949 (apply dup->port port/fd (port-mode port/fd) maybe-fd)))
950
951(define (duplicate-port port modes)
952 (dup->port port modes))
953
954(define (fdes->inport fdes)
955 (let loop ((rest-ports (fdes->ports fdes)))
956 (cond ((null? rest-ports)
9b5a0d84
AW
957 (let ((result (fdopen fdes "r")))
958 (set-port-revealed! result 1)
959 result))
960 ((input-port? (car rest-ports))
961 (set-port-revealed! (car rest-ports)
962 (+ (port-revealed (car rest-ports)) 1))
963 (car rest-ports))
964 (else
965 (loop (cdr rest-ports))))))
e38303a2
GH
966
967(define (fdes->outport fdes)
968 (let loop ((rest-ports (fdes->ports fdes)))
969 (cond ((null? rest-ports)
9b5a0d84
AW
970 (let ((result (fdopen fdes "w")))
971 (set-port-revealed! result 1)
972 result))
973 ((output-port? (car rest-ports))
974 (set-port-revealed! (car rest-ports)
975 (+ (port-revealed (car rest-ports)) 1))
976 (car rest-ports))
977 (else
978 (loop (cdr rest-ports))))))
e38303a2
GH
979
980(define (port->fdes port)
981 (set-port-revealed! port (+ (port-revealed port) 1))
982 (fileno port))
983
956055a9
GH
984(define (setenv name value)
985 (if value
986 (putenv (string-append name "=" value))
987 (putenv name)))
988
5c1254da
MV
989(define (unsetenv name)
990 "Remove the entry for NAME from the environment."
991 (putenv name))
992
0f2d19dd 993\f
3d2ada2f 994
0f2d19dd
JB
995;;; {Load Paths}
996;;;
997
0f2d19dd
JB
998;;; Here for backward compatability
999;;
1000(define scheme-file-suffix (lambda () ".scm"))
1001
3cab8392
JB
1002(define (in-vicinity vicinity file)
1003 (let ((tail (let ((len (string-length vicinity)))
9b5a0d84
AW
1004 (if (zero? len)
1005 #f
1006 (string-ref vicinity (- len 1))))))
3cab8392 1007 (string-append vicinity
9b5a0d84
AW
1008 (if (or (not tail)
1009 (eq? tail #\/))
1010 ""
1011 "/")
1012 file)))
02ceadb8 1013
0f2d19dd 1014\f
3d2ada2f 1015
ef00e7f4 1016;;; {Help for scm_shell}
3d2ada2f 1017;;;
ef00e7f4
JB
1018;;; The argument-processing code used by Guile-based shells generates
1019;;; Scheme code based on the argument list. This page contains help
1020;;; functions for the code it generates.
3d2ada2f 1021;;;
ef00e7f4 1022
ef00e7f4
JB
1023(define (command-line) (program-arguments))
1024
5aa7fe69
JB
1025;; This is mostly for the internal use of the code generated by
1026;; scm_compile_shell_switches.
eef6519b
MV
1027
1028(define (turn-on-debugging)
1029 (debug-enable 'debug)
1030 (debug-enable 'backtrace)
1031 (read-enable 'positions))
4eecfeb7 1032
ef00e7f4 1033(define (load-user-init)
1f08acd9 1034 (let* ((home (or (getenv "HOME")
9b5a0d84
AW
1035 (false-if-exception (passwd:dir (getpwuid (getuid))))
1036 "/")) ;; fallback for cygwin etc.
1037 (init-file (in-vicinity home ".guile")))
1f08acd9 1038 (if (file-exists? init-file)
9b5a0d84 1039 (primitive-load init-file))))
ef00e7f4
JB
1040
1041\f
3d2ada2f 1042
107139ea
AW
1043;;; {The interpreter stack}
1044;;;
1045
06dcb9df 1046;; %stacks defined in stacks.c
a6cd3555 1047(define (%start-stack tag thunk)
8fc43b12
AW
1048 (let ((prompt-tag (make-prompt-tag "start-stack")))
1049 (call-with-prompt
1050 prompt-tag
1051 (lambda ()
1052 (with-fluids ((%stacks (acons tag prompt-tag
1053 (or (fluid-ref %stacks) '()))))
1054 (thunk)))
1055 (lambda (k . args)
a6cd3555
AW
1056 (%start-stack tag (lambda () (apply k args)))))))
1057(define-syntax start-stack
1058 (syntax-rules ()
1059 ((_ tag exp)
1060 (%start-stack tag (lambda () exp)))))
107139ea
AW
1061
1062\f
1063
a06181a2 1064;;; {Loading by paths}
3d2ada2f 1065;;;
a06181a2
JB
1066
1067;;; Load a Scheme source file named NAME, searching for it in the
1068;;; directories listed in %load-path, and applying each of the file
1069;;; name extensions listed in %load-extensions.
1070(define (load-from-path name)
1071 (start-stack 'load-stack
9b5a0d84 1072 (primitive-load-path name)))
0f2d19dd 1073
85e95b47
AW
1074(define %load-verbosely #f)
1075(define (assert-load-verbosity v) (set! %load-verbosely v))
1076
1077(define (%load-announce file)
1078 (if %load-verbosely
1079 (with-output-to-port (current-error-port)
9b5a0d84
AW
1080 (lambda ()
1081 (display ";;; ")
1082 (display "loading ")
1083 (display file)
1084 (newline)
1085 (force-output)))))
85e95b47
AW
1086
1087(set! %load-hook %load-announce)
1088
1089(define (load name . reader)
1ab3976e
AW
1090 ;; Returns the .go file corresponding to `name'. Does not search load
1091 ;; paths, only the fallback path. If the .go file is missing or out of
1092 ;; date, and autocompilation is enabled, will try autocompilation, just
1093 ;; as primitive-load-path does internally. primitive-load is
1094 ;; unaffected. Returns #f if autocompilation failed or was disabled.
04af4c4c
AW
1095 ;;
1096 ;; NB: Unless we need to compile the file, this function should not cause
1097 ;; (system base compile) to be loaded up. For that reason compiled-file-name
1098 ;; partially duplicates functionality from (system base compile).
1099 (define (compiled-file-name canon-path)
1100 (and %compile-fallback-path
1101 (string-append
1102 %compile-fallback-path
1103 ;; no need for '/' separator here, canon-path is absolute
1104 canon-path
1105 (cond ((or (null? %load-compiled-extensions)
1106 (string-null? (car %load-compiled-extensions)))
1107 (warn "invalid %load-compiled-extensions"
1108 %load-compiled-extensions)
1109 ".go")
1110 (else (car %load-compiled-extensions))))))
1111 (define (fresh-compiled-file-name go-path)
1ab3976e
AW
1112 (catch #t
1113 (lambda ()
04af4c4c
AW
1114 (let* ((scmstat (stat name))
1115 (gostat (stat go-path #f)))
1ab3976e 1116 (if (and gostat (= (stat:mtime gostat) (stat:mtime scmstat)))
04af4c4c 1117 go-path
1ab3976e
AW
1118 (begin
1119 (if gostat
1120 (format (current-error-port)
1121 ";;; note: source file ~a\n;;; newer than compiled ~a\n"
04af4c4c 1122 name go-path))
1ab3976e
AW
1123 (cond
1124 (%load-should-autocompile
1125 (%warn-autocompilation-enabled)
1126 (format (current-error-port) ";;; compiling ~a\n" name)
1127 (let ((cfn ((@ (system base compile) compile-file) name
1128 #:env (current-module))))
1129 (format (current-error-port) ";;; compiled ~a\n" cfn)
1130 cfn))
1131 (else #f))))))
1132 (lambda (k . args)
1133 (format (current-error-port)
1134 ";;; WARNING: compilation of ~a failed:\n;;; key ~a, throw_args ~s\n"
1135 name k args)
1136 #f)))
eddd16d7
AW
1137 (with-fluids ((current-reader (and (pair? reader) (car reader))))
1138 (let ((cfn (and=> (and=> (false-if-exception (canonicalize-path name))
1139 compiled-file-name)
1140 fresh-compiled-file-name)))
1141 (if cfn
1142 (load-compiled cfn)
1143 (start-stack 'load-stack
1144 (primitive-load name))))))
5552355a 1145
0f2d19dd 1146\f
3d2ada2f 1147
0f2d19dd
JB
1148;;; {Reader Extensions}
1149;;;
0f2d19dd
JB
1150;;; Reader code for various "#c" forms.
1151;;;
1152
600c9584
RB
1153(define read-eval? (make-fluid))
1154(fluid-set! read-eval? #f)
1155(read-hash-extend #\.
1156 (lambda (c port)
1157 (if (fluid-ref read-eval?)
1158 (eval (read port) (interaction-environment))
1159 (error
71335c0d 1160 "#. read expansion found and read-eval? is #f."))))
75a97b92 1161
0f2d19dd 1162\f
3d2ada2f 1163
0f2d19dd
JB
1164;;; {Command Line Options}
1165;;;
1166
1167(define (get-option argv kw-opts kw-args return)
1168 (cond
1169 ((null? argv)
1170 (return #f #f argv))
1171
1172 ((or (not (eq? #\- (string-ref (car argv) 0)))
9b5a0d84 1173 (eq? (string-length (car argv)) 1))
0f2d19dd
JB
1174 (return 'normal-arg (car argv) (cdr argv)))
1175
1176 ((eq? #\- (string-ref (car argv) 1))
1177 (let* ((kw-arg-pos (or (string-index (car argv) #\=)
9b5a0d84
AW
1178 (string-length (car argv))))
1179 (kw (symbol->keyword (substring (car argv) 2 kw-arg-pos)))
1180 (kw-opt? (member kw kw-opts))
1181 (kw-arg? (member kw kw-args))
1182 (arg (or (and (not (eq? kw-arg-pos (string-length (car argv))))
1183 (substring (car argv)
1184 (+ kw-arg-pos 1)
1185 (string-length (car argv))))
1186 (and kw-arg?
1187 (begin (set! argv (cdr argv)) (car argv))))))
0f2d19dd 1188 (if (or kw-opt? kw-arg?)
9b5a0d84
AW
1189 (return kw arg (cdr argv))
1190 (return 'usage-error kw (cdr argv)))))
0f2d19dd
JB
1191
1192 (else
1193 (let* ((char (substring (car argv) 1 2))
9b5a0d84 1194 (kw (symbol->keyword char)))
0f2d19dd
JB
1195 (cond
1196
1197 ((member kw kw-opts)
9b5a0d84
AW
1198 (let* ((rest-car (substring (car argv) 2 (string-length (car argv))))
1199 (new-argv (if (= 0 (string-length rest-car))
1200 (cdr argv)
1201 (cons (string-append "-" rest-car) (cdr argv)))))
1202 (return kw #f new-argv)))
0f2d19dd
JB
1203
1204 ((member kw kw-args)
9b5a0d84
AW
1205 (let* ((rest-car (substring (car argv) 2 (string-length (car argv))))
1206 (arg (if (= 0 (string-length rest-car))
1207 (cadr argv)
1208 rest-car))
1209 (new-argv (if (= 0 (string-length rest-car))
1210 (cddr argv)
1211 (cdr argv))))
1212 (return kw arg new-argv)))
0f2d19dd
JB
1213
1214 (else (return 'usage-error kw argv)))))))
1215
1216(define (for-next-option proc argv kw-opts kw-args)
1217 (let loop ((argv argv))
1218 (get-option argv kw-opts kw-args
9b5a0d84
AW
1219 (lambda (opt opt-arg argv)
1220 (and opt (proc opt opt-arg argv loop))))))
0f2d19dd
JB
1221
1222(define (display-usage-report kw-desc)
1223 (for-each
1224 (lambda (kw)
1225 (or (eq? (car kw) #t)
9b5a0d84
AW
1226 (eq? (car kw) 'else)
1227 (let* ((opt-desc kw)
1228 (help (cadr opt-desc))
1229 (opts (car opt-desc))
1230 (opts-proper (if (string? (car opts)) (cdr opts) opts))
1231 (arg-name (if (string? (car opts))
1232 (string-append "<" (car opts) ">")
1233 ""))
1234 (left-part (string-append
1235 (with-output-to-string
1236 (lambda ()
1237 (map (lambda (x) (display (keyword->symbol x)) (display " "))
1238 opts-proper)))
1239 arg-name))
1240 (middle-part (if (and (< (string-length left-part) 30)
1241 (< (string-length help) 40))
1242 (make-string (- 30 (string-length left-part)) #\ )
1243 "\n\t")))
1244 (display left-part)
1245 (display middle-part)
1246 (display help)
1247 (newline))))
0f2d19dd 1248 kw-desc))
0f2d19dd 1249
20edfbbd
TTN
1250
1251
0f2d19dd
JB
1252(define (transform-usage-lambda cases)
1253 (let* ((raw-usage (delq! 'else (map car cases)))
9b5a0d84
AW
1254 (usage-sans-specials (map (lambda (x)
1255 (or (and (not (list? x)) x)
1256 (and (symbol? (car x)) #t)
1257 (and (boolean? (car x)) #t)
1258 x))
1259 raw-usage))
1260 (usage-desc (delq! #t usage-sans-specials))
1261 (kw-desc (map car usage-desc))
1262 (kw-opts (apply append (map (lambda (x) (and (not (string? (car x))) x)) kw-desc)))
1263 (kw-args (apply append (map (lambda (x) (and (string? (car x)) (cdr x))) kw-desc)))
1264 (transmogrified-cases (map (lambda (case)
1265 (cons (let ((opts (car case)))
1266 (if (or (boolean? opts) (eq? 'else opts))
1267 opts
1268 (cond
1269 ((symbol? (car opts)) opts)
1270 ((boolean? (car opts)) opts)
1271 ((string? (caar opts)) (cdar opts))
1272 (else (car opts)))))
1273 (cdr case)))
1274 cases)))
0f2d19dd
JB
1275 `(let ((%display-usage (lambda () (display-usage-report ',usage-desc))))
1276 (lambda (%argv)
9b5a0d84
AW
1277 (let %next-arg ((%argv %argv))
1278 (get-option %argv
1279 ',kw-opts
1280 ',kw-args
1281 (lambda (%opt %arg %new-argv)
1282 (case %opt
1283 ,@ transmogrified-cases))))))))
0f2d19dd
JB
1284
1285
1286\f
1287
1288;;; {Low Level Modules}
1289;;;
1290;;; These are the low level data structures for modules.
1291;;;
37f5dfe5
DH
1292;;; Every module object is of the type 'module-type', which is a record
1293;;; consisting of the following members:
1294;;;
1295;;; - eval-closure: the function that defines for its module the strategy that
1296;;; shall be followed when looking up symbols in the module.
1297;;;
1298;;; An eval-closure is a function taking two arguments: the symbol to be
1299;;; looked up and a boolean value telling whether a binding for the symbol
1300;;; should be created if it does not exist yet. If the symbol lookup
1301;;; succeeded (either because an existing binding was found or because a new
1302;;; binding was created), a variable object representing the binding is
1303;;; returned. Otherwise, the value #f is returned. Note that the eval
1304;;; closure does not take the module to be searched as an argument: During
1305;;; construction of the eval-closure, the eval-closure has to store the
1306;;; module it belongs to in its environment. This means, that any
1307;;; eval-closure can belong to only one module.
1308;;;
1309;;; The eval-closure of a module can be defined arbitrarily. However, three
1310;;; special cases of eval-closures are to be distinguished: During startup
1311;;; the module system is not yet activated. In this phase, no modules are
1312;;; defined and all bindings are automatically stored by the system in the
1313;;; pre-modules-obarray. Since no eval-closures exist at this time, the
1314;;; functions which require an eval-closure as their argument need to be
1315;;; passed the value #f.
1316;;;
1317;;; The other two special cases of eval-closures are the
1318;;; standard-eval-closure and the standard-interface-eval-closure. Both
1319;;; behave equally for the case that no new binding is to be created. The
1320;;; difference between the two comes in, when the boolean argument to the
1321;;; eval-closure indicates that a new binding shall be created if it is not
1322;;; found.
1323;;;
1324;;; Given that no new binding shall be created, both standard eval-closures
1325;;; define the following standard strategy of searching bindings in the
1326;;; module: First, the module's obarray is searched for the symbol. Second,
1327;;; if no binding for the symbol was found in the module's obarray, the
1328;;; module's binder procedure is exececuted. If this procedure did not
1329;;; return a binding for the symbol, the modules referenced in the module's
1330;;; uses list are recursively searched for a binding of the symbol. If the
1331;;; binding can not be found in these modules also, the symbol lookup has
1332;;; failed.
1333;;;
1334;;; If a new binding shall be created, the standard-interface-eval-closure
1335;;; immediately returns indicating failure. That is, it does not even try
1336;;; to look up the symbol. In contrast, the standard-eval-closure would
1337;;; first search the obarray, and if no binding was found there, would
1338;;; create a new binding in the obarray, therefore not calling the binder
1339;;; procedure or searching the modules in the uses list.
1340;;;
1341;;; The explanation of the following members obarray, binder and uses
1342;;; assumes that the symbol lookup follows the strategy that is defined in
1343;;; the standard-eval-closure and the standard-interface-eval-closure.
1344;;;
1345;;; - obarray: a hash table that maps symbols to variable objects. In this
1346;;; hash table, the definitions are found that are local to the module (that
1347;;; is, not imported from other modules). When looking up bindings in the
1348;;; module, this hash table is searched first.
1349;;;
1350;;; - binder: either #f or a function taking a module and a symbol argument.
1351;;; If it is a function it is called after the obarray has been
1352;;; unsuccessfully searched for a binding. It then can provide bindings
1353;;; that would otherwise not be found locally in the module.
1354;;;
1355;;; - uses: a list of modules from which non-local bindings can be inherited.
1356;;; These modules are the third place queried for bindings after the obarray
1357;;; has been unsuccessfully searched and the binder function did not deliver
1358;;; a result either.
1359;;;
1360;;; - transformer: either #f or a function taking a scheme expression as
1361;;; delivered by read. If it is a function, it will be called to perform
1362;;; syntax transformations (e. g. makro expansion) on the given scheme
1363;;; expression. The output of the transformer function will then be passed
1364;;; to Guile's internal memoizer. This means that the output must be valid
1365;;; scheme code. The only exception is, that the output may make use of the
1366;;; syntax extensions provided to identify the modules that a binding
1367;;; belongs to.
1368;;;
1369;;; - name: the name of the module. This is used for all kinds of printing
1370;;; outputs. In certain places the module name also serves as a way of
1371;;; identification. When adding a module to the uses list of another
1372;;; module, it is made sure that the new uses list will not contain two
1373;;; modules of the same name.
1374;;;
1375;;; - kind: classification of the kind of module. The value is (currently?)
1376;;; only used for printing. It has no influence on how a module is treated.
1377;;; Currently the following values are used when setting the module kind:
1378;;; 'module, 'directory, 'interface, 'custom-interface. If no explicit kind
1379;;; is set, it defaults to 'module.
1380;;;
608860a5
LC
1381;;; - duplicates-handlers: a list of procedures that get called to make a
1382;;; choice between two duplicate bindings when name clashes occur. See the
1383;;; `duplicate-handlers' global variable below.
37f5dfe5 1384;;;
608860a5
LC
1385;;; - observers: a list of procedures that get called when the module is
1386;;; modified.
37f5dfe5 1387;;;
608860a5
LC
1388;;; - weak-observers: a weak-key hash table of procedures that get called
1389;;; when the module is modified. See `module-observe-weak' for details.
37f5dfe5
DH
1390;;;
1391;;; In addition, the module may (must?) contain a binding for
608860a5
LC
1392;;; `%module-public-interface'. This variable should be bound to a module
1393;;; representing the exported interface of a module. See the
1394;;; `module-public-interface' and `module-export!' procedures.
37f5dfe5 1395;;;
0f2d19dd
JB
1396;;; !!! warning: The interface to lazy binder procedures is going
1397;;; to be changed in an incompatible way to permit all the basic
1398;;; module ops to be virtualized.
1399;;;
1400;;; (make-module size use-list lazy-binding-proc) => module
1401;;; module-{obarray,uses,binder}[|-set!]
1402;;; (module? obj) => [#t|#f]
1403;;; (module-locally-bound? module symbol) => [#t|#f]
1404;;; (module-bound? module symbol) => [#t|#f]
1405;;; (module-symbol-locally-interned? module symbol) => [#t|#f]
1406;;; (module-symbol-interned? module symbol) => [#t|#f]
1407;;; (module-local-variable module symbol) => [#<variable ...> | #f]
1408;;; (module-variable module symbol) => [#<variable ...> | #f]
1409;;; (module-symbol-binding module symbol opt-value)
9b5a0d84 1410;;; => [ <obj> | opt-value | an error occurs ]
0f2d19dd
JB
1411;;; (module-make-local-var! module symbol) => #<variable...>
1412;;; (module-add! module symbol var) => unspecified
1413;;; (module-remove! module symbol) => unspecified
1414;;; (module-for-each proc module) => unspecified
1415;;; (make-scm-module) => module ; a lazy copy of the symhash module
1416;;; (set-current-module module) => unspecified
1417;;; (current-module) => #<module...>
1418;;;
1419;;;
1420
1421\f
3d2ada2f 1422
44cf1f0f 1423;;; {Printing Modules}
3d2ada2f
DH
1424;;;
1425
44cf1f0f 1426;; This is how modules are printed. You can re-define it.
31ac29b6 1427(define (%print-module mod port)
0f2d19dd
JB
1428 (display "#<" port)
1429 (display (or (module-kind mod) "module") port)
dc1eed52
AW
1430 (display " " port)
1431 (display (module-name mod) port)
0f2d19dd
JB
1432 (display " " port)
1433 (display (number->string (object-address mod) 16) port)
1434 (display ">" port))
1435
31ac29b6
AW
1436(letrec-syntax
1437 ;; Locally extend the syntax to allow record accessors to be defined at
1438 ;; compile-time. Cache the rtd locally to the constructor, the getters and
1439 ;; the setters, in order to allow for redefinition of the record type; not
1440 ;; relevant in the case of modules, but perhaps if we make this public, it
1441 ;; could matter.
1442
1443 ((define-record-type
1444 (lambda (x)
1445 (define (make-id scope . fragments)
1446 (datum->syntax #'scope
1447 (apply symbol-append
1448 (map (lambda (x)
1449 (if (symbol? x) x (syntax->datum x)))
1450 fragments))))
1451
1452 (define (getter rtd type-name field slot)
1453 #`(define #,(make-id rtd type-name '- field)
1454 (let ((rtd #,rtd))
1455 (lambda (#,type-name)
1456 (if (eq? (struct-vtable #,type-name) rtd)
1457 (struct-ref #,type-name #,slot)
1458 (%record-type-error rtd #,type-name))))))
1459
1460 (define (setter rtd type-name field slot)
1461 #`(define #,(make-id rtd 'set- type-name '- field '!)
1462 (let ((rtd #,rtd))
1463 (lambda (#,type-name val)
1464 (if (eq? (struct-vtable #,type-name) rtd)
1465 (struct-set! #,type-name #,slot val)
1466 (%record-type-error rtd #,type-name))))))
1467
1468 (define (accessors rtd type-name fields n exp)
1469 (syntax-case fields ()
1470 (() exp)
1471 (((field #:no-accessors) field* ...) (identifier? #'field)
1472 (accessors rtd type-name #'(field* ...) (1+ n)
1473 exp))
1474 (((field #:no-setter) field* ...) (identifier? #'field)
1475 (accessors rtd type-name #'(field* ...) (1+ n)
1476 #`(begin #,exp
1477 #,(getter rtd type-name #'field n))))
1478 (((field #:no-getter) field* ...) (identifier? #'field)
1479 (accessors rtd type-name #'(field* ...) (1+ n)
1480 #`(begin #,exp
1481 #,(setter rtd type-name #'field n))))
1482 ((field field* ...) (identifier? #'field)
1483 (accessors rtd type-name #'(field* ...) (1+ n)
1484 #`(begin #,exp
1485 #,(getter rtd type-name #'field n)
1486 #,(setter rtd type-name #'field n))))))
1487
1488 (define (predicate rtd type-name fields exp)
1489 (accessors
1490 rtd type-name fields 0
1491 #`(begin
1492 #,exp
1493 (define (#,(make-id rtd type-name '?) obj)
1494 (and (struct? obj) (eq? (struct-vtable obj) #,rtd))))))
1495
1496 (define (field-list fields)
1497 (syntax-case fields ()
1498 (() '())
1499 (((f . opts) . rest) (identifier? #'f)
1500 (cons #'f (field-list #'rest)))
1501 ((f . rest) (identifier? #'f)
1502 (cons #'f (field-list #'rest)))))
1503
1504 (define (constructor rtd type-name fields exp)
1505 (let ((ctor (make-id rtd type-name '-constructor))
1506 (args (field-list fields)))
1507 (predicate rtd type-name fields
1508 #`(begin #,exp
1509 (define #,ctor
1510 (let ((rtd #,rtd))
1511 (lambda #,args
1512 (make-struct rtd 0 #,@args))))
1513 (struct-set! #,rtd (+ vtable-offset-user 2)
1514 #,ctor)))))
1515
1516 (define (type type-name printer fields)
1517 (define (make-layout)
1518 (let lp ((fields fields) (slots '()))
1519 (syntax-case fields ()
1520 (() (datum->syntax #'here
1521 (make-struct-layout
1522 (apply string-append slots))))
1523 ((_ . rest) (lp #'rest (cons "pw" slots))))))
1524
1525 (let ((rtd (make-id type-name type-name '-type)))
1526 (constructor rtd type-name fields
1527 #`(begin
1528 (define #,rtd
1529 (make-struct record-type-vtable 0
1530 '#,(make-layout)
1531 #,printer
1532 '#,type-name
1533 '#,(field-list fields)))
1534 (set-struct-vtable-name! #,rtd '#,type-name)))))
1535
1536 (syntax-case x ()
1537 ((_ type-name printer (field ...))
1538 (type #'type-name #'printer #'(field ...)))))))
1539
1540 ;; module-type
1541 ;;
1542 ;; A module is characterized by an obarray in which local symbols
1543 ;; are interned, a list of modules, "uses", from which non-local
1544 ;; bindings can be inherited, and an optional lazy-binder which
1545 ;; is a (CLOSURE module symbol) which, as a last resort, can provide
1546 ;; bindings that would otherwise not be found locally in the module.
1547 ;;
1548 ;; NOTE: If you change the set of fields or their order, you also need to
1549 ;; change the constants in libguile/modules.h.
1550 ;;
1551 ;; NOTE: The getter `module-eval-closure' is used in libguile/modules.c.
1552 ;; NOTE: The getter `module-transfomer' is defined libguile/modules.c.
1553 ;; NOTE: The getter `module-name' is defined later, due to boot reasons.
1554 ;;
1555 (define-record-type module
1556 (lambda (obj port) (%print-module obj port))
1557 (obarray
1558 uses
1559 binder
1560 eval-closure
1561 (transformer #:no-getter)
1562 (name #:no-getter)
1563 kind
1564 duplicates-handlers
1565 (import-obarray #:no-setter)
1566 observers
1567 (weak-observers #:no-setter)
f905381d 1568 version
81fc66cf
AW
1569 submodules
1570 submodule-binder)))
31ac29b6 1571
0f2d19dd 1572
8b718458 1573;; make-module &opt size uses binder
0f2d19dd 1574;;
8b718458
JB
1575;; Create a new module, perhaps with a particular size of obarray,
1576;; initial uses list, or binding procedure.
0f2d19dd 1577;;
0f2d19dd
JB
1578(define make-module
1579 (lambda args
0f2d19dd 1580
8b718458 1581 (define (parse-arg index default)
9b5a0d84
AW
1582 (if (> (length args) index)
1583 (list-ref args index)
1584 default))
8b718458 1585
608860a5
LC
1586 (define %default-import-size
1587 ;; Typical number of imported bindings actually used by a module.
1588 600)
1589
8b718458 1590 (if (> (length args) 3)
9b5a0d84 1591 (error "Too many args to make-module." args))
0f2d19dd 1592
231a4ea8 1593 (let ((size (parse-arg 0 31))
9b5a0d84
AW
1594 (uses (parse-arg 1 '()))
1595 (binder (parse-arg 2 #f)))
1596
1597 (if (not (integer? size))
1598 (error "Illegal size to make-module." size))
1599 (if (not (and (list? uses)
1600 (and-map module? uses)))
1601 (error "Incorrect use list." uses))
1602 (if (and binder (not (procedure? binder)))
1603 (error
1604 "Lazy-binder expected to be a procedure or #f." binder))
1605
1606 (let ((module (module-constructor (make-hash-table size)
1607 uses binder #f %pre-modules-transformer
13182603 1608 #f #f #f
9b5a0d84
AW
1609 (make-hash-table %default-import-size)
1610 '()
f905381d 1611 (make-weak-key-hash-table 31) #f
81fc66cf 1612 (make-hash-table 7) #f)))
8b718458 1613
9b5a0d84
AW
1614 ;; We can't pass this as an argument to module-constructor,
1615 ;; because we need it to close over a pointer to the module
1616 ;; itself.
1617 (set-module-eval-closure! module (standard-eval-closure module))
8b718458 1618
9b5a0d84 1619 module))))
0f2d19dd 1620
8b718458 1621
0f2d19dd 1622\f
3d2ada2f 1623
1777c18b
MD
1624;;; {Observer protocol}
1625;;;
1626
1627(define (module-observe module proc)
1628 (set-module-observers! module (cons proc (module-observers module)))
1629 (cons module proc))
1630
608860a5
LC
1631(define (module-observe-weak module observer-id . proc)
1632 ;; Register PROC as an observer of MODULE under name OBSERVER-ID (which can
1633 ;; be any Scheme object). PROC is invoked and passed MODULE any time
1634 ;; MODULE is modified. PROC gets unregistered when OBSERVER-ID gets GC'd
1635 ;; (thus, it is never unregistered if OBSERVER-ID is an immediate value,
1636 ;; for instance).
1637
1638 ;; The two-argument version is kept for backward compatibility: when called
1639 ;; with two arguments, the observer gets unregistered when closure PROC
1640 ;; gets GC'd (making it impossible to use an anonymous lambda for PROC).
1641
1642 (let ((proc (if (null? proc) observer-id (car proc))))
1643 (hashq-set! (module-weak-observers module) observer-id proc)))
1777c18b
MD
1644
1645(define (module-unobserve token)
1646 (let ((module (car token))
9b5a0d84 1647 (id (cdr token)))
1777c18b 1648 (if (integer? id)
9b5a0d84
AW
1649 (hash-remove! (module-weak-observers module) id)
1650 (set-module-observers! module (delq1! id (module-observers module)))))
1777c18b
MD
1651 *unspecified*)
1652
d57da08b 1653(define module-defer-observers #f)
03d6cddc 1654(define module-defer-observers-mutex (make-mutex 'recursive))
d57da08b
MD
1655(define module-defer-observers-table (make-hash-table))
1656
1a961d7e 1657(define (module-modified m)
d57da08b
MD
1658 (if module-defer-observers
1659 (hash-set! module-defer-observers-table m #t)
1660 (module-call-observers m)))
1661
1662;;; This function can be used to delay calls to observers so that they
1663;;; can be called once only in the face of massive updating of modules.
1664;;;
1665(define (call-with-deferred-observers thunk)
1666 (dynamic-wind
1667 (lambda ()
9b5a0d84
AW
1668 (lock-mutex module-defer-observers-mutex)
1669 (set! module-defer-observers #t))
d57da08b
MD
1670 thunk
1671 (lambda ()
9b5a0d84
AW
1672 (set! module-defer-observers #f)
1673 (hash-for-each (lambda (m dummy)
1674 (module-call-observers m))
1675 module-defer-observers-table)
1676 (hash-clear! module-defer-observers-table)
1677 (unlock-mutex module-defer-observers-mutex))))
d57da08b
MD
1678
1679(define (module-call-observers m)
1777c18b 1680 (for-each (lambda (proc) (proc m)) (module-observers m))
608860a5
LC
1681
1682 ;; We assume that weak observers don't (un)register themselves as they are
1683 ;; called since this would preclude proper iteration over the hash table
1684 ;; elements.
1685 (hash-for-each (lambda (id proc) (proc m)) (module-weak-observers m)))
1777c18b
MD
1686
1687\f
3d2ada2f 1688
0f2d19dd
JB
1689;;; {Module Searching in General}
1690;;;
1691;;; We sometimes want to look for properties of a symbol
1692;;; just within the obarray of one module. If the property
1693;;; holds, then it is said to hold ``locally'' as in, ``The symbol
1694;;; DISPLAY is locally rebound in the module `safe-guile'.''
1695;;;
1696;;;
1697;;; Other times, we want to test for a symbol property in the obarray
1698;;; of M and, if it is not found there, try each of the modules in the
1699;;; uses list of M. This is the normal way of testing for some
1700;;; property, so we state these properties without qualification as
1701;;; in: ``The symbol 'fnord is interned in module M because it is
1702;;; interned locally in module M2 which is a member of the uses list
1703;;; of M.''
1704;;;
1705
1706;; module-search fn m
20edfbbd 1707;;
0f2d19dd
JB
1708;; return the first non-#f result of FN applied to M and then to
1709;; the modules in the uses of m, and so on recursively. If all applications
1710;; return #f, then so does this function.
1711;;
1712(define (module-search fn m v)
1713 (define (loop pos)
1714 (and (pair? pos)
9b5a0d84
AW
1715 (or (module-search fn (car pos) v)
1716 (loop (cdr pos)))))
0f2d19dd
JB
1717 (or (fn m v)
1718 (loop (module-uses m))))
1719
1720
1721;;; {Is a symbol bound in a module?}
1722;;;
1723;;; Symbol S in Module M is bound if S is interned in M and if the binding
1724;;; of S in M has been set to some well-defined value.
1725;;;
1726
1727;; module-locally-bound? module symbol
1728;;
1729;; Is a symbol bound (interned and defined) locally in a given module?
1730;;
1731(define (module-locally-bound? m v)
1732 (let ((var (module-local-variable m v)))
1733 (and var
9b5a0d84 1734 (variable-bound? var))))
0f2d19dd
JB
1735
1736;; module-bound? module symbol
1737;;
1738;; Is a symbol bound (interned and defined) anywhere in a given module
1739;; or its uses?
1740;;
1741(define (module-bound? m v)
f176c584
AW
1742 (let ((var (module-variable m v)))
1743 (and var
9b5a0d84 1744 (variable-bound? var))))
0f2d19dd
JB
1745
1746;;; {Is a symbol interned in a module?}
1747;;;
20edfbbd 1748;;; Symbol S in Module M is interned if S occurs in
0f2d19dd
JB
1749;;; of S in M has been set to some well-defined value.
1750;;;
1751;;; It is possible to intern a symbol in a module without providing
1752;;; an initial binding for the corresponding variable. This is done
1753;;; with:
1754;;; (module-add! module symbol (make-undefined-variable))
1755;;;
1756;;; In that case, the symbol is interned in the module, but not
1757;;; bound there. The unbound symbol shadows any binding for that
1758;;; symbol that might otherwise be inherited from a member of the uses list.
1759;;;
1760
1761(define (module-obarray-get-handle ob key)
1762 ((if (symbol? key) hashq-get-handle hash-get-handle) ob key))
1763
1764(define (module-obarray-ref ob key)
1765 ((if (symbol? key) hashq-ref hash-ref) ob key))
1766
1767(define (module-obarray-set! ob key val)
1768 ((if (symbol? key) hashq-set! hash-set!) ob key val))
1769
1770(define (module-obarray-remove! ob key)
1771 ((if (symbol? key) hashq-remove! hash-remove!) ob key))
1772
1773;; module-symbol-locally-interned? module symbol
20edfbbd 1774;;
0f2d19dd
JB
1775;; is a symbol interned (not neccessarily defined) locally in a given module
1776;; or its uses? Interned symbols shadow inherited bindings even if
1777;; they are not themselves bound to a defined value.
1778;;
1779(define (module-symbol-locally-interned? m v)
1780 (not (not (module-obarray-get-handle (module-obarray m) v))))
1781
1782;; module-symbol-interned? module symbol
20edfbbd 1783;;
0f2d19dd
JB
1784;; is a symbol interned (not neccessarily defined) anywhere in a given module
1785;; or its uses? Interned symbols shadow inherited bindings even if
1786;; they are not themselves bound to a defined value.
1787;;
1788(define (module-symbol-interned? m v)
1789 (module-search module-symbol-locally-interned? m v))
1790
1791
1792;;; {Mapping modules x symbols --> variables}
1793;;;
1794
1795;; module-local-variable module symbol
1796;; return the local variable associated with a MODULE and SYMBOL.
1797;;
1798;;; This function is very important. It is the only function that can
1799;;; return a variable from a module other than the mutators that store
1800;;; new variables in modules. Therefore, this function is the location
1801;;; of the "lazy binder" hack.
1802;;;
1803;;; If symbol is defined in MODULE, and if the definition binds symbol
1804;;; to a variable, return that variable object.
1805;;;
1806;;; If the symbols is not found at first, but the module has a lazy binder,
1807;;; then try the binder.
1808;;;
1809;;; If the symbol is not found at all, return #f.
1810;;;
608860a5
LC
1811;;; (This is now written in C, see `modules.c'.)
1812;;;
0f2d19dd
JB
1813
1814;;; {Mapping modules x symbols --> bindings}
1815;;;
1816;;; These are similar to the mapping to variables, except that the
1817;;; variable is dereferenced.
1818;;;
1819
1820;; module-symbol-binding module symbol opt-value
20edfbbd 1821;;
0f2d19dd
JB
1822;; return the binding of a variable specified by name within
1823;; a given module, signalling an error if the variable is unbound.
1824;; If the OPT-VALUE is passed, then instead of signalling an error,
1825;; return OPT-VALUE.
1826;;
1827(define (module-symbol-local-binding m v . opt-val)
1828 (let ((var (module-local-variable m v)))
7b07e5ef 1829 (if (and var (variable-bound? var))
9b5a0d84
AW
1830 (variable-ref var)
1831 (if (not (null? opt-val))
1832 (car opt-val)
1833 (error "Locally unbound variable." v)))))
0f2d19dd
JB
1834
1835;; module-symbol-binding module symbol opt-value
20edfbbd 1836;;
0f2d19dd
JB
1837;; return the binding of a variable specified by name within
1838;; a given module, signalling an error if the variable is unbound.
1839;; If the OPT-VALUE is passed, then instead of signalling an error,
1840;; return OPT-VALUE.
1841;;
1842(define (module-symbol-binding m v . opt-val)
1843 (let ((var (module-variable m v)))
7b07e5ef 1844 (if (and var (variable-bound? var))
9b5a0d84
AW
1845 (variable-ref var)
1846 (if (not (null? opt-val))
1847 (car opt-val)
1848 (error "Unbound variable." v)))))
0f2d19dd
JB
1849
1850
1851\f
3d2ada2f 1852
0f2d19dd
JB
1853;;; {Adding Variables to Modules}
1854;;;
0f2d19dd
JB
1855
1856;; module-make-local-var! module symbol
20edfbbd 1857;;
0f2d19dd
JB
1858;; ensure a variable for V in the local namespace of M.
1859;; If no variable was already there, then create a new and uninitialzied
1860;; variable.
1861;;
d57da08b
MD
1862;; This function is used in modules.c.
1863;;
0f2d19dd
JB
1864(define (module-make-local-var! m v)
1865 (or (let ((b (module-obarray-ref (module-obarray m) v)))
9b5a0d84
AW
1866 (and (variable? b)
1867 (begin
1868 ;; Mark as modified since this function is called when
1869 ;; the standard eval closure defines a binding
1870 (module-modified m)
1871 b)))
0c5f718b 1872
608860a5
LC
1873 ;; Create a new local variable.
1874 (let ((local-var (make-undefined-variable)))
1875 (module-add! m v local-var)
1876 local-var)))
0f2d19dd 1877
89d06712 1878;; module-ensure-local-variable! module symbol
9540368e 1879;;
89d06712
MV
1880;; Ensure that there is a local variable in MODULE for SYMBOL. If
1881;; there is no binding for SYMBOL, create a new uninitialized
1882;; variable. Return the local variable.
9540368e 1883;;
89d06712
MV
1884(define (module-ensure-local-variable! module symbol)
1885 (or (module-local-variable module symbol)
9540368e 1886 (let ((var (make-undefined-variable)))
9b5a0d84
AW
1887 (module-add! module symbol var)
1888 var)))
9540368e 1889
0f2d19dd 1890;; module-add! module symbol var
20edfbbd 1891;;
0f2d19dd
JB
1892;; ensure a particular variable for V in the local namespace of M.
1893;;
1894(define (module-add! m v var)
1895 (if (not (variable? var))
1896 (error "Bad variable to module-add!" var))
1777c18b 1897 (module-obarray-set! (module-obarray m) v var)
1a961d7e 1898 (module-modified m))
0f2d19dd 1899
20edfbbd
TTN
1900;; module-remove!
1901;;
0f2d19dd
JB
1902;; make sure that a symbol is undefined in the local namespace of M.
1903;;
1904(define (module-remove! m v)
c35738c1 1905 (module-obarray-remove! (module-obarray m) v)
1a961d7e 1906 (module-modified m))
0f2d19dd
JB
1907
1908(define (module-clear! m)
c35738c1 1909 (hash-clear! (module-obarray m))
1a961d7e 1910 (module-modified m))
0f2d19dd
JB
1911
1912;; MODULE-FOR-EACH -- exported
20edfbbd 1913;;
0f2d19dd
JB
1914;; Call PROC on each symbol in MODULE, with arguments of (SYMBOL VARIABLE).
1915;;
1916(define (module-for-each proc module)
c35738c1 1917 (hash-for-each proc (module-obarray module)))
0f2d19dd
JB
1918
1919(define (module-map proc module)
711a9fd7 1920 (hash-map->list proc (module-obarray module)))
c35738c1 1921
0f27ab8a
AW
1922;; Submodules
1923;;
1924;; Modules exist in a separate namespace from values, because you generally do
1925;; not want the name of a submodule, which you might not even use, to collide
1926;; with local variables that happen to be named the same as the submodule.
1927;;
1928(define (module-ref-submodule module name)
81fc66cf
AW
1929 (or (hashq-ref (module-submodules module) name)
1930 (and (module-submodule-binder module)
1931 ((module-submodule-binder module) module name))))
0f27ab8a
AW
1932
1933(define (module-define-submodule! module name submodule)
f6a5308b 1934 (hashq-set! (module-submodules module) name submodule))
0f27ab8a 1935
0f2d19dd
JB
1936\f
1937
1938;;; {Low Level Bootstrapping}
1939;;;
1940
20edfbbd 1941;; make-root-module
0f2d19dd 1942
296ff5e7
MV
1943;; A root module uses the pre-modules-obarray as its obarray. This
1944;; special obarray accumulates all bindings that have been established
1945;; before the module system is fully booted.
0f2d19dd 1946;;
296ff5e7
MV
1947;; (The obarray continues to be used by code that has been closed over
1948;; before the module system has been booted.)
0f2d19dd
JB
1949
1950(define (make-root-module)
296ff5e7
MV
1951 (let ((m (make-module 0)))
1952 (set-module-obarray! m (%get-pre-modules-obarray))
1953 m))
0f2d19dd 1954
b622dec7 1955;; make-scm-module
0f2d19dd 1956
296ff5e7
MV
1957;; The root interface is a module that uses the same obarray as the
1958;; root module. It does not allow new definitions, tho.
0f2d19dd 1959
6906bd0d 1960(define (make-scm-module)
296ff5e7
MV
1961 (let ((m (make-module 0)))
1962 (set-module-obarray! m (%get-pre-modules-obarray))
1963 (set-module-eval-closure! m (standard-interface-eval-closure m))
1964 m))
0f2d19dd
JB
1965
1966
0f2d19dd 1967\f
3d2ada2f 1968
0f2d19dd
JB
1969;;; {Module-based Loading}
1970;;;
1971
1972(define (save-module-excursion thunk)
1973 (let ((inner-module (current-module))
9b5a0d84 1974 (outer-module #f))
0f2d19dd 1975 (dynamic-wind (lambda ()
9b5a0d84
AW
1976 (set! outer-module (current-module))
1977 (set-current-module inner-module)
1978 (set! inner-module #f))
1979 thunk
1980 (lambda ()
1981 (set! inner-module (current-module))
1982 (set-current-module outer-module)
1983 (set! outer-module #f)))))
0f2d19dd 1984
0f2d19dd
JB
1985(define basic-load load)
1986
ec3a8ace 1987(define (load-module filename . reader)
c6775c40
MD
1988 (save-module-excursion
1989 (lambda ()
1990 (let ((oldname (and (current-load-port)
9b5a0d84 1991 (port-filename (current-load-port)))))
ec3a8ace 1992 (apply basic-load
9b5a0d84
AW
1993 (if (and oldname
1994 (> (string-length filename) 0)
1995 (not (char=? (string-ref filename 0) #\/))
1996 (not (string=? (dirname oldname) ".")))
1997 (string-append (dirname oldname) "/" filename)
1998 filename)
1999 reader)))))
0f2d19dd
JB
2000
2001
2002\f
3d2ada2f 2003
44cf1f0f 2004;;; {MODULE-REF -- exported}
3d2ada2f
DH
2005;;;
2006
0f2d19dd
JB
2007;; Returns the value of a variable called NAME in MODULE or any of its
2008;; used modules. If there is no such variable, then if the optional third
2009;; argument DEFAULT is present, it is returned; otherwise an error is signaled.
20edfbbd 2010;;
0f2d19dd
JB
2011(define (module-ref module name . rest)
2012 (let ((variable (module-variable module name)))
2013 (if (and variable (variable-bound? variable))
9b5a0d84
AW
2014 (variable-ref variable)
2015 (if (null? rest)
2016 (error "No variable named" name 'in module)
2017 (car rest) ; default value
2018 ))))
0f2d19dd
JB
2019
2020;; MODULE-SET! -- exported
2021;;
2022;; Sets the variable called NAME in MODULE (or in a module that MODULE uses)
2023;; to VALUE; if there is no such variable, an error is signaled.
20edfbbd 2024;;
0f2d19dd
JB
2025(define (module-set! module name value)
2026 (let ((variable (module-variable module name)))
2027 (if variable
9b5a0d84
AW
2028 (variable-set! variable value)
2029 (error "No variable named" name 'in module))))
0f2d19dd
JB
2030
2031;; MODULE-DEFINE! -- exported
2032;;
2033;; Sets the variable called NAME in MODULE to VALUE; if there is no such
2034;; variable, it is added first.
20edfbbd 2035;;
0f2d19dd
JB
2036(define (module-define! module name value)
2037 (let ((variable (module-local-variable module name)))
2038 (if variable
9b5a0d84
AW
2039 (begin
2040 (variable-set! variable value)
2041 (module-modified module))
2042 (let ((variable (make-variable value)))
2043 (module-add! module name variable)))))
0f2d19dd 2044
ed218d98
MV
2045;; MODULE-DEFINED? -- exported
2046;;
2047;; Return #t iff NAME is defined in MODULE (or in a module that MODULE
2048;; uses)
2049;;
2050(define (module-defined? module name)
2051 (let ((variable (module-variable module name)))
2052 (and variable (variable-bound? variable))))
2053
0f2d19dd
JB
2054;; MODULE-USE! module interface
2055;;
2056;; Add INTERFACE to the list of interfaces used by MODULE.
20edfbbd 2057;;
0f2d19dd 2058(define (module-use! module interface)
b1907902
AW
2059 (if (not (or (eq? module interface)
2060 (memq interface (module-uses module))))
608860a5
LC
2061 (begin
2062 ;; Newly used modules must be appended rather than consed, so that
2063 ;; `module-variable' traverses the use list starting from the first
2064 ;; used module.
2065 (set-module-uses! module
2066 (append (filter (lambda (m)
2067 (not
2068 (equal? (module-name m)
2069 (module-name interface))))
2070 (module-uses module))
2071 (list interface)))
8f44138a 2072 (hash-clear! (module-import-obarray module))
608860a5 2073 (module-modified module))))
0f2d19dd 2074
7b07e5ef
MD
2075;; MODULE-USE-INTERFACES! module interfaces
2076;;
2077;; Same as MODULE-USE! but add multiple interfaces and check for duplicates
2078;;
2079(define (module-use-interfaces! module interfaces)
608860a5
LC
2080 (set-module-uses! module
2081 (append (module-uses module) interfaces))
8f44138a 2082 (hash-clear! (module-import-obarray module))
608860a5 2083 (module-modified module))
7b07e5ef 2084
0f2d19dd 2085\f
3d2ada2f 2086
0f2d19dd
JB
2087;;; {Recursive Namespaces}
2088;;;
0f2d19dd 2089;;; A hierarchical namespace emerges if we consider some module to be
b910c4ac 2090;;; root, and submodules of that module to be nested namespaces.
0f2d19dd 2091;;;
b910c4ac 2092;;; The routines here manage variable names in hierarchical namespace.
0f2d19dd
JB
2093;;; Each variable name is a list of elements, looked up in successively nested
2094;;; modules.
2095;;;
9b5a0d84 2096;;; (nested-ref some-root-module '(foo bar baz))
b910c4ac
AW
2097;;; => <value of a variable named baz in the submodule bar of
2098;;; the submodule foo of some-root-module>
0f2d19dd
JB
2099;;;
2100;;;
2101;;; There are:
2102;;;
9b5a0d84
AW
2103;;; ;; a-root is a module
2104;;; ;; name is a list of symbols
0f2d19dd 2105;;;
9b5a0d84
AW
2106;;; nested-ref a-root name
2107;;; nested-set! a-root name val
2108;;; nested-define! a-root name val
2109;;; nested-remove! a-root name
0f2d19dd 2110;;;
b910c4ac
AW
2111;;; These functions manipulate values in namespaces. For referencing the
2112;;; namespaces themselves, use the following:
0f2d19dd 2113;;;
b910c4ac
AW
2114;;; nested-ref-module a-root name
2115;;; nested-define-module! a-root name mod
2116;;;
2117;;; (current-module) is a natural choice for a root so for convenience there are
0f2d19dd
JB
2118;;; also:
2119;;;
b910c4ac
AW
2120;;; local-ref name == nested-ref (current-module) name
2121;;; local-set! name val == nested-set! (current-module) name val
2122;;; local-define name val == nested-define! (current-module) name val
2123;;; local-remove name == nested-remove! (current-module) name
2124;;; local-ref-module name == nested-ref-module (current-module) name
2125;;; local-define-module! name m == nested-define-module! (current-module) name m
0f2d19dd
JB
2126;;;
2127
2128
0dd5491c 2129(define (nested-ref root names)
b910c4ac
AW
2130 (if (null? names)
2131 root
2132 (let loop ((cur root)
2133 (head (car names))
2134 (tail (cdr names)))
2135 (if (null? tail)
2136 (module-ref cur head #f)
2137 (let ((cur (module-ref-submodule cur head)))
2138 (and cur
2139 (loop cur (car tail) (cdr tail))))))))
0f2d19dd 2140
0dd5491c 2141(define (nested-set! root names val)
0f2d19dd 2142 (let loop ((cur root)
b910c4ac
AW
2143 (head (car names))
2144 (tail (cdr names)))
2145 (if (null? tail)
2146 (module-set! cur head val)
2147 (let ((cur (module-ref-submodule cur head)))
2148 (if (not cur)
2149 (error "failed to resolve module" names)
2150 (loop cur (car tail) (cdr tail)))))))
0f2d19dd 2151
0dd5491c 2152(define (nested-define! root names val)
0f2d19dd 2153 (let loop ((cur root)
b910c4ac
AW
2154 (head (car names))
2155 (tail (cdr names)))
2156 (if (null? tail)
2157 (module-define! cur head val)
2158 (let ((cur (module-ref-submodule cur head)))
2159 (if (not cur)
2160 (error "failed to resolve module" names)
2161 (loop cur (car tail) (cdr tail)))))))
0f2d19dd 2162
0dd5491c 2163(define (nested-remove! root names)
0f2d19dd 2164 (let loop ((cur root)
b910c4ac
AW
2165 (head (car names))
2166 (tail (cdr names)))
2167 (if (null? tail)
2168 (module-remove! cur head)
2169 (let ((cur (module-ref-submodule cur head)))
2170 (if (not cur)
2171 (error "failed to resolve module" names)
2172 (loop cur (car tail) (cdr tail)))))))
2173
2174
2175(define (nested-ref-module root names)
2176 (let loop ((cur root)
2177 (names names))
2178 (if (null? names)
2179 cur
2180 (let ((cur (module-ref-submodule cur (car names))))
2181 (and cur
2182 (loop cur (cdr names)))))))
2183
2184(define (nested-define-module! root names module)
2185 (if (null? names)
2186 (error "can't redefine root module" root module)
2187 (let loop ((cur root)
2188 (head (car names))
2189 (tail (cdr names)))
2190 (if (null? tail)
2191 (module-define-submodule! cur head module)
2192 (let ((cur (or (module-ref-submodule cur head)
2193 (let ((m (make-module 31)))
2194 (set-module-kind! m 'directory)
2195 (set-module-name! m (append (module-name cur)
2196 (list head)))
2197 (module-define-submodule! cur head m)
2198 m))))
2199 (loop cur (car tail) (cdr tail)))))))
2200
0f2d19dd 2201
0dd5491c
MD
2202(define (local-ref names) (nested-ref (current-module) names))
2203(define (local-set! names val) (nested-set! (current-module) names val))
2204(define (local-define names val) (nested-define! (current-module) names val))
2205(define (local-remove names) (nested-remove! (current-module) names))
b910c4ac
AW
2206(define (local-ref-module names) (nested-ref-module (current-module) names))
2207(define (local-define-module names mod) (nested-define-module! (current-module) names mod))
2208
0f2d19dd
JB
2209
2210
2211\f
3d2ada2f 2212
cb67c838 2213;;; {The (guile) module}
0f2d19dd 2214;;;
cb67c838
AW
2215;;; The standard module, which has the core Guile bindings. Also called the
2216;;; "root module", as it is imported by many other modules, but it is not
2217;;; necessarily the root of anything; and indeed, the module named '() might be
2218;;; better thought of as a root.
0f2d19dd 2219;;;
bbd1d133 2220
dc68fdb9 2221;; module-public-interface is defined in C.
edc185c7
MD
2222(define (set-module-public-interface! m i)
2223 (module-define! m '%module-public-interface i))
2224(define (set-system-module! m s)
2225 (set-procedure-property! (module-eval-closure m) 'system-module s))
0f2d19dd
JB
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)
d5504515
MD
2229(set-module-name! the-root-module '(guile))
2230(set-module-name! the-scm-module '(guile))
2231(set-module-kind! the-scm-module 'interface)
25d8cd3a
AW
2232(set-system-module! the-root-module #t)
2233(set-system-module! the-scm-module #t)
0f2d19dd 2234
bbd1d133
AW
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.
296ff5e7 2256;;
bbd1d133
AW
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))))
cb67c838
AW
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.
bbd1d133 2272 (set-module-name! mod name)
9e0bfdba 2273 (nested-define-module! (resolve-module '() #f) name mod)
bbd1d133
AW
2274 (accessor mod))))))
2275
296ff5e7 2276(define (make-modules-in module name)
9e0bfdba
AW
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)))
0f2d19dd 2283
296ff5e7
MV
2284(define (beautify-user-module! module)
2285 (let ((interface (module-public-interface module)))
2286 (if (or (not interface)
9b5a0d84
AW
2287 (eq? interface module))
2288 (let ((interface (make-module 31)))
2289 (set-module-name! interface (module-name module))
dca14012 2290 (set-module-version! interface (module-version module))
9b5a0d84
AW
2291 (set-module-kind! interface 'interface)
2292 (set-module-public-interface! module interface))))
296ff5e7 2293 (if (and (not (memq the-scm-module (module-uses module)))
9b5a0d84 2294 (not (eq? module the-root-module)))
608860a5
LC
2295 ;; Import the default set of bindings (from the SCM module) in MODULE.
2296 (module-use! module the-scm-module)))
432558b9 2297
dca14012
JG
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)))
0dfe0e75 2329 ((eq? cv 'not) (not (version-matches? (cadr version-ref) target)))
dca14012
JG
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
f95f82f8
AW
2395(define (make-fresh-user-module)
2396 (let ((m (make-module)))
2397 (beautify-user-module! m)
2398 m))
2399
1f60d9d2
MD
2400;; NOTE: This binding is used in libguile/modules.c.
2401;;
53f84bc8 2402(define resolve-module
cb67c838
AW
2403 (let ((root (make-module)))
2404 (set-module-name! root '())
2405 ;; Define the-root-module as '(guile).
d58ccc66 2406 (module-define-submodule! root 'guile the-root-module)
cb67c838 2407
dbbbc2a1 2408 (lambda (name . args) ;; #:optional (autoload #t) (version #f)
d58ccc66 2409 (let* ((already (nested-ref-module root name))
cb67c838
AW
2410 (numargs (length args))
2411 (autoload (or (= numargs 0) (car args)))
2412 (version (and (> numargs 1) (cadr args))))
2413 (cond
d58ccc66 2414 ((and already
cb67c838
AW
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
51b22dbb
AW
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))))))))
cb67c838 2430
296ff5e7 2431
dca14012
JG
2432(define (try-load-module name version)
2433 (try-module-autoload name version))
0f2d19dd 2434
90847923
MD
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)
9b5a0d84
AW
2439 (eq? (car (last-pair use-list)) the-scm-module))
2440 (set-module-uses! module (reverse (cdr (reverse use-list)))))))
90847923 2441
4eecfeb7 2442;; Return a module that is an interface to the module designated by
532cf805
MV
2443;; NAME.
2444;;
c614a00b 2445;; `resolve-interface' takes four keyword arguments:
532cf805
MV
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
4eecfeb7 2454;; a renamer, only the bindings that already exist in the used module
532cf805
MV
2455;; are made available in the interface. Bindings that are added later
2456;; are not picked up.
2457;;
c614a00b 2458;; #:hide BINDINGS
532cf805 2459;;
c614a00b 2460;; BINDINGS is a list of bindings which should not be imported.
f595ccfe
MD
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.
532cf805 2466;;
c614a00b
MD
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;;
532cf805
MV
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)
9b5a0d84
AW
2480 => (lambda (kw-arg)
2481 (if (null? (cdr kw-arg))
2482 (error "keyword without value: " kw))
2483 (cadr kw-arg)))
2484 (else
2485 def)))
532cf805
MV
2486
2487 (let* ((select (get-keyword-arg args #:select #f))
9b5a0d84
AW
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))
dca14012
JG
2493 (version (get-keyword-arg args #:version #f))
2494 (module (resolve-module name #t version))
b622dec7
TTN
2495 (public-i (and module (module-public-interface module))))
2496 (and (or (not module) (not public-i))
2497 (error "no code for module" name))
c614a00b 2498 (if (and (not select) (null? hide) (eq? renamer identity))
b622dec7 2499 public-i
532cf805 2500 (let ((selection (or select (module-map (lambda (sym var) sym)
9b5a0d84 2501 public-i)))
b622dec7 2502 (custom-i (make-module 31)))
c614a00b 2503 (set-module-kind! custom-i 'custom-interface)
9b5a0d84
AW
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)
b622dec7 2532 custom-i))))
fb1b76f4
TTN
2533
2534(define (symbol-prefix-proc prefix)
2535 (lambda (symbol)
2536 (symbol-append prefix symbol)))
0f2d19dd 2537
482a28f9
MV
2538;; This function is called from "modules.c". If you change it, be
2539;; sure to update "modules.c" as well.
2540
0f2d19dd 2541(define (process-define-module args)
f8a502cb
TTN
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))))
0f2d19dd 2547 (beautify-user-module! module)
0209ca9a 2548 (let loop ((kws kws)
1b92d94c
AW
2549 (reversed-interfaces '())
2550 (exports '())
2551 (re-exports '())
2552 (replacements '())
608860a5 2553 (autoloads '()))
e4da0740 2554
0209ca9a 2555 (if (null? kws)
1b92d94c
AW
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)
608860a5
LC
2562 (if (not (null? autoloads))
2563 (apply module-autoload! module autoloads))))
1b92d94c
AW
2564 (case (car kws)
2565 ((#:use-module #:use-syntax)
2566 (or (pair? (cdr kws))
2567 (unrecognized kws))
13182603
AW
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.")
1b92d94c 2572 (loop (cddr kws)
13182603 2573 reversed-interfaces
1b92d94c
AW
2574 exports
2575 re-exports
2576 replacements
13182603
AW
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)))))
1b92d94c
AW
2596 ((#:autoload)
2597 (or (and (pair? (cdr kws)) (pair? (cddr kws)))
2598 (unrecognized kws))
2599 (loop (cdddr kws)
608860a5 2600 reversed-interfaces
1b92d94c
AW
2601 exports
2602 re-exports
2603 replacements
608860a5
LC
2604 (let ((name (cadr kws))
2605 (bindings (caddr kws)))
2606 (cons* name bindings autoloads))))
1b92d94c
AW
2607 ((#:no-backtrace)
2608 (set-system-module! module #t)
2609 (loop (cdr kws) reversed-interfaces exports re-exports
608860a5 2610 replacements autoloads))
1b92d94c
AW
2611 ((#:pure)
2612 (purify-module! module)
2613 (loop (cdr kws) reversed-interfaces exports re-exports
608860a5 2614 replacements autoloads))
dca14012
JG
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))
1b92d94c
AW
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
608860a5 2630 replacements autoloads))
1b92d94c
AW
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
608860a5 2639 autoloads))
1b92d94c
AW
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
608860a5 2648 autoloads))
1b92d94c
AW
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)
608860a5 2657 autoloads))
1b92d94c
AW
2658 (else
2659 (unrecognized kws)))))
db853761 2660 (run-hook module-defined-hook module)
0f2d19dd 2661 module))
71225060 2662
db853761
NJ
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
3d2ada2f
DH
2668\f
2669
71225060 2670;;; {Autoload}
3d2ada2f 2671;;;
71225060
MD
2672
2673(define (make-autoload-interface module name bindings)
2674 (let ((b (lambda (a sym definep)
9b5a0d84
AW
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))))))
608860a5 2685 (module-constructor (make-hash-table 0) '() b #f #f name 'autoload #f
f905381d 2686 (make-hash-table 0) '() (make-weak-value-hash-table 31) #f
81fc66cf 2687 (make-hash-table 0) #f)))
608860a5
LC
2688
2689(define (module-autoload! module . args)
2690 "Have @var{module} automatically load the module named @var{name} when one
2691of the symbols listed in @var{bindings} is looked up. @var{args} should be a
2692list of module-name/binding-list pairs, e.g., as in @code{(module-autoload!
2693module '(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
71225060 2706
0f2d19dd 2707\f
3d2ada2f 2708
44cf1f0f 2709;;; {Autoloading modules}
3d2ada2f 2710;;;
0f2d19dd
JB
2711
2712(define autoloads-in-progress '())
2713
482a28f9
MV
2714;; This function is called from "modules.c". If you change it, be
2715;; sure to update "modules.c" as well.
2716
dca14012 2717(define (try-module-autoload module-name . args)
0f2d19dd 2718 (let* ((reverse-name (reverse module-name))
9b5a0d84 2719 (name (symbol->string (car reverse-name)))
dca14012 2720 (version (and (not (null? args)) (car args)))
9b5a0d84
AW
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))))
0209ca9a 2726 (resolve-module dir-hint-module-name #f)
0f2d19dd 2727 (and (not (autoload-done-or-in-progress? dir-hint name))
9b5a0d84
AW
2728 (let ((didit #f))
2729 (dynamic-wind
2730 (lambda () (autoload-in-progress! dir-hint name))
2731 (lambda ()
eddd16d7
AW
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)))))
9b5a0d84
AW
2740 (lambda () (set-autoloaded! dir-hint name didit)))
2741 didit))))
0f2d19dd 2742
71225060 2743\f
3d2ada2f
DH
2744
2745;;; {Dynamic linking of modules}
2746;;;
d0cbd20c 2747
0f2d19dd
JB
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)
9b5a0d84 2753 (member n autoloads-in-progress)))))
0f2d19dd
JB
2754
2755(define (autoload-done! p m)
2756 (let ((n (cons p m)))
2757 (set! autoloads-in-progress
9b5a0d84 2758 (delete! n autoloads-in-progress))
0f2d19dd 2759 (or (member n autoloads-done)
9b5a0d84 2760 (set! autoloads-done (cons n autoloads-done)))))
0f2d19dd
JB
2761
2762(define (autoload-in-progress! p m)
2763 (let ((n (cons p m)))
2764 (set! autoloads-done
9b5a0d84 2765 (delete! n autoloads-done))
0f2d19dd
JB
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)))
9b5a0d84
AW
2772 (set! autoloads-done (delete! n autoloads-done))
2773 (set! autoloads-in-progress (delete! n autoloads-in-progress)))))
0f2d19dd 2774
0f2d19dd
JB
2775\f
2776
83b38198 2777;;; {Run-time options}
3d2ada2f 2778;;;
83b38198 2779
27af6bc2 2780(defmacro define-option-interface (option-group)
9ea12179 2781 (let* ((option-name 'car)
9b5a0d84
AW
2782 (option-value 'cadr)
2783 (option-documentation 'caddr)
e9bab9df 2784
9b5a0d84 2785 ;; Below follow the macros defining the run-time option interfaces.
e9bab9df 2786
9b5a0d84
AW
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
27af6bc2 2793 (lambda (option)
9ea12179 2794 (display (,option-name option))
27af6bc2 2795 (if (< (string-length
9ea12179 2796 (symbol->string (,option-name option)))
27af6bc2
AW
2797 8)
2798 (display #\tab))
2799 (display #\tab)
9ea12179 2800 (display (,option-value option))
27af6bc2 2801 (display #\tab)
9ea12179 2802 (display (,option-documentation option))
27af6bc2
AW
2803 (newline))
2804 (,interface #t)))))))
e9bab9df 2805
9b5a0d84
AW
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))))))
27af6bc2
AW
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))))))))
e9bab9df
DH
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!)))
83b38198
MD
2857
2858\f
2859
0f2d19dd
JB
2860;;; {Running Repls}
2861;;;
2862
2863(define (repl read evaler print)
75a97b92 2864 (let loop ((source (read (current-input-port))))
0f2d19dd 2865 (print (evaler source))
75a97b92 2866 (loop (read (current-input-port)))))
0f2d19dd
JB
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
21ed9efe
MD
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
79451588 2879(define scm-repl-verbose #f)
0f2d19dd
JB
2880(define (assert-repl-verbosity v) (set! scm-repl-verbose v))
2881
e6875011 2882(define scm-repl-prompt "guile> ")
0f2d19dd 2883
e6875011
MD
2884(define (set-repl-prompt! v) (set! scm-repl-prompt v))
2885
9f0e9918 2886(define (default-pre-unwind-handler key . args)
06dcb9df
AW
2887 ;; Narrow by two more frames: this one, and the throw handler.
2888 (save-stack 2)
d5d34fa1
MD
2889 (apply throw key args))
2890
1351c2db
AW
2891(begin-deprecated
2892 (define (pre-unwind-handler-dispatch key . args)
2893 (apply default-pre-unwind-handler key args)))
0f2d19dd 2894
3e3cec45 2895(define abort-hook (make-hook))
59e1116d 2896
28d8ab3c
GH
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)
4bbbcd5c 2901
0f2d19dd 2902(define (error-catching-loop thunk)
4bbbcd5c 2903 (let ((status #f)
9b5a0d84 2904 (interactive #t))
8e44e7a0 2905 (define (loop first)
20edfbbd 2906 (let ((next
9b5a0d84
AW
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)))))))
56658166 2969
1351c2db 2970 default-pre-unwind-handler)))
56658166 2971
9b5a0d84 2972 (if next (loop next) status)))
5f5f2642 2973 (set! set-batch-mode?! (lambda (arg)
9b5a0d84
AW
2974 (cond (arg
2975 (set! interactive #f)
2976 (restore-signals))
2977 (#t
2978 (error "sorry, not implemented")))))
5f5f2642 2979 (set! batch-mode? (lambda () (not interactive)))
bb00edfa
MV
2980 (call-with-blocked-asyncs
2981 (lambda () (loop (lambda () #t))))))
0f2d19dd 2982
8bb7f646 2983;;(define the-last-stack (make-fluid)) Defined by scm_init_backtrace ()
8087b6be 2984(define before-signal-stack (make-fluid))
06dcb9df 2985;; FIXME: stack-saved? is broken in the presence of threads.
21ed9efe
MD
2986(define stack-saved? #f)
2987
2988(define (save-stack . narrowing)
06dcb9df
AW
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))))
1c6cd8e8 3004
3e3cec45
MD
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))
1c6cd8e8 3009
21ed9efe
MD
3010(define has-shown-debugger-hint? #f)
3011
35c5db87
GH
3012(define (handle-system-error key . args)
3013 (let ((cep (current-error-port)))
8bb7f646 3014 (cond ((not (stack? (fluid-ref the-last-stack))))
9b5a0d84
AW
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))))
04efd24d 3027 (run-hook before-error-hook)
8bb7f646 3028 (apply display-error (fluid-ref the-last-stack) cep args)
04efd24d 3029 (run-hook after-error-hook)
35c5db87
GH
3030 (force-output cep)
3031 (throw 'abort key)))
21ed9efe 3032
0f2d19dd
JB
3033(define (quit . args)
3034 (apply throw 'quit args))
3035
7950df7c
GH
3036(define exit quit)
3037
d590bbf6
MD
3038;;(define has-shown-backtrace-hint? #f) Defined by scm_init_backtrace ()
3039
3040;; Replaced by C code:
3041;;(define (backtrace)
8bb7f646 3042;; (if (fluid-ref the-last-stack)
d590bbf6 3043;; (begin
9b5a0d84
AW
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
d590bbf6
MD
3051;;"Type \"(debug-enable 'backtrace)\" if you would like a backtrace
3052;;automatically if an error occurs in the future.\n")
9b5a0d84 3053;; (set! has-shown-backtrace-hint? #t))))
d590bbf6 3054;; (display "No backtrace available.\n")))
21ed9efe 3055
0f2d19dd 3056(define (error-catching-repl r e p)
5f89fb13
MV
3057 (error-catching-loop
3058 (lambda ()
3059 (call-with-values (lambda () (e (r)))
3060 (lambda the-values (for-each p the-values))))))
0f2d19dd
JB
3061
3062(define (gc-run-time)
3063 (cdr (assq 'gc-time-taken (gc-stats))))
3064
3e3cec45
MD
3065(define before-read-hook (make-hook))
3066(define after-read-hook (make-hook))
870777d7
KN
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))
1c6cd8e8 3071
dc5c2038
MD
3072;;; The default repl-reader function. We may override this if we've
3073;;; the readline library.
3074(define repl-reader
a58b7fbb 3075 (lambda (prompt . reader)
0becb8f3
AW
3076 (if (not (char-ready?))
3077 (display (if (string? prompt) prompt (prompt))))
dc5c2038 3078 (force-output)
04efd24d 3079 (run-hook before-read-hook)
a58b7fbb
AW
3080 ((or (and (pair? reader) (car reader))
3081 (fluid-ref current-reader)
3082 read)
3083 (current-input-port))))
dc5c2038 3084
0f2d19dd 3085(define (scm-style-repl)
9d774814 3086
0f2d19dd 3087 (letrec (
9b5a0d84
AW
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)))
0f2d19dd 3186
8e44e7a0 3187 (let ((status (error-catching-repl -read
9b5a0d84
AW
3188 -eval
3189 -print)))
8e44e7a0 3190 (-quit status))))
20edfbbd 3191
0f2d19dd 3192
0f2d19dd 3193\f
3d2ada2f 3194
44cf1f0f 3195;;; {IOTA functions: generating lists of numbers}
3d2ada2f 3196;;;
0f2d19dd 3197
e69cd299
MD
3198(define (iota n)
3199 (let loop ((count (1- n)) (result '()))
3200 (if (< count 0) result
3201 (loop (1- count) (cons count result)))))
0f2d19dd
JB
3202
3203\f
3d2ada2f 3204
7398c2c2
MD
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.)
3d2ada2f 3211;;;
7398c2c2
MD
3212
3213(defmacro collect forms
3214 (cons 'list forms))
0f2d19dd 3215
3d2ada2f
DH
3216\f
3217
773abfbb
KR
3218;;; {While}
3219;;;
3220;;; with `continue' and `break'.
3221;;;
3222
3223;; The inner `do' loop avoids re-establishing a catch every iteration,
5578a53f
KR
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
972c33e5 3226;; `while' even when recursing.
c8fc38b1 3227;;
972c33e5
AW
3228;; FIXME: This macro is unintentionally unhygienic with respect to let,
3229;; make-symbol, do, throw, catch, lambda, and not.
c8fc38b1 3230;;
773abfbb 3231(define-macro (while cond . body)
972c33e5
AW
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)))))))
5578a53f 3245
773abfbb 3246
0f2d19dd 3247\f
3d2ada2f 3248
0f2d19dd
JB
3249;;; {Module System Macros}
3250;;;
3251
532cf805
MV
3252;; Return a list of expressions that evaluate to the appropriate
3253;; arguments for resolve-interface according to SPEC.
3254
b15dea68 3255(eval-when
25d8cd3a
AW
3256 (compile)
3257 (if (memq 'prefix (read-options))
3258 (error "boot-9 must be compiled with #:kw, not :kw")))
1a1a10d3 3259
532cf805
MV
3260(define (compile-interface-spec spec)
3261 (define (make-keyarg sym key quote?)
3262 (cond ((or (memq sym spec)
9b5a0d84
AW
3263 (memq key spec))
3264 => (lambda (rest)
3265 (if quote?
3266 (list key (list 'quote (cadr rest)))
3267 (list key (cadr rest)))))
3268 (else
3269 '())))
532cf805
MV
3270 (define (map-apply func list)
3271 (map (lambda (args) (apply func args)) list))
bbf5a913 3272 (define keys
532cf805
MV
3273 ;; sym key quote?
3274 '((:select #:select #t)
9b5a0d84 3275 (:hide #:hide #t)
f595ccfe 3276 (:prefix #:prefix #t)
dca14012
JG
3277 (:renamer #:renamer #f)
3278 (:version #:version #t)))
532cf805
MV
3279 (if (not (pair? (car spec)))
3280 `(',spec)
3281 `(',(car spec)
9b5a0d84 3282 ,@(apply append (map-apply make-keyarg keys)))))
532cf805
MV
3283
3284(define (keyword-like-symbol->keyword sym)
3285 (symbol->keyword (string->symbol (substring (symbol->string sym) 1))))
3286
3287(define (compile-define-module-args args)
3288 ;; Just quote everything except #:use-module and #:use-syntax. We
3289 ;; need to know about all arguments regardless since we want to turn
3290 ;; symbols that look like keywords into real keywords, and the
3291 ;; keyword args in a define-module form are not regular
3292 ;; (i.e. no-backtrace doesn't take a value).
3293 (let loop ((compiled-args `((quote ,(car args))))
9b5a0d84 3294 (args (cdr args)))
532cf805 3295 (cond ((null? args)
9b5a0d84
AW
3296 (reverse! compiled-args))
3297 ;; symbol in keyword position
3298 ((symbol? (car args))
3299 (loop compiled-args
3300 (cons (keyword-like-symbol->keyword (car args)) (cdr args))))
3301 ((memq (car args) '(#:no-backtrace #:pure))
3302 (loop (cons (car args) compiled-args)
3303 (cdr args)))
3304 ((null? (cdr args))
3305 (error "keyword without value:" (car args)))
3306 ((memq (car args) '(#:use-module #:use-syntax))
3307 (loop (cons* `(list ,@(compile-interface-spec (cadr args)))
3308 (car args)
3309 compiled-args)
3310 (cddr args)))
3311 ((eq? (car args) #:autoload)
3312 (loop (cons* `(quote ,(caddr args))
3313 `(quote ,(cadr args))
3314 (car args)
3315 compiled-args)
3316 (cdddr args)))
3317 (else
3318 (loop (cons* `(quote ,(cadr args))
3319 (car args)
3320 compiled-args)
3321 (cddr args))))))
532cf805 3322
0f2d19dd 3323(defmacro define-module args
b15dea68
AW
3324 `(eval-when
3325 (eval load compile)
3326 (let ((m (process-define-module
3327 (list ,@(compile-define-module-args args)))))
3328 (set-current-module m)
3329 m)))
0f2d19dd 3330
532cf805
MV
3331;; The guts of the use-modules macro. Add the interfaces of the named
3332;; modules to the use-list of the current module, in order.
3333
482a28f9
MV
3334;; This function is called by "modules.c". If you change it, be sure
3335;; to change scm_c_use_module as well.
3336
532cf805 3337(define (process-use-modules module-interface-args)
d57da08b 3338 (let ((interfaces (map (lambda (mif-args)
9b5a0d84
AW
3339 (or (apply resolve-interface mif-args)
3340 (error "no such module" mif-args)))
3341 module-interface-args)))
d57da08b
MD
3342 (call-with-deferred-observers
3343 (lambda ()
3344 (module-use-interfaces! (current-module) interfaces)))))
89da9036 3345
33cf699f 3346(defmacro use-modules modules
b15dea68
AW
3347 `(eval-when
3348 (eval load compile)
3349 (process-use-modules
3350 (list ,@(map (lambda (m)
3351 `(list ,@(compile-interface-spec m)))
3352 modules)))
3353 *unspecified*))
33cf699f 3354
cf266109 3355(defmacro use-syntax (spec)
b15dea68
AW
3356 `(eval-when
3357 (eval load compile)
13182603
AW
3358 (issue-deprecation-warning
3359 "`use-syntax' is deprecated. Please contact guile-devel for more info.")
3360 (process-use-modules (list (list ,@(compile-interface-spec spec))))
3361 *unspecified*))
0f2d19dd 3362
13182603
AW
3363(define-syntax define-private
3364 (syntax-rules ()
3365 ((_ foo bar)
3366 (define foo bar))))
3367
3368(define-syntax define-public
3369 (syntax-rules ()
3370 ((_ (name . args) . body)
3371 (define-public name (lambda args . body)))
3372 ((_ name val)
3373 (begin
3374 (define name val)
3375 (export name)))))
3376
3377(define-syntax defmacro-public
3378 (syntax-rules ()
3379 ((_ name args . body)
3380 (begin
3381 (defmacro name args . body)
3382 (export-syntax name)))))
0f2d19dd 3383
87e00370
LC
3384;; And now for the most important macro.
3385(define-syntax λ
3386 (syntax-rules ()
3387 ((_ formals body ...)
3388 (lambda formals body ...))))
3389
3390\f
89d06712 3391;; Export a local variable
482a28f9
MV
3392
3393;; This function is called from "modules.c". If you change it, be
3394;; sure to update "modules.c" as well.
3395
90847923
MD
3396(define (module-export! m names)
3397 (let ((public-i (module-public-interface m)))
3398 (for-each (lambda (name)
78c22f5e
JG
3399 (let* ((internal-name (if (pair? name) (car name) name))
3400 (external-name (if (pair? name) (cdr name) name))
3401 (var (module-ensure-local-variable! m internal-name)))
3402 (module-add! public-i external-name var)))
9b5a0d84 3403 names)))
89d06712 3404
f595ccfe
MD
3405(define (module-replace! m names)
3406 (let ((public-i (module-public-interface m)))
3407 (for-each (lambda (name)
78c22f5e
JG
3408 (let* ((internal-name (if (pair? name) (car name) name))
3409 (external-name (if (pair? name) (cdr name) name))
3410 (var (module-ensure-local-variable! m internal-name)))
9b5a0d84 3411 (set-object-property! var 'replace #t)
78c22f5e 3412 (module-add! public-i external-name var)))
9b5a0d84 3413 names)))
f595ccfe 3414
89d06712
MV
3415;; Re-export a imported variable
3416;;
3417(define (module-re-export! m names)
3418 (let ((public-i (module-public-interface m)))
3419 (for-each (lambda (name)
78c22f5e
JG
3420 (let* ((internal-name (if (pair? name) (car name) name))
3421 (external-name (if (pair? name) (cdr name) name))
3422 (var (module-variable m internal-name)))
9b5a0d84 3423 (cond ((not var)
78c22f5e
JG
3424 (error "Undefined variable:" internal-name))
3425 ((eq? var (module-local-variable m internal-name))
3426 (error "re-exporting local variable:" internal-name))
9b5a0d84 3427 (else
78c22f5e 3428 (module-add! public-i external-name var)))))
9b5a0d84 3429 names)))
90847923 3430
a0cc0a01 3431(defmacro export names
41131340
LC
3432 `(eval-when (eval load compile)
3433 (call-with-deferred-observers
3434 (lambda ()
3435 (module-export! (current-module) ',names)))))
a0cc0a01 3436
89d06712 3437(defmacro re-export names
41131340
LC
3438 `(eval-when (eval load compile)
3439 (call-with-deferred-observers
3440 (lambda ()
3441 (module-re-export! (current-module) ',names)))))
89d06712 3442
ab382f52 3443(defmacro export-syntax names
6aa9ea7c 3444 `(export ,@names))
a0cc0a01 3445
f2cbc0e5
DH
3446(defmacro re-export-syntax names
3447 `(re-export ,@names))
a0cc0a01 3448
0f2d19dd
JB
3449(define load load-module)
3450
3de80ed5
AW
3451\f
3452
f595ccfe
MD
3453;;; {Parameters}
3454;;;
3455
3456(define make-mutable-parameter
3457 (let ((make (lambda (fluid converter)
9b5a0d84
AW
3458 (lambda args
3459 (if (null? args)
3460 (fluid-ref fluid)
3461 (fluid-set! fluid (converter (car args))))))))
f595ccfe
MD
3462 (lambda (init . converter)
3463 (let ((fluid (make-fluid))
9b5a0d84
AW
3464 (converter (if (null? converter)
3465 identity
3466 (car converter))))
3467 (fluid-set! fluid (converter init))
3468 (make fluid converter)))))
f595ccfe
MD
3469
3470\f
3d2ada2f 3471
7b07e5ef
MD
3472;;; {Handling of duplicate imported bindings}
3473;;;
3474
3475;; Duplicate handlers take the following arguments:
3476;;
3477;; module importing module
9b5a0d84
AW
3478;; name conflicting name
3479;; int1 old interface where name occurs
3480;; val1 value of binding in old interface
3481;; int2 new interface where name occurs
3482;; val2 value of binding in new interface
3483;; var previous resolution or #f
3484;; val value of previous resolution
7b07e5ef
MD
3485;;
3486;; A duplicate handler can take three alternative actions:
3487;;
3488;; 1. return #f => leave responsibility to next handler
3489;; 2. exit with an error
3490;; 3. return a variable resolving the conflict
3491;;
3492
3493(define duplicate-handlers
3494 (let ((m (make-module 7)))
f595ccfe
MD
3495
3496 (define (check module name int1 val1 int2 val2 var val)
3497 (scm-error 'misc-error
9b5a0d84
AW
3498 #f
3499 "~A: `~A' imported from both ~A and ~A"
3500 (list (module-name module)
3501 name
3502 (module-name int1)
3503 (module-name int2))
3504 #f))
f595ccfe 3505
65bed4aa 3506 (define (warn module name int1 val1 int2 val2 var val)
d7c0c26d 3507 (format (current-error-port)
9b5a0d84
AW
3508 "WARNING: ~A: `~A' imported from both ~A and ~A\n"
3509 (module-name module)
3510 name
3511 (module-name int1)
3512 (module-name int2))
65bed4aa 3513 #f)
f595ccfe
MD
3514
3515 (define (replace module name int1 val1 int2 val2 var val)
3516 (let ((old (or (and var (object-property var 'replace) var)
9b5a0d84
AW
3517 (module-variable int1 name)))
3518 (new (module-variable int2 name)))
3519 (if (object-property old 'replace)
3520 (and (or (eq? old new)
3521 (not (object-property new 'replace)))
3522 old)
3523 (and (object-property new 'replace)
3524 new))))
f595ccfe 3525
65bed4aa
MD
3526 (define (warn-override-core module name int1 val1 int2 val2 var val)
3527 (and (eq? int1 the-scm-module)
9b5a0d84
AW
3528 (begin
3529 (format (current-error-port)
3530 "WARNING: ~A: imported module ~A overrides core binding `~A'\n"
3531 (module-name module)
3532 (module-name int2)
3533 name)
3534 (module-local-variable int2 name))))
f595ccfe 3535
65bed4aa
MD
3536 (define (first module name int1 val1 int2 val2 var val)
3537 (or var (module-local-variable int1 name)))
f595ccfe 3538
65bed4aa
MD
3539 (define (last module name int1 val1 int2 val2 var val)
3540 (module-local-variable int2 name))
f595ccfe 3541
65bed4aa
MD
3542 (define (noop module name int1 val1 int2 val2 var val)
3543 #f)
3544
7b07e5ef
MD
3545 (set-module-name! m 'duplicate-handlers)
3546 (set-module-kind! m 'interface)
f595ccfe
MD
3547 (module-define! m 'check check)
3548 (module-define! m 'warn warn)
3549 (module-define! m 'replace replace)
3550 (module-define! m 'warn-override-core warn-override-core)
3551 (module-define! m 'first first)
3552 (module-define! m 'last last)
65bed4aa
MD
3553 (module-define! m 'merge-generics noop)
3554 (module-define! m 'merge-accessors noop)
7b07e5ef
MD
3555 m))
3556
f595ccfe 3557(define (lookup-duplicates-handlers handler-names)
109c2c9f
MD
3558 (and handler-names
3559 (map (lambda (handler-name)
9b5a0d84
AW
3560 (or (module-symbol-local-binding
3561 duplicate-handlers handler-name #f)
3562 (error "invalid duplicate handler name:"
3563 handler-name)))
3564 (if (list? handler-names)
3565 handler-names
3566 (list handler-names)))))
f595ccfe 3567
70a459e3
MD
3568(define default-duplicate-binding-procedures
3569 (make-mutable-parameter #f))
3570
3571(define default-duplicate-binding-handler
6496a663 3572 (make-mutable-parameter '(replace warn-override-core warn last)
9b5a0d84
AW
3573 (lambda (handler-names)
3574 (default-duplicate-binding-procedures
3575 (lookup-duplicates-handlers handler-names))
3576 handler-names)))
f595ccfe 3577
7b07e5ef 3578\f
7f24bc58
MG
3579
3580;;; {`cond-expand' for SRFI-0 support.}
3581;;;
3582;;; This syntactic form expands into different commands or
3583;;; definitions, depending on the features provided by the Scheme
3584;;; implementation.
3585;;;
3586;;; Syntax:
3587;;;
3588;;; <cond-expand>
3589;;; --> (cond-expand <cond-expand-clause>+)
3590;;; | (cond-expand <cond-expand-clause>* (else <command-or-definition>))
3591;;; <cond-expand-clause>
3592;;; --> (<feature-requirement> <command-or-definition>*)
3593;;; <feature-requirement>
3594;;; --> <feature-identifier>
3595;;; | (and <feature-requirement>*)
3596;;; | (or <feature-requirement>*)
3597;;; | (not <feature-requirement>)
3598;;; <feature-identifier>
3599;;; --> <a symbol which is the name or alias of a SRFI>
3600;;;
3601;;; Additionally, this implementation provides the
3602;;; <feature-identifier>s `guile' and `r5rs', so that programs can
3603;;; determine the implementation type and the supported standard.
3604;;;
3605;;; Currently, the following feature identifiers are supported:
3606;;;
08b609aa 3607;;; guile r5rs srfi-0 srfi-4 srfi-6 srfi-13 srfi-14 srfi-55 srfi-61
7f24bc58
MG
3608;;;
3609;;; Remember to update the features list when adding more SRFIs.
3d2ada2f 3610;;;
7f24bc58 3611
b9b8f9da 3612(define %cond-expand-features
f41be016 3613 ;; Adjust the above comment when changing this.
018733ff 3614 '(guile
60c8ad9e 3615 guile-2
018733ff
KR
3616 r5rs
3617 srfi-0 ;; cond-expand itself
85acb35f 3618 srfi-4 ;; homogenous numeric vectors
018733ff 3619 srfi-6 ;; open-input-string etc, in the guile core
4a276c08
MV
3620 srfi-13 ;; string library
3621 srfi-14 ;; character sets
344d68d5 3622 srfi-55 ;; require-extension
08b609aa 3623 srfi-61 ;; general cond clause
018733ff 3624 ))
1d00af09 3625
b9b8f9da
MG
3626;; This table maps module public interfaces to the list of features.
3627;;
3628(define %cond-expand-table (make-hash-table 31))
3629
3630;; Add one or more features to the `cond-expand' feature list of the
3631;; module `module'.
3632;;
3633(define (cond-expand-provide module features)
3634 (let ((mod (module-public-interface module)))
3635 (and mod
9b5a0d84
AW
3636 (hashq-set! %cond-expand-table mod
3637 (append (hashq-ref %cond-expand-table mod '())
3638 features)))))
b9b8f9da 3639
f4bf64b4
LC
3640(define-macro (cond-expand . clauses)
3641 (let ((syntax-error (lambda (cl)
3642 (error "invalid clause in `cond-expand'" cl))))
3643 (letrec
3644 ((test-clause
3645 (lambda (clause)
3646 (cond
3647 ((symbol? clause)
3648 (or (memq clause %cond-expand-features)
3649 (let lp ((uses (module-uses (current-module))))
3650 (if (pair? uses)
3651 (or (memq clause
3652 (hashq-ref %cond-expand-table
3653 (car uses) '()))
3654 (lp (cdr uses)))
3655 #f))))
3656 ((pair? clause)
3657 (cond
3658 ((eq? 'and (car clause))
3659 (let lp ((l (cdr clause)))
3660 (cond ((null? l)
3661 #t)
3662 ((pair? l)
3663 (and (test-clause (car l)) (lp (cdr l))))
3664 (else
3665 (syntax-error clause)))))
3666 ((eq? 'or (car clause))
3667 (let lp ((l (cdr clause)))
3668 (cond ((null? l)
3669 #f)
3670 ((pair? l)
3671 (or (test-clause (car l)) (lp (cdr l))))
3672 (else
3673 (syntax-error clause)))))
3674 ((eq? 'not (car clause))
3675 (cond ((not (pair? (cdr clause)))
3676 (syntax-error clause))
3677 ((pair? (cddr clause))
3678 ((syntax-error clause))))
3679 (not (test-clause (cadr clause))))
3680 (else
3681 (syntax-error clause))))
3682 (else
3683 (syntax-error clause))))))
3684 (let lp ((c clauses))
3685 (cond
3686 ((null? c)
3687 (error "Unfulfilled `cond-expand'"))
3688 ((not (pair? c))
3689 (syntax-error c))
3690 ((not (pair? (car c)))
3691 (syntax-error (car c)))
3692 ((test-clause (caar c))
3693 `(begin ,@(cdar c)))
3694 ((eq? (caar c) 'else)
3695 (if (pair? (cdr c))
3696 (syntax-error c))
3697 `(begin ,@(cdar c)))
3698 (else
3699 (lp (cdr c))))))))
0f2d19dd 3700
f41be016
MG
3701;; This procedure gets called from the startup code with a list of
3702;; numbers, which are the numbers of the SRFIs to be loaded on startup.
3703;;
3704(define (use-srfis srfis)
9a18d8d4
KR
3705 (process-use-modules
3706 (map (lambda (num)
9b5a0d84
AW
3707 (list (list 'srfi (string->symbol
3708 (string-append "srfi-" (number->string num))))))
3709 srfis)))
f8a502cb 3710
0f2d19dd 3711\f
9d774814 3712
344d68d5
RB
3713;;; srfi-55: require-extension
3714;;;
3715
3716(define-macro (require-extension extension-spec)
3717 ;; This macro only handles the srfi extension, which, at present, is
3718 ;; the only one defined by the standard.
3719 (if (not (pair? extension-spec))
3720 (scm-error 'wrong-type-arg "require-extension"
3721 "Not an extension: ~S" (list extension-spec) #f))
3722 (let ((extension (car extension-spec))
3723 (extension-args (cdr extension-spec)))
3724 (case extension
3725 ((srfi)
3726 (let ((use-list '()))
3727 (for-each
3728 (lambda (i)
3729 (if (not (integer? i))
3730 (scm-error 'wrong-type-arg "require-extension"
3731 "Invalid srfi name: ~S" (list i) #f))
3732 (let ((srfi-sym (string->symbol
3733 (string-append "srfi-" (number->string i)))))
3734 (if (not (memq srfi-sym %cond-expand-features))
3735 (set! use-list (cons `(use-modules (srfi ,srfi-sym))
3736 use-list)))))
3737 extension-args)
3738 (if (pair? use-list)
3739 ;; i.e. (begin (use-modules x) (use-modules y) (use-modules z))
3740 `(begin ,@(reverse! use-list)))))
3741 (else
3742 (scm-error
3743 'wrong-type-arg "require-extension"
3744 "Not a recognized extension type: ~S" (list extension) #f)))))
3745
3746\f
3747
9aca88c3 3748;;; {Load emacs interface support if emacs option is given.}
3d2ada2f 3749;;;
9aca88c3 3750
645e38d9 3751(define (named-module-use! user usee)
89d06712 3752 (module-use! (resolve-module user) (resolve-interface usee)))
645e38d9 3753
9aca88c3 3754(define (load-emacs-interface)
fb1b76f4
TTN
3755 (and (provided? 'debug-extensions)
3756 (debug-enable 'backtrace))
645e38d9 3757 (named-module-use! '(guile-user) '(ice-9 emacs)))
9aca88c3
JB
3758
3759\f
0f2d19dd 3760
755457ec
MD
3761(define using-readline?
3762 (let ((using-readline? (make-fluid)))
3763 (make-procedure-with-setter
3764 (lambda () (fluid-ref using-readline?))
3765 (lambda (v) (fluid-set! using-readline? v)))))
3766
20edfbbd 3767(define (top-repl)
615bfe72
MV
3768 (let ((guile-user-module (resolve-module '(guile-user))))
3769
3770 ;; Load emacs interface support if emacs option is given.
454b82f4 3771 (if (and (module-defined? guile-user-module 'use-emacs-interface)
9b5a0d84
AW
3772 (module-ref guile-user-module 'use-emacs-interface))
3773 (load-emacs-interface))
615bfe72
MV
3774
3775 ;; Use some convenient modules (in reverse order)
bbf5a913 3776
9a18d8d4
KR
3777 (set-current-module guile-user-module)
3778 (process-use-modules
3779 (append
3780 '(((ice-9 r5rs))
9b5a0d84
AW
3781 ((ice-9 session))
3782 ((ice-9 debug)))
9a18d8d4 3783 (if (provided? 'regex)
9b5a0d84
AW
3784 '(((ice-9 regex)))
3785 '())
9a18d8d4 3786 (if (provided? 'threads)
9b5a0d84
AW
3787 '(((ice-9 threads)))
3788 '())))
615bfe72 3789 ;; load debugger on demand
42ee0d00 3790 (module-autoload! guile-user-module '(system vm debug) '(debug))
615bfe72 3791
9a18d8d4
KR
3792 ;; Note: SIGFPE, SIGSEGV and SIGBUS are actually "query-only" (see
3793 ;; scmsigs.c scm_sigaction_for_thread), so the handlers setup here have
3794 ;; no effect.
615bfe72 3795 (let ((old-handlers #f)
6a01fabf
AW
3796 (start-repl (module-ref (resolve-interface '(system repl repl))
3797 'start-repl))
9b5a0d84
AW
3798 (signals (if (provided? 'posix)
3799 `((,SIGINT . "User interrupt")
3800 (,SIGFPE . "Arithmetic error")
3801 (,SIGSEGV
3802 . "Bad memory access (Segmentation violation)"))
3803 '())))
9a18d8d4
KR
3804 ;; no SIGBUS on mingw
3805 (if (defined? 'SIGBUS)
9b5a0d84
AW
3806 (set! signals (acons SIGBUS "Bad memory access (bus error)"
3807 signals)))
615bfe72
MV
3808
3809 (dynamic-wind
3810
9b5a0d84
AW
3811 ;; call at entry
3812 (lambda ()
3813 (let ((make-handler (lambda (msg)
3814 (lambda (sig)
3815 ;; Make a backup copy of the stack
3816 (fluid-set! before-signal-stack
3817 (fluid-ref the-last-stack))
3818 (save-stack 2)
3819 (scm-error 'signal
3820 #f
3821 msg
3822 #f
3823 (list sig))))))
3824 (set! old-handlers
3825 (map (lambda (sig-msg)
3826 (sigaction (car sig-msg)
3827 (make-handler (cdr sig-msg))))
3828 signals))))
3829
3830 ;; the protected thunk.
3831 (lambda ()
6a01fabf 3832 (let ((status (start-repl 'scheme)))
9b5a0d84
AW
3833 (run-hook exit-hook)
3834 status))
3835
3836 ;; call at exit.
3837 (lambda ()
3838 (map (lambda (sig-msg old-handler)
3839 (if (not (car old-handler))
3840 ;; restore original C handler.
3841 (sigaction (car sig-msg) #f)
3842 ;; restore Scheme handler, SIG_IGN or SIG_DFL.
3843 (sigaction (car sig-msg)
3844 (car old-handler)
3845 (cdr old-handler))))
3846 signals old-handlers))))))
0f2d19dd 3847
2055a1bc
MD
3848;;; This hook is run at the very end of an interactive session.
3849;;;
3e3cec45 3850(define exit-hook (make-hook))
2055a1bc 3851
4d31f0da 3852\f
3d2ada2f
DH
3853
3854;;; {Deprecated stuff}
3855;;;
3856
3d2ada2f 3857(begin-deprecated
0ea72faa 3858 (module-use! the-scm-module (resolve-interface '(ice-9 deprecated))))
3d2ada2f
DH
3859
3860\f
3861
3862;;; Place the user in the guile-user module.
3863;;;
6eb396fe 3864
13182603
AW
3865;;; FIXME: annotate ?
3866;; (define (syncase exp)
3867;; (with-fluids ((expansion-eval-closure
9b5a0d84 3868;; (module-eval-closure (current-module))))
8a73a6d2 3869;; (deannotate/source-properties (macroexpand (annotate exp)))))
13182603 3870
a2689737
AW
3871;; FIXME:
3872(module-use! the-scm-module (resolve-interface '(srfi srfi-4)))
3873
68623e8e
AW
3874(define-module (guile-user)
3875 #:autoload (system base compile) (compile))
6d36532c 3876
7385dc12
LC
3877;; Remain in the `(guile)' module at compilation-time so that the
3878;; `-Wunused-toplevel' warning works as expected.
3879(eval-when (compile) (set-current-module the-root-module))
3880
20edfbbd 3881;;; boot-9.scm ends here