(generic-write): New per-line-prefix argument.
[bpt/guile.git] / NEWS
CommitLineData
f7b47737 1Guile NEWS --- history of user-visible changes. -*- text -*-
6fe692e9 2Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
5c54da76
JB
3See the end for copying conditions.
4
e1b6c710 5Please send Guile bug reports to bug-guile@gnu.org.
5c54da76 6\f
ee0c7345
MV
7Changes since the stable branch:
8
f12ef3fd
MV
9* Changes to the standalone interpreter
10
11** New command line option `--no-debug'.
12
13Specifying `--no-debug' on the command line will keep the debugging
14evaluator turned off, even for interactive sessions.
15
16** User-init file ~/.guile is now loaded with the debugging evaluator.
17
18Previously, the normal evaluator would have been used. Using the
19debugging evaluator gives better error messages.
20
21* Changes to Scheme functions and syntax
22
8c84b81e 23** Variables have no longer a special behavior for `equal?'.
ee0c7345
MV
24
25Previously, comparing two variables with `equal?' would recursivly
26compare their values. This is no longer done. Variables are now only
27`equal?' if they are `eq?'.
28
4e21fa60
MV
29** `(begin)' is now valid.
30
31You can now use an empty `begin' form. It will yield #<unspecified>
32when evaluated and simply be ignored in a definition context.
33
adb8c0f2
MV
34** Removed: substring-move-left!, substring-move-right!
35
36Use `substring-move!' instead.
37
b00418df
DH
38* Changes to the C interface
39
40** New function: scm_str2string
41
42This function creates a scheme string from a 0-terminated C string. The input
43string is copied.
44
4aa104a4
MV
45** Declarations of exported features are marked with SCM_API.
46
47Every declaration of a feature that belongs to the exported Guile API
48has been marked by adding the macro "SCM_API" to the start of the
49declaration. This macro can expand into different things, the most
50common of which is just "extern" for Unix platforms. On Win32, it can
51be used to control which symbols are exported from a DLL.
52
8f99e3f3 53If you `#define SCM_IMPORT' before including <libguile.h>, SCM_API
4aa104a4
MV
54will expand into "__declspec (dllimport) extern", which is needed for
55linking to the Guile DLL in Windows.
56
8f99e3f3
SJ
57There are also SCM_RL_IMPORT, QT_IMPORT, SCM_SRFI1314_IMPORT, and
58SCM_SRFI4_IMPORT, for the corresponding libraries.
4aa104a4 59
a9930d22
MV
60** SCM_NEWCELL and SCM_NEWCELL2 have been deprecated.
61
62Use the new functions scm_alloc_cell and scm_alloc_double_cell
63instead. The old macros had problems because with them allocation and
64initialization was separated and the GC could sometimes observe half
65initialized cells. Only careful coding by the user of SCM_NEWCELL and
66SCM_NEWCELL2 could make this safe and efficient.
67
c299f186
MD
68Changes since Guile 1.4:
69
70* Changes to the distribution
71
32d6f999
TTN
72** A top-level TODO file is included.
73
311b6a3c 74** Guile now uses a versioning scheme similar to that of the Linux kernel.
c81ea65d
RB
75
76Guile now always uses three numbers to represent the version,
77i.e. "1.6.5". The first number, 1, is the major version number, the
78second number, 6, is the minor version number, and the third number,
795, is the micro version number. Changes in major version number
80indicate major changes in Guile.
81
82Minor version numbers that are even denote stable releases, and odd
83minor version numbers denote development versions (which may be
84unstable). The micro version number indicates a minor sub-revision of
85a given MAJOR.MINOR release.
86
87In keeping with the new scheme, (minor-version) and scm_minor_version
88no longer return everything but the major version number. They now
89just return the minor version number. Two new functions
90(micro-version) and scm_micro_version have been added to report the
91micro version number.
92
93In addition, ./GUILE-VERSION now defines GUILE_MICRO_VERSION.
94
5c790b44
RB
95** New preprocessor definitions are available for checking versions.
96
97version.h now #defines SCM_MAJOR_VERSION, SCM_MINOR_VERSION, and
98SCM_MICRO_VERSION to the appropriate integer values.
99
311b6a3c
MV
100** Guile now actively warns about deprecated features.
101
102The new configure option `--enable-deprecated=LEVEL' and the
103environment variable GUILE_WARN_DEPRECATED control this mechanism.
104See INSTALL and README for more information.
105
0b073f0f
RB
106** Guile is much more likely to work on 64-bit architectures.
107
108Guile now compiles and passes "make check" with only two UNRESOLVED GC
5e137c65
RB
109cases on Alpha and ia64 based machines now. Thanks to John Goerzen
110for the use of a test machine, and thanks to Stefan Jahn for ia64
111patches.
0b073f0f 112
e658215a
RB
113** New functions: setitimer and getitimer.
114
115These implement a fairly direct interface to the libc functions of the
116same name.
117
8630fdfc
RB
118** The #. reader extension is now disabled by default.
119
120For safety reasons, #. evaluation is disabled by default. To
121re-enable it, set the fluid read-eval? to #t. For example:
122
67b7dd9e 123 (fluid-set! read-eval? #t)
8630fdfc
RB
124
125but make sure you realize the potential security risks involved. With
126read-eval? enabled, reading a data file from an untrusted source can
127be dangerous.
128
f2a75d81 129** New SRFI modules have been added:
4df36934 130
dfdf5826
MG
131SRFI-0 `cond-expand' is now supported in Guile, without requiring
132using a module.
133
e8bb0476
MG
134(srfi srfi-1) is a library containing many useful pair- and list-processing
135 procedures.
136
7adc2c58 137(srfi srfi-2) exports and-let*.
4df36934 138
b74a7ec8
MG
139(srfi srfi-4) implements homogeneous numeric vector datatypes.
140
7adc2c58
RB
141(srfi srfi-6) is a dummy module for now, since guile already provides
142 all of the srfi-6 procedures by default: open-input-string,
143 open-output-string, get-output-string.
4df36934 144
7adc2c58 145(srfi srfi-8) exports receive.
4df36934 146
7adc2c58 147(srfi srfi-9) exports define-record-type.
4df36934 148
dfdf5826
MG
149(srfi srfi-10) exports define-reader-ctor and implements the reader
150 extension #,().
151
7adc2c58 152(srfi srfi-11) exports let-values and let*-values.
4df36934 153
7adc2c58 154(srfi srfi-13) implements the SRFI String Library.
53e29a1e 155
7adc2c58 156(srfi srfi-14) implements the SRFI Character-Set Library.
53e29a1e 157
dfdf5826
MG
158(srfi srfi-17) implements setter and getter-with-setter and redefines
159 some accessor procedures as procedures with getters. (such as car,
160 cdr, vector-ref etc.)
161
162(srfi srfi-19) implements the SRFI Time/Date Library.
2b60bc95 163
466bb4b3
TTN
164** New scripts / "executable modules"
165
166Subdirectory "scripts" contains Scheme modules that are packaged to
167also be executable as scripts. At this time, these scripts are available:
168
169 display-commentary
170 doc-snarf
171 generate-autoload
172 punify
58e5b910 173 read-scheme-source
466bb4b3
TTN
174 use2dot
175
176See README there for more info.
177
54c17ccb
TTN
178These scripts can be invoked from the shell with the new program
179"guile-tools", which keeps track of installation directory for you.
180For example:
181
182 $ guile-tools display-commentary srfi/*.scm
183
184guile-tools is copied to the standard $bindir on "make install".
185
0109c4bf
MD
186** New module (ice-9 stack-catch):
187
188stack-catch is like catch, but saves the current state of the stack in
3c1d1301
RB
189the fluid the-last-stack. This fluid can be useful when using the
190debugger and when re-throwing an error.
0109c4bf 191
fbf0c8c7
MV
192** The module (ice-9 and-let*) has been renamed to (ice-9 and-let-star)
193
194This has been done to prevent problems on lesser operating systems
195that can't tolerate `*'s in file names. The exported macro continues
196to be named `and-let*', of course.
197
4f60cc33 198On systems that support it, there is also a compatibility module named
fbf0c8c7 199(ice-9 and-let*). It will go away in the next release.
6c0201ad 200
9d774814 201** New modules (oop goops) etc.:
14f1d9fe
MD
202
203 (oop goops)
204 (oop goops describe)
205 (oop goops save)
206 (oop goops active-slot)
207 (oop goops composite-slot)
208
9d774814 209The Guile Object Oriented Programming System (GOOPS) has been
311b6a3c
MV
210integrated into Guile. For further information, consult the GOOPS
211manual and tutorial in the `doc' directory.
14f1d9fe 212
9d774814
GH
213** New module (ice-9 rdelim).
214
215This exports the following procedures which were previously defined
1c8cbd62 216in the default environment:
9d774814 217
1c8cbd62
GH
218read-line read-line! read-delimited read-delimited! %read-delimited!
219%read-line write-line
9d774814 220
1c8cbd62
GH
221For backwards compatibility the definitions are still imported into the
222default environment in this version of Guile. However you should add:
9d774814
GH
223
224(use-modules (ice-9 rdelim))
225
1c8cbd62
GH
226to any program which uses the definitions, since this may change in
227future.
9d774814
GH
228
229Alternatively, if guile-scsh is installed, the (scsh rdelim) module
230can be used for similar functionality.
231
7e267da1
GH
232** New module (ice-9 rw)
233
234This is a subset of the (scsh rw) module from guile-scsh. Currently
373f4948 235it defines two procedures:
7e267da1 236
311b6a3c 237*** New function: read-string!/partial str [port_or_fdes [start [end]]]
7e267da1 238
4bcdfe46
GH
239 Read characters from a port or file descriptor into a string STR.
240 A port must have an underlying file descriptor -- a so-called
241 fport. This procedure is scsh-compatible and can efficiently read
311b6a3c 242 large strings.
7e267da1 243
4bcdfe46
GH
244*** New function: write-string/partial str [port_or_fdes [start [end]]]
245
246 Write characters from a string STR to a port or file descriptor.
247 A port must have an underlying file descriptor -- a so-called
248 fport. This procedure is mostly compatible and can efficiently
249 write large strings.
250
e5005373
KN
251** New module (ice-9 match)
252
311b6a3c
MV
253This module includes Andrew K. Wright's pattern matcher. See
254ice-9/match.scm for brief description or
e5005373 255
311b6a3c 256 http://www.star-lab.com/wright/code.html
e5005373 257
311b6a3c 258for complete documentation.
e5005373 259
4f60cc33
NJ
260** New module (ice-9 buffered-input)
261
262This module provides procedures to construct an input port from an
263underlying source of input that reads and returns its input in chunks.
264The underlying input source is a Scheme procedure, specified by the
265caller, which the port invokes whenever it needs more input.
266
267This is useful when building an input port whose back end is Readline
268or a UI element such as the GtkEntry widget.
269
270** Documentation
271
272The reference and tutorial documentation that was previously
273distributed separately, as `guile-doc', is now included in the core
274Guile distribution. The documentation consists of the following
275manuals.
276
277- The Guile Tutorial (guile-tut.texi) contains a tutorial introduction
278 to using Guile.
279
280- The Guile Reference Manual (guile.texi) contains (or is intended to
281 contain) reference documentation on all aspects of Guile.
282
283- The GOOPS Manual (goops.texi) contains both tutorial-style and
284 reference documentation for using GOOPS, Guile's Object Oriented
285 Programming System.
286
c3e62877
NJ
287- The Revised^5 Report on the Algorithmic Language Scheme
288 (r5rs.texi).
4f60cc33
NJ
289
290See the README file in the `doc' directory for more details.
291
094a67bb
MV
292** There are a couple of examples in the examples/ directory now.
293
9d774814
GH
294* Changes to the stand-alone interpreter
295
e7e58018
MG
296** New command line option `--use-srfi'
297
298Using this option, SRFI modules can be loaded on startup and be
299available right from the beginning. This makes programming portable
300Scheme programs easier.
301
302The option `--use-srfi' expects a comma-separated list of numbers,
303each representing a SRFI number to be loaded into the interpreter
304before starting evaluating a script file or the REPL. Additionally,
305the feature identifier for the loaded SRFIs is recognized by
306`cond-expand' when using this option.
307
308Example:
309$ guile --use-srfi=8,13
310guile> (receive (x z) (values 1 2) (+ 1 2))
3113
58e5b910 312guile> (string-pad "bla" 20)
e7e58018
MG
313" bla"
314
094a67bb
MV
315** Guile now always starts up in the `(guile-user)' module.
316
6e9382f1 317Previously, scripts executed via the `-s' option would run in the
094a67bb
MV
318`(guile)' module and the repl would run in the `(guile-user)' module.
319Now every user action takes place in the `(guile-user)' module by
320default.
e7e58018 321
c299f186
MD
322* Changes to Scheme functions and syntax
323
720e1c30
MV
324** Character classifiers work for non-ASCII characters.
325
326The predicates `char-alphabetic?', `char-numeric?',
327`char-whitespace?', `char-lower?', `char-upper?' and `char-is-both?'
328no longer check whether their arguments are ASCII characters.
329Previously, a character would only be considered alphabetic when it
330was also ASCII, for example.
331
311b6a3c
MV
332** Previously deprecated Scheme functions have been removed:
333
334 tag - no replacement.
335 fseek - replaced by seek.
336 list* - replaced by cons*.
337
338** It's now possible to create modules with controlled environments
339
340Example:
341
342(use-modules (ice-9 safe))
343(define m (make-safe-module))
344;;; m will now be a module containing only a safe subset of R5RS
345(eval '(+ 1 2) m) --> 3
346(eval 'load m) --> ERROR: Unbound variable: load
347
348** Evaluation of "()", the empty list, is now an error.
8c2c9967
MV
349
350Previously, the expression "()" evaluated to the empty list. This has
351been changed to signal a "missing expression" error. The correct way
352to write the empty list as a literal constant is to use quote: "'()".
353
311b6a3c
MV
354** New concept of `Guile Extensions'.
355
356A Guile Extension is just a ordinary shared library that can be linked
357at run-time. We found it advantageous to give this simple concept a
358dedicated name to distinguish the issues related to shared libraries
359from the issues related to the module system.
360
361*** New function: load-extension
362
363Executing (load-extension lib init) is mostly equivalent to
364
365 (dynamic-call init (dynamic-link lib))
366
367except when scm_register_extension has been called previously.
368Whenever appropriate, you should use `load-extension' instead of
369dynamic-link and dynamic-call.
370
371*** New C function: scm_c_register_extension
372
373This function registers a initialization function for use by
374`load-extension'. Use it when you don't want specific extensions to
375be loaded as shared libraries (for example on platforms that don't
376support dynamic linking).
377
8c2c9967
MV
378** Auto-loading of compiled-code modules is deprecated.
379
380Guile used to be able to automatically find and link a shared
c10ecc4c 381library to satisfy requests for a module. For example, the module
8c2c9967
MV
382`(foo bar)' could be implemented by placing a shared library named
383"foo/libbar.so" (or with a different extension) in a directory on the
384load path of Guile.
385
311b6a3c
MV
386This has been found to be too tricky, and is no longer supported. The
387shared libraries are now called "extensions". You should now write a
388small Scheme file that calls `load-extension' to load the shared
389library and initialize it explicitely.
8c2c9967
MV
390
391The shared libraries themselves should be installed in the usual
392places for shared libraries, with names like "libguile-foo-bar".
393
394For example, place this into a file "foo/bar.scm"
395
396 (define-module (foo bar))
397
311b6a3c
MV
398 (load-extension "libguile-foo-bar" "foobar_init")
399
400** Backward incompatible change: eval EXP ENVIRONMENT-SPECIFIER
401
402`eval' is now R5RS, that is it takes two arguments.
403The second argument is an environment specifier, i.e. either
404
405 (scheme-report-environment 5)
406 (null-environment 5)
407 (interaction-environment)
408
409or
8c2c9967 410
311b6a3c 411 any module.
8c2c9967 412
6f76852b
MV
413** The module system has been made more disciplined.
414
311b6a3c
MV
415The function `eval' will save and restore the current module around
416the evaluation of the specified expression. While this expression is
417evaluated, `(current-module)' will now return the right module, which
418is the module specified as the second argument to `eval'.
6f76852b 419
311b6a3c 420A consequence of this change is that `eval' is not particularly
6f76852b
MV
421useful when you want allow the evaluated code to change what module is
422designated as the current module and have this change persist from one
423call to `eval' to the next. The read-eval-print-loop is an example
424where `eval' is now inadequate. To compensate, there is a new
425function `primitive-eval' that does not take a module specifier and
426that does not save/restore the current module. You should use this
427function together with `set-current-module', `current-module', etc
428when you want to have more control over the state that is carried from
429one eval to the next.
430
431Additionally, it has been made sure that forms that are evaluated at
432the top level are always evaluated with respect to the current module.
433Previously, subforms of top-level forms such as `begin', `case',
434etc. did not respect changes to the current module although these
435subforms are at the top-level as well.
436
311b6a3c 437To prevent strange behavior, the forms `define-module',
6f76852b
MV
438`use-modules', `use-syntax', and `export' have been restricted to only
439work on the top level. The forms `define-public' and
440`defmacro-public' only export the new binding on the top level. They
441behave just like `define' and `defmacro', respectively, when they are
442used in a lexical environment.
443
0a892a2c
MV
444Also, `export' will no longer silently re-export bindings imported
445from a used module. It will emit a `deprecation' warning and will
446cease to perform any re-export in the next version. If you actually
447want to re-export bindings, use the new `re-export' in place of
448`export'. The new `re-export' will not make copies of variables when
449rexporting them, as `export' did wrongly.
450
047dc3ae
TTN
451** Module system now allows selection and renaming of imported bindings
452
453Previously, when using `use-modules' or the `#:use-module' clause in
454the `define-module' form, all the bindings (association of symbols to
455values) for imported modules were added to the "current module" on an
456as-is basis. This has been changed to allow finer control through two
457new facilities: selection and renaming.
458
459You can now select which of the imported module's bindings are to be
460visible in the current module by using the `:select' clause. This
461clause also can be used to rename individual bindings. For example:
462
463 ;; import all bindings no questions asked
464 (use-modules (ice-9 common-list))
465
466 ;; import four bindings, renaming two of them;
467 ;; the current module sees: every some zonk-y zonk-n
468 (use-modules ((ice-9 common-list)
469 :select (every some
470 (remove-if . zonk-y)
471 (remove-if-not . zonk-n))))
472
473You can also programmatically rename all selected bindings using the
474`:renamer' clause, which specifies a proc that takes a symbol and
475returns another symbol. Because it is common practice to use a prefix,
476we now provide the convenience procedure `symbol-prefix-proc'. For
477example:
478
479 ;; import four bindings, renaming two of them specifically,
480 ;; and all four w/ prefix "CL:";
481 ;; the current module sees: CL:every CL:some CL:zonk-y CL:zonk-n
482 (use-modules ((ice-9 common-list)
483 :select (every some
484 (remove-if . zonk-y)
485 (remove-if-not . zonk-n))
486 :renamer (symbol-prefix-proc 'CL:)))
487
488 ;; import four bindings, renaming two of them specifically,
489 ;; and all four by upcasing.
490 ;; the current module sees: EVERY SOME ZONK-Y ZONK-N
491 (define (upcase-symbol sym)
492 (string->symbol (string-upcase (symbol->string sym))))
493
494 (use-modules ((ice-9 common-list)
495 :select (every some
496 (remove-if . zonk-y)
497 (remove-if-not . zonk-n))
498 :renamer upcase-symbol))
499
500Note that programmatic renaming is done *after* individual renaming.
501Also, the above examples show `use-modules', but the same facilities are
502available for the `#:use-module' clause of `define-module'.
503
504See manual for more info.
505
b7d69200 506** The semantics of guardians have changed.
56495472 507
b7d69200 508The changes are for the most part compatible. An important criterion
6c0201ad 509was to keep the typical usage of guardians as simple as before, but to
c0a5d888 510make the semantics safer and (as a result) more useful.
56495472 511
c0a5d888 512*** All objects returned from guardians are now properly alive.
56495472 513
c0a5d888
ML
514It is now guaranteed that any object referenced by an object returned
515from a guardian is alive. It's now impossible for a guardian to
516return a "contained" object before its "containing" object.
56495472
ML
517
518One incompatible (but probably not very important) change resulting
519from this is that it is no longer possible to guard objects that
520indirectly reference themselves (i.e. are parts of cycles). If you do
521so accidentally, you'll get a warning.
522
c0a5d888
ML
523*** There are now two types of guardians: greedy and sharing.
524
525If you call (make-guardian #t) or just (make-guardian), you'll get a
526greedy guardian, and for (make-guardian #f) a sharing guardian.
527
528Greedy guardians are the default because they are more "defensive".
529You can only greedily guard an object once. If you guard an object
530more than once, once in a greedy guardian and the rest of times in
531sharing guardians, then it is guaranteed that the object won't be
532returned from sharing guardians as long as it is greedily guarded
533and/or alive.
534
535Guardians returned by calls to `make-guardian' can now take one more
536optional parameter, which says whether to throw an error in case an
537attempt is made to greedily guard an object that is already greedily
538guarded. The default is true, i.e. throw an error. If the parameter
539is false, the guardian invocation returns #t if guarding was
540successful and #f if it wasn't.
541
542Also, since greedy guarding is, in effect, a side-effecting operation
543on objects, a new function is introduced: `destroy-guardian!'.
544Invoking this function on a guardian renders it unoperative and, if
545the guardian is greedy, clears the "greedily guarded" property of the
546objects that were guarded by it, thus undoing the side effect.
547
548Note that all this hair is hardly very important, since guardian
549objects are usually permanent.
550
311b6a3c
MV
551** Continuations created by call-with-current-continuation now accept
552any number of arguments, as required by R5RS.
818febc0 553
c10ecc4c 554** New function `issue-deprecation-warning'
56426fdb 555
311b6a3c 556This function is used to display the deprecation messages that are
c10ecc4c 557controlled by GUILE_WARN_DEPRECATION as explained in the README.
56426fdb
KN
558
559 (define (id x)
c10ecc4c
MV
560 (issue-deprecation-warning "`id' is deprecated. Use `identity' instead.")
561 (identity x))
56426fdb
KN
562
563 guile> (id 1)
564 ;; `id' is deprecated. Use `identity' instead.
565 1
566 guile> (id 1)
567 1
568
c10ecc4c
MV
569** New syntax `begin-deprecated'
570
571When deprecated features are included (as determined by the configure
572option --enable-deprecated), `begin-deprecated' is identical to
573`begin'. When deprecated features are excluded, it always evaluates
574to `#f', ignoring the body forms.
575
17f367e0
MV
576** New function `make-object-property'
577
578This function returns a new `procedure with setter' P that can be used
579to attach a property to objects. When calling P as
580
581 (set! (P obj) val)
582
583where `obj' is any kind of object, it attaches `val' to `obj' in such
584a way that it can be retrieved by calling P as
585
586 (P obj)
587
588This function will replace procedure properties, symbol properties and
589source properties eventually.
590
76ef92f3
MV
591** Module (ice-9 optargs) now uses keywords instead of `#&'.
592
593Instead of #&optional, #&key, etc you should now use #:optional,
594#:key, etc. Since #:optional is a keyword, you can write it as just
595:optional when (read-set! keywords 'prefix) is active.
596
597The old reader syntax `#&' is still supported, but deprecated. It
598will be removed in the next release.
599
c0997079
MD
600** New define-module option: pure
601
602Tells the module system not to include any bindings from the root
603module.
604
605Example:
606
607(define-module (totally-empty-module)
608 :pure)
609
610** New define-module option: export NAME1 ...
611
612Export names NAME1 ...
613
614This option is required if you want to be able to export bindings from
615a module which doesn't import one of `define-public' or `export'.
616
617Example:
618
311b6a3c
MV
619 (define-module (foo)
620 :pure
621 :use-module (ice-9 r5rs)
622 :export (bar))
69b5f65a 623
311b6a3c 624 ;;; Note that we're pure R5RS below this point!
69b5f65a 625
311b6a3c
MV
626 (define (bar)
627 ...)
daa6ba18 628
1f3908c4
KN
629** New function: object->string OBJ
630
631Return a Scheme string obtained by printing a given object.
632
eb5c0a2a
GH
633** New function: port? X
634
635Returns a boolean indicating whether X is a port. Equivalent to
636`(or (input-port? X) (output-port? X))'.
637
efa40607
DH
638** New function: file-port?
639
640Determines whether a given object is a port that is related to a file.
641
34b56ec4
GH
642** New function: port-for-each proc
643
311b6a3c
MV
644Apply PROC to each port in the Guile port table in turn. The return
645value is unspecified. More specifically, PROC is applied exactly once
646to every port that exists in the system at the time PORT-FOR-EACH is
647invoked. Changes to the port table while PORT-FOR-EACH is running
648have no effect as far as PORT-FOR-EACH is concerned.
34b56ec4
GH
649
650** New function: dup2 oldfd newfd
651
652A simple wrapper for the `dup2' system call. Copies the file
653descriptor OLDFD to descriptor number NEWFD, replacing the
654previous meaning of NEWFD. Both OLDFD and NEWFD must be integers.
655Unlike for dup->fdes or primitive-move->fdes, no attempt is made
264e9cbc 656to move away ports which are using NEWFD. The return value is
34b56ec4
GH
657unspecified.
658
659** New function: close-fdes fd
660
661A simple wrapper for the `close' system call. Close file
662descriptor FD, which must be an integer. Unlike close (*note
663close: Ports and File Descriptors.), the file descriptor will be
664closed even if a port is using it. The return value is
665unspecified.
666
94e6d793
MG
667** New function: crypt password salt
668
669Encrypts `password' using the standard unix password encryption
670algorithm.
671
672** New function: chroot path
673
674Change the root directory of the running process to `path'.
675
676** New functions: getlogin, cuserid
677
678Return the login name or the user name of the current effective user
679id, respectively.
680
681** New functions: getpriority which who, setpriority which who prio
682
683Get or set the priority of the running process.
684
685** New function: getpass prompt
686
687Read a password from the terminal, first displaying `prompt' and
688disabling echoing.
689
690** New function: flock file operation
691
692Set/remove an advisory shared or exclusive lock on `file'.
693
694** New functions: sethostname name, gethostname
695
696Set or get the hostname of the machine the current process is running
697on.
698
6d163216 699** New function: mkstemp! tmpl
4f60cc33 700
6d163216
GH
701mkstemp creates a new unique file in the file system and returns a
702new buffered port open for reading and writing to the file. TMPL
703is a string specifying where the file should be created: it must
704end with `XXXXXX' and will be changed in place to return the name
705of the temporary file.
706
62e63ba9
MG
707** New function: open-input-string string
708
709Return an input string port which delivers the characters from
4f60cc33 710`string'. This procedure, together with `open-output-string' and
62e63ba9
MG
711`get-output-string' implements SRFI-6.
712
713** New function: open-output-string
714
715Return an output string port which collects all data written to it.
716The data can then be retrieved by `get-output-string'.
717
718** New function: get-output-string
719
720Return the contents of an output string port.
721
56426fdb
KN
722** New function: identity
723
724Return the argument.
725
5bef627d
GH
726** socket, connect, accept etc., now have support for IPv6. IPv6 addresses
727 are represented in Scheme as integers with normal host byte ordering.
728
729** New function: inet-pton family address
730
311b6a3c
MV
731Convert a printable string network address into an integer. Note that
732unlike the C version of this function, the result is an integer with
733normal host byte ordering. FAMILY can be `AF_INET' or `AF_INET6'.
734e.g.,
735
736 (inet-pton AF_INET "127.0.0.1") => 2130706433
737 (inet-pton AF_INET6 "::1") => 1
5bef627d
GH
738
739** New function: inet-ntop family address
740
311b6a3c
MV
741Convert an integer network address into a printable string. Note that
742unlike the C version of this function, the input is an integer with
743normal host byte ordering. FAMILY can be `AF_INET' or `AF_INET6'.
744e.g.,
745
746 (inet-ntop AF_INET 2130706433) => "127.0.0.1"
747 (inet-ntop AF_INET6 (- (expt 2 128) 1)) =>
5bef627d
GH
748 ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff
749
56426fdb
KN
750** Deprecated: id
751
752Use `identity' instead.
753
5cd06d5e
DH
754** Deprecated: -1+
755
756Use `1-' instead.
757
758** Deprecated: return-it
759
311b6a3c 760Do without it.
5cd06d5e
DH
761
762** Deprecated: string-character-length
763
764Use `string-length' instead.
765
766** Deprecated: flags
767
768Use `logior' instead.
769
4f60cc33
NJ
770** Deprecated: close-all-ports-except.
771
772This was intended for closing ports in a child process after a fork,
773but it has the undesirable side effect of flushing buffers.
774port-for-each is more flexible.
34b56ec4
GH
775
776** The (ice-9 popen) module now attempts to set up file descriptors in
777the child process from the current Scheme ports, instead of using the
778current values of file descriptors 0, 1, and 2 in the parent process.
779
b52e071b
DH
780** Removed function: builtin-weak-bindings
781
782There is no such concept as a weak binding any more.
783
9d774814 784** Removed constants: bignum-radix, scm-line-incrementors
0f979f3f 785
7d435120
MD
786** define-method: New syntax mandatory.
787
788The new method syntax is now mandatory:
789
790(define-method (NAME ARG-SPEC ...) BODY ...)
791(define-method (NAME ARG-SPEC ... . REST-ARG) BODY ...)
792
793 ARG-SPEC ::= ARG-NAME | (ARG-NAME TYPE)
794 REST-ARG ::= ARG-NAME
795
796If you have old code using the old syntax, import
797(oop goops old-define-method) before (oop goops) as in:
798
799 (use-modules (oop goops old-define-method) (oop goops))
800
f3f9dcbc
MV
801** Deprecated function: builtin-variable
802 Removed function: builtin-bindings
803
804There is no longer a distinction between builtin or other variables.
805Use module system operations for all variables.
806
311b6a3c
MV
807** Lazy-catch handlers are no longer allowed to return.
808
809That is, a call to `throw', `error', etc is now guaranteed to not
810return.
811
a583bf1e 812** Bugfixes for (ice-9 getopt-long)
8c84b81e 813
a583bf1e
TTN
814This module is now tested using test-suite/tests/getopt-long.test.
815The following bugs have been fixed:
816
817*** Parsing for options that are specified to have `optional' args now checks
818if the next element is an option instead of unconditionally taking it as the
8c84b81e
TTN
819option arg.
820
a583bf1e
TTN
821*** An error is now thrown for `--opt=val' when the option description
822does not specify `(value #t)' or `(value optional)'. This condition used to
823be accepted w/o error, contrary to the documentation.
824
825*** The error message for unrecognized options is now more informative.
826It used to be "not a record", an artifact of the implementation.
827
828*** The error message for `--opt' terminating the arg list (no value), when
829`(value #t)' is specified, is now more informative. It used to be "not enough
830args".
831
832*** "Clumped" single-char args now preserve trailing string, use it as arg.
833The expansion used to be like so:
834
835 ("-abc5d" "--xyz") => ("-a" "-b" "-c" "--xyz")
836
837Note that the "5d" is dropped. Now it is like so:
838
839 ("-abc5d" "--xyz") => ("-a" "-b" "-c" "5d" "--xyz")
840
841This enables single-char options to have adjoining arguments as long as their
842constituent characters are not potential single-char options.
8c84b81e 843
998bfc70
TTN
844** (ice-9 session) procedure `arity' now works with (ice-9 optargs) `lambda*'
845
846The `lambda*' and derivative forms in (ice-9 optargs) now set a procedure
847property `arglist', which can be retrieved by `arity'. The result is that
848`arity' can give more detailed information than before:
849
850Before:
851
852 guile> (use-modules (ice-9 optargs))
853 guile> (define* (foo #:optional a b c) a)
854 guile> (arity foo)
855 0 or more arguments in `lambda*:G0'.
856
857After:
858
859 guile> (arity foo)
860 3 optional arguments: `a', `b' and `c'.
861 guile> (define* (bar a b #:key c d #:allow-other-keys) a)
862 guile> (arity bar)
863 2 required arguments: `a' and `b', 2 keyword arguments: `c'
864 and `d', other keywords allowed.
865 guile> (define* (baz a b #:optional c #:rest r) a)
866 guile> (arity baz)
867 2 required arguments: `a' and `b', 1 optional argument: `c',
868 the rest in `r'.
869
311b6a3c
MV
870* Changes to the C interface
871
c81c130e
MV
872** Types have been renamed from scm_*_t to scm_t_*.
873
874This has been done for POSIX sake. It reserves identifiers ending
875with "_t". What a concept.
876
877The old names are still available with status `deprecated'.
878
879** scm_t_bits (former scm_bits_t) is now a unsigned type.
880
6e9382f1 881** Deprecated features have been removed.
e6c9e497
MV
882
883*** Macros removed
884
885 SCM_INPORTP, SCM_OUTPORTP SCM_ICHRP, SCM_ICHR, SCM_MAKICHR
886 SCM_SETJMPBUF SCM_NSTRINGP SCM_NRWSTRINGP SCM_NVECTORP SCM_DOUBLE_CELLP
887
888*** C Functions removed
889
890 scm_sysmissing scm_tag scm_tc16_flo scm_tc_flo
891 scm_fseek - replaced by scm_seek.
892 gc-thunk - replaced by after-gc-hook.
893 gh_int2scmb - replaced by gh_bool2scm.
894 scm_tc_dblr - replaced by scm_tc16_real.
895 scm_tc_dblc - replaced by scm_tc16_complex.
896 scm_list_star - replaced by scm_cons_star.
897
36284627
DH
898** Deprecated: scm_makfromstr
899
900Use scm_mem2string instead.
901
311b6a3c
MV
902** Deprecated: scm_make_shared_substring
903
904Explicit shared substrings will disappear from Guile.
905
906Instead, "normal" strings will be implemented using sharing
907internally, combined with a copy-on-write strategy.
908
909** Deprecated: scm_read_only_string_p
910
911The concept of read-only strings will disappear in next release of
912Guile.
913
914** Deprecated: scm_sloppy_memq, scm_sloppy_memv, scm_sloppy_member
c299f186 915
311b6a3c 916Instead, use scm_c_memq or scm_memq, scm_memv, scm_member.
c299f186 917
dd0e04ed
KN
918** New functions: scm_call_0, scm_call_1, scm_call_2, scm_call_3
919
920Call a procedure with the indicated number of arguments.
921
922Example:
923
924 scm_call_1 (proc, arg1);
925
926** New functions: scm_apply_0, scm_apply_1, scm_apply_2, scm_apply_3
927
928Call a procedure with the indicated number of arguments and a list
929of arguments.
930
931Example:
932
933 scm_apply_1 (proc, arg1, args);
934
e235f2a6
KN
935** New functions: scm_list_1, scm_list_2, scm_list_3, scm_list_4, scm_list_5
936
937Create a list of the given number of elements.
938
939** Renamed function: scm_listify has been replaced by scm_list_n.
940
941** Deprecated macros: SCM_LIST0, SCM_LIST1, SCM_LIST2, SCM_LIST3, SCM_LIST4,
942SCM_LIST5, SCM_LIST6, SCM_LIST7, SCM_LIST8, SCM_LIST9.
943
944Use functions scm_list_N instead.
945
6fe692e9
MD
946** New function: scm_c_read (SCM port, void *buffer, scm_sizet size)
947
948Used by an application to read arbitrary number of bytes from a port.
949Same semantics as libc read, except that scm_c_read only returns less
950than SIZE bytes if at end-of-file.
951
952Warning: Doesn't update port line and column counts!
953
954** New function: scm_c_write (SCM port, const void *ptr, scm_sizet size)
955
956Used by an application to write arbitrary number of bytes to an SCM
957port. Similar semantics as libc write. However, unlike libc
958write, scm_c_write writes the requested number of bytes and has no
959return value.
960
961Warning: Doesn't update port line and column counts!
962
17f367e0
MV
963** New function: scm_init_guile ()
964
965In contrast to scm_boot_guile, scm_init_guile will return normally
966after initializing Guile. It is not available on all systems, tho.
967
23ade5e7
DH
968** New functions: scm_str2symbol, scm_mem2symbol
969
970The function scm_str2symbol takes a const char* pointing to a zero-terminated
971field of characters and creates a scheme symbol object from that C string.
972The function scm_mem2symbol takes a const char* and a number of characters and
973creates a symbol from the characters in that memory area.
974
17f367e0
MV
975** New functions: scm_primitive_make_property
976 scm_primitive_property_ref
977 scm_primitive_property_set_x
978 scm_primitive_property_del_x
979
980These functions implement a new way to deal with object properties.
981See libguile/properties.c for their documentation.
982
9d47a1e6
ML
983** New function: scm_done_free (long size)
984
985This function is the inverse of scm_done_malloc. Use it to report the
986amount of smob memory you free. The previous method, which involved
987calling scm_done_malloc with negative argument, was somewhat
988unintuitive (and is still available, of course).
989
79a3dafe
DH
990** New function: scm_c_memq (SCM obj, SCM list)
991
992This function provides a fast C level alternative for scm_memq for the case
993that the list parameter is known to be a proper list. The function is a
994replacement for scm_sloppy_memq, but is stricter in its requirements on its
995list input parameter, since for anything else but a proper list the function's
996behaviour is undefined - it may even crash or loop endlessly. Further, for
997the case that the object is not found in the list, scm_c_memq returns #f which
998is similar to scm_memq, but different from scm_sloppy_memq's behaviour.
999
6c0201ad 1000** New functions: scm_remember_upto_here_1, scm_remember_upto_here_2,
5d2b97cd
DH
1001scm_remember_upto_here
1002
1003These functions replace the function scm_remember.
1004
1005** Deprecated function: scm_remember
1006
1007Use one of the new functions scm_remember_upto_here_1,
1008scm_remember_upto_here_2 or scm_remember_upto_here instead.
1009
be54b15d
DH
1010** New function: scm_allocate_string
1011
1012This function replaces the function scm_makstr.
1013
1014** Deprecated function: scm_makstr
1015
1016Use the new function scm_allocate_string instead.
1017
32d0d4b1
DH
1018** New global variable scm_gc_running_p introduced.
1019
1020Use this variable to find out if garbage collection is being executed. Up to
1021now applications have used scm_gc_heap_lock to test if garbage collection was
1022running, which also works because of the fact that up to know only the garbage
1023collector has set this variable. But, this is an implementation detail that
1024may change. Further, scm_gc_heap_lock is not set throughout gc, thus the use
1025of this variable is (and has been) not fully safe anyway.
1026
5b9eb8ae
DH
1027** New macros: SCM_BITVECTOR_MAX_LENGTH, SCM_UVECTOR_MAX_LENGTH
1028
1029Use these instead of SCM_LENGTH_MAX.
1030
6c0201ad 1031** New macros: SCM_CONTINUATION_LENGTH, SCM_CCLO_LENGTH, SCM_STACK_LENGTH,
a6d9e5ab
DH
1032SCM_STRING_LENGTH, SCM_SYMBOL_LENGTH, SCM_UVECTOR_LENGTH,
1033SCM_BITVECTOR_LENGTH, SCM_VECTOR_LENGTH.
1034
1035Use these instead of SCM_LENGTH.
1036
6c0201ad 1037** New macros: SCM_SET_CONTINUATION_LENGTH, SCM_SET_STRING_LENGTH,
93778877
DH
1038SCM_SET_SYMBOL_LENGTH, SCM_SET_VECTOR_LENGTH, SCM_SET_UVECTOR_LENGTH,
1039SCM_SET_BITVECTOR_LENGTH
bc0eaf7b
DH
1040
1041Use these instead of SCM_SETLENGTH
1042
6c0201ad 1043** New macros: SCM_STRING_CHARS, SCM_SYMBOL_CHARS, SCM_CCLO_BASE,
a6d9e5ab
DH
1044SCM_VECTOR_BASE, SCM_UVECTOR_BASE, SCM_BITVECTOR_BASE, SCM_COMPLEX_MEM,
1045SCM_ARRAY_MEM
1046
e51fe79c
DH
1047Use these instead of SCM_CHARS, SCM_UCHARS, SCM_ROCHARS, SCM_ROUCHARS or
1048SCM_VELTS.
a6d9e5ab 1049
6c0201ad 1050** New macros: SCM_SET_BIGNUM_BASE, SCM_SET_STRING_CHARS,
6a0476fd
DH
1051SCM_SET_SYMBOL_CHARS, SCM_SET_UVECTOR_BASE, SCM_SET_BITVECTOR_BASE,
1052SCM_SET_VECTOR_BASE
1053
1054Use these instead of SCM_SETCHARS.
1055
a6d9e5ab
DH
1056** New macro: SCM_BITVECTOR_P
1057
1058** New macro: SCM_STRING_COERCE_0TERMINATION_X
1059
1060Use instead of SCM_COERCE_SUBSTR.
1061
30ea841d
DH
1062** New macros: SCM_DIR_OPEN_P, SCM_DIR_FLAG_OPEN
1063
1064For directory objects, use these instead of SCM_OPDIRP and SCM_OPN.
1065
6c0201ad
TTN
1066** Deprecated macros: SCM_OUTOFRANGE, SCM_NALLOC, SCM_HUP_SIGNAL,
1067SCM_INT_SIGNAL, SCM_FPE_SIGNAL, SCM_BUS_SIGNAL, SCM_SEGV_SIGNAL,
1068SCM_ALRM_SIGNAL, SCM_GC_SIGNAL, SCM_TICK_SIGNAL, SCM_SIG_ORD,
d1ca2c64 1069SCM_ORD_SIG, SCM_NUM_SIGS, SCM_SYMBOL_SLOTS, SCM_SLOTS, SCM_SLOPPY_STRINGP,
a6d9e5ab
DH
1070SCM_VALIDATE_STRINGORSUBSTR, SCM_FREEP, SCM_NFREEP, SCM_CHARS, SCM_UCHARS,
1071SCM_VALIDATE_ROSTRING, SCM_VALIDATE_ROSTRING_COPY,
1072SCM_VALIDATE_NULLORROSTRING_COPY, SCM_ROLENGTH, SCM_LENGTH, SCM_HUGE_LENGTH,
b24b5e13 1073SCM_SUBSTRP, SCM_SUBSTR_STR, SCM_SUBSTR_OFFSET, SCM_COERCE_SUBSTR,
34f0f2b8 1074SCM_ROSTRINGP, SCM_RWSTRINGP, SCM_VALIDATE_RWSTRING, SCM_ROCHARS,
fd336365 1075SCM_ROUCHARS, SCM_SETLENGTH, SCM_SETCHARS, SCM_LENGTH_MAX, SCM_GC8MARKP,
30ea841d 1076SCM_SETGC8MARK, SCM_CLRGC8MARK, SCM_GCTYP16, SCM_GCCDR, SCM_SUBR_DOC,
b3fcac34
DH
1077SCM_OPDIRP, SCM_VALIDATE_OPDIR, SCM_WTA, RETURN_SCM_WTA, SCM_CONST_LONG,
1078SCM_WNA, SCM_FUNC_NAME, SCM_VALIDATE_NUMBER_COPY,
61045190 1079SCM_VALIDATE_NUMBER_DEF_COPY, SCM_SLOPPY_CONSP, SCM_SLOPPY_NCONSP,
e038c042 1080SCM_SETAND_CDR, SCM_SETOR_CDR, SCM_SETAND_CAR, SCM_SETOR_CAR
b63a956d
DH
1081
1082Use SCM_ASSERT_RANGE or SCM_VALIDATE_XXX_RANGE instead of SCM_OUTOFRANGE.
1083Use scm_memory_error instead of SCM_NALLOC.
c1aef037 1084Use SCM_STRINGP instead of SCM_SLOPPY_STRINGP.
d1ca2c64
DH
1085Use SCM_VALIDATE_STRING instead of SCM_VALIDATE_STRINGORSUBSTR.
1086Use SCM_FREE_CELL_P instead of SCM_FREEP/SCM_NFREEP
a6d9e5ab 1087Use a type specific accessor macro instead of SCM_CHARS/SCM_UCHARS.
6c0201ad 1088Use a type specific accessor instead of SCM(_|_RO|_HUGE_)LENGTH.
a6d9e5ab
DH
1089Use SCM_VALIDATE_(SYMBOL|STRING) instead of SCM_VALIDATE_ROSTRING.
1090Use SCM_STRING_COERCE_0TERMINATION_X instead of SCM_COERCE_SUBSTR.
b24b5e13 1091Use SCM_STRINGP or SCM_SYMBOLP instead of SCM_ROSTRINGP.
f0942910
DH
1092Use SCM_STRINGP instead of SCM_RWSTRINGP.
1093Use SCM_VALIDATE_STRING instead of SCM_VALIDATE_RWSTRING.
34f0f2b8
DH
1094Use SCM_STRING_CHARS instead of SCM_ROCHARS.
1095Use SCM_STRING_UCHARS instead of SCM_ROUCHARS.
93778877 1096Use a type specific setter macro instead of SCM_SETLENGTH.
6a0476fd 1097Use a type specific setter macro instead of SCM_SETCHARS.
5b9eb8ae 1098Use a type specific length macro instead of SCM_LENGTH_MAX.
fd336365
DH
1099Use SCM_GCMARKP instead of SCM_GC8MARKP.
1100Use SCM_SETGCMARK instead of SCM_SETGC8MARK.
1101Use SCM_CLRGCMARK instead of SCM_CLRGC8MARK.
1102Use SCM_TYP16 instead of SCM_GCTYP16.
1103Use SCM_CDR instead of SCM_GCCDR.
30ea841d 1104Use SCM_DIR_OPEN_P instead of SCM_OPDIRP.
276dd677
DH
1105Use SCM_MISC_ERROR or SCM_WRONG_TYPE_ARG instead of SCM_WTA.
1106Use SCM_MISC_ERROR or SCM_WRONG_TYPE_ARG instead of RETURN_SCM_WTA.
8dea8611 1107Use SCM_VCELL_INIT instead of SCM_CONST_LONG.
b3fcac34 1108Use SCM_WRONG_NUM_ARGS instead of SCM_WNA.
ced99e92
DH
1109Use SCM_CONSP instead of SCM_SLOPPY_CONSP.
1110Use !SCM_CONSP instead of SCM_SLOPPY_NCONSP.
b63a956d 1111
f7620510
DH
1112** Removed function: scm_struct_init
1113
93d40df2
DH
1114** Removed variable: scm_symhash_dim
1115
818febc0
GH
1116** Renamed function: scm_make_cont has been replaced by
1117scm_make_continuation, which has a different interface.
1118
cc4feeca
DH
1119** Deprecated function: scm_call_catching_errors
1120
1121Use scm_catch or scm_lazy_catch from throw.[ch] instead.
1122
28b06554
DH
1123** Deprecated function: scm_strhash
1124
1125Use scm_string_hash instead.
1126
1b9be268
DH
1127** Deprecated function: scm_vector_set_length_x
1128
1129Instead, create a fresh vector of the desired size and copy the contents.
1130
302f229e
MD
1131** scm_gensym has changed prototype
1132
1133scm_gensym now only takes one argument.
1134
1660782e
DH
1135** Deprecated type tags: scm_tc7_ssymbol, scm_tc7_msymbol, scm_tcs_symbols,
1136scm_tc7_lvector
28b06554
DH
1137
1138There is now only a single symbol type scm_tc7_symbol.
1660782e 1139The tag scm_tc7_lvector was not used anyway.
28b06554 1140
2f6fb7c5
KN
1141** Deprecated function: scm_make_smob_type_mfpe, scm_set_smob_mfpe.
1142
1143Use scm_make_smob_type and scm_set_smob_XXX instead.
1144
1145** New function scm_set_smob_apply.
1146
1147This can be used to set an apply function to a smob type.
1148
1f3908c4
KN
1149** Deprecated function: scm_strprint_obj
1150
1151Use scm_object_to_string instead.
1152
b3fcac34
DH
1153** Deprecated function: scm_wta
1154
1155Use scm_wrong_type_arg, or another appropriate error signalling function
1156instead.
1157
f3f9dcbc
MV
1158** Explicit support for obarrays has been deprecated.
1159
1160Use `scm_str2symbol' and the generic hashtable functions instead.
1161
1162** The concept of `vcells' has been deprecated.
1163
1164The data type `variable' is now used exclusively. `Vcells' have been
1165a low-level concept so you are likely not affected by this change.
1166
1167*** Deprecated functions: scm_sym2vcell, scm_sysintern,
1168 scm_sysintern0, scm_symbol_value0, scm_intern, scm_intern0.
1169
1170Use scm_c_define or scm_c_lookup instead, as appropriate.
1171
1172*** New functions: scm_c_module_lookup, scm_c_lookup,
1173 scm_c_module_define, scm_c_define, scm_module_lookup, scm_lookup,
1174 scm_module_define, scm_define.
1175
1176These functions work with variables instead of with vcells.
1177
311b6a3c
MV
1178** New functions for creating and defining `subr's and `gsubr's.
1179
1180The new functions more clearly distinguish between creating a subr (or
1181gsubr) object and adding it to the current module.
1182
1183These new functions are available: scm_c_make_subr, scm_c_define_subr,
1184scm_c_make_subr_with_generic, scm_c_define_subr_with_generic,
1185scm_c_make_gsubr, scm_c_define_gsubr, scm_c_make_gsubr_with_generic,
1186scm_c_define_gsubr_with_generic.
1187
1188** Deprecated functions: scm_make_subr, scm_make_subr_opt,
1189 scm_make_subr_with_generic, scm_make_gsubr,
1190 scm_make_gsubr_with_generic.
1191
1192Use the new ones from above instead.
1193
1194** C interface to the module system has changed.
1195
1196While we suggest that you avoid as many explicit module system
1197operations from C as possible for the time being, the C interface has
1198been made more similar to the high-level Scheme module system.
1199
1200*** New functions: scm_c_define_module, scm_c_use_module,
1201 scm_c_export, scm_c_resolve_module.
1202
1203They mostly work like their Scheme namesakes. scm_c_define_module
1204takes a function that is called a context where the new module is
1205current.
1206
1207*** Deprecated functions: scm_the_root_module, scm_make_module,
1208 scm_ensure_user_module, scm_load_scheme_module.
1209
1210Use the new functions instead.
1211
1212** Renamed function: scm_internal_with_fluids becomes
1213 scm_c_with_fluids.
1214
1215scm_internal_with_fluids is available as a deprecated function.
1216
1217** New function: scm_c_with_fluid.
1218
1219Just like scm_c_with_fluids, but takes one fluid and one value instead
1220of lists of same.
1221
1be6b49c
ML
1222** Deprecated typedefs: long_long, ulong_long.
1223
1224They are of questionable utility and they pollute the global
1225namespace.
1226
1be6b49c
ML
1227** Deprecated typedef: scm_sizet
1228
1229It is of questionable utility now that Guile requires ANSI C, and is
1230oddly named.
1231
1232** Deprecated typedefs: scm_port_rw_active, scm_port,
1233 scm_ptob_descriptor, scm_debug_info, scm_debug_frame, scm_fport,
1234 scm_option, scm_rstate, scm_rng, scm_array, scm_array_dim.
1235
1236Made more compliant with the naming policy by adding a _t at the end.
1237
1238** Deprecated functions: scm_mkbig, scm_big2num, scm_adjbig,
1239 scm_normbig, scm_copybig, scm_2ulong2big, scm_dbl2big, scm_big2dbl
1240
373f4948 1241With the exception of the mysterious scm_2ulong2big, they are still
1be6b49c
ML
1242available under new names (scm_i_mkbig etc). These functions are not
1243intended to be used in user code. You should avoid dealing with
1244bignums directly, and should deal with numbers in general (which can
1245be bignums).
1246
147c18a0
MD
1247** Change in behavior: scm_num2long, scm_num2ulong
1248
1249The scm_num2[u]long functions don't any longer accept an inexact
1250argument. This change in behavior is motivated by concordance with
1251R5RS: It is more common that a primitive doesn't want to accept an
1252inexact for an exact.
1253
1be6b49c 1254** New functions: scm_short2num, scm_ushort2num, scm_int2num,
f3f70257
ML
1255 scm_uint2num, scm_size2num, scm_ptrdiff2num, scm_num2short,
1256 scm_num2ushort, scm_num2int, scm_num2uint, scm_num2ptrdiff,
1be6b49c
ML
1257 scm_num2size.
1258
1259These are conversion functions between the various ANSI C integral
147c18a0
MD
1260types and Scheme numbers. NOTE: The scm_num2xxx functions don't
1261accept an inexact argument.
1be6b49c 1262
5437598b
MD
1263** New functions: scm_float2num, scm_double2num,
1264 scm_num2float, scm_num2double.
1265
1266These are conversion functions between the two ANSI C float types and
1267Scheme numbers.
1268
1be6b49c 1269** New number validation macros:
f3f70257 1270 SCM_NUM2{SIZE,PTRDIFF,SHORT,USHORT,INT,UINT}[_DEF]
1be6b49c
ML
1271
1272See above.
1273
fc62c86a
ML
1274** New functions: scm_gc_protect_object, scm_gc_unprotect_object
1275
1276These are just nicer-named old scm_protect_object and
1277scm_unprotect_object.
1278
1279** Deprecated functions: scm_protect_object, scm_unprotect_object
1280
1281** New functions: scm_gc_[un]register_root, scm_gc_[un]register_roots
1282
1283These functions can be used to register pointers to locations that
1284hold SCM values.
1285
5b2ad23b
ML
1286** Deprecated function: scm_create_hook.
1287
1288Its sins are: misleading name, non-modularity and lack of general
1289usefulness.
1290
c299f186 1291\f
cc36e791
JB
1292Changes since Guile 1.3.4:
1293
80f27102
JB
1294* Changes to the distribution
1295
ce358662
JB
1296** Trees from nightly snapshots and CVS now require you to run autogen.sh.
1297
1298We've changed the way we handle generated files in the Guile source
1299repository. As a result, the procedure for building trees obtained
1300from the nightly FTP snapshots or via CVS has changed:
1301- You must have appropriate versions of autoconf, automake, and
1302 libtool installed on your system. See README for info on how to
1303 obtain these programs.
1304- Before configuring the tree, you must first run the script
1305 `autogen.sh' at the top of the source tree.
1306
1307The Guile repository used to contain not only source files, written by
1308humans, but also some generated files, like configure scripts and
1309Makefile.in files. Even though the contents of these files could be
1310derived mechanically from other files present, we thought it would
1311make the tree easier to build if we checked them into CVS.
1312
1313However, this approach means that minor differences between
1314developer's installed tools and habits affected the whole team.
1315So we have removed the generated files from the repository, and
1316added the autogen.sh script, which will reconstruct them
1317appropriately.
1318
1319
dc914156
GH
1320** configure now has experimental options to remove support for certain
1321features:
52cfc69b 1322
dc914156
GH
1323--disable-arrays omit array and uniform array support
1324--disable-posix omit posix interfaces
1325--disable-networking omit networking interfaces
1326--disable-regex omit regular expression interfaces
52cfc69b
GH
1327
1328These are likely to become separate modules some day.
1329
9764c29b 1330** New configure option --enable-debug-freelist
e1b0d0ac 1331
38a15cfd
GB
1332This enables a debugging version of SCM_NEWCELL(), and also registers
1333an extra primitive, the setter `gc-set-debug-check-freelist!'.
1334
1335Configure with the --enable-debug-freelist option to enable
1336the gc-set-debug-check-freelist! primitive, and then use:
1337
1338(gc-set-debug-check-freelist! #t) # turn on checking of the freelist
1339(gc-set-debug-check-freelist! #f) # turn off checking
1340
1341Checking of the freelist forces a traversal of the freelist and
1342a garbage collection before each allocation of a cell. This can
1343slow down the interpreter dramatically, so the setter should be used to
1344turn on this extra processing only when necessary.
e1b0d0ac 1345
9764c29b
MD
1346** New configure option --enable-debug-malloc
1347
1348Include code for debugging of calls to scm_must_malloc/realloc/free.
1349
1350Checks that
1351
13521. objects freed by scm_must_free has been mallocated by scm_must_malloc
13532. objects reallocated by scm_must_realloc has been allocated by
1354 scm_must_malloc
13553. reallocated objects are reallocated with the same what string
1356
1357But, most importantly, it records the number of allocated objects of
1358each kind. This is useful when searching for memory leaks.
1359
1360A Guile compiled with this option provides the primitive
1361`malloc-stats' which returns an alist with pairs of kind and the
1362number of objects of that kind.
1363
e415cb06
MD
1364** All includes are now referenced relative to the root directory
1365
1366Since some users have had problems with mixups between Guile and
1367system headers, we have decided to always refer to Guile headers via
1368their parent directories. This essentially creates a "private name
1369space" for Guile headers. This means that the compiler only is given
1370-I options for the root build and root source directory.
1371
341f78c9
MD
1372** Header files kw.h and genio.h have been removed.
1373
1374** The module (ice-9 getopt-gnu-style) has been removed.
1375
e8855f8d
MD
1376** New module (ice-9 documentation)
1377
1378Implements the interface to documentation strings associated with
1379objects.
1380
0c0ffe09
KN
1381** New module (ice-9 time)
1382
1383Provides a macro `time', which displays execution time of a given form.
1384
cf7a5ee5
KN
1385** New module (ice-9 history)
1386
1387Loading this module enables value history in the repl.
1388
0af43c4a 1389* Changes to the stand-alone interpreter
bd9e24b3 1390
67ef2dca
MD
1391** New command line option --debug
1392
1393Start Guile with debugging evaluator and backtraces enabled.
1394
1395This is useful when debugging your .guile init file or scripts.
1396
aa4bb95d
MD
1397** New help facility
1398
341f78c9
MD
1399Usage: (help NAME) gives documentation about objects named NAME (a symbol)
1400 (help REGEXP) ditto for objects with names matching REGEXP (a string)
58e5b910 1401 (help 'NAME) gives documentation for NAME, even if it is not an object
341f78c9 1402 (help ,EXPR) gives documentation for object returned by EXPR
6c0201ad 1403 (help (my module)) gives module commentary for `(my module)'
341f78c9
MD
1404 (help) gives this text
1405
1406`help' searches among bindings exported from loaded modules, while
1407`apropos' searches among bindings visible from the "current" module.
1408
1409Examples: (help help)
1410 (help cons)
1411 (help "output-string")
aa4bb95d 1412
e8855f8d
MD
1413** `help' and `apropos' now prints full module names
1414
0af43c4a 1415** Dynamic linking now uses libltdl from the libtool package.
bd9e24b3 1416
0af43c4a
MD
1417The old system dependent code for doing dynamic linking has been
1418replaced with calls to the libltdl functions which do all the hairy
1419details for us.
bd9e24b3 1420
0af43c4a
MD
1421The major improvement is that you can now directly pass libtool
1422library names like "libfoo.la" to `dynamic-link' and `dynamic-link'
1423will be able to do the best shared library job you can get, via
1424libltdl.
bd9e24b3 1425
0af43c4a
MD
1426The way dynamic libraries are found has changed and is not really
1427portable across platforms, probably. It is therefore recommended to
1428use absolute filenames when possible.
1429
1430If you pass a filename without an extension to `dynamic-link', it will
1431try a few appropriate ones. Thus, the most platform ignorant way is
1432to specify a name like "libfoo", without any directories and
1433extensions.
0573ddae 1434
91163914
MD
1435** Guile COOP threads are now compatible with LinuxThreads
1436
1437Previously, COOP threading wasn't possible in applications linked with
1438Linux POSIX threads due to their use of the stack pointer to find the
1439thread context. This has now been fixed with a workaround which uses
1440the pthreads to allocate the stack.
1441
6c0201ad 1442** New primitives: `pkgdata-dir', `site-dir', `library-dir'
62b82274 1443
9770d235
MD
1444** Positions of erring expression in scripts
1445
1446With version 1.3.4, the location of the erring expression in Guile
1447scipts is no longer automatically reported. (This should have been
1448documented before the 1.3.4 release.)
1449
1450You can get this information by enabling recording of positions of
1451source expressions and running the debugging evaluator. Put this at
1452the top of your script (or in your "site" file):
1453
1454 (read-enable 'positions)
1455 (debug-enable 'debug)
1456
0573ddae
MD
1457** Backtraces in scripts
1458
1459It is now possible to get backtraces in scripts.
1460
1461Put
1462
1463 (debug-enable 'debug 'backtrace)
1464
1465at the top of the script.
1466
1467(The first options enables the debugging evaluator.
1468 The second enables backtraces.)
1469
e8855f8d
MD
1470** Part of module system symbol lookup now implemented in C
1471
1472The eval closure of most modules is now implemented in C. Since this
1473was one of the bottlenecks for loading speed, Guile now loads code
1474substantially faster than before.
1475
f25f761d
GH
1476** Attempting to get the value of an unbound variable now produces
1477an exception with a key of 'unbound-variable instead of 'misc-error.
1478
1a35eadc
GH
1479** The initial default output port is now unbuffered if it's using a
1480tty device. Previously in this situation it was line-buffered.
1481
820920e6
MD
1482** New hook: after-gc-hook
1483
1484after-gc-hook takes over the role of gc-thunk. This hook is run at
1485the first SCM_TICK after a GC. (Thus, the code is run at the same
1486point during evaluation as signal handlers.)
1487
1488Note that this hook should be used only for diagnostic and debugging
1489purposes. It is not certain that it will continue to be well-defined
1490when this hook is run in the future.
1491
1492C programmers: Note the new C level hooks scm_before_gc_c_hook,
1493scm_before_sweep_c_hook, scm_after_gc_c_hook.
1494
b5074b23
MD
1495** Improvements to garbage collector
1496
1497Guile 1.4 has a new policy for triggering heap allocation and
1498determining the sizes of heap segments. It fixes a number of problems
1499in the old GC.
1500
15011. The new policy can handle two separate pools of cells
1502 (2-word/4-word) better. (The old policy would run wild, allocating
1503 more and more memory for certain programs.)
1504
15052. The old code would sometimes allocate far too much heap so that the
1506 Guile process became gigantic. The new code avoids this.
1507
15083. The old code would sometimes allocate too little so that few cells
1509 were freed at GC so that, in turn, too much time was spent in GC.
1510
15114. The old code would often trigger heap allocation several times in a
1512 row. (The new scheme predicts how large the segments needs to be
1513 in order not to need further allocation.)
1514
e8855f8d
MD
1515All in all, the new GC policy will make larger applications more
1516efficient.
1517
b5074b23
MD
1518The new GC scheme also is prepared for POSIX threading. Threads can
1519allocate private pools of cells ("clusters") with just a single
1520function call. Allocation of single cells from such a cluster can
1521then proceed without any need of inter-thread synchronization.
1522
1523** New environment variables controlling GC parameters
1524
1525GUILE_MAX_SEGMENT_SIZE Maximal segment size
1526 (default = 2097000)
1527
1528Allocation of 2-word cell heaps:
1529
1530GUILE_INIT_SEGMENT_SIZE_1 Size of initial heap segment in bytes
1531 (default = 360000)
1532
1533GUILE_MIN_YIELD_1 Minimum number of freed cells at each
1534 GC in percent of total heap size
1535 (default = 40)
1536
1537Allocation of 4-word cell heaps
1538(used for real numbers and misc other objects):
1539
1540GUILE_INIT_SEGMENT_SIZE_2, GUILE_MIN_YIELD_2
1541
1542(See entry "Way for application to customize GC parameters" under
1543 section "Changes to the scm_ interface" below.)
1544
67ef2dca
MD
1545** Guile now implements reals using 4-word cells
1546
1547This speeds up computation with reals. (They were earlier allocated
1548with `malloc'.) There is still some room for optimizations, however.
1549
1550** Some further steps toward POSIX thread support have been taken
1551
1552*** Guile's critical sections (SCM_DEFER/ALLOW_INTS)
1553don't have much effect any longer, and many of them will be removed in
1554next release.
1555
1556*** Signals
1557are only handled at the top of the evaluator loop, immediately after
1558I/O, and in scm_equalp.
1559
1560*** The GC can allocate thread private pools of pairs.
1561
0af43c4a
MD
1562* Changes to Scheme functions and syntax
1563
a0128ebe 1564** close-input-port and close-output-port are now R5RS
7c1e0b12 1565
a0128ebe 1566These procedures have been turned into primitives and have R5RS behaviour.
7c1e0b12 1567
0af43c4a
MD
1568** New procedure: simple-format PORT MESSAGE ARG1 ...
1569
1570(ice-9 boot) makes `format' an alias for `simple-format' until possibly
1571extended by the more sophisticated version in (ice-9 format)
1572
1573(simple-format port message . args)
1574Write MESSAGE to DESTINATION, defaulting to `current-output-port'.
1575MESSAGE can contain ~A (was %s) and ~S (was %S) escapes. When printed,
1576the escapes are replaced with corresponding members of ARGS:
1577~A formats using `display' and ~S formats using `write'.
1578If DESTINATION is #t, then use the `current-output-port',
1579if DESTINATION is #f, then return a string containing the formatted text.
1580Does not add a trailing newline."
1581
1582** string-ref: the second argument is no longer optional.
1583
1584** string, list->string: no longer accept strings in their arguments,
1585only characters, for compatibility with R5RS.
1586
1587** New procedure: port-closed? PORT
1588Returns #t if PORT is closed or #f if it is open.
1589
0a9e521f
MD
1590** Deprecated: list*
1591
1592The list* functionality is now provided by cons* (SRFI-1 compliant)
1593
b5074b23
MD
1594** New procedure: cons* ARG1 ARG2 ... ARGn
1595
1596Like `list', but the last arg provides the tail of the constructed list,
1597returning (cons ARG1 (cons ARG2 (cons ... ARGn))).
1598
1599Requires at least one argument. If given one argument, that argument
1600is returned as result.
1601
1602This function is called `list*' in some other Schemes and in Common LISP.
1603
341f78c9
MD
1604** Removed deprecated: serial-map, serial-array-copy!, serial-array-map!
1605
e8855f8d
MD
1606** New procedure: object-documentation OBJECT
1607
1608Returns the documentation string associated with OBJECT. The
1609procedure uses a caching mechanism so that subsequent lookups are
1610faster.
1611
1612Exported by (ice-9 documentation).
1613
1614** module-name now returns full names of modules
1615
1616Previously, only the last part of the name was returned (`session' for
1617`(ice-9 session)'). Ex: `(ice-9 session)'.
1618
894a712b
DH
1619* Changes to the gh_ interface
1620
1621** Deprecated: gh_int2scmb
1622
1623Use gh_bool2scm instead.
1624
a2349a28
GH
1625* Changes to the scm_ interface
1626
810e1aec
MD
1627** Guile primitives now carry docstrings!
1628
1629Thanks to Greg Badros!
1630
0a9e521f 1631** Guile primitives are defined in a new way: SCM_DEFINE/SCM_DEFINE1/SCM_PROC
0af43c4a 1632
0a9e521f
MD
1633Now Guile primitives are defined using the SCM_DEFINE/SCM_DEFINE1/SCM_PROC
1634macros and must contain a docstring that is extracted into foo.doc using a new
0af43c4a
MD
1635guile-doc-snarf script (that uses guile-doc-snarf.awk).
1636
0a9e521f
MD
1637However, a major overhaul of these macros is scheduled for the next release of
1638guile.
1639
0af43c4a
MD
1640** Guile primitives use a new technique for validation of arguments
1641
1642SCM_VALIDATE_* macros are defined to ease the redundancy and improve
1643the readability of argument checking.
1644
1645** All (nearly?) K&R prototypes for functions replaced with ANSI C equivalents.
1646
894a712b 1647** New macros: SCM_PACK, SCM_UNPACK
f8a72ca4
MD
1648
1649Compose/decompose an SCM value.
1650
894a712b
DH
1651The SCM type is now treated as an abstract data type and may be defined as a
1652long, a void* or as a struct, depending on the architecture and compile time
1653options. This makes it easier to find several types of bugs, for example when
1654SCM values are treated as integers without conversion. Values of the SCM type
1655should be treated as "atomic" values. These macros are used when
f8a72ca4
MD
1656composing/decomposing an SCM value, either because you want to access
1657individual bits, or because you want to treat it as an integer value.
1658
1659E.g., in order to set bit 7 in an SCM value x, use the expression
1660
1661 SCM_PACK (SCM_UNPACK (x) | 0x80)
1662
e11f8b42
DH
1663** The name property of hooks is deprecated.
1664Thus, the use of SCM_HOOK_NAME and scm_make_hook_with_name is deprecated.
1665
1666You can emulate this feature by using object properties.
1667
6c0201ad 1668** Deprecated macros: SCM_INPORTP, SCM_OUTPORTP, SCM_CRDY, SCM_ICHRP,
894a712b
DH
1669SCM_ICHR, SCM_MAKICHR, SCM_SETJMPBUF, SCM_NSTRINGP, SCM_NRWSTRINGP,
1670SCM_NVECTORP
f8a72ca4 1671
894a712b 1672These macros will be removed in a future release of Guile.
7c1e0b12 1673
6c0201ad 1674** The following types, functions and macros from numbers.h are deprecated:
0a9e521f
MD
1675scm_dblproc, SCM_UNEGFIXABLE, SCM_FLOBUFLEN, SCM_INEXP, SCM_CPLXP, SCM_REAL,
1676SCM_IMAG, SCM_REALPART, scm_makdbl, SCM_SINGP, SCM_NUM2DBL, SCM_NO_BIGDIG
1677
1678Further, it is recommended not to rely on implementation details for guile's
1679current implementation of bignums. It is planned to replace this
1680implementation with gmp in the future.
1681
a2349a28
GH
1682** Port internals: the rw_random variable in the scm_port structure
1683must be set to non-zero in any random access port. In recent Guile
1684releases it was only set for bidirectional random-access ports.
1685
7dcb364d
GH
1686** Port internals: the seek ptob procedure is now responsible for
1687resetting the buffers if required. The change was made so that in the
1688special case of reading the current position (i.e., seek p 0 SEEK_CUR)
1689the fport and strport ptobs can avoid resetting the buffers,
1690in particular to avoid discarding unread chars. An existing port
1691type can be fixed by adding something like the following to the
1692beginning of the ptob seek procedure:
1693
1694 if (pt->rw_active == SCM_PORT_READ)
1695 scm_end_input (object);
1696 else if (pt->rw_active == SCM_PORT_WRITE)
1697 ptob->flush (object);
1698
1699although to actually avoid resetting the buffers and discard unread
1700chars requires further hacking that depends on the characteristics
1701of the ptob.
1702
894a712b
DH
1703** Deprecated functions: scm_fseek, scm_tag
1704
1705These functions are no longer used and will be removed in a future version.
1706
f25f761d
GH
1707** The scm_sysmissing procedure is no longer used in libguile.
1708Unless it turns out to be unexpectedly useful to somebody, it will be
1709removed in a future version.
1710
0af43c4a
MD
1711** The format of error message strings has changed
1712
1713The two C procedures: scm_display_error and scm_error, as well as the
1714primitive `scm-error', now use scm_simple_format to do their work.
1715This means that the message strings of all code must be updated to use
1716~A where %s was used before, and ~S where %S was used before.
1717
1718During the period when there still are a lot of old Guiles out there,
1719you might want to support both old and new versions of Guile.
1720
1721There are basically two methods to achieve this. Both methods use
1722autoconf. Put
1723
1724 AC_CHECK_FUNCS(scm_simple_format)
1725
1726in your configure.in.
1727
1728Method 1: Use the string concatenation features of ANSI C's
1729 preprocessor.
1730
1731In C:
1732
1733#ifdef HAVE_SCM_SIMPLE_FORMAT
1734#define FMT_S "~S"
1735#else
1736#define FMT_S "%S"
1737#endif
1738
1739Then represent each of your error messages using a preprocessor macro:
1740
1741#define E_SPIDER_ERROR "There's a spider in your " ## FMT_S ## "!!!"
1742
1743In Scheme:
1744
1745(define fmt-s (if (defined? 'simple-format) "~S" "%S"))
1746(define make-message string-append)
1747
1748(define e-spider-error (make-message "There's a spider in your " fmt-s "!!!"))
1749
1750Method 2: Use the oldfmt function found in doc/oldfmt.c.
1751
1752In C:
1753
1754scm_misc_error ("picnic", scm_c_oldfmt0 ("There's a spider in your ~S!!!"),
1755 ...);
1756
1757In Scheme:
1758
1759(scm-error 'misc-error "picnic" (oldfmt "There's a spider in your ~S!!!")
1760 ...)
1761
1762
f3b5e185
MD
1763** Deprecated: coop_mutex_init, coop_condition_variable_init
1764
1765Don't use the functions coop_mutex_init and
1766coop_condition_variable_init. They will change.
1767
1768Use scm_mutex_init and scm_cond_init instead.
1769
f3b5e185
MD
1770** New function: int scm_cond_timedwait (scm_cond_t *COND, scm_mutex_t *MUTEX, const struct timespec *ABSTIME)
1771 `scm_cond_timedwait' atomically unlocks MUTEX and waits on
1772 COND, as `scm_cond_wait' does, but it also bounds the duration
1773 of the wait. If COND has not been signaled before time ABSTIME,
1774 the mutex MUTEX is re-acquired and `scm_cond_timedwait'
1775 returns the error code `ETIMEDOUT'.
1776
1777 The ABSTIME parameter specifies an absolute time, with the same
1778 origin as `time' and `gettimeofday': an ABSTIME of 0 corresponds
1779 to 00:00:00 GMT, January 1, 1970.
1780
1781** New function: scm_cond_broadcast (scm_cond_t *COND)
1782 `scm_cond_broadcast' restarts all the threads that are waiting
1783 on the condition variable COND. Nothing happens if no threads are
1784 waiting on COND.
1785
1786** New function: scm_key_create (scm_key_t *KEY, void (*destr_function) (void *))
1787 `scm_key_create' allocates a new TSD key. The key is stored in
1788 the location pointed to by KEY. There is no limit on the number
1789 of keys allocated at a given time. The value initially associated
1790 with the returned key is `NULL' in all currently executing threads.
1791
1792 The DESTR_FUNCTION argument, if not `NULL', specifies a destructor
1793 function associated with the key. When a thread terminates,
1794 DESTR_FUNCTION is called on the value associated with the key in
1795 that thread. The DESTR_FUNCTION is not called if a key is deleted
1796 with `scm_key_delete' or a value is changed with
1797 `scm_setspecific'. The order in which destructor functions are
1798 called at thread termination time is unspecified.
1799
1800 Destructors are not yet implemented.
1801
1802** New function: scm_setspecific (scm_key_t KEY, const void *POINTER)
1803 `scm_setspecific' changes the value associated with KEY in the
1804 calling thread, storing the given POINTER instead.
1805
1806** New function: scm_getspecific (scm_key_t KEY)
1807 `scm_getspecific' returns the value currently associated with
1808 KEY in the calling thread.
1809
1810** New function: scm_key_delete (scm_key_t KEY)
1811 `scm_key_delete' deallocates a TSD key. It does not check
1812 whether non-`NULL' values are associated with that key in the
1813 currently executing threads, nor call the destructor function
1814 associated with the key.
1815
820920e6
MD
1816** New function: scm_c_hook_init (scm_c_hook_t *HOOK, void *HOOK_DATA, scm_c_hook_type_t TYPE)
1817
1818Initialize a C level hook HOOK with associated HOOK_DATA and type
1819TYPE. (See scm_c_hook_run ().)
1820
1821** New function: scm_c_hook_add (scm_c_hook_t *HOOK, scm_c_hook_function_t FUNC, void *FUNC_DATA, int APPENDP)
1822
1823Add hook function FUNC with associated FUNC_DATA to HOOK. If APPENDP
1824is true, add it last, otherwise first. The same FUNC can be added
1825multiple times if FUNC_DATA differ and vice versa.
1826
1827** New function: scm_c_hook_remove (scm_c_hook_t *HOOK, scm_c_hook_function_t FUNC, void *FUNC_DATA)
1828
1829Remove hook function FUNC with associated FUNC_DATA from HOOK. A
1830function is only removed if both FUNC and FUNC_DATA matches.
1831
1832** New function: void *scm_c_hook_run (scm_c_hook_t *HOOK, void *DATA)
1833
1834Run hook HOOK passing DATA to the hook functions.
1835
1836If TYPE is SCM_C_HOOK_NORMAL, all hook functions are run. The value
1837returned is undefined.
1838
1839If TYPE is SCM_C_HOOK_OR, hook functions are run until a function
1840returns a non-NULL value. This value is returned as the result of
1841scm_c_hook_run. If all functions return NULL, NULL is returned.
1842
1843If TYPE is SCM_C_HOOK_AND, hook functions are run until a function
1844returns a NULL value, and NULL is returned. If all functions returns
1845a non-NULL value, the last value is returned.
1846
1847** New C level GC hooks
1848
1849Five new C level hooks has been added to the garbage collector.
1850
1851 scm_before_gc_c_hook
1852 scm_after_gc_c_hook
1853
1854are run before locking and after unlocking the heap. The system is
1855thus in a mode where evaluation can take place. (Except that
1856scm_before_gc_c_hook must not allocate new cells.)
1857
1858 scm_before_mark_c_hook
1859 scm_before_sweep_c_hook
1860 scm_after_sweep_c_hook
1861
1862are run when the heap is locked. These are intended for extension of
1863the GC in a modular fashion. Examples are the weaks and guardians
1864modules.
1865
b5074b23
MD
1866** Way for application to customize GC parameters
1867
1868The application can set up other default values for the GC heap
1869allocation parameters
1870
1871 GUILE_INIT_HEAP_SIZE_1, GUILE_MIN_YIELD_1,
1872 GUILE_INIT_HEAP_SIZE_2, GUILE_MIN_YIELD_2,
1873 GUILE_MAX_SEGMENT_SIZE,
1874
1875by setting
1876
1877 scm_default_init_heap_size_1, scm_default_min_yield_1,
1878 scm_default_init_heap_size_2, scm_default_min_yield_2,
1879 scm_default_max_segment_size
1880
1881respectively before callong scm_boot_guile.
1882
1883(See entry "New environment variables ..." in section
1884"Changes to the stand-alone interpreter" above.)
1885
9704841c
MD
1886** scm_protect_object/scm_unprotect_object now nest
1887
67ef2dca
MD
1888This means that you can call scm_protect_object multiple times on an
1889object and count on the object being protected until
1890scm_unprotect_object has been call the same number of times.
1891
1892The functions also have better time complexity.
1893
1894Still, it is usually possible to structure the application in a way
1895that you don't need to use these functions. For example, if you use a
1896protected standard Guile list to keep track of live objects rather
1897than some custom data type, objects will die a natural death when they
1898are no longer needed.
1899
0a9e521f
MD
1900** Deprecated type tags: scm_tc16_flo, scm_tc_flo, scm_tc_dblr, scm_tc_dblc
1901
1902Guile does not provide the float representation for inexact real numbers any
1903more. Now, only doubles are used to represent inexact real numbers. Further,
1904the tag names scm_tc_dblr and scm_tc_dblc have been changed to scm_tc16_real
1905and scm_tc16_complex, respectively.
1906
341f78c9
MD
1907** Removed deprecated type scm_smobfuns
1908
1909** Removed deprecated function scm_newsmob
1910
b5074b23
MD
1911** Warning: scm_make_smob_type_mfpe might become deprecated in a future release
1912
1913There is an ongoing discussion among the developers whether to
1914deprecate `scm_make_smob_type_mfpe' or not. Please use the current
1915standard interface (scm_make_smob_type, scm_set_smob_XXX) in new code
1916until this issue has been settled.
1917
341f78c9
MD
1918** Removed deprecated type tag scm_tc16_kw
1919
2728d7f4
MD
1920** Added type tag scm_tc16_keyword
1921
1922(This was introduced already in release 1.3.4 but was not documented
1923 until now.)
1924
67ef2dca
MD
1925** gdb_print now prints "*** Guile not initialized ***" until Guile initialized
1926
f25f761d
GH
1927* Changes to system call interfaces:
1928
28d77376
GH
1929** The "select" procedure now tests port buffers for the ability to
1930provide input or accept output. Previously only the underlying file
1931descriptors were checked.
1932
bd9e24b3
GH
1933** New variable PIPE_BUF: the maximum number of bytes that can be
1934atomically written to a pipe.
1935
f25f761d
GH
1936** If a facility is not available on the system when Guile is
1937compiled, the corresponding primitive procedure will not be defined.
1938Previously it would have been defined but would throw a system-error
1939exception if called. Exception handlers which catch this case may
1940need minor modification: an error will be thrown with key
1941'unbound-variable instead of 'system-error. Alternatively it's
1942now possible to use `defined?' to check whether the facility is
1943available.
1944
38c1d3c4 1945** Procedures which depend on the timezone should now give the correct
6c0201ad 1946result on systems which cache the TZ environment variable, even if TZ
38c1d3c4
GH
1947is changed without calling tzset.
1948
5c11cc9d
GH
1949* Changes to the networking interfaces:
1950
1951** New functions: htons, ntohs, htonl, ntohl: for converting short and
1952long integers between network and host format. For now, it's not
1953particularly convenient to do this kind of thing, but consider:
1954
1955(define write-network-long
1956 (lambda (value port)
1957 (let ((v (make-uniform-vector 1 1 0)))
1958 (uniform-vector-set! v 0 (htonl value))
1959 (uniform-vector-write v port))))
1960
1961(define read-network-long
1962 (lambda (port)
1963 (let ((v (make-uniform-vector 1 1 0)))
1964 (uniform-vector-read! v port)
1965 (ntohl (uniform-vector-ref v 0)))))
1966
1967** If inet-aton fails, it now throws an error with key 'misc-error
1968instead of 'system-error, since errno is not relevant.
1969
1970** Certain gethostbyname/gethostbyaddr failures now throw errors with
1971specific keys instead of 'system-error. The latter is inappropriate
1972since errno will not have been set. The keys are:
afe5177e 1973'host-not-found, 'try-again, 'no-recovery and 'no-data.
5c11cc9d
GH
1974
1975** sethostent, setnetent, setprotoent, setservent: now take an
1976optional argument STAYOPEN, which specifies whether the database
1977remains open after a database entry is accessed randomly (e.g., using
1978gethostbyname for the hosts database.) The default is #f. Previously
1979#t was always used.
1980
cc36e791 1981\f
43fa9a05
JB
1982Changes since Guile 1.3.2:
1983
0fdcbcaa
MD
1984* Changes to the stand-alone interpreter
1985
1986** Debugger
1987
1988An initial version of the Guile debugger written by Chris Hanson has
1989been added. The debugger is still under development but is included
1990in the distribution anyway since it is already quite useful.
1991
1992Type
1993
1994 (debug)
1995
1996after an error to enter the debugger. Type `help' inside the debugger
1997for a description of available commands.
1998
1999If you prefer to have stack frames numbered and printed in
2000anti-chronological order and prefer up in the stack to be down on the
2001screen as is the case in gdb, you can put
2002
2003 (debug-enable 'backwards)
2004
2005in your .guile startup file. (However, this means that Guile can't
2006use indentation to indicate stack level.)
2007
2008The debugger is autoloaded into Guile at the first use.
2009
2010** Further enhancements to backtraces
2011
2012There is a new debug option `width' which controls the maximum width
2013on the screen of printed stack frames. Fancy printing parameters
2014("level" and "length" as in Common LISP) are adaptively adjusted for
2015each stack frame to give maximum information while still fitting
2016within the bounds. If the stack frame can't be made to fit by
2017adjusting parameters, it is simply cut off at the end. This is marked
2018with a `$'.
2019
2020** Some modules are now only loaded when the repl is started
2021
2022The modules (ice-9 debug), (ice-9 session), (ice-9 threads) and (ice-9
2023regex) are now loaded into (guile-user) only if the repl has been
2024started. The effect is that the startup time for scripts has been
2025reduced to 30% of what it was previously.
2026
2027Correctly written scripts load the modules they require at the top of
2028the file and should not be affected by this change.
2029
ece41168
MD
2030** Hooks are now represented as smobs
2031
6822fe53
MD
2032* Changes to Scheme functions and syntax
2033
0ce204b0
MV
2034** Readline support has changed again.
2035
2036The old (readline-activator) module is gone. Use (ice-9 readline)
2037instead, which now contains all readline functionality. So the code
2038to activate readline is now
2039
2040 (use-modules (ice-9 readline))
2041 (activate-readline)
2042
2043This should work at any time, including from the guile prompt.
2044
5d195868
JB
2045To avoid confusion about the terms of Guile's license, please only
2046enable readline for your personal use; please don't make it the
2047default for others. Here is why we make this rather odd-sounding
2048request:
2049
2050Guile is normally licensed under a weakened form of the GNU General
2051Public License, which allows you to link code with Guile without
2052placing that code under the GPL. This exception is important to some
2053people.
2054
2055However, since readline is distributed under the GNU General Public
2056License, when you link Guile with readline, either statically or
2057dynamically, you effectively change Guile's license to the strict GPL.
2058Whenever you link any strictly GPL'd code into Guile, uses of Guile
2059which are normally permitted become forbidden. This is a rather
2060non-obvious consequence of the licensing terms.
2061
2062So, to make sure things remain clear, please let people choose for
2063themselves whether to link GPL'd libraries like readline with Guile.
2064
25b0654e
JB
2065** regexp-substitute/global has changed slightly, but incompatibly.
2066
2067If you include a function in the item list, the string of the match
2068object it receives is the same string passed to
2069regexp-substitute/global, not some suffix of that string.
2070Correspondingly, the match's positions are relative to the entire
2071string, not the suffix.
2072
2073If the regexp can match the empty string, the way matches are chosen
2074from the string has changed. regexp-substitute/global recognizes the
2075same set of matches that list-matches does; see below.
2076
2077** New function: list-matches REGEXP STRING [FLAGS]
2078
2079Return a list of match objects, one for every non-overlapping, maximal
2080match of REGEXP in STRING. The matches appear in left-to-right order.
2081list-matches only reports matches of the empty string if there are no
2082other matches which begin on, end at, or include the empty match's
2083position.
2084
2085If present, FLAGS is passed as the FLAGS argument to regexp-exec.
2086
2087** New function: fold-matches REGEXP STRING INIT PROC [FLAGS]
2088
2089For each match of REGEXP in STRING, apply PROC to the match object,
2090and the last value PROC returned, or INIT for the first call. Return
2091the last value returned by PROC. We apply PROC to the matches as they
2092appear from left to right.
2093
2094This function recognizes matches according to the same criteria as
2095list-matches.
2096
2097Thus, you could define list-matches like this:
2098
2099 (define (list-matches regexp string . flags)
2100 (reverse! (apply fold-matches regexp string '() cons flags)))
2101
2102If present, FLAGS is passed as the FLAGS argument to regexp-exec.
2103
bc848f7f
MD
2104** Hooks
2105
2106*** New function: hook? OBJ
2107
2108Return #t if OBJ is a hook, otherwise #f.
2109
ece41168
MD
2110*** New function: make-hook-with-name NAME [ARITY]
2111
2112Return a hook with name NAME and arity ARITY. The default value for
2113ARITY is 0. The only effect of NAME is that it will appear when the
2114hook object is printed to ease debugging.
2115
bc848f7f
MD
2116*** New function: hook-empty? HOOK
2117
2118Return #t if HOOK doesn't contain any procedures, otherwise #f.
2119
2120*** New function: hook->list HOOK
2121
2122Return a list of the procedures that are called when run-hook is
2123applied to HOOK.
2124
b074884f
JB
2125** `map' signals an error if its argument lists are not all the same length.
2126
2127This is the behavior required by R5RS, so this change is really a bug
2128fix. But it seems to affect a lot of people's code, so we're
2129mentioning it here anyway.
2130
6822fe53
MD
2131** Print-state handling has been made more transparent
2132
2133Under certain circumstances, ports are represented as a port with an
2134associated print state. Earlier, this pair was represented as a pair
2135(see "Some magic has been added to the printer" below). It is now
2136indistinguishable (almost; see `get-print-state') from a port on the
2137user level.
2138
2139*** New function: port-with-print-state OUTPUT-PORT PRINT-STATE
2140
2141Return a new port with the associated print state PRINT-STATE.
2142
2143*** New function: get-print-state OUTPUT-PORT
2144
2145Return the print state associated with this port if it exists,
2146otherwise return #f.
2147
340a8770 2148*** New function: directory-stream? OBJECT
77242ff9 2149
340a8770 2150Returns true iff OBJECT is a directory stream --- the sort of object
77242ff9
GH
2151returned by `opendir'.
2152
0fdcbcaa
MD
2153** New function: using-readline?
2154
2155Return #t if readline is in use in the current repl.
2156
26405bc1
MD
2157** structs will be removed in 1.4
2158
2159Structs will be replaced in Guile 1.4. We will merge GOOPS into Guile
2160and use GOOPS objects as the fundamental record type.
2161
49199eaa
MD
2162* Changes to the scm_ interface
2163
26405bc1
MD
2164** structs will be removed in 1.4
2165
2166The entire current struct interface (struct.c, struct.h) will be
2167replaced in Guile 1.4. We will merge GOOPS into libguile and use
2168GOOPS objects as the fundamental record type.
2169
49199eaa
MD
2170** The internal representation of subr's has changed
2171
2172Instead of giving a hint to the subr name, the CAR field of the subr
2173now contains an index to a subr entry in scm_subr_table.
2174
2175*** New variable: scm_subr_table
2176
2177An array of subr entries. A subr entry contains the name, properties
2178and documentation associated with the subr. The properties and
2179documentation slots are not yet used.
2180
2181** A new scheme for "forwarding" calls to a builtin to a generic function
2182
2183It is now possible to extend the functionality of some Guile
2184primitives by letting them defer a call to a GOOPS generic function on
240ed66f 2185argument mismatch. This means that there is no loss of efficiency in
daf516d6 2186normal evaluation.
49199eaa
MD
2187
2188Example:
2189
daf516d6 2190 (use-modules (oop goops)) ; Must be GOOPS version 0.2.
49199eaa
MD
2191 (define-method + ((x <string>) (y <string>))
2192 (string-append x y))
2193
86a4d62e
MD
2194+ will still be as efficient as usual in numerical calculations, but
2195can also be used for concatenating strings.
49199eaa 2196
86a4d62e 2197Who will be the first one to extend Guile's numerical tower to
daf516d6
MD
2198rationals? :) [OK, there a few other things to fix before this can
2199be made in a clean way.]
49199eaa
MD
2200
2201*** New snarf macros for defining primitives: SCM_GPROC, SCM_GPROC1
2202
2203 New macro: SCM_GPROC (CNAME, SNAME, REQ, OPT, VAR, CFUNC, GENERIC)
2204
2205 New macro: SCM_GPROC1 (CNAME, SNAME, TYPE, CFUNC, GENERIC)
2206
d02cafe7 2207These do the same job as SCM_PROC and SCM_PROC1, but they also define
49199eaa
MD
2208a variable GENERIC which can be used by the dispatch macros below.
2209
2210[This is experimental code which may change soon.]
2211
2212*** New macros for forwarding control to a generic on arg type error
2213
2214 New macro: SCM_WTA_DISPATCH_1 (GENERIC, ARG1, POS, SUBR)
2215
2216 New macro: SCM_WTA_DISPATCH_2 (GENERIC, ARG1, ARG2, POS, SUBR)
2217
2218These correspond to the scm_wta function call, and have the same
2219behaviour until the user has called the GOOPS primitive
2220`enable-primitive-generic!'. After that, these macros will apply the
2221generic function GENERIC to the argument(s) instead of calling
2222scm_wta.
2223
2224[This is experimental code which may change soon.]
2225
2226*** New macros for argument testing with generic dispatch
2227
2228 New macro: SCM_GASSERT1 (COND, GENERIC, ARG1, POS, SUBR)
2229
2230 New macro: SCM_GASSERT2 (COND, GENERIC, ARG1, ARG2, POS, SUBR)
2231
2232These correspond to the SCM_ASSERT macro, but will defer control to
2233GENERIC on error after `enable-primitive-generic!' has been called.
2234
2235[This is experimental code which may change soon.]
2236
2237** New function: SCM scm_eval_body (SCM body, SCM env)
2238
2239Evaluates the body of a special form.
2240
2241** The internal representation of struct's has changed
2242
2243Previously, four slots were allocated for the procedure(s) of entities
2244and operators. The motivation for this representation had to do with
2245the structure of the evaluator, the wish to support tail-recursive
2246generic functions, and efficiency. Since the generic function
2247dispatch mechanism has changed, there is no longer a need for such an
2248expensive representation, and the representation has been simplified.
2249
2250This should not make any difference for most users.
2251
2252** GOOPS support has been cleaned up.
2253
2254Some code has been moved from eval.c to objects.c and code in both of
2255these compilation units has been cleaned up and better structured.
2256
2257*** New functions for applying generic functions
2258
2259 New function: SCM scm_apply_generic (GENERIC, ARGS)
2260 New function: SCM scm_call_generic_0 (GENERIC)
2261 New function: SCM scm_call_generic_1 (GENERIC, ARG1)
2262 New function: SCM scm_call_generic_2 (GENERIC, ARG1, ARG2)
2263 New function: SCM scm_call_generic_3 (GENERIC, ARG1, ARG2, ARG3)
2264
ece41168
MD
2265** Deprecated function: scm_make_named_hook
2266
2267It is now replaced by:
2268
2269** New function: SCM scm_create_hook (const char *name, int arity)
2270
2271Creates a hook in the same way as make-hook above but also
2272binds a variable named NAME to it.
2273
2274This is the typical way of creating a hook from C code.
2275
2276Currently, the variable is created in the "current" module.
2277This might change when we get the new module system.
2278
2279[The behaviour is identical to scm_make_named_hook.]
2280
2281
43fa9a05 2282\f
f3227c7a
JB
2283Changes since Guile 1.3:
2284
6ca345f3
JB
2285* Changes to mailing lists
2286
2287** Some of the Guile mailing lists have moved to sourceware.cygnus.com.
2288
2289See the README file to find current addresses for all the Guile
2290mailing lists.
2291
d77fb593
JB
2292* Changes to the distribution
2293
1d335863
JB
2294** Readline support is no longer included with Guile by default.
2295
2296Based on the different license terms of Guile and Readline, we
2297concluded that Guile should not *by default* cause the linking of
2298Readline into an application program. Readline support is now offered
2299as a separate module, which is linked into an application only when
2300you explicitly specify it.
2301
2302Although Guile is GNU software, its distribution terms add a special
2303exception to the usual GNU General Public License (GPL). Guile's
2304license includes a clause that allows you to link Guile with non-free
2305programs. We add this exception so as not to put Guile at a
2306disadvantage vis-a-vis other extensibility packages that support other
2307languages.
2308
2309In contrast, the GNU Readline library is distributed under the GNU
2310General Public License pure and simple. This means that you may not
2311link Readline, even dynamically, into an application unless it is
2312distributed under a free software license that is compatible the GPL.
2313
2314Because of this difference in distribution terms, an application that
2315can use Guile may not be able to use Readline. Now users will be
2316explicitly offered two independent decisions about the use of these
2317two packages.
d77fb593 2318
0e8a8468
MV
2319You can activate the readline support by issuing
2320
2321 (use-modules (readline-activator))
2322 (activate-readline)
2323
2324from your ".guile" file, for example.
2325
e4eae9b1
MD
2326* Changes to the stand-alone interpreter
2327
67ad463a
MD
2328** All builtins now print as primitives.
2329Previously builtin procedures not belonging to the fundamental subr
2330types printed as #<compiled closure #<primitive-procedure gsubr-apply>>.
2331Now, they print as #<primitive-procedure NAME>.
2332
2333** Backtraces slightly more intelligible.
2334gsubr-apply and macro transformer application frames no longer appear
2335in backtraces.
2336
69c6acbb
JB
2337* Changes to Scheme functions and syntax
2338
2a52b429
MD
2339** Guile now correctly handles internal defines by rewriting them into
2340their equivalent letrec. Previously, internal defines would
2341incrementally add to the innermost environment, without checking
2342whether the restrictions specified in RnRS were met. This lead to the
2343correct behaviour when these restriction actually were met, but didn't
2344catch all illegal uses. Such an illegal use could lead to crashes of
2345the Guile interpreter or or other unwanted results. An example of
2346incorrect internal defines that made Guile behave erratically:
2347
2348 (let ()
2349 (define a 1)
2350 (define (b) a)
2351 (define c (1+ (b)))
2352 (define d 3)
2353
2354 (b))
2355
2356 => 2
2357
2358The problem with this example is that the definition of `c' uses the
2359value of `b' directly. This confuses the meoization machine of Guile
2360so that the second call of `b' (this time in a larger environment that
2361also contains bindings for `c' and `d') refers to the binding of `c'
2362instead of `a'. You could also make Guile crash with a variation on
2363this theme:
2364
2365 (define (foo flag)
2366 (define a 1)
2367 (define (b flag) (if flag a 1))
2368 (define c (1+ (b flag)))
2369 (define d 3)
2370
2371 (b #t))
2372
2373 (foo #f)
2374 (foo #t)
2375
2376From now on, Guile will issue an `Unbound variable: b' error message
2377for both examples.
2378
36d3d540
MD
2379** Hooks
2380
2381A hook contains a list of functions which should be called on
2382particular occasions in an existing program. Hooks are used for
2383customization.
2384
2385A window manager might have a hook before-window-map-hook. The window
2386manager uses the function run-hooks to call all functions stored in
2387before-window-map-hook each time a window is mapped. The user can
2388store functions in the hook using add-hook!.
2389
2390In Guile, hooks are first class objects.
2391
2392*** New function: make-hook [N_ARGS]
2393
2394Return a hook for hook functions which can take N_ARGS arguments.
2395The default value for N_ARGS is 0.
2396
ad91d6c3
MD
2397(See also scm_make_named_hook below.)
2398
36d3d540
MD
2399*** New function: add-hook! HOOK PROC [APPEND_P]
2400
2401Put PROC at the beginning of the list of functions stored in HOOK.
2402If APPEND_P is supplied, and non-false, put PROC at the end instead.
2403
2404PROC must be able to take the number of arguments specified when the
2405hook was created.
2406
2407If PROC already exists in HOOK, then remove it first.
2408
2409*** New function: remove-hook! HOOK PROC
2410
2411Remove PROC from the list of functions in HOOK.
2412
2413*** New function: reset-hook! HOOK
2414
2415Clear the list of hook functions stored in HOOK.
2416
2417*** New function: run-hook HOOK ARG1 ...
2418
2419Run all hook functions stored in HOOK with arguments ARG1 ... .
2420The number of arguments supplied must correspond to the number given
2421when the hook was created.
2422
56a19408
MV
2423** The function `dynamic-link' now takes optional keyword arguments.
2424 The only keyword argument that is currently defined is `:global
2425 BOOL'. With it, you can control whether the shared library will be
2426 linked in global mode or not. In global mode, the symbols from the
2427 linked library can be used to resolve references from other
2428 dynamically linked libraries. In non-global mode, the linked
2429 library is essentially invisible and can only be accessed via
2430 `dynamic-func', etc. The default is now to link in global mode.
2431 Previously, the default has been non-global mode.
2432
2433 The `#:global' keyword is only effective on platforms that support
2434 the dlopen family of functions.
2435
ad226f25 2436** New function `provided?'
b7e13f65
JB
2437
2438 - Function: provided? FEATURE
2439 Return true iff FEATURE is supported by this installation of
2440 Guile. FEATURE must be a symbol naming a feature; the global
2441 variable `*features*' is a list of available features.
2442
ad226f25
JB
2443** Changes to the module (ice-9 expect):
2444
2445*** The expect-strings macro now matches `$' in a regular expression
2446 only at a line-break or end-of-file by default. Previously it would
ab711359
JB
2447 match the end of the string accumulated so far. The old behaviour
2448 can be obtained by setting the variable `expect-strings-exec-flags'
2449 to 0.
ad226f25
JB
2450
2451*** The expect-strings macro now uses a variable `expect-strings-exec-flags'
2452 for the regexp-exec flags. If `regexp/noteol' is included, then `$'
2453 in a regular expression will still match before a line-break or
2454 end-of-file. The default is `regexp/noteol'.
2455
6c0201ad 2456*** The expect-strings macro now uses a variable
ad226f25
JB
2457 `expect-strings-compile-flags' for the flags to be supplied to
2458 `make-regexp'. The default is `regexp/newline', which was previously
2459 hard-coded.
2460
2461*** The expect macro now supplies two arguments to a match procedure:
ab711359
JB
2462 the current accumulated string and a flag to indicate whether
2463 end-of-file has been reached. Previously only the string was supplied.
2464 If end-of-file is reached, the match procedure will be called an
2465 additional time with the same accumulated string as the previous call
2466 but with the flag set.
ad226f25 2467
b7e13f65
JB
2468** New module (ice-9 format), implementing the Common Lisp `format' function.
2469
2470This code, and the documentation for it that appears here, was
2471borrowed from SLIB, with minor adaptations for Guile.
2472
2473 - Function: format DESTINATION FORMAT-STRING . ARGUMENTS
2474 An almost complete implementation of Common LISP format description
2475 according to the CL reference book `Common LISP' from Guy L.
2476 Steele, Digital Press. Backward compatible to most of the
2477 available Scheme format implementations.
2478
2479 Returns `#t', `#f' or a string; has side effect of printing
2480 according to FORMAT-STRING. If DESTINATION is `#t', the output is
2481 to the current output port and `#t' is returned. If DESTINATION
2482 is `#f', a formatted string is returned as the result of the call.
2483 NEW: If DESTINATION is a string, DESTINATION is regarded as the
2484 format string; FORMAT-STRING is then the first argument and the
2485 output is returned as a string. If DESTINATION is a number, the
2486 output is to the current error port if available by the
2487 implementation. Otherwise DESTINATION must be an output port and
2488 `#t' is returned.
2489
2490 FORMAT-STRING must be a string. In case of a formatting error
2491 format returns `#f' and prints a message on the current output or
2492 error port. Characters are output as if the string were output by
2493 the `display' function with the exception of those prefixed by a
2494 tilde (~). For a detailed description of the FORMAT-STRING syntax
2495 please consult a Common LISP format reference manual. For a test
2496 suite to verify this format implementation load `formatst.scm'.
2497 Please send bug reports to `lutzeb@cs.tu-berlin.de'.
2498
2499 Note: `format' is not reentrant, i.e. only one `format'-call may
2500 be executed at a time.
2501
2502
2503*** Format Specification (Format version 3.0)
2504
2505 Please consult a Common LISP format reference manual for a detailed
2506description of the format string syntax. For a demonstration of the
2507implemented directives see `formatst.scm'.
2508
2509 This implementation supports directive parameters and modifiers (`:'
2510and `@' characters). Multiple parameters must be separated by a comma
2511(`,'). Parameters can be numerical parameters (positive or negative),
2512character parameters (prefixed by a quote character (`''), variable
2513parameters (`v'), number of rest arguments parameter (`#'), empty and
2514default parameters. Directive characters are case independent. The
2515general form of a directive is:
2516
2517DIRECTIVE ::= ~{DIRECTIVE-PARAMETER,}[:][@]DIRECTIVE-CHARACTER
2518
2519DIRECTIVE-PARAMETER ::= [ [-|+]{0-9}+ | 'CHARACTER | v | # ]
2520
2521*** Implemented CL Format Control Directives
2522
2523 Documentation syntax: Uppercase characters represent the
2524corresponding control directive characters. Lowercase characters
2525represent control directive parameter descriptions.
2526
2527`~A'
2528 Any (print as `display' does).
2529 `~@A'
2530 left pad.
2531
2532 `~MINCOL,COLINC,MINPAD,PADCHARA'
2533 full padding.
2534
2535`~S'
2536 S-expression (print as `write' does).
2537 `~@S'
2538 left pad.
2539
2540 `~MINCOL,COLINC,MINPAD,PADCHARS'
2541 full padding.
2542
2543`~D'
2544 Decimal.
2545 `~@D'
2546 print number sign always.
2547
2548 `~:D'
2549 print comma separated.
2550
2551 `~MINCOL,PADCHAR,COMMACHARD'
2552 padding.
2553
2554`~X'
2555 Hexadecimal.
2556 `~@X'
2557 print number sign always.
2558
2559 `~:X'
2560 print comma separated.
2561
2562 `~MINCOL,PADCHAR,COMMACHARX'
2563 padding.
2564
2565`~O'
2566 Octal.
2567 `~@O'
2568 print number sign always.
2569
2570 `~:O'
2571 print comma separated.
2572
2573 `~MINCOL,PADCHAR,COMMACHARO'
2574 padding.
2575
2576`~B'
2577 Binary.
2578 `~@B'
2579 print number sign always.
2580
2581 `~:B'
2582 print comma separated.
2583
2584 `~MINCOL,PADCHAR,COMMACHARB'
2585 padding.
2586
2587`~NR'
2588 Radix N.
2589 `~N,MINCOL,PADCHAR,COMMACHARR'
2590 padding.
2591
2592`~@R'
2593 print a number as a Roman numeral.
2594
2595`~:@R'
2596 print a number as an "old fashioned" Roman numeral.
2597
2598`~:R'
2599 print a number as an ordinal English number.
2600
2601`~:@R'
2602 print a number as a cardinal English number.
2603
2604`~P'
2605 Plural.
2606 `~@P'
2607 prints `y' and `ies'.
2608
2609 `~:P'
2610 as `~P but jumps 1 argument backward.'
2611
2612 `~:@P'
2613 as `~@P but jumps 1 argument backward.'
2614
2615`~C'
2616 Character.
2617 `~@C'
2618 prints a character as the reader can understand it (i.e. `#\'
2619 prefixing).
2620
2621 `~:C'
2622 prints a character as emacs does (eg. `^C' for ASCII 03).
2623
2624`~F'
2625 Fixed-format floating-point (prints a flonum like MMM.NNN).
2626 `~WIDTH,DIGITS,SCALE,OVERFLOWCHAR,PADCHARF'
2627 `~@F'
2628 If the number is positive a plus sign is printed.
2629
2630`~E'
2631 Exponential floating-point (prints a flonum like MMM.NNN`E'EE).
2632 `~WIDTH,DIGITS,EXPONENTDIGITS,SCALE,OVERFLOWCHAR,PADCHAR,EXPONENTCHARE'
2633 `~@E'
2634 If the number is positive a plus sign is printed.
2635
2636`~G'
2637 General floating-point (prints a flonum either fixed or
2638 exponential).
2639 `~WIDTH,DIGITS,EXPONENTDIGITS,SCALE,OVERFLOWCHAR,PADCHAR,EXPONENTCHARG'
2640 `~@G'
2641 If the number is positive a plus sign is printed.
2642
2643`~$'
2644 Dollars floating-point (prints a flonum in fixed with signs
2645 separated).
2646 `~DIGITS,SCALE,WIDTH,PADCHAR$'
2647 `~@$'
2648 If the number is positive a plus sign is printed.
2649
2650 `~:@$'
2651 A sign is always printed and appears before the padding.
2652
2653 `~:$'
2654 The sign appears before the padding.
2655
2656`~%'
2657 Newline.
2658 `~N%'
2659 print N newlines.
2660
2661`~&'
2662 print newline if not at the beginning of the output line.
2663 `~N&'
2664 prints `~&' and then N-1 newlines.
2665
2666`~|'
2667 Page Separator.
2668 `~N|'
2669 print N page separators.
2670
2671`~~'
2672 Tilde.
2673 `~N~'
2674 print N tildes.
2675
2676`~'<newline>
2677 Continuation Line.
2678 `~:'<newline>
2679 newline is ignored, white space left.
2680
2681 `~@'<newline>
2682 newline is left, white space ignored.
2683
2684`~T'
2685 Tabulation.
2686 `~@T'
2687 relative tabulation.
2688
2689 `~COLNUM,COLINCT'
2690 full tabulation.
2691
2692`~?'
2693 Indirection (expects indirect arguments as a list).
2694 `~@?'
2695 extracts indirect arguments from format arguments.
2696
2697`~(STR~)'
2698 Case conversion (converts by `string-downcase').
2699 `~:(STR~)'
2700 converts by `string-capitalize'.
2701
2702 `~@(STR~)'
2703 converts by `string-capitalize-first'.
2704
2705 `~:@(STR~)'
2706 converts by `string-upcase'.
2707
2708`~*'
2709 Argument Jumping (jumps 1 argument forward).
2710 `~N*'
2711 jumps N arguments forward.
2712
2713 `~:*'
2714 jumps 1 argument backward.
2715
2716 `~N:*'
2717 jumps N arguments backward.
2718
2719 `~@*'
2720 jumps to the 0th argument.
2721
2722 `~N@*'
2723 jumps to the Nth argument (beginning from 0)
2724
2725`~[STR0~;STR1~;...~;STRN~]'
2726 Conditional Expression (numerical clause conditional).
2727 `~N['
2728 take argument from N.
2729
2730 `~@['
2731 true test conditional.
2732
2733 `~:['
2734 if-else-then conditional.
2735
2736 `~;'
2737 clause separator.
2738
2739 `~:;'
2740 default clause follows.
2741
2742`~{STR~}'
2743 Iteration (args come from the next argument (a list)).
2744 `~N{'
2745 at most N iterations.
2746
2747 `~:{'
2748 args from next arg (a list of lists).
2749
2750 `~@{'
2751 args from the rest of arguments.
2752
2753 `~:@{'
2754 args from the rest args (lists).
2755
2756`~^'
2757 Up and out.
2758 `~N^'
2759 aborts if N = 0
2760
2761 `~N,M^'
2762 aborts if N = M
2763
2764 `~N,M,K^'
2765 aborts if N <= M <= K
2766
2767*** Not Implemented CL Format Control Directives
2768
2769`~:A'
2770 print `#f' as an empty list (see below).
2771
2772`~:S'
2773 print `#f' as an empty list (see below).
2774
2775`~<~>'
2776 Justification.
2777
2778`~:^'
2779 (sorry I don't understand its semantics completely)
2780
2781*** Extended, Replaced and Additional Control Directives
2782
2783`~MINCOL,PADCHAR,COMMACHAR,COMMAWIDTHD'
2784`~MINCOL,PADCHAR,COMMACHAR,COMMAWIDTHX'
2785`~MINCOL,PADCHAR,COMMACHAR,COMMAWIDTHO'
2786`~MINCOL,PADCHAR,COMMACHAR,COMMAWIDTHB'
2787`~N,MINCOL,PADCHAR,COMMACHAR,COMMAWIDTHR'
2788 COMMAWIDTH is the number of characters between two comma
2789 characters.
2790
2791`~I'
2792 print a R4RS complex number as `~F~@Fi' with passed parameters for
2793 `~F'.
2794
2795`~Y'
2796 Pretty print formatting of an argument for scheme code lists.
2797
2798`~K'
2799 Same as `~?.'
2800
2801`~!'
2802 Flushes the output if format DESTINATION is a port.
2803
2804`~_'
2805 Print a `#\space' character
2806 `~N_'
2807 print N `#\space' characters.
2808
2809`~/'
2810 Print a `#\tab' character
2811 `~N/'
2812 print N `#\tab' characters.
2813
2814`~NC'
2815 Takes N as an integer representation for a character. No arguments
2816 are consumed. N is converted to a character by `integer->char'. N
2817 must be a positive decimal number.
2818
2819`~:S'
2820 Print out readproof. Prints out internal objects represented as
2821 `#<...>' as strings `"#<...>"' so that the format output can always
2822 be processed by `read'.
2823
2824`~:A'
2825 Print out readproof. Prints out internal objects represented as
2826 `#<...>' as strings `"#<...>"' so that the format output can always
2827 be processed by `read'.
2828
2829`~Q'
2830 Prints information and a copyright notice on the format
2831 implementation.
2832 `~:Q'
2833 prints format version.
2834
2835`~F, ~E, ~G, ~$'
2836 may also print number strings, i.e. passing a number as a string
2837 and format it accordingly.
2838
2839*** Configuration Variables
2840
2841 The format module exports some configuration variables to suit the
2842systems and users needs. There should be no modification necessary for
2843the configuration that comes with Guile. Format detects automatically
2844if the running scheme system implements floating point numbers and
2845complex numbers.
2846
2847format:symbol-case-conv
2848 Symbols are converted by `symbol->string' so the case type of the
2849 printed symbols is implementation dependent.
2850 `format:symbol-case-conv' is a one arg closure which is either
2851 `#f' (no conversion), `string-upcase', `string-downcase' or
2852 `string-capitalize'. (default `#f')
2853
2854format:iobj-case-conv
2855 As FORMAT:SYMBOL-CASE-CONV but applies for the representation of
2856 implementation internal objects. (default `#f')
2857
2858format:expch
2859 The character prefixing the exponent value in `~E' printing.
2860 (default `#\E')
2861
2862*** Compatibility With Other Format Implementations
2863
2864SLIB format 2.x:
2865 See `format.doc'.
2866
2867SLIB format 1.4:
2868 Downward compatible except for padding support and `~A', `~S',
2869 `~P', `~X' uppercase printing. SLIB format 1.4 uses C-style
2870 `printf' padding support which is completely replaced by the CL
2871 `format' padding style.
2872
2873MIT C-Scheme 7.1:
2874 Downward compatible except for `~', which is not documented
2875 (ignores all characters inside the format string up to a newline
2876 character). (7.1 implements `~a', `~s', ~NEWLINE, `~~', `~%',
2877 numerical and variable parameters and `:/@' modifiers in the CL
2878 sense).
2879
2880Elk 1.5/2.0:
2881 Downward compatible except for `~A' and `~S' which print in
2882 uppercase. (Elk implements `~a', `~s', `~~', and `~%' (no
2883 directive parameters or modifiers)).
2884
2885Scheme->C 01nov91:
2886 Downward compatible except for an optional destination parameter:
2887 S2C accepts a format call without a destination which returns a
2888 formatted string. This is equivalent to a #f destination in S2C.
2889 (S2C implements `~a', `~s', `~c', `~%', and `~~' (no directive
2890 parameters or modifiers)).
2891
2892
e7d37b0a 2893** Changes to string-handling functions.
b7e13f65 2894
e7d37b0a 2895These functions were added to support the (ice-9 format) module, above.
b7e13f65 2896
e7d37b0a
JB
2897*** New function: string-upcase STRING
2898*** New function: string-downcase STRING
b7e13f65 2899
e7d37b0a
JB
2900These are non-destructive versions of the existing string-upcase! and
2901string-downcase! functions.
b7e13f65 2902
e7d37b0a
JB
2903*** New function: string-capitalize! STRING
2904*** New function: string-capitalize STRING
2905
2906These functions convert the first letter of each word in the string to
2907upper case. Thus:
2908
2909 (string-capitalize "howdy there")
2910 => "Howdy There"
2911
2912As with the other functions, string-capitalize! modifies the string in
2913place, while string-capitalize returns a modified copy of its argument.
2914
2915*** New function: string-ci->symbol STRING
2916
2917Return a symbol whose name is STRING, but having the same case as if
2918the symbol had be read by `read'.
2919
2920Guile can be configured to be sensitive or insensitive to case
2921differences in Scheme identifiers. If Guile is case-insensitive, all
2922symbols are converted to lower case on input. The `string-ci->symbol'
2923function returns a symbol whose name in STRING, transformed as Guile
2924would if STRING were input.
2925
2926*** New function: substring-move! STRING1 START END STRING2 START
2927
2928Copy the substring of STRING1 from START (inclusive) to END
2929(exclusive) to STRING2 at START. STRING1 and STRING2 may be the same
2930string, and the source and destination areas may overlap; in all
2931cases, the function behaves as if all the characters were copied
2932simultanously.
2933
6c0201ad 2934*** Extended functions: substring-move-left! substring-move-right!
e7d37b0a
JB
2935
2936These functions now correctly copy arbitrarily overlapping substrings;
2937they are both synonyms for substring-move!.
b7e13f65 2938
b7e13f65 2939
deaceb4e
JB
2940** New module (ice-9 getopt-long), with the function `getopt-long'.
2941
2942getopt-long is a function for parsing command-line arguments in a
2943manner consistent with other GNU programs.
2944
2945(getopt-long ARGS GRAMMAR)
2946Parse the arguments ARGS according to the argument list grammar GRAMMAR.
2947
2948ARGS should be a list of strings. Its first element should be the
2949name of the program; subsequent elements should be the arguments
2950that were passed to the program on the command line. The
2951`program-arguments' procedure returns a list of this form.
2952
2953GRAMMAR is a list of the form:
2954((OPTION (PROPERTY VALUE) ...) ...)
2955
2956Each OPTION should be a symbol. `getopt-long' will accept a
2957command-line option named `--OPTION'.
2958Each option can have the following (PROPERTY VALUE) pairs:
2959
2960 (single-char CHAR) --- Accept `-CHAR' as a single-character
2961 equivalent to `--OPTION'. This is how to specify traditional
2962 Unix-style flags.
2963 (required? BOOL) --- If BOOL is true, the option is required.
2964 getopt-long will raise an error if it is not found in ARGS.
2965 (value BOOL) --- If BOOL is #t, the option accepts a value; if
2966 it is #f, it does not; and if it is the symbol
2967 `optional', the option may appear in ARGS with or
6c0201ad 2968 without a value.
deaceb4e
JB
2969 (predicate FUNC) --- If the option accepts a value (i.e. you
2970 specified `(value #t)' for this option), then getopt
2971 will apply FUNC to the value, and throw an exception
2972 if it returns #f. FUNC should be a procedure which
2973 accepts a string and returns a boolean value; you may
2974 need to use quasiquotes to get it into GRAMMAR.
2975
2976The (PROPERTY VALUE) pairs may occur in any order, but each
2977property may occur only once. By default, options do not have
2978single-character equivalents, are not required, and do not take
2979values.
2980
2981In ARGS, single-character options may be combined, in the usual
2982Unix fashion: ("-x" "-y") is equivalent to ("-xy"). If an option
2983accepts values, then it must be the last option in the
2984combination; the value is the next argument. So, for example, using
2985the following grammar:
2986 ((apples (single-char #\a))
2987 (blimps (single-char #\b) (value #t))
2988 (catalexis (single-char #\c) (value #t)))
2989the following argument lists would be acceptable:
2990 ("-a" "-b" "bang" "-c" "couth") ("bang" and "couth" are the values
2991 for "blimps" and "catalexis")
2992 ("-ab" "bang" "-c" "couth") (same)
2993 ("-ac" "couth" "-b" "bang") (same)
2994 ("-abc" "couth" "bang") (an error, since `-b' is not the
2995 last option in its combination)
2996
2997If an option's value is optional, then `getopt-long' decides
2998whether it has a value by looking at what follows it in ARGS. If
2999the next element is a string, and it does not appear to be an
3000option itself, then that string is the option's value.
3001
3002The value of a long option can appear as the next element in ARGS,
3003or it can follow the option name, separated by an `=' character.
3004Thus, using the same grammar as above, the following argument lists
3005are equivalent:
3006 ("--apples" "Braeburn" "--blimps" "Goodyear")
3007 ("--apples=Braeburn" "--blimps" "Goodyear")
3008 ("--blimps" "Goodyear" "--apples=Braeburn")
3009
3010If the option "--" appears in ARGS, argument parsing stops there;
3011subsequent arguments are returned as ordinary arguments, even if
3012they resemble options. So, in the argument list:
3013 ("--apples" "Granny Smith" "--" "--blimp" "Goodyear")
3014`getopt-long' will recognize the `apples' option as having the
3015value "Granny Smith", but it will not recognize the `blimp'
3016option; it will return the strings "--blimp" and "Goodyear" as
3017ordinary argument strings.
3018
3019The `getopt-long' function returns the parsed argument list as an
3020assocation list, mapping option names --- the symbols from GRAMMAR
3021--- onto their values, or #t if the option does not accept a value.
3022Unused options do not appear in the alist.
3023
3024All arguments that are not the value of any option are returned
3025as a list, associated with the empty list.
3026
3027`getopt-long' throws an exception if:
3028- it finds an unrecognized option in ARGS
3029- a required option is omitted
3030- an option that requires an argument doesn't get one
3031- an option that doesn't accept an argument does get one (this can
3032 only happen using the long option `--opt=value' syntax)
3033- an option predicate fails
3034
3035So, for example:
3036
3037(define grammar
3038 `((lockfile-dir (required? #t)
3039 (value #t)
3040 (single-char #\k)
3041 (predicate ,file-is-directory?))
3042 (verbose (required? #f)
3043 (single-char #\v)
3044 (value #f))
3045 (x-includes (single-char #\x))
6c0201ad 3046 (rnet-server (single-char #\y)
deaceb4e
JB
3047 (predicate ,string?))))
3048
6c0201ad 3049(getopt-long '("my-prog" "-vk" "/tmp" "foo1" "--x-includes=/usr/include"
deaceb4e
JB
3050 "--rnet-server=lamprod" "--" "-fred" "foo2" "foo3")
3051 grammar)
3052=> ((() "foo1" "-fred" "foo2" "foo3")
3053 (rnet-server . "lamprod")
3054 (x-includes . "/usr/include")
3055 (lockfile-dir . "/tmp")
3056 (verbose . #t))
3057
3058** The (ice-9 getopt-gnu-style) module is obsolete; use (ice-9 getopt-long).
3059
3060It will be removed in a few releases.
3061
08394899
MS
3062** New syntax: lambda*
3063** New syntax: define*
6c0201ad 3064** New syntax: define*-public
08394899
MS
3065** New syntax: defmacro*
3066** New syntax: defmacro*-public
6c0201ad 3067Guile now supports optional arguments.
08394899
MS
3068
3069`lambda*', `define*', `define*-public', `defmacro*' and
3070`defmacro*-public' are identical to the non-* versions except that
3071they use an extended type of parameter list that has the following BNF
3072syntax (parentheses are literal, square brackets indicate grouping,
3073and `*', `+' and `?' have the usual meaning):
3074
3075 ext-param-list ::= ( [identifier]* [#&optional [ext-var-decl]+]?
6c0201ad 3076 [#&key [ext-var-decl]+ [#&allow-other-keys]?]?
08394899
MS
3077 [[#&rest identifier]|[. identifier]]? ) | [identifier]
3078
6c0201ad 3079 ext-var-decl ::= identifier | ( identifier expression )
08394899
MS
3080
3081The semantics are best illustrated with the following documentation
3082and examples for `lambda*':
3083
3084 lambda* args . body
3085 lambda extended for optional and keyword arguments
6c0201ad 3086
08394899
MS
3087 lambda* creates a procedure that takes optional arguments. These
3088 are specified by putting them inside brackets at the end of the
3089 paramater list, but before any dotted rest argument. For example,
3090 (lambda* (a b #&optional c d . e) '())
3091 creates a procedure with fixed arguments a and b, optional arguments c
3092 and d, and rest argument e. If the optional arguments are omitted
3093 in a call, the variables for them are unbound in the procedure. This
3094 can be checked with the bound? macro.
3095
3096 lambda* can also take keyword arguments. For example, a procedure
3097 defined like this:
3098 (lambda* (#&key xyzzy larch) '())
3099 can be called with any of the argument lists (#:xyzzy 11)
3100 (#:larch 13) (#:larch 42 #:xyzzy 19) (). Whichever arguments
3101 are given as keywords are bound to values.
3102
3103 Optional and keyword arguments can also be given default values
3104 which they take on when they are not present in a call, by giving a
3105 two-item list in place of an optional argument, for example in:
6c0201ad 3106 (lambda* (foo #&optional (bar 42) #&key (baz 73)) (list foo bar baz))
08394899
MS
3107 foo is a fixed argument, bar is an optional argument with default
3108 value 42, and baz is a keyword argument with default value 73.
3109 Default value expressions are not evaluated unless they are needed
6c0201ad 3110 and until the procedure is called.
08394899
MS
3111
3112 lambda* now supports two more special parameter list keywords.
3113
3114 lambda*-defined procedures now throw an error by default if a
3115 keyword other than one of those specified is found in the actual
3116 passed arguments. However, specifying #&allow-other-keys
3117 immediately after the kyword argument declarations restores the
3118 previous behavior of ignoring unknown keywords. lambda* also now
3119 guarantees that if the same keyword is passed more than once, the
3120 last one passed is the one that takes effect. For example,
3121 ((lambda* (#&key (heads 0) (tails 0)) (display (list heads tails)))
3122 #:heads 37 #:tails 42 #:heads 99)
3123 would result in (99 47) being displayed.
3124
3125 #&rest is also now provided as a synonym for the dotted syntax rest
3126 argument. The argument lists (a . b) and (a #&rest b) are equivalent in
3127 all respects to lambda*. This is provided for more similarity to DSSSL,
3128 MIT-Scheme and Kawa among others, as well as for refugees from other
3129 Lisp dialects.
3130
3131Further documentation may be found in the optargs.scm file itself.
3132
3133The optional argument module also exports the macros `let-optional',
3134`let-optional*', `let-keywords', `let-keywords*' and `bound?'. These
3135are not documented here because they may be removed in the future, but
3136full documentation is still available in optargs.scm.
3137
2e132553
JB
3138** New syntax: and-let*
3139Guile now supports the `and-let*' form, described in the draft SRFI-2.
3140
3141Syntax: (land* (<clause> ...) <body> ...)
3142Each <clause> should have one of the following forms:
3143 (<variable> <expression>)
3144 (<expression>)
3145 <bound-variable>
3146Each <variable> or <bound-variable> should be an identifier. Each
3147<expression> should be a valid expression. The <body> should be a
3148possibly empty sequence of expressions, like the <body> of a
3149lambda form.
3150
3151Semantics: A LAND* expression is evaluated by evaluating the
3152<expression> or <bound-variable> of each of the <clause>s from
3153left to right. The value of the first <expression> or
3154<bound-variable> that evaluates to a false value is returned; the
3155remaining <expression>s and <bound-variable>s are not evaluated.
3156The <body> forms are evaluated iff all the <expression>s and
3157<bound-variable>s evaluate to true values.
3158
3159The <expression>s and the <body> are evaluated in an environment
3160binding each <variable> of the preceding (<variable> <expression>)
3161clauses to the value of the <expression>. Later bindings
3162shadow earlier bindings.
3163
3164Guile's and-let* macro was contributed by Michael Livshin.
3165
36d3d540
MD
3166** New sorting functions
3167
3168*** New function: sorted? SEQUENCE LESS?
ed8c8636
MD
3169Returns `#t' when the sequence argument is in non-decreasing order
3170according to LESS? (that is, there is no adjacent pair `... x y
3171...' for which `(less? y x)').
3172
3173Returns `#f' when the sequence contains at least one out-of-order
3174pair. It is an error if the sequence is neither a list nor a
3175vector.
3176
36d3d540 3177*** New function: merge LIST1 LIST2 LESS?
ed8c8636
MD
3178LIST1 and LIST2 are sorted lists.
3179Returns the sorted list of all elements in LIST1 and LIST2.
3180
3181Assume that the elements a and b1 in LIST1 and b2 in LIST2 are "equal"
3182in the sense that (LESS? x y) --> #f for x, y in {a, b1, b2},
3183and that a < b1 in LIST1. Then a < b1 < b2 in the result.
3184(Here "<" should read "comes before".)
3185
36d3d540 3186*** New procedure: merge! LIST1 LIST2 LESS?
ed8c8636
MD
3187Merges two lists, re-using the pairs of LIST1 and LIST2 to build
3188the result. If the code is compiled, and LESS? constructs no new
3189pairs, no pairs at all will be allocated. The first pair of the
3190result will be either the first pair of LIST1 or the first pair of
3191LIST2.
3192
36d3d540 3193*** New function: sort SEQUENCE LESS?
ed8c8636
MD
3194Accepts either a list or a vector, and returns a new sequence
3195which is sorted. The new sequence is the same type as the input.
3196Always `(sorted? (sort sequence less?) less?)'. The original
3197sequence is not altered in any way. The new sequence shares its
3198elements with the old one; no elements are copied.
3199
36d3d540 3200*** New procedure: sort! SEQUENCE LESS
ed8c8636
MD
3201Returns its sorted result in the original boxes. No new storage is
3202allocated at all. Proper usage: (set! slist (sort! slist <))
3203
36d3d540 3204*** New function: stable-sort SEQUENCE LESS?
ed8c8636
MD
3205Similar to `sort' but stable. That is, if "equal" elements are
3206ordered a < b in the original sequence, they will have the same order
3207in the result.
3208
36d3d540 3209*** New function: stable-sort! SEQUENCE LESS?
ed8c8636
MD
3210Similar to `sort!' but stable.
3211Uses temporary storage when sorting vectors.
3212
36d3d540 3213*** New functions: sort-list, sort-list!
ed8c8636
MD
3214Added for compatibility with scsh.
3215
36d3d540
MD
3216** New built-in random number support
3217
3218*** New function: random N [STATE]
3e8370c3
MD
3219Accepts a positive integer or real N and returns a number of the
3220same type between zero (inclusive) and N (exclusive). The values
3221returned have a uniform distribution.
3222
3223The optional argument STATE must be of the type produced by
416075f1
MD
3224`copy-random-state' or `seed->random-state'. It defaults to the value
3225of the variable `*random-state*'. This object is used to maintain the
3226state of the pseudo-random-number generator and is altered as a side
3227effect of the `random' operation.
3e8370c3 3228
36d3d540 3229*** New variable: *random-state*
3e8370c3
MD
3230Holds a data structure that encodes the internal state of the
3231random-number generator that `random' uses by default. The nature
3232of this data structure is implementation-dependent. It may be
3233printed out and successfully read back in, but may or may not
3234function correctly as a random-number state object in another
3235implementation.
3236
36d3d540 3237*** New function: copy-random-state [STATE]
3e8370c3
MD
3238Returns a new object of type suitable for use as the value of the
3239variable `*random-state*' and as a second argument to `random'.
3240If argument STATE is given, a copy of it is returned. Otherwise a
3241copy of `*random-state*' is returned.
416075f1 3242
36d3d540 3243*** New function: seed->random-state SEED
416075f1
MD
3244Returns a new object of type suitable for use as the value of the
3245variable `*random-state*' and as a second argument to `random'.
3246SEED is a string or a number. A new state is generated and
3247initialized using SEED.
3e8370c3 3248
36d3d540 3249*** New function: random:uniform [STATE]
3e8370c3
MD
3250Returns an uniformly distributed inexact real random number in the
3251range between 0 and 1.
3252
36d3d540 3253*** New procedure: random:solid-sphere! VECT [STATE]
3e8370c3
MD
3254Fills VECT with inexact real random numbers the sum of whose
3255squares is less than 1.0. Thinking of VECT as coordinates in
3256space of dimension N = `(vector-length VECT)', the coordinates are
3257uniformly distributed within the unit N-shere. The sum of the
3258squares of the numbers is returned. VECT can be either a vector
3259or a uniform vector of doubles.
3260
36d3d540 3261*** New procedure: random:hollow-sphere! VECT [STATE]
3e8370c3
MD
3262Fills VECT with inexact real random numbers the sum of whose squares
3263is equal to 1.0. Thinking of VECT as coordinates in space of
3264dimension n = `(vector-length VECT)', the coordinates are uniformly
3265distributed over the surface of the unit n-shere. VECT can be either
3266a vector or a uniform vector of doubles.
3267
36d3d540 3268*** New function: random:normal [STATE]
3e8370c3
MD
3269Returns an inexact real in a normal distribution with mean 0 and
3270standard deviation 1. For a normal distribution with mean M and
3271standard deviation D use `(+ M (* D (random:normal)))'.
3272
36d3d540 3273*** New procedure: random:normal-vector! VECT [STATE]
3e8370c3
MD
3274Fills VECT with inexact real random numbers which are independent and
3275standard normally distributed (i.e., with mean 0 and variance 1).
3276VECT can be either a vector or a uniform vector of doubles.
3277
36d3d540 3278*** New function: random:exp STATE
3e8370c3
MD
3279Returns an inexact real in an exponential distribution with mean 1.
3280For an exponential distribution with mean U use (* U (random:exp)).
3281
69c6acbb
JB
3282** The range of logand, logior, logxor, logtest, and logbit? have changed.
3283
3284These functions now operate on numbers in the range of a C unsigned
3285long.
3286
3287These functions used to operate on numbers in the range of a C signed
3288long; however, this seems inappropriate, because Guile integers don't
3289overflow.
3290
ba4ee0d6
MD
3291** New function: make-guardian
3292This is an implementation of guardians as described in
3293R. Kent Dybvig, Carl Bruggeman, and David Eby (1993) "Guardians in a
3294Generation-Based Garbage Collector" ACM SIGPLAN Conference on
3295Programming Language Design and Implementation, June 1993
3296ftp://ftp.cs.indiana.edu/pub/scheme-repository/doc/pubs/guardians.ps.gz
3297
88ceea5c
MD
3298** New functions: delq1!, delv1!, delete1!
3299These procedures behave similar to delq! and friends but delete only
3300one object if at all.
3301
55254a6a
MD
3302** New function: unread-string STRING PORT
3303Unread STRING to PORT, that is, push it back onto the port so that
3304next read operation will work on the pushed back characters.
3305
3306** unread-char can now be called multiple times
3307If unread-char is called multiple times, the unread characters will be
3308read again in last-in first-out order.
3309
9e97c52d
GH
3310** the procedures uniform-array-read! and uniform-array-write! now
3311work on any kind of port, not just ports which are open on a file.
3312
b074884f 3313** Now 'l' in a port mode requests line buffering.
9e97c52d 3314
69bc9ff3
GH
3315** The procedure truncate-file now works on string ports as well
3316as file ports. If the size argument is omitted, the current
1b9c3dae 3317file position is used.
9e97c52d 3318
c94577b4 3319** new procedure: seek PORT/FDES OFFSET WHENCE
9e97c52d
GH
3320The arguments are the same as for the old fseek procedure, but it
3321works on string ports as well as random-access file ports.
3322
3323** the fseek procedure now works on string ports, since it has been
c94577b4 3324redefined using seek.
9e97c52d
GH
3325
3326** the setvbuf procedure now uses a default size if mode is _IOFBF and
3327size is not supplied.
3328
3329** the newline procedure no longer flushes the port if it's not
3330line-buffered: previously it did if it was the current output port.
3331
3332** open-pipe and close-pipe are no longer primitive procedures, but
3333an emulation can be obtained using `(use-modules (ice-9 popen))'.
3334
3335** the freopen procedure has been removed.
3336
3337** new procedure: drain-input PORT
3338Drains PORT's read buffers (including any pushed-back characters)
3339and returns the contents as a single string.
3340
67ad463a 3341** New function: map-in-order PROC LIST1 LIST2 ...
d41b3904
MD
3342Version of `map' which guarantees that the procedure is applied to the
3343lists in serial order.
3344
67ad463a
MD
3345** Renamed `serial-array-copy!' and `serial-array-map!' to
3346`array-copy-in-order!' and `array-map-in-order!'. The old names are
3347now obsolete and will go away in release 1.5.
3348
cf7132b3 3349** New syntax: collect BODY1 ...
d41b3904
MD
3350Version of `begin' which returns a list of the results of the body
3351forms instead of the result of the last body form. In contrast to
cf7132b3 3352`begin', `collect' allows an empty body.
d41b3904 3353
e4eae9b1
MD
3354** New functions: read-history FILENAME, write-history FILENAME
3355Read/write command line history from/to file. Returns #t on success
3356and #f if an error occured.
3357
d21ffe26
JB
3358** `ls' and `lls' in module (ice-9 ls) now handle no arguments.
3359
3360These procedures return a list of definitions available in the specified
3361argument, a relative module reference. In the case of no argument,
3362`(current-module)' is now consulted for definitions to return, instead
3363of simply returning #f, the former behavior.
3364
f8c9d497
JB
3365** The #/ syntax for lists is no longer supported.
3366
3367Earlier versions of Scheme accepted this syntax, but printed a
3368warning.
3369
3370** Guile no longer consults the SCHEME_LOAD_PATH environment variable.
3371
3372Instead, you should set GUILE_LOAD_PATH to tell Guile where to find
3373modules.
3374
3ffc7a36
MD
3375* Changes to the gh_ interface
3376
3377** gh_scm2doubles
3378
3379Now takes a second argument which is the result array. If this
3380pointer is NULL, a new array is malloced (the old behaviour).
3381
3382** gh_chars2byvect, gh_shorts2svect, gh_floats2fvect, gh_scm2chars,
3383 gh_scm2shorts, gh_scm2longs, gh_scm2floats
3384
3385New functions.
3386
3e8370c3
MD
3387* Changes to the scm_ interface
3388
ad91d6c3
MD
3389** Function: scm_make_named_hook (char* name, int n_args)
3390
3391Creates a hook in the same way as make-hook above but also
3392binds a variable named NAME to it.
3393
3394This is the typical way of creating a hook from C code.
3395
ece41168
MD
3396Currently, the variable is created in the "current" module. This
3397might change when we get the new module system.
ad91d6c3 3398
16a5a9a4
MD
3399** The smob interface
3400
3401The interface for creating smobs has changed. For documentation, see
3402data-rep.info (made from guile-core/doc/data-rep.texi).
3403
3404*** Deprecated function: SCM scm_newsmob (scm_smobfuns *)
3405
3406>>> This function will be removed in 1.3.4. <<<
3407
3408It is replaced by:
3409
3410*** Function: SCM scm_make_smob_type (const char *name, scm_sizet size)
3411This function adds a new smob type, named NAME, with instance size
3412SIZE to the system. The return value is a tag that is used in
3413creating instances of the type. If SIZE is 0, then no memory will
3414be allocated when instances of the smob are created, and nothing
3415will be freed by the default free function.
6c0201ad 3416
16a5a9a4
MD
3417*** Function: void scm_set_smob_mark (long tc, SCM (*mark) (SCM))
3418This function sets the smob marking procedure for the smob type
3419specified by the tag TC. TC is the tag returned by
3420`scm_make_smob_type'.
3421
3422*** Function: void scm_set_smob_free (long tc, SCM (*mark) (SCM))
3423This function sets the smob freeing procedure for the smob type
3424specified by the tag TC. TC is the tag returned by
3425`scm_make_smob_type'.
3426
3427*** Function: void scm_set_smob_print (tc, print)
3428
3429 - Function: void scm_set_smob_print (long tc,
3430 scm_sizet (*print) (SCM,
3431 SCM,
3432 scm_print_state *))
3433
3434This function sets the smob printing procedure for the smob type
3435specified by the tag TC. TC is the tag returned by
3436`scm_make_smob_type'.
3437
3438*** Function: void scm_set_smob_equalp (long tc, SCM (*equalp) (SCM, SCM))
3439This function sets the smob equality-testing predicate for the
3440smob type specified by the tag TC. TC is the tag returned by
3441`scm_make_smob_type'.
3442
3443*** Macro: void SCM_NEWSMOB (SCM var, long tc, void *data)
3444Make VALUE contain a smob instance of the type with type code TC and
3445smob data DATA. VALUE must be previously declared as C type `SCM'.
3446
3447*** Macro: fn_returns SCM_RETURN_NEWSMOB (long tc, void *data)
3448This macro expands to a block of code that creates a smob instance
3449of the type with type code TC and smob data DATA, and returns that
3450`SCM' value. It should be the last piece of code in a block.
3451
9e97c52d
GH
3452** The interfaces for using I/O ports and implementing port types
3453(ptobs) have changed significantly. The new interface is based on
3454shared access to buffers and a new set of ptob procedures.
3455
16a5a9a4
MD
3456*** scm_newptob has been removed
3457
3458It is replaced by:
3459
3460*** Function: SCM scm_make_port_type (type_name, fill_buffer, write_flush)
3461
3462- Function: SCM scm_make_port_type (char *type_name,
3463 int (*fill_buffer) (SCM port),
3464 void (*write_flush) (SCM port));
3465
3466Similarly to the new smob interface, there is a set of function
3467setters by which the user can customize the behaviour of his port
544e9093 3468type. See ports.h (scm_set_port_XXX).
16a5a9a4 3469
9e97c52d
GH
3470** scm_strport_to_string: New function: creates a new string from
3471a string port's buffer.
3472
3e8370c3
MD
3473** Plug in interface for random number generators
3474The variable `scm_the_rng' in random.c contains a value and three
3475function pointers which together define the current random number
3476generator being used by the Scheme level interface and the random
3477number library functions.
3478
3479The user is free to replace the default generator with the generator
3480of his own choice.
3481
3482*** Variable: size_t scm_the_rng.rstate_size
3483The size of the random state type used by the current RNG
3484measured in chars.
3485
3486*** Function: unsigned long scm_the_rng.random_bits (scm_rstate *STATE)
3487Given the random STATE, return 32 random bits.
3488
3489*** Function: void scm_the_rng.init_rstate (scm_rstate *STATE, chars *S, int N)
3490Seed random state STATE using string S of length N.
3491
3492*** Function: scm_rstate *scm_the_rng.copy_rstate (scm_rstate *STATE)
3493Given random state STATE, return a malloced copy.
3494
3495** Default RNG
3496The default RNG is the MWC (Multiply With Carry) random number
3497generator described by George Marsaglia at the Department of
3498Statistics and Supercomputer Computations Research Institute, The
3499Florida State University (http://stat.fsu.edu/~geo).
3500
3501It uses 64 bits, has a period of 4578426017172946943 (4.6e18), and
3502passes all tests in the DIEHARD test suite
3503(http://stat.fsu.edu/~geo/diehard.html). The generation of 32 bits
3504costs one multiply and one add on platforms which either supports long
3505longs (gcc does this on most systems) or have 64 bit longs. The cost
3506is four multiply on other systems but this can be optimized by writing
3507scm_i_uniform32 in assembler.
3508
3509These functions are provided through the scm_the_rng interface for use
3510by libguile and the application.
3511
3512*** Function: unsigned long scm_i_uniform32 (scm_i_rstate *STATE)
3513Given the random STATE, return 32 random bits.
3514Don't use this function directly. Instead go through the plugin
3515interface (see "Plug in interface" above).
3516
3517*** Function: void scm_i_init_rstate (scm_i_rstate *STATE, char *SEED, int N)
3518Initialize STATE using SEED of length N.
3519
3520*** Function: scm_i_rstate *scm_i_copy_rstate (scm_i_rstate *STATE)
3521Return a malloc:ed copy of STATE. This function can easily be re-used
3522in the interfaces to other RNGs.
3523
3524** Random number library functions
3525These functions use the current RNG through the scm_the_rng interface.
3526It might be a good idea to use these functions from your C code so
3527that only one random generator is used by all code in your program.
3528
259529f2 3529The default random state is stored in:
3e8370c3
MD
3530
3531*** Variable: SCM scm_var_random_state
3532Contains the vcell of the Scheme variable "*random-state*" which is
3533used as default state by all random number functions in the Scheme
3534level interface.
3535
3536Example:
3537
259529f2 3538 double x = scm_c_uniform01 (SCM_RSTATE (SCM_CDR (scm_var_random_state)));
3e8370c3 3539
259529f2
MD
3540*** Function: scm_rstate *scm_c_default_rstate (void)
3541This is a convenience function which returns the value of
3542scm_var_random_state. An error message is generated if this value
3543isn't a random state.
3544
3545*** Function: scm_rstate *scm_c_make_rstate (char *SEED, int LENGTH)
3546Make a new random state from the string SEED of length LENGTH.
3547
3548It is generally not a good idea to use multiple random states in a
3549program. While subsequent random numbers generated from one random
3550state are guaranteed to be reasonably independent, there is no such
3551guarantee for numbers generated from different random states.
3552
3553*** Macro: unsigned long scm_c_uniform32 (scm_rstate *STATE)
3554Return 32 random bits.
3555
3556*** Function: double scm_c_uniform01 (scm_rstate *STATE)
3e8370c3
MD
3557Return a sample from the uniform(0,1) distribution.
3558
259529f2 3559*** Function: double scm_c_normal01 (scm_rstate *STATE)
3e8370c3
MD
3560Return a sample from the normal(0,1) distribution.
3561
259529f2 3562*** Function: double scm_c_exp1 (scm_rstate *STATE)
3e8370c3
MD
3563Return a sample from the exp(1) distribution.
3564
259529f2
MD
3565*** Function: unsigned long scm_c_random (scm_rstate *STATE, unsigned long M)
3566Return a sample from the discrete uniform(0,M) distribution.
3567
3568*** Function: SCM scm_c_random_bignum (scm_rstate *STATE, SCM M)
3e8370c3 3569Return a sample from the discrete uniform(0,M) distribution.
259529f2 3570M must be a bignum object. The returned value may be an INUM.
3e8370c3 3571
9e97c52d 3572
f3227c7a 3573\f
d23bbf3e 3574Changes in Guile 1.3 (released Monday, October 19, 1998):
c484bf7f
JB
3575
3576* Changes to the distribution
3577
e2d6569c
JB
3578** We renamed the SCHEME_LOAD_PATH environment variable to GUILE_LOAD_PATH.
3579To avoid conflicts, programs should name environment variables after
3580themselves, except when there's a common practice establishing some
3581other convention.
3582
3583For now, Guile supports both GUILE_LOAD_PATH and SCHEME_LOAD_PATH,
3584giving the former precedence, and printing a warning message if the
3585latter is set. Guile 1.4 will not recognize SCHEME_LOAD_PATH at all.
3586
3587** The header files related to multi-byte characters have been removed.
3588They were: libguile/extchrs.h and libguile/mbstrings.h. Any C code
3589which referred to these explicitly will probably need to be rewritten,
3590since the support for the variant string types has been removed; see
3591below.
3592
3593** The header files append.h and sequences.h have been removed. These
3594files implemented non-R4RS operations which would encourage
3595non-portable programming style and less easy-to-read code.
3a97e020 3596
c484bf7f
JB
3597* Changes to the stand-alone interpreter
3598
2e368582 3599** New procedures have been added to implement a "batch mode":
ec4ab4fd 3600
2e368582 3601*** Function: batch-mode?
ec4ab4fd
GH
3602
3603 Returns a boolean indicating whether the interpreter is in batch
3604 mode.
3605
2e368582 3606*** Function: set-batch-mode?! ARG
ec4ab4fd
GH
3607
3608 If ARG is true, switches the interpreter to batch mode. The `#f'
3609 case has not been implemented.
3610
2e368582
JB
3611** Guile now provides full command-line editing, when run interactively.
3612To use this feature, you must have the readline library installed.
3613The Guile build process will notice it, and automatically include
3614support for it.
3615
3616The readline library is available via anonymous FTP from any GNU
3617mirror site; the canonical location is "ftp://prep.ai.mit.edu/pub/gnu".
3618
a5d6d578
MD
3619** the-last-stack is now a fluid.
3620
c484bf7f
JB
3621* Changes to the procedure for linking libguile with your programs
3622
71f20534 3623** You can now use the `guile-config' utility to build programs that use Guile.
2e368582 3624
2adfe1c0 3625Guile now includes a command-line utility called `guile-config', which
71f20534
JB
3626can provide information about how to compile and link programs that
3627use Guile.
3628
3629*** `guile-config compile' prints any C compiler flags needed to use Guile.
3630You should include this command's output on the command line you use
3631to compile C or C++ code that #includes the Guile header files. It's
3632usually just a `-I' flag to help the compiler find the Guile headers.
3633
3634
3635*** `guile-config link' prints any linker flags necessary to link with Guile.
8aa5c148 3636
71f20534 3637This command writes to its standard output a list of flags which you
8aa5c148
JB
3638must pass to the linker to link your code against the Guile library.
3639The flags include '-lguile' itself, any other libraries the Guile
3640library depends upon, and any `-L' flags needed to help the linker
3641find those libraries.
2e368582
JB
3642
3643For example, here is a Makefile rule that builds a program named 'foo'
3644from the object files ${FOO_OBJECTS}, and links them against Guile:
3645
3646 foo: ${FOO_OBJECTS}
2adfe1c0 3647 ${CC} ${CFLAGS} ${FOO_OBJECTS} `guile-config link` -o foo
2e368582 3648
e2d6569c
JB
3649Previous Guile releases recommended that you use autoconf to detect
3650which of a predefined set of libraries were present on your system.
2adfe1c0 3651It is more robust to use `guile-config', since it records exactly which
e2d6569c
JB
3652libraries the installed Guile library requires.
3653
2adfe1c0
JB
3654This was originally called `build-guile', but was renamed to
3655`guile-config' before Guile 1.3 was released, to be consistent with
3656the analogous script for the GTK+ GUI toolkit, which is called
3657`gtk-config'.
3658
2e368582 3659
8aa5c148
JB
3660** Use the GUILE_FLAGS macro in your configure.in file to find Guile.
3661
3662If you are using the GNU autoconf package to configure your program,
3663you can use the GUILE_FLAGS autoconf macro to call `guile-config'
3664(described above) and gather the necessary values for use in your
3665Makefiles.
3666
3667The GUILE_FLAGS macro expands to configure script code which runs the
3668`guile-config' script, to find out where Guile's header files and
3669libraries are installed. It sets two variables, marked for
3670substitution, as by AC_SUBST.
3671
3672 GUILE_CFLAGS --- flags to pass to a C or C++ compiler to build
3673 code that uses Guile header files. This is almost always just a
3674 -I flag.
3675
3676 GUILE_LDFLAGS --- flags to pass to the linker to link a
3677 program against Guile. This includes `-lguile' for the Guile
3678 library itself, any libraries that Guile itself requires (like
3679 -lqthreads), and so on. It may also include a -L flag to tell the
3680 compiler where to find the libraries.
3681
3682GUILE_FLAGS is defined in the file guile.m4, in the top-level
3683directory of the Guile distribution. You can copy it into your
3684package's aclocal.m4 file, and then use it in your configure.in file.
3685
3686If you are using the `aclocal' program, distributed with GNU automake,
3687to maintain your aclocal.m4 file, the Guile installation process
3688installs guile.m4 where aclocal will find it. All you need to do is
3689use GUILE_FLAGS in your configure.in file, and then run `aclocal';
3690this will copy the definition of GUILE_FLAGS into your aclocal.m4
3691file.
3692
3693
c484bf7f 3694* Changes to Scheme functions and syntax
7ad3c1e7 3695
02755d59 3696** Multi-byte strings have been removed, as have multi-byte and wide
e2d6569c
JB
3697ports. We felt that these were the wrong approach to
3698internationalization support.
02755d59 3699
2e368582
JB
3700** New function: readline [PROMPT]
3701Read a line from the terminal, and allow the user to edit it,
3702prompting with PROMPT. READLINE provides a large set of Emacs-like
3703editing commands, lets the user recall previously typed lines, and
3704works on almost every kind of terminal, including dumb terminals.
3705
3706READLINE assumes that the cursor is at the beginning of the line when
3707it is invoked. Thus, you can't print a prompt yourself, and then call
3708READLINE; you need to package up your prompt as a string, pass it to
3709the function, and let READLINE print the prompt itself. This is
3710because READLINE needs to know the prompt's screen width.
3711
8cd57bd0
JB
3712For Guile to provide this function, you must have the readline
3713library, version 2.1 or later, installed on your system. Readline is
3714available via anonymous FTP from prep.ai.mit.edu in pub/gnu, or from
3715any GNU mirror site.
2e368582
JB
3716
3717See also ADD-HISTORY function.
3718
3719** New function: add-history STRING
3720Add STRING as the most recent line in the history used by the READLINE
3721command. READLINE does not add lines to the history itself; you must
3722call ADD-HISTORY to make previous input available to the user.
3723
8cd57bd0
JB
3724** The behavior of the read-line function has changed.
3725
3726This function now uses standard C library functions to read the line,
3727for speed. This means that it doesn not respect the value of
3728scm-line-incrementors; it assumes that lines are delimited with
3729#\newline.
3730
3731(Note that this is read-line, the function that reads a line of text
3732from a port, not readline, the function that reads a line from a
3733terminal, providing full editing capabilities.)
3734
1a0106ef
JB
3735** New module (ice-9 getopt-gnu-style): Parse command-line arguments.
3736
3737This module provides some simple argument parsing. It exports one
3738function:
3739
3740Function: getopt-gnu-style ARG-LS
3741 Parse a list of program arguments into an alist of option
3742 descriptions.
3743
3744 Each item in the list of program arguments is examined to see if
3745 it meets the syntax of a GNU long-named option. An argument like
3746 `--MUMBLE' produces an element of the form (MUMBLE . #t) in the
3747 returned alist, where MUMBLE is a keyword object with the same
3748 name as the argument. An argument like `--MUMBLE=FROB' produces
3749 an element of the form (MUMBLE . FROB), where FROB is a string.
3750
3751 As a special case, the returned alist also contains a pair whose
3752 car is the symbol `rest'. The cdr of this pair is a list
3753 containing all the items in the argument list that are not options
3754 of the form mentioned above.
3755
3756 The argument `--' is treated specially: all items in the argument
3757 list appearing after such an argument are not examined, and are
3758 returned in the special `rest' list.
3759
3760 This function does not parse normal single-character switches.
3761 You will need to parse them out of the `rest' list yourself.
3762
8cd57bd0
JB
3763** The read syntax for byte vectors and short vectors has changed.
3764
3765Instead of #bytes(...), write #y(...).
3766
3767Instead of #short(...), write #h(...).
3768
3769This may seem nutty, but, like the other uniform vectors, byte vectors
3770and short vectors want to have the same print and read syntax (and,
3771more basic, want to have read syntax!). Changing the read syntax to
3772use multiple characters after the hash sign breaks with the
3773conventions used in R5RS and the conventions used for the other
3774uniform vectors. It also introduces complexity in the current reader,
3775both on the C and Scheme levels. (The Right solution is probably to
3776change the syntax and prototypes for uniform vectors entirely.)
3777
3778
3779** The new module (ice-9 session) provides useful interactive functions.
3780
3781*** New procedure: (apropos REGEXP OPTION ...)
3782
3783Display a list of top-level variables whose names match REGEXP, and
3784the modules they are imported from. Each OPTION should be one of the
3785following symbols:
3786
3787 value --- Show the value of each matching variable.
3788 shadow --- Show bindings shadowed by subsequently imported modules.
3789 full --- Same as both `shadow' and `value'.
3790
3791For example:
3792
3793 guile> (apropos "trace" 'full)
3794 debug: trace #<procedure trace args>
3795 debug: untrace #<procedure untrace args>
3796 the-scm-module: display-backtrace #<compiled-closure #<primitive-procedure gsubr-apply>>
3797 the-scm-module: before-backtrace-hook ()
3798 the-scm-module: backtrace #<primitive-procedure backtrace>
3799 the-scm-module: after-backtrace-hook ()
3800 the-scm-module: has-shown-backtrace-hint? #f
6c0201ad 3801 guile>
8cd57bd0
JB
3802
3803** There are new functions and syntax for working with macros.
3804
3805Guile implements macros as a special object type. Any variable whose
3806top-level binding is a macro object acts as a macro. The macro object
3807specifies how the expression should be transformed before evaluation.
3808
3809*** Macro objects now print in a reasonable way, resembling procedures.
3810
3811*** New function: (macro? OBJ)
3812True iff OBJ is a macro object.
3813
3814*** New function: (primitive-macro? OBJ)
3815Like (macro? OBJ), but true only if OBJ is one of the Guile primitive
3816macro transformers, implemented in eval.c rather than Scheme code.
3817
dbdd0c16
JB
3818Why do we have this function?
3819- For symmetry with procedure? and primitive-procedure?,
3820- to allow custom print procedures to tell whether a macro is
3821 primitive, and display it differently, and
3822- to allow compilers and user-written evaluators to distinguish
3823 builtin special forms from user-defined ones, which could be
3824 compiled.
3825
8cd57bd0
JB
3826*** New function: (macro-type OBJ)
3827Return a value indicating what kind of macro OBJ is. Possible return
3828values are:
3829
3830 The symbol `syntax' --- a macro created by procedure->syntax.
3831 The symbol `macro' --- a macro created by procedure->macro.
3832 The symbol `macro!' --- a macro created by procedure->memoizing-macro.
6c0201ad 3833 The boolean #f --- if OBJ is not a macro object.
8cd57bd0
JB
3834
3835*** New function: (macro-name MACRO)
3836Return the name of the macro object MACRO's procedure, as returned by
3837procedure-name.
3838
3839*** New function: (macro-transformer MACRO)
3840Return the transformer procedure for MACRO.
3841
3842*** New syntax: (use-syntax MODULE ... TRANSFORMER)
3843
3844Specify a new macro expander to use in the current module. Each
3845MODULE is a module name, with the same meaning as in the `use-modules'
3846form; each named module's exported bindings are added to the current
3847top-level environment. TRANSFORMER is an expression evaluated in the
3848resulting environment which must yield a procedure to use as the
3849module's eval transformer: every expression evaluated in this module
3850is passed to this function, and the result passed to the Guile
6c0201ad 3851interpreter.
8cd57bd0
JB
3852
3853*** macro-eval! is removed. Use local-eval instead.
29521173 3854
8d9dcb3c
MV
3855** Some magic has been added to the printer to better handle user
3856written printing routines (like record printers, closure printers).
3857
3858The problem is that these user written routines must have access to
7fbd77df 3859the current `print-state' to be able to handle fancy things like
8d9dcb3c
MV
3860detection of circular references. These print-states have to be
3861passed to the builtin printing routines (display, write, etc) to
3862properly continue the print chain.
3863
3864We didn't want to change all existing print code so that it
8cd57bd0 3865explicitly passes thru a print state in addition to a port. Instead,
8d9dcb3c
MV
3866we extented the possible values that the builtin printing routines
3867accept as a `port'. In addition to a normal port, they now also take
3868a pair of a normal port and a print-state. Printing will go to the
3869port and the print-state will be used to control the detection of
3870circular references, etc. If the builtin function does not care for a
3871print-state, it is simply ignored.
3872
3873User written callbacks are now called with such a pair as their
3874`port', but because every function now accepts this pair as a PORT
3875argument, you don't have to worry about that. In fact, it is probably
3876safest to not check for these pairs.
3877
3878However, it is sometimes necessary to continue a print chain on a
3879different port, for example to get a intermediate string
3880representation of the printed value, mangle that string somehow, and
3881then to finally print the mangled string. Use the new function
3882
3883 inherit-print-state OLD-PORT NEW-PORT
3884
3885for this. It constructs a new `port' that prints to NEW-PORT but
3886inherits the print-state of OLD-PORT.
3887
ef1ea498
MD
3888** struct-vtable-offset renamed to vtable-offset-user
3889
3890** New constants: vtable-index-layout, vtable-index-vtable, vtable-index-printer
3891
e478dffa
MD
3892** There is now a third optional argument to make-vtable-vtable
3893 (and fourth to make-struct) when constructing new types (vtables).
3894 This argument initializes field vtable-index-printer of the vtable.
ef1ea498 3895
4851dc57
MV
3896** The detection of circular references has been extended to structs.
3897That is, a structure that -- in the process of being printed -- prints
3898itself does not lead to infinite recursion.
3899
3900** There is now some basic support for fluids. Please read
3901"libguile/fluid.h" to find out more. It is accessible from Scheme with
3902the following functions and macros:
3903
9c3fb66f
MV
3904Function: make-fluid
3905
3906 Create a new fluid object. Fluids are not special variables or
3907 some other extension to the semantics of Scheme, but rather
3908 ordinary Scheme objects. You can store them into variables (that
3909 are still lexically scoped, of course) or into any other place you
3910 like. Every fluid has a initial value of `#f'.
04c76b58 3911
9c3fb66f 3912Function: fluid? OBJ
04c76b58 3913
9c3fb66f 3914 Test whether OBJ is a fluid.
04c76b58 3915
9c3fb66f
MV
3916Function: fluid-ref FLUID
3917Function: fluid-set! FLUID VAL
04c76b58
MV
3918
3919 Access/modify the fluid FLUID. Modifications are only visible
3920 within the current dynamic root (that includes threads).
3921
9c3fb66f
MV
3922Function: with-fluids* FLUIDS VALUES THUNK
3923
3924 FLUIDS is a list of fluids and VALUES a corresponding list of
3925 values for these fluids. Before THUNK gets called the values are
6c0201ad 3926 installed in the fluids and the old values of the fluids are
9c3fb66f
MV
3927 saved in the VALUES list. When the flow of control leaves THUNK
3928 or reenters it, the values get swapped again. You might think of
3929 this as a `safe-fluid-excursion'. Note that the VALUES list is
3930 modified by `with-fluids*'.
3931
3932Macro: with-fluids ((FLUID VALUE) ...) FORM ...
3933
3934 The same as `with-fluids*' but with a different syntax. It looks
3935 just like `let', but both FLUID and VALUE are evaluated. Remember,
3936 fluids are not special variables but ordinary objects. FLUID
3937 should evaluate to a fluid.
04c76b58 3938
e2d6569c 3939** Changes to system call interfaces:
64d01d13 3940
e2d6569c 3941*** close-port, close-input-port and close-output-port now return a
64d01d13
GH
3942boolean instead of an `unspecified' object. #t means that the port
3943was successfully closed, while #f means it was already closed. It is
3944also now possible for these procedures to raise an exception if an
3945error occurs (some errors from write can be delayed until close.)
3946
e2d6569c 3947*** the first argument to chmod, fcntl, ftell and fseek can now be a
6afcd3b2
GH
3948file descriptor.
3949
e2d6569c 3950*** the third argument to fcntl is now optional.
6afcd3b2 3951
e2d6569c 3952*** the first argument to chown can now be a file descriptor or a port.
6afcd3b2 3953
e2d6569c 3954*** the argument to stat can now be a port.
6afcd3b2 3955
e2d6569c 3956*** The following new procedures have been added (most use scsh
64d01d13
GH
3957interfaces):
3958
e2d6569c 3959*** procedure: close PORT/FD
ec4ab4fd
GH
3960 Similar to close-port (*note close-port: Closing Ports.), but also
3961 works on file descriptors. A side effect of closing a file
3962 descriptor is that any ports using that file descriptor are moved
3963 to a different file descriptor and have their revealed counts set
3964 to zero.
3965
e2d6569c 3966*** procedure: port->fdes PORT
ec4ab4fd
GH
3967 Returns the integer file descriptor underlying PORT. As a side
3968 effect the revealed count of PORT is incremented.
3969
e2d6569c 3970*** procedure: fdes->ports FDES
ec4ab4fd
GH
3971 Returns a list of existing ports which have FDES as an underlying
3972 file descriptor, without changing their revealed counts.
3973
e2d6569c 3974*** procedure: fdes->inport FDES
ec4ab4fd
GH
3975 Returns an existing input port which has FDES as its underlying
3976 file descriptor, if one exists, and increments its revealed count.
3977 Otherwise, returns a new input port with a revealed count of 1.
3978
e2d6569c 3979*** procedure: fdes->outport FDES
ec4ab4fd
GH
3980 Returns an existing output port which has FDES as its underlying
3981 file descriptor, if one exists, and increments its revealed count.
3982 Otherwise, returns a new output port with a revealed count of 1.
3983
3984 The next group of procedures perform a `dup2' system call, if NEWFD
3985(an integer) is supplied, otherwise a `dup'. The file descriptor to be
3986duplicated can be supplied as an integer or contained in a port. The
64d01d13
GH
3987type of value returned varies depending on which procedure is used.
3988
ec4ab4fd
GH
3989 All procedures also have the side effect when performing `dup2' that
3990any ports using NEWFD are moved to a different file descriptor and have
64d01d13
GH
3991their revealed counts set to zero.
3992
e2d6569c 3993*** procedure: dup->fdes PORT/FD [NEWFD]
ec4ab4fd 3994 Returns an integer file descriptor.
64d01d13 3995
e2d6569c 3996*** procedure: dup->inport PORT/FD [NEWFD]
ec4ab4fd 3997 Returns a new input port using the new file descriptor.
64d01d13 3998
e2d6569c 3999*** procedure: dup->outport PORT/FD [NEWFD]
ec4ab4fd 4000 Returns a new output port using the new file descriptor.
64d01d13 4001
e2d6569c 4002*** procedure: dup PORT/FD [NEWFD]
ec4ab4fd
GH
4003 Returns a new port if PORT/FD is a port, with the same mode as the
4004 supplied port, otherwise returns an integer file descriptor.
64d01d13 4005
e2d6569c 4006*** procedure: dup->port PORT/FD MODE [NEWFD]
ec4ab4fd
GH
4007 Returns a new port using the new file descriptor. MODE supplies a
4008 mode string for the port (*note open-file: File Ports.).
64d01d13 4009
e2d6569c 4010*** procedure: setenv NAME VALUE
ec4ab4fd
GH
4011 Modifies the environment of the current process, which is also the
4012 default environment inherited by child processes.
64d01d13 4013
ec4ab4fd
GH
4014 If VALUE is `#f', then NAME is removed from the environment.
4015 Otherwise, the string NAME=VALUE is added to the environment,
4016 replacing any existing string with name matching NAME.
64d01d13 4017
ec4ab4fd 4018 The return value is unspecified.
956055a9 4019
e2d6569c 4020*** procedure: truncate-file OBJ SIZE
6afcd3b2
GH
4021 Truncates the file referred to by OBJ to at most SIZE bytes. OBJ
4022 can be a string containing a file name or an integer file
4023 descriptor or port open for output on the file. The underlying
4024 system calls are `truncate' and `ftruncate'.
4025
4026 The return value is unspecified.
4027
e2d6569c 4028*** procedure: setvbuf PORT MODE [SIZE]
7a6f1ffa
GH
4029 Set the buffering mode for PORT. MODE can be:
4030 `_IONBF'
4031 non-buffered
4032
4033 `_IOLBF'
4034 line buffered
4035
4036 `_IOFBF'
4037 block buffered, using a newly allocated buffer of SIZE bytes.
4038 However if SIZE is zero or unspecified, the port will be made
4039 non-buffered.
4040
4041 This procedure should not be used after I/O has been performed with
4042 the port.
4043
4044 Ports are usually block buffered by default, with a default buffer
4045 size. Procedures e.g., *Note open-file: File Ports, which accept a
4046 mode string allow `0' to be added to request an unbuffered port.
4047
e2d6569c 4048*** procedure: fsync PORT/FD
6afcd3b2
GH
4049 Copies any unwritten data for the specified output file descriptor
4050 to disk. If PORT/FD is a port, its buffer is flushed before the
4051 underlying file descriptor is fsync'd. The return value is
4052 unspecified.
4053
e2d6569c 4054*** procedure: open-fdes PATH FLAGS [MODES]
6afcd3b2
GH
4055 Similar to `open' but returns a file descriptor instead of a port.
4056
e2d6569c 4057*** procedure: execle PATH ENV [ARG] ...
6afcd3b2
GH
4058 Similar to `execl', but the environment of the new process is
4059 specified by ENV, which must be a list of strings as returned by
4060 the `environ' procedure.
4061
4062 This procedure is currently implemented using the `execve' system
4063 call, but we call it `execle' because of its Scheme calling
4064 interface.
4065
e2d6569c 4066*** procedure: strerror ERRNO
ec4ab4fd
GH
4067 Returns the Unix error message corresponding to ERRNO, an integer.
4068
e2d6569c 4069*** procedure: primitive-exit [STATUS]
6afcd3b2
GH
4070 Terminate the current process without unwinding the Scheme stack.
4071 This is would typically be useful after a fork. The exit status
4072 is STATUS if supplied, otherwise zero.
4073
e2d6569c 4074*** procedure: times
6afcd3b2
GH
4075 Returns an object with information about real and processor time.
4076 The following procedures accept such an object as an argument and
4077 return a selected component:
4078
4079 `tms:clock'
4080 The current real time, expressed as time units relative to an
4081 arbitrary base.
4082
4083 `tms:utime'
4084 The CPU time units used by the calling process.
4085
4086 `tms:stime'
4087 The CPU time units used by the system on behalf of the
4088 calling process.
4089
4090 `tms:cutime'
4091 The CPU time units used by terminated child processes of the
4092 calling process, whose status has been collected (e.g., using
4093 `waitpid').
4094
4095 `tms:cstime'
4096 Similarly, the CPU times units used by the system on behalf of
4097 terminated child processes.
7ad3c1e7 4098
e2d6569c
JB
4099** Removed: list-length
4100** Removed: list-append, list-append!
4101** Removed: list-reverse, list-reverse!
4102
4103** array-map renamed to array-map!
4104
4105** serial-array-map renamed to serial-array-map!
4106
660f41fa
MD
4107** catch doesn't take #f as first argument any longer
4108
4109Previously, it was possible to pass #f instead of a key to `catch'.
4110That would cause `catch' to pass a jump buffer object to the procedure
4111passed as second argument. The procedure could then use this jump
4112buffer objekt as an argument to throw.
4113
4114This mechanism has been removed since its utility doesn't motivate the
4115extra complexity it introduces.
4116
332d00f6
JB
4117** The `#/' notation for lists now provokes a warning message from Guile.
4118This syntax will be removed from Guile in the near future.
4119
4120To disable the warning message, set the GUILE_HUSH environment
4121variable to any non-empty value.
4122
8cd57bd0
JB
4123** The newline character now prints as `#\newline', following the
4124normal Scheme notation, not `#\nl'.
4125
c484bf7f
JB
4126* Changes to the gh_ interface
4127
8986901b
JB
4128** The gh_enter function now takes care of loading the Guile startup files.
4129gh_enter works by calling scm_boot_guile; see the remarks below.
4130
5424b4f7
MD
4131** Function: void gh_write (SCM x)
4132
4133Write the printed representation of the scheme object x to the current
4134output port. Corresponds to the scheme level `write'.
4135
3a97e020
MD
4136** gh_list_length renamed to gh_length.
4137
8d6787b6
MG
4138** vector handling routines
4139
4140Several major changes. In particular, gh_vector() now resembles
4141(vector ...) (with a caveat -- see manual), and gh_make_vector() now
956328d2
MG
4142exists and behaves like (make-vector ...). gh_vset() and gh_vref()
4143have been renamed gh_vector_set_x() and gh_vector_ref(). Some missing
8d6787b6
MG
4144vector-related gh_ functions have been implemented.
4145
7fee59bd
MG
4146** pair and list routines
4147
4148Implemented several of the R4RS pair and list functions that were
4149missing.
4150
171422a9
MD
4151** gh_scm2doubles, gh_doubles2scm, gh_doubles2dvect
4152
4153New function. Converts double arrays back and forth between Scheme
4154and C.
4155
c484bf7f
JB
4156* Changes to the scm_ interface
4157
8986901b
JB
4158** The function scm_boot_guile now takes care of loading the startup files.
4159
4160Guile's primary initialization function, scm_boot_guile, now takes
4161care of loading `boot-9.scm', in the `ice-9' module, to initialize
4162Guile, define the module system, and put together some standard
4163bindings. It also loads `init.scm', which is intended to hold
4164site-specific initialization code.
4165
4166Since Guile cannot operate properly until boot-9.scm is loaded, there
4167is no reason to separate loading boot-9.scm from Guile's other
4168initialization processes.
4169
4170This job used to be done by scm_compile_shell_switches, which didn't
4171make much sense; in particular, it meant that people using Guile for
4172non-shell-like applications had to jump through hoops to get Guile
4173initialized properly.
4174
4175** The function scm_compile_shell_switches no longer loads the startup files.
4176Now, Guile always loads the startup files, whenever it is initialized;
4177see the notes above for scm_boot_guile and scm_load_startup_files.
4178
4179** Function: scm_load_startup_files
4180This new function takes care of loading Guile's initialization file
4181(`boot-9.scm'), and the site initialization file, `init.scm'. Since
4182this is always called by the Guile initialization process, it's
4183probably not too useful to call this yourself, but it's there anyway.
4184
87148d9e
JB
4185** The semantics of smob marking have changed slightly.
4186
4187The smob marking function (the `mark' member of the scm_smobfuns
4188structure) is no longer responsible for setting the mark bit on the
4189smob. The generic smob handling code in the garbage collector will
4190set this bit. The mark function need only ensure that any other
4191objects the smob refers to get marked.
4192
4193Note that this change means that the smob's GC8MARK bit is typically
4194already set upon entry to the mark function. Thus, marking functions
4195which look like this:
4196
4197 {
4198 if (SCM_GC8MARKP (ptr))
4199 return SCM_BOOL_F;
4200 SCM_SETGC8MARK (ptr);
4201 ... mark objects to which the smob refers ...
4202 }
4203
4204are now incorrect, since they will return early, and fail to mark any
4205other objects the smob refers to. Some code in the Guile library used
4206to work this way.
4207
1cf84ea5
JB
4208** The semantics of the I/O port functions in scm_ptobfuns have changed.
4209
4210If you have implemented your own I/O port type, by writing the
4211functions required by the scm_ptobfuns and then calling scm_newptob,
4212you will need to change your functions slightly.
4213
4214The functions in a scm_ptobfuns structure now expect the port itself
4215as their argument; they used to expect the `stream' member of the
4216port's scm_port_table structure. This allows functions in an
4217scm_ptobfuns structure to easily access the port's cell (and any flags
4218it its CAR), and the port's scm_port_table structure.
4219
4220Guile now passes the I/O port itself as the `port' argument in the
4221following scm_ptobfuns functions:
4222
4223 int (*free) (SCM port);
4224 int (*fputc) (int, SCM port);
4225 int (*fputs) (char *, SCM port);
4226 scm_sizet (*fwrite) SCM_P ((char *ptr,
4227 scm_sizet size,
4228 scm_sizet nitems,
4229 SCM port));
4230 int (*fflush) (SCM port);
4231 int (*fgetc) (SCM port);
4232 int (*fclose) (SCM port);
4233
4234The interfaces to the `mark', `print', `equalp', and `fgets' methods
4235are unchanged.
4236
4237If you have existing code which defines its own port types, it is easy
4238to convert your code to the new interface; simply apply SCM_STREAM to
4239the port argument to yield the value you code used to expect.
4240
4241Note that since both the port and the stream have the same type in the
4242C code --- they are both SCM values --- the C compiler will not remind
4243you if you forget to update your scm_ptobfuns functions.
4244
4245
933a7411
MD
4246** Function: int scm_internal_select (int fds,
4247 SELECT_TYPE *rfds,
4248 SELECT_TYPE *wfds,
4249 SELECT_TYPE *efds,
4250 struct timeval *timeout);
4251
4252This is a replacement for the `select' function provided by the OS.
4253It enables I/O blocking and sleeping to happen for one cooperative
4254thread without blocking other threads. It also avoids busy-loops in
4255these situations. It is intended that all I/O blocking and sleeping
4256will finally go through this function. Currently, this function is
4257only available on systems providing `gettimeofday' and `select'.
4258
5424b4f7
MD
4259** Function: SCM scm_internal_stack_catch (SCM tag,
4260 scm_catch_body_t body,
4261 void *body_data,
4262 scm_catch_handler_t handler,
4263 void *handler_data)
4264
4265A new sibling to the other two C level `catch' functions
4266scm_internal_catch and scm_internal_lazy_catch. Use it if you want
4267the stack to be saved automatically into the variable `the-last-stack'
4268(scm_the_last_stack_var) on error. This is necessary if you want to
4269use advanced error reporting, such as calling scm_display_error and
4270scm_display_backtrace. (They both take a stack object as argument.)
4271
df366c26
MD
4272** Function: SCM scm_spawn_thread (scm_catch_body_t body,
4273 void *body_data,
4274 scm_catch_handler_t handler,
4275 void *handler_data)
4276
4277Spawns a new thread. It does a job similar to
4278scm_call_with_new_thread but takes arguments more suitable when
4279spawning threads from application C code.
4280
88482b31
MD
4281** The hook scm_error_callback has been removed. It was originally
4282intended as a way for the user to install his own error handler. But
4283that method works badly since it intervenes between throw and catch,
4284thereby changing the semantics of expressions like (catch #t ...).
4285The correct way to do it is to use one of the C level catch functions
4286in throw.c: scm_internal_catch/lazy_catch/stack_catch.
4287
3a97e020
MD
4288** Removed functions:
4289
4290scm_obj_length, scm_list_length, scm_list_append, scm_list_append_x,
4291scm_list_reverse, scm_list_reverse_x
4292
4293** New macros: SCM_LISTn where n is one of the integers 0-9.
4294
4295These can be used for pretty list creation from C. The idea is taken
4296from Erick Gallesio's STk.
4297
298aa6e3
MD
4298** scm_array_map renamed to scm_array_map_x
4299
527da704
MD
4300** mbstrings are now removed
4301
4302This means that the type codes scm_tc7_mb_string and
4303scm_tc7_mb_substring has been removed.
4304
8cd57bd0
JB
4305** scm_gen_putc, scm_gen_puts, scm_gen_write, and scm_gen_getc have changed.
4306
4307Since we no longer support multi-byte strings, these I/O functions
4308have been simplified, and renamed. Here are their old names, and
4309their new names and arguments:
4310
4311scm_gen_putc -> void scm_putc (int c, SCM port);
4312scm_gen_puts -> void scm_puts (char *s, SCM port);
4313scm_gen_write -> void scm_lfwrite (char *ptr, scm_sizet size, SCM port);
4314scm_gen_getc -> void scm_getc (SCM port);
4315
4316
527da704
MD
4317** The macros SCM_TYP7D and SCM_TYP7SD has been removed.
4318
4319** The macro SCM_TYP7S has taken the role of the old SCM_TYP7D
4320
4321SCM_TYP7S now masks away the bit which distinguishes substrings from
4322strings.
4323
660f41fa
MD
4324** scm_catch_body_t: Backward incompatible change!
4325
4326Body functions to scm_internal_catch and friends do not any longer
4327take a second argument. This is because it is no longer possible to
4328pass a #f arg to catch.
4329
a8e05009
JB
4330** Calls to scm_protect_object and scm_unprotect now nest properly.
4331
4332The function scm_protect_object protects its argument from being freed
4333by the garbage collector. scm_unprotect_object removes that
4334protection.
4335
4336These functions now nest properly. That is, for every object O, there
4337is a counter which scm_protect_object(O) increments and
4338scm_unprotect_object(O) decrements, if the counter is greater than
4339zero. Every object's counter is zero when it is first created. If an
4340object's counter is greater than zero, the garbage collector will not
4341reclaim its storage.
4342
4343This allows you to use scm_protect_object in your code without
4344worrying that some other function you call will call
4345scm_unprotect_object, and allow it to be freed. Assuming that the
4346functions you call are well-behaved, and unprotect only those objects
4347they protect, you can follow the same rule and have confidence that
4348objects will be freed only at appropriate times.
4349
c484bf7f
JB
4350\f
4351Changes in Guile 1.2 (released Tuesday, June 24 1997):
cf78e9e8 4352
737c9113
JB
4353* Changes to the distribution
4354
832b09ed
JB
4355** Nightly snapshots are now available from ftp.red-bean.com.
4356The old server, ftp.cyclic.com, has been relinquished to its rightful
4357owner.
4358
4359Nightly snapshots of the Guile development sources are now available via
4360anonymous FTP from ftp.red-bean.com, as /pub/guile/guile-snap.tar.gz.
4361
4362Via the web, that's: ftp://ftp.red-bean.com/pub/guile/guile-snap.tar.gz
4363For getit, that's: ftp.red-bean.com:/pub/guile/guile-snap.tar.gz
4364
0fcab5ed
JB
4365** To run Guile without installing it, the procedure has changed a bit.
4366
4367If you used a separate build directory to compile Guile, you'll need
4368to include the build directory in SCHEME_LOAD_PATH, as well as the
4369source directory. See the `INSTALL' file for examples.
4370
737c9113
JB
4371* Changes to the procedure for linking libguile with your programs
4372
94982a4e
JB
4373** The standard Guile load path for Scheme code now includes
4374$(datadir)/guile (usually /usr/local/share/guile). This means that
4375you can install your own Scheme files there, and Guile will find them.
4376(Previous versions of Guile only checked a directory whose name
4377contained the Guile version number, so you had to re-install or move
4378your Scheme sources each time you installed a fresh version of Guile.)
4379
4380The load path also includes $(datadir)/guile/site; we recommend
4381putting individual Scheme files there. If you want to install a
4382package with multiple source files, create a directory for them under
4383$(datadir)/guile.
4384
4385** Guile 1.2 will now use the Rx regular expression library, if it is
4386installed on your system. When you are linking libguile into your own
4387programs, this means you will have to link against -lguile, -lqt (if
4388you configured Guile with thread support), and -lrx.
27590f82
JB
4389
4390If you are using autoconf to generate configuration scripts for your
4391application, the following lines should suffice to add the appropriate
4392libraries to your link command:
4393
4394### Find Rx, quickthreads and libguile.
4395AC_CHECK_LIB(rx, main)
4396AC_CHECK_LIB(qt, main)
4397AC_CHECK_LIB(guile, scm_shell)
4398
94982a4e
JB
4399The Guile 1.2 distribution does not contain sources for the Rx
4400library, as Guile 1.0 did. If you want to use Rx, you'll need to
4401retrieve it from a GNU FTP site and install it separately.
4402
b83b8bee
JB
4403* Changes to Scheme functions and syntax
4404
e035e7e6
MV
4405** The dynamic linking features of Guile are now enabled by default.
4406You can disable them by giving the `--disable-dynamic-linking' option
4407to configure.
4408
e035e7e6
MV
4409 (dynamic-link FILENAME)
4410
4411 Find the object file denoted by FILENAME (a string) and link it
4412 into the running Guile application. When everything works out,
4413 return a Scheme object suitable for representing the linked object
4414 file. Otherwise an error is thrown. How object files are
4415 searched is system dependent.
4416
4417 (dynamic-object? VAL)
4418
4419 Determine whether VAL represents a dynamically linked object file.
4420
4421 (dynamic-unlink DYNOBJ)
4422
4423 Unlink the indicated object file from the application. DYNOBJ
4424 should be one of the values returned by `dynamic-link'.
4425
4426 (dynamic-func FUNCTION DYNOBJ)
4427
4428 Search the C function indicated by FUNCTION (a string or symbol)
4429 in DYNOBJ and return some Scheme object that can later be used
4430 with `dynamic-call' to actually call this function. Right now,
4431 these Scheme objects are formed by casting the address of the
4432 function to `long' and converting this number to its Scheme
4433 representation.
4434
4435 (dynamic-call FUNCTION DYNOBJ)
4436
4437 Call the C function indicated by FUNCTION and DYNOBJ. The
4438 function is passed no arguments and its return value is ignored.
4439 When FUNCTION is something returned by `dynamic-func', call that
4440 function and ignore DYNOBJ. When FUNCTION is a string (or symbol,
4441 etc.), look it up in DYNOBJ; this is equivalent to
4442
4443 (dynamic-call (dynamic-func FUNCTION DYNOBJ) #f)
4444
4445 Interrupts are deferred while the C function is executing (with
4446 SCM_DEFER_INTS/SCM_ALLOW_INTS).
4447
4448 (dynamic-args-call FUNCTION DYNOBJ ARGS)
4449
4450 Call the C function indicated by FUNCTION and DYNOBJ, but pass it
4451 some arguments and return its return value. The C function is
4452 expected to take two arguments and return an `int', just like
4453 `main':
4454
4455 int c_func (int argc, char **argv);
4456
4457 ARGS must be a list of strings and is converted into an array of
4458 `char *'. The array is passed in ARGV and its size in ARGC. The
4459 return value is converted to a Scheme number and returned from the
4460 call to `dynamic-args-call'.
4461
0fcab5ed
JB
4462When dynamic linking is disabled or not supported on your system,
4463the above functions throw errors, but they are still available.
4464
e035e7e6
MV
4465Here is a small example that works on GNU/Linux:
4466
4467 (define libc-obj (dynamic-link "libc.so"))
4468 (dynamic-args-call 'rand libc-obj '())
4469
4470See the file `libguile/DYNAMIC-LINKING' for additional comments.
4471
27590f82 4472** The #/ syntax for module names is depreciated, and will be removed
6c0201ad 4473in a future version of Guile. Instead of
27590f82
JB
4474
4475 #/foo/bar/baz
4476
4477instead write
4478
4479 (foo bar baz)
4480
4481The latter syntax is more consistent with existing Lisp practice.
4482
5dade857
MV
4483** Guile now does fancier printing of structures. Structures are the
4484underlying implementation for records, which in turn are used to
4485implement modules, so all of these object now print differently and in
4486a more informative way.
4487
161029df
JB
4488The Scheme printer will examine the builtin variable *struct-printer*
4489whenever it needs to print a structure object. When this variable is
4490not `#f' it is deemed to be a procedure and will be applied to the
4491structure object and the output port. When *struct-printer* is `#f'
4492or the procedure return `#f' the structure object will be printed in
4493the boring #<struct 80458270> form.
5dade857
MV
4494
4495This hook is used by some routines in ice-9/boot-9.scm to implement
4496type specific printing routines. Please read the comments there about
4497"printing structs".
4498
4499One of the more specific uses of structs are records. The printing
4500procedure that could be passed to MAKE-RECORD-TYPE is now actually
4501called. It should behave like a *struct-printer* procedure (described
4502above).
4503
b83b8bee
JB
4504** Guile now supports a new R4RS-compliant syntax for keywords. A
4505token of the form #:NAME, where NAME has the same syntax as a Scheme
4506symbol, is the external representation of the keyword named NAME.
4507Keyword objects print using this syntax as well, so values containing
1e5afba0
JB
4508keyword objects can be read back into Guile. When used in an
4509expression, keywords are self-quoting objects.
b83b8bee
JB
4510
4511Guile suports this read syntax, and uses this print syntax, regardless
4512of the current setting of the `keyword' read option. The `keyword'
4513read option only controls whether Guile recognizes the `:NAME' syntax,
4514which is incompatible with R4RS. (R4RS says such token represent
4515symbols.)
737c9113
JB
4516
4517** Guile has regular expression support again. Guile 1.0 included
4518functions for matching regular expressions, based on the Rx library.
4519In Guile 1.1, the Guile/Rx interface was removed to simplify the
4520distribution, and thus Guile had no regular expression support. Guile
94982a4e
JB
45211.2 again supports the most commonly used functions, and supports all
4522of SCSH's regular expression functions.
2409cdfa 4523
94982a4e
JB
4524If your system does not include a POSIX regular expression library,
4525and you have not linked Guile with a third-party regexp library such as
4526Rx, these functions will not be available. You can tell whether your
4527Guile installation includes regular expression support by checking
4528whether the `*features*' list includes the `regex' symbol.
737c9113 4529
94982a4e 4530*** regexp functions
161029df 4531
94982a4e
JB
4532By default, Guile supports POSIX extended regular expressions. That
4533means that the characters `(', `)', `+' and `?' are special, and must
4534be escaped if you wish to match the literal characters.
e1a191a8 4535
94982a4e
JB
4536This regular expression interface was modeled after that implemented
4537by SCSH, the Scheme Shell. It is intended to be upwardly compatible
4538with SCSH regular expressions.
4539
4540**** Function: string-match PATTERN STR [START]
4541 Compile the string PATTERN into a regular expression and compare
4542 it with STR. The optional numeric argument START specifies the
4543 position of STR at which to begin matching.
4544
4545 `string-match' returns a "match structure" which describes what,
4546 if anything, was matched by the regular expression. *Note Match
4547 Structures::. If STR does not match PATTERN at all,
4548 `string-match' returns `#f'.
4549
4550 Each time `string-match' is called, it must compile its PATTERN
4551argument into a regular expression structure. This operation is
4552expensive, which makes `string-match' inefficient if the same regular
4553expression is used several times (for example, in a loop). For better
4554performance, you can compile a regular expression in advance and then
4555match strings against the compiled regexp.
4556
4557**** Function: make-regexp STR [FLAGS]
4558 Compile the regular expression described by STR, and return the
4559 compiled regexp structure. If STR does not describe a legal
4560 regular expression, `make-regexp' throws a
4561 `regular-expression-syntax' error.
4562
4563 FLAGS may be the bitwise-or of one or more of the following:
4564
4565**** Constant: regexp/extended
4566 Use POSIX Extended Regular Expression syntax when interpreting
4567 STR. If not set, POSIX Basic Regular Expression syntax is used.
4568 If the FLAGS argument is omitted, we assume regexp/extended.
4569
4570**** Constant: regexp/icase
4571 Do not differentiate case. Subsequent searches using the
4572 returned regular expression will be case insensitive.
4573
4574**** Constant: regexp/newline
4575 Match-any-character operators don't match a newline.
4576
4577 A non-matching list ([^...]) not containing a newline matches a
4578 newline.
4579
4580 Match-beginning-of-line operator (^) matches the empty string
4581 immediately after a newline, regardless of whether the FLAGS
4582 passed to regexp-exec contain regexp/notbol.
4583
4584 Match-end-of-line operator ($) matches the empty string
4585 immediately before a newline, regardless of whether the FLAGS
4586 passed to regexp-exec contain regexp/noteol.
4587
4588**** Function: regexp-exec REGEXP STR [START [FLAGS]]
4589 Match the compiled regular expression REGEXP against `str'. If
4590 the optional integer START argument is provided, begin matching
4591 from that position in the string. Return a match structure
4592 describing the results of the match, or `#f' if no match could be
4593 found.
4594
4595 FLAGS may be the bitwise-or of one or more of the following:
4596
4597**** Constant: regexp/notbol
4598 The match-beginning-of-line operator always fails to match (but
4599 see the compilation flag regexp/newline above) This flag may be
4600 used when different portions of a string are passed to
4601 regexp-exec and the beginning of the string should not be
4602 interpreted as the beginning of the line.
4603
4604**** Constant: regexp/noteol
4605 The match-end-of-line operator always fails to match (but see the
4606 compilation flag regexp/newline above)
4607
4608**** Function: regexp? OBJ
4609 Return `#t' if OBJ is a compiled regular expression, or `#f'
4610 otherwise.
4611
4612 Regular expressions are commonly used to find patterns in one string
4613and replace them with the contents of another string.
4614
4615**** Function: regexp-substitute PORT MATCH [ITEM...]
4616 Write to the output port PORT selected contents of the match
4617 structure MATCH. Each ITEM specifies what should be written, and
4618 may be one of the following arguments:
4619
4620 * A string. String arguments are written out verbatim.
4621
4622 * An integer. The submatch with that number is written.
4623
4624 * The symbol `pre'. The portion of the matched string preceding
4625 the regexp match is written.
4626
4627 * The symbol `post'. The portion of the matched string
4628 following the regexp match is written.
4629
4630 PORT may be `#f', in which case nothing is written; instead,
4631 `regexp-substitute' constructs a string from the specified ITEMs
4632 and returns that.
4633
4634**** Function: regexp-substitute/global PORT REGEXP TARGET [ITEM...]
4635 Similar to `regexp-substitute', but can be used to perform global
4636 substitutions on STR. Instead of taking a match structure as an
4637 argument, `regexp-substitute/global' takes two string arguments: a
4638 REGEXP string describing a regular expression, and a TARGET string
4639 which should be matched against this regular expression.
4640
4641 Each ITEM behaves as in REGEXP-SUBSTITUTE, with the following
4642 exceptions:
4643
4644 * A function may be supplied. When this function is called, it
4645 will be passed one argument: a match structure for a given
4646 regular expression match. It should return a string to be
4647 written out to PORT.
4648
4649 * The `post' symbol causes `regexp-substitute/global' to recurse
4650 on the unmatched portion of STR. This *must* be supplied in
4651 order to perform global search-and-replace on STR; if it is
4652 not present among the ITEMs, then `regexp-substitute/global'
4653 will return after processing a single match.
4654
4655*** Match Structures
4656
4657 A "match structure" is the object returned by `string-match' and
4658`regexp-exec'. It describes which portion of a string, if any, matched
4659the given regular expression. Match structures include: a reference to
4660the string that was checked for matches; the starting and ending
4661positions of the regexp match; and, if the regexp included any
4662parenthesized subexpressions, the starting and ending positions of each
4663submatch.
4664
4665 In each of the regexp match functions described below, the `match'
4666argument must be a match structure returned by a previous call to
4667`string-match' or `regexp-exec'. Most of these functions return some
4668information about the original target string that was matched against a
4669regular expression; we will call that string TARGET for easy reference.
4670
4671**** Function: regexp-match? OBJ
4672 Return `#t' if OBJ is a match structure returned by a previous
4673 call to `regexp-exec', or `#f' otherwise.
4674
4675**** Function: match:substring MATCH [N]
4676 Return the portion of TARGET matched by subexpression number N.
4677 Submatch 0 (the default) represents the entire regexp match. If
4678 the regular expression as a whole matched, but the subexpression
4679 number N did not match, return `#f'.
4680
4681**** Function: match:start MATCH [N]
4682 Return the starting position of submatch number N.
4683
4684**** Function: match:end MATCH [N]
4685 Return the ending position of submatch number N.
4686
4687**** Function: match:prefix MATCH
4688 Return the unmatched portion of TARGET preceding the regexp match.
4689
4690**** Function: match:suffix MATCH
4691 Return the unmatched portion of TARGET following the regexp match.
4692
4693**** Function: match:count MATCH
4694 Return the number of parenthesized subexpressions from MATCH.
4695 Note that the entire regular expression match itself counts as a
4696 subexpression, and failed submatches are included in the count.
4697
4698**** Function: match:string MATCH
4699 Return the original TARGET string.
4700
4701*** Backslash Escapes
4702
4703 Sometimes you will want a regexp to match characters like `*' or `$'
4704exactly. For example, to check whether a particular string represents
4705a menu entry from an Info node, it would be useful to match it against
4706a regexp like `^* [^:]*::'. However, this won't work; because the
4707asterisk is a metacharacter, it won't match the `*' at the beginning of
4708the string. In this case, we want to make the first asterisk un-magic.
4709
4710 You can do this by preceding the metacharacter with a backslash
4711character `\'. (This is also called "quoting" the metacharacter, and
4712is known as a "backslash escape".) When Guile sees a backslash in a
4713regular expression, it considers the following glyph to be an ordinary
4714character, no matter what special meaning it would ordinarily have.
4715Therefore, we can make the above example work by changing the regexp to
4716`^\* [^:]*::'. The `\*' sequence tells the regular expression engine
4717to match only a single asterisk in the target string.
4718
4719 Since the backslash is itself a metacharacter, you may force a
4720regexp to match a backslash in the target string by preceding the
4721backslash with itself. For example, to find variable references in a
4722TeX program, you might want to find occurrences of the string `\let\'
4723followed by any number of alphabetic characters. The regular expression
4724`\\let\\[A-Za-z]*' would do this: the double backslashes in the regexp
4725each match a single backslash in the target string.
4726
4727**** Function: regexp-quote STR
4728 Quote each special character found in STR with a backslash, and
4729 return the resulting string.
4730
4731 *Very important:* Using backslash escapes in Guile source code (as
4732in Emacs Lisp or C) can be tricky, because the backslash character has
4733special meaning for the Guile reader. For example, if Guile encounters
4734the character sequence `\n' in the middle of a string while processing
4735Scheme code, it replaces those characters with a newline character.
4736Similarly, the character sequence `\t' is replaced by a horizontal tab.
4737Several of these "escape sequences" are processed by the Guile reader
4738before your code is executed. Unrecognized escape sequences are
4739ignored: if the characters `\*' appear in a string, they will be
4740translated to the single character `*'.
4741
4742 This translation is obviously undesirable for regular expressions,
4743since we want to be able to include backslashes in a string in order to
4744escape regexp metacharacters. Therefore, to make sure that a backslash
4745is preserved in a string in your Guile program, you must use *two*
4746consecutive backslashes:
4747
4748 (define Info-menu-entry-pattern (make-regexp "^\\* [^:]*"))
4749
4750 The string in this example is preprocessed by the Guile reader before
4751any code is executed. The resulting argument to `make-regexp' is the
4752string `^\* [^:]*', which is what we really want.
4753
4754 This also means that in order to write a regular expression that
4755matches a single backslash character, the regular expression string in
4756the source code must include *four* backslashes. Each consecutive pair
4757of backslashes gets translated by the Guile reader to a single
4758backslash, and the resulting double-backslash is interpreted by the
4759regexp engine as matching a single backslash character. Hence:
4760
4761 (define tex-variable-pattern (make-regexp "\\\\let\\\\=[A-Za-z]*"))
4762
4763 The reason for the unwieldiness of this syntax is historical. Both
4764regular expression pattern matchers and Unix string processing systems
4765have traditionally used backslashes with the special meanings described
4766above. The POSIX regular expression specification and ANSI C standard
4767both require these semantics. Attempting to abandon either convention
4768would cause other kinds of compatibility problems, possibly more severe
4769ones. Therefore, without extending the Scheme reader to support
4770strings with different quoting conventions (an ungainly and confusing
4771extension when implemented in other languages), we must adhere to this
4772cumbersome escape syntax.
4773
7ad3c1e7
GH
4774* Changes to the gh_ interface
4775
4776* Changes to the scm_ interface
4777
4778* Changes to system call interfaces:
94982a4e 4779
7ad3c1e7 4780** The value returned by `raise' is now unspecified. It throws an exception
e1a191a8
GH
4781if an error occurs.
4782
94982a4e 4783*** A new procedure `sigaction' can be used to install signal handlers
115b09a5
GH
4784
4785(sigaction signum [action] [flags])
4786
4787signum is the signal number, which can be specified using the value
4788of SIGINT etc.
4789
4790If action is omitted, sigaction returns a pair: the CAR is the current
4791signal hander, which will be either an integer with the value SIG_DFL
4792(default action) or SIG_IGN (ignore), or the Scheme procedure which
4793handles the signal, or #f if a non-Scheme procedure handles the
4794signal. The CDR contains the current sigaction flags for the handler.
4795
4796If action is provided, it is installed as the new handler for signum.
4797action can be a Scheme procedure taking one argument, or the value of
4798SIG_DFL (default action) or SIG_IGN (ignore), or #f to restore
4799whatever signal handler was installed before sigaction was first used.
4800Flags can optionally be specified for the new handler (SA_RESTART is
4801always used if the system provides it, so need not be specified.) The
4802return value is a pair with information about the old handler as
4803described above.
4804
4805This interface does not provide access to the "signal blocking"
4806facility. Maybe this is not needed, since the thread support may
4807provide solutions to the problem of consistent access to data
4808structures.
e1a191a8 4809
94982a4e 4810*** A new procedure `flush-all-ports' is equivalent to running
89ea5b7c
GH
4811`force-output' on every port open for output.
4812
94982a4e
JB
4813** Guile now provides information on how it was built, via the new
4814global variable, %guile-build-info. This variable records the values
4815of the standard GNU makefile directory variables as an assocation
4816list, mapping variable names (symbols) onto directory paths (strings).
4817For example, to find out where the Guile link libraries were
4818installed, you can say:
4819
4820guile -c "(display (assq-ref %guile-build-info 'libdir)) (newline)"
4821
4822
4823* Changes to the scm_ interface
4824
4825** The new function scm_handle_by_message_noexit is just like the
4826existing scm_handle_by_message function, except that it doesn't call
4827exit to terminate the process. Instead, it prints a message and just
4828returns #f. This might be a more appropriate catch-all handler for
4829new dynamic roots and threads.
4830
cf78e9e8 4831\f
c484bf7f 4832Changes in Guile 1.1 (released Friday, May 16 1997):
f3b1485f
JB
4833
4834* Changes to the distribution.
4835
4836The Guile 1.0 distribution has been split up into several smaller
4837pieces:
4838guile-core --- the Guile interpreter itself.
4839guile-tcltk --- the interface between the Guile interpreter and
4840 Tcl/Tk; Tcl is an interpreter for a stringy language, and Tk
4841 is a toolkit for building graphical user interfaces.
4842guile-rgx-ctax --- the interface between Guile and the Rx regular
4843 expression matcher, and the translator for the Ctax
4844 programming language. These are packaged together because the
4845 Ctax translator uses Rx to parse Ctax source code.
4846
095936d2
JB
4847This NEWS file describes the changes made to guile-core since the 1.0
4848release.
4849
48d224d7
JB
4850We no longer distribute the documentation, since it was either out of
4851date, or incomplete. As soon as we have current documentation, we
4852will distribute it.
4853
0fcab5ed
JB
4854
4855
f3b1485f
JB
4856* Changes to the stand-alone interpreter
4857
48d224d7
JB
4858** guile now accepts command-line arguments compatible with SCSH, Olin
4859Shivers' Scheme Shell.
4860
4861In general, arguments are evaluated from left to right, but there are
4862exceptions. The following switches stop argument processing, and
4863stash all remaining command-line arguments as the value returned by
4864the (command-line) function.
4865 -s SCRIPT load Scheme source code from FILE, and exit
4866 -c EXPR evalute Scheme expression EXPR, and exit
4867 -- stop scanning arguments; run interactively
4868
4869The switches below are processed as they are encountered.
4870 -l FILE load Scheme source code from FILE
4871 -e FUNCTION after reading script, apply FUNCTION to
4872 command line arguments
4873 -ds do -s script at this point
4874 --emacs enable Emacs protocol (experimental)
4875 -h, --help display this help and exit
4876 -v, --version display version information and exit
4877 \ read arguments from following script lines
4878
4879So, for example, here is a Guile script named `ekko' (thanks, Olin)
4880which re-implements the traditional "echo" command:
4881
4882#!/usr/local/bin/guile -s
4883!#
4884(define (main args)
4885 (map (lambda (arg) (display arg) (display " "))
4886 (cdr args))
4887 (newline))
4888
4889(main (command-line))
4890
4891Suppose we invoke this script as follows:
4892
4893 ekko a speckled gecko
4894
4895Through the magic of Unix script processing (triggered by the `#!'
4896token at the top of the file), /usr/local/bin/guile receives the
4897following list of command-line arguments:
4898
4899 ("-s" "./ekko" "a" "speckled" "gecko")
4900
4901Unix inserts the name of the script after the argument specified on
4902the first line of the file (in this case, "-s"), and then follows that
4903with the arguments given to the script. Guile loads the script, which
4904defines the `main' function, and then applies it to the list of
4905remaining command-line arguments, ("a" "speckled" "gecko").
4906
095936d2
JB
4907In Unix, the first line of a script file must take the following form:
4908
4909#!INTERPRETER ARGUMENT
4910
4911where INTERPRETER is the absolute filename of the interpreter
4912executable, and ARGUMENT is a single command-line argument to pass to
4913the interpreter.
4914
4915You may only pass one argument to the interpreter, and its length is
4916limited. These restrictions can be annoying to work around, so Guile
4917provides a general mechanism (borrowed from, and compatible with,
4918SCSH) for circumventing them.
4919
4920If the ARGUMENT in a Guile script is a single backslash character,
4921`\', Guile will open the script file, parse arguments from its second
4922and subsequent lines, and replace the `\' with them. So, for example,
4923here is another implementation of the `ekko' script:
4924
4925#!/usr/local/bin/guile \
4926-e main -s
4927!#
4928(define (main args)
4929 (for-each (lambda (arg) (display arg) (display " "))
4930 (cdr args))
4931 (newline))
4932
4933If the user invokes this script as follows:
4934
4935 ekko a speckled gecko
4936
4937Unix expands this into
4938
4939 /usr/local/bin/guile \ ekko a speckled gecko
4940
4941When Guile sees the `\' argument, it replaces it with the arguments
4942read from the second line of the script, producing:
4943
4944 /usr/local/bin/guile -e main -s ekko a speckled gecko
4945
4946This tells Guile to load the `ekko' script, and apply the function
4947`main' to the argument list ("a" "speckled" "gecko").
4948
4949Here is how Guile parses the command-line arguments:
4950- Each space character terminates an argument. This means that two
4951 spaces in a row introduce an empty-string argument.
4952- The tab character is not permitted (unless you quote it with the
4953 backslash character, as described below), to avoid confusion.
4954- The newline character terminates the sequence of arguments, and will
4955 also terminate a final non-empty argument. (However, a newline
4956 following a space will not introduce a final empty-string argument;
4957 it only terminates the argument list.)
4958- The backslash character is the escape character. It escapes
4959 backslash, space, tab, and newline. The ANSI C escape sequences
4960 like \n and \t are also supported. These produce argument
4961 constituents; the two-character combination \n doesn't act like a
4962 terminating newline. The escape sequence \NNN for exactly three
4963 octal digits reads as the character whose ASCII code is NNN. As
4964 above, characters produced this way are argument constituents.
4965 Backslash followed by other characters is not allowed.
4966
48d224d7
JB
4967* Changes to the procedure for linking libguile with your programs
4968
4969** Guile now builds and installs a shared guile library, if your
4970system support shared libraries. (It still builds a static library on
4971all systems.) Guile automatically detects whether your system
4972supports shared libraries. To prevent Guile from buildisg shared
4973libraries, pass the `--disable-shared' flag to the configure script.
4974
4975Guile takes longer to compile when it builds shared libraries, because
4976it must compile every file twice --- once to produce position-
4977independent object code, and once to produce normal object code.
4978
4979** The libthreads library has been merged into libguile.
4980
4981To link a program against Guile, you now need only link against
4982-lguile and -lqt; -lthreads is no longer needed. If you are using
4983autoconf to generate configuration scripts for your application, the
4984following lines should suffice to add the appropriate libraries to
4985your link command:
4986
4987### Find quickthreads and libguile.
4988AC_CHECK_LIB(qt, main)
4989AC_CHECK_LIB(guile, scm_shell)
f3b1485f
JB
4990
4991* Changes to Scheme functions
4992
095936d2
JB
4993** Guile Scheme's special syntax for keyword objects is now optional,
4994and disabled by default.
4995
4996The syntax variation from R4RS made it difficult to port some
4997interesting packages to Guile. The routines which accepted keyword
4998arguments (mostly in the module system) have been modified to also
4999accept symbols whose names begin with `:'.
5000
5001To change the keyword syntax, you must first import the (ice-9 debug)
5002module:
5003 (use-modules (ice-9 debug))
5004
5005Then you can enable the keyword syntax as follows:
5006 (read-set! keywords 'prefix)
5007
5008To disable keyword syntax, do this:
5009 (read-set! keywords #f)
5010
5011** Many more primitive functions accept shared substrings as
5012arguments. In the past, these functions required normal, mutable
5013strings as arguments, although they never made use of this
5014restriction.
5015
5016** The uniform array functions now operate on byte vectors. These
5017functions are `array-fill!', `serial-array-copy!', `array-copy!',
5018`serial-array-map', `array-map', `array-for-each', and
5019`array-index-map!'.
5020
5021** The new functions `trace' and `untrace' implement simple debugging
5022support for Scheme functions.
5023
5024The `trace' function accepts any number of procedures as arguments,
5025and tells the Guile interpreter to display each procedure's name and
5026arguments each time the procedure is invoked. When invoked with no
5027arguments, `trace' returns the list of procedures currently being
5028traced.
5029
5030The `untrace' function accepts any number of procedures as arguments,
5031and tells the Guile interpreter not to trace them any more. When
5032invoked with no arguments, `untrace' untraces all curretly traced
5033procedures.
5034
5035The tracing in Guile has an advantage over most other systems: we
5036don't create new procedure objects, but mark the procedure objects
5037themselves. This means that anonymous and internal procedures can be
5038traced.
5039
5040** The function `assert-repl-prompt' has been renamed to
5041`set-repl-prompt!'. It takes one argument, PROMPT.
5042- If PROMPT is #f, the Guile read-eval-print loop will not prompt.
5043- If PROMPT is a string, we use it as a prompt.
5044- If PROMPT is a procedure accepting no arguments, we call it, and
5045 display the result as a prompt.
5046- Otherwise, we display "> ".
5047
5048** The new function `eval-string' reads Scheme expressions from a
5049string and evaluates them, returning the value of the last expression
5050in the string. If the string contains no expressions, it returns an
5051unspecified value.
5052
5053** The new function `thunk?' returns true iff its argument is a
5054procedure of zero arguments.
5055
5056** `defined?' is now a builtin function, instead of syntax. This
5057means that its argument should be quoted. It returns #t iff its
5058argument is bound in the current module.
5059
5060** The new syntax `use-modules' allows you to add new modules to your
5061environment without re-typing a complete `define-module' form. It
5062accepts any number of module names as arguments, and imports their
5063public bindings into the current module.
5064
5065** The new function (module-defined? NAME MODULE) returns true iff
5066NAME, a symbol, is defined in MODULE, a module object.
5067
5068** The new function `builtin-bindings' creates and returns a hash
5069table containing copies of all the root module's bindings.
5070
5071** The new function `builtin-weak-bindings' does the same as
5072`builtin-bindings', but creates a doubly-weak hash table.
5073
5074** The `equal?' function now considers variable objects to be
5075equivalent if they have the same name and the same value.
5076
5077** The new function `command-line' returns the command-line arguments
5078given to Guile, as a list of strings.
5079
5080When using guile as a script interpreter, `command-line' returns the
5081script's arguments; those processed by the interpreter (like `-s' or
5082`-c') are omitted. (In other words, you get the normal, expected
5083behavior.) Any application that uses scm_shell to process its
5084command-line arguments gets this behavior as well.
5085
5086** The new function `load-user-init' looks for a file called `.guile'
5087in the user's home directory, and loads it if it exists. This is
5088mostly for use by the code generated by scm_compile_shell_switches,
5089but we thought it might also be useful in other circumstances.
5090
5091** The new function `log10' returns the base-10 logarithm of its
5092argument.
5093
5094** Changes to I/O functions
5095
6c0201ad 5096*** The functions `read', `primitive-load', `read-and-eval!', and
095936d2
JB
5097`primitive-load-path' no longer take optional arguments controlling
5098case insensitivity and a `#' parser.
5099
5100Case sensitivity is now controlled by a read option called
5101`case-insensitive'. The user can add new `#' syntaxes with the
5102`read-hash-extend' function (see below).
5103
5104*** The new function `read-hash-extend' allows the user to change the
5105syntax of Guile Scheme in a somewhat controlled way.
5106
5107(read-hash-extend CHAR PROC)
5108 When parsing S-expressions, if we read a `#' character followed by
5109 the character CHAR, use PROC to parse an object from the stream.
5110 If PROC is #f, remove any parsing procedure registered for CHAR.
5111
5112 The reader applies PROC to two arguments: CHAR and an input port.
5113
6c0201ad 5114*** The new functions read-delimited and read-delimited! provide a
095936d2
JB
5115general mechanism for doing delimited input on streams.
5116
5117(read-delimited DELIMS [PORT HANDLE-DELIM])
5118 Read until we encounter one of the characters in DELIMS (a string),
5119 or end-of-file. PORT is the input port to read from; it defaults to
5120 the current input port. The HANDLE-DELIM parameter determines how
5121 the terminating character is handled; it should be one of the
5122 following symbols:
5123
5124 'trim omit delimiter from result
5125 'peek leave delimiter character in input stream
5126 'concat append delimiter character to returned value
5127 'split return a pair: (RESULT . TERMINATOR)
5128
5129 HANDLE-DELIM defaults to 'peek.
5130
5131(read-delimited! DELIMS BUF [PORT HANDLE-DELIM START END])
5132 A side-effecting variant of `read-delimited'.
5133
5134 The data is written into the string BUF at the indices in the
5135 half-open interval [START, END); the default interval is the whole
5136 string: START = 0 and END = (string-length BUF). The values of
5137 START and END must specify a well-defined interval in BUF, i.e.
5138 0 <= START <= END <= (string-length BUF).
5139
5140 It returns NBYTES, the number of bytes read. If the buffer filled
5141 up without a delimiter character being found, it returns #f. If the
5142 port is at EOF when the read starts, it returns the EOF object.
5143
5144 If an integer is returned (i.e., the read is successfully terminated
5145 by reading a delimiter character), then the HANDLE-DELIM parameter
5146 determines how to handle the terminating character. It is described
5147 above, and defaults to 'peek.
5148
5149(The descriptions of these functions were borrowed from the SCSH
5150manual, by Olin Shivers and Brian Carlstrom.)
5151
5152*** The `%read-delimited!' function is the primitive used to implement
5153`read-delimited' and `read-delimited!'.
5154
5155(%read-delimited! DELIMS BUF GOBBLE? [PORT START END])
5156
5157This returns a pair of values: (TERMINATOR . NUM-READ).
5158- TERMINATOR describes why the read was terminated. If it is a
5159 character or the eof object, then that is the value that terminated
5160 the read. If it is #f, the function filled the buffer without finding
5161 a delimiting character.
5162- NUM-READ is the number of characters read into BUF.
5163
5164If the read is successfully terminated by reading a delimiter
5165character, then the gobble? parameter determines what to do with the
5166terminating character. If true, the character is removed from the
5167input stream; if false, the character is left in the input stream
5168where a subsequent read operation will retrieve it. In either case,
5169the character is also the first value returned by the procedure call.
5170
5171(The descriptions of this function was borrowed from the SCSH manual,
5172by Olin Shivers and Brian Carlstrom.)
5173
5174*** The `read-line' and `read-line!' functions have changed; they now
5175trim the terminator by default; previously they appended it to the
5176returned string. For the old behavior, use (read-line PORT 'concat).
5177
5178*** The functions `uniform-array-read!' and `uniform-array-write!' now
5179take new optional START and END arguments, specifying the region of
5180the array to read and write.
5181
f348c807
JB
5182*** The `ungetc-char-ready?' function has been removed. We feel it's
5183inappropriate for an interface to expose implementation details this
5184way.
095936d2
JB
5185
5186** Changes to the Unix library and system call interface
5187
5188*** The new fcntl function provides access to the Unix `fcntl' system
5189call.
5190
5191(fcntl PORT COMMAND VALUE)
5192 Apply COMMAND to PORT's file descriptor, with VALUE as an argument.
5193 Values for COMMAND are:
5194
5195 F_DUPFD duplicate a file descriptor
5196 F_GETFD read the descriptor's close-on-exec flag
5197 F_SETFD set the descriptor's close-on-exec flag to VALUE
5198 F_GETFL read the descriptor's flags, as set on open
5199 F_SETFL set the descriptor's flags, as set on open to VALUE
5200 F_GETOWN return the process ID of a socket's owner, for SIGIO
5201 F_SETOWN set the process that owns a socket to VALUE, for SIGIO
5202 FD_CLOEXEC not sure what this is
5203
5204For details, see the documentation for the fcntl system call.
5205
5206*** The arguments to `select' have changed, for compatibility with
5207SCSH. The TIMEOUT parameter may now be non-integral, yielding the
5208expected behavior. The MILLISECONDS parameter has been changed to
5209MICROSECONDS, to more closely resemble the underlying system call.
5210The RVEC, WVEC, and EVEC arguments can now be vectors; the type of the
5211corresponding return set will be the same.
5212
5213*** The arguments to the `mknod' system call have changed. They are
5214now:
5215
5216(mknod PATH TYPE PERMS DEV)
5217 Create a new file (`node') in the file system. PATH is the name of
5218 the file to create. TYPE is the kind of file to create; it should
5219 be 'fifo, 'block-special, or 'char-special. PERMS specifies the
5220 permission bits to give the newly created file. If TYPE is
5221 'block-special or 'char-special, DEV specifies which device the
5222 special file refers to; its interpretation depends on the kind of
5223 special file being created.
5224
5225*** The `fork' function has been renamed to `primitive-fork', to avoid
5226clashing with various SCSH forks.
5227
5228*** The `recv' and `recvfrom' functions have been renamed to `recv!'
5229and `recvfrom!'. They no longer accept a size for a second argument;
5230you must pass a string to hold the received value. They no longer
5231return the buffer. Instead, `recv' returns the length of the message
5232received, and `recvfrom' returns a pair containing the packet's length
6c0201ad 5233and originating address.
095936d2
JB
5234
5235*** The file descriptor datatype has been removed, as have the
5236`read-fd', `write-fd', `close', `lseek', and `dup' functions.
5237We plan to replace these functions with a SCSH-compatible interface.
5238
5239*** The `create' function has been removed; it's just a special case
5240of `open'.
5241
5242*** There are new functions to break down process termination status
5243values. In the descriptions below, STATUS is a value returned by
5244`waitpid'.
5245
5246(status:exit-val STATUS)
5247 If the child process exited normally, this function returns the exit
5248 code for the child process (i.e., the value passed to exit, or
5249 returned from main). If the child process did not exit normally,
5250 this function returns #f.
5251
5252(status:stop-sig STATUS)
5253 If the child process was suspended by a signal, this function
5254 returns the signal that suspended the child. Otherwise, it returns
5255 #f.
5256
5257(status:term-sig STATUS)
5258 If the child process terminated abnormally, this function returns
5259 the signal that terminated the child. Otherwise, this function
5260 returns false.
5261
5262POSIX promises that exactly one of these functions will return true on
5263a valid STATUS value.
5264
5265These functions are compatible with SCSH.
5266
5267*** There are new accessors and setters for the broken-out time vectors
48d224d7
JB
5268returned by `localtime', `gmtime', and that ilk. They are:
5269
5270 Component Accessor Setter
5271 ========================= ============ ============
5272 seconds tm:sec set-tm:sec
5273 minutes tm:min set-tm:min
5274 hours tm:hour set-tm:hour
5275 day of the month tm:mday set-tm:mday
5276 month tm:mon set-tm:mon
5277 year tm:year set-tm:year
5278 day of the week tm:wday set-tm:wday
5279 day in the year tm:yday set-tm:yday
5280 daylight saving time tm:isdst set-tm:isdst
5281 GMT offset, seconds tm:gmtoff set-tm:gmtoff
5282 name of time zone tm:zone set-tm:zone
5283
095936d2
JB
5284*** There are new accessors for the vectors returned by `uname',
5285describing the host system:
48d224d7
JB
5286
5287 Component Accessor
5288 ============================================== ================
5289 name of the operating system implementation utsname:sysname
5290 network name of this machine utsname:nodename
5291 release level of the operating system utsname:release
5292 version level of the operating system utsname:version
5293 machine hardware platform utsname:machine
5294
095936d2
JB
5295*** There are new accessors for the vectors returned by `getpw',
5296`getpwnam', `getpwuid', and `getpwent', describing entries from the
5297system's user database:
5298
5299 Component Accessor
5300 ====================== =================
5301 user name passwd:name
5302 user password passwd:passwd
5303 user id passwd:uid
5304 group id passwd:gid
5305 real name passwd:gecos
5306 home directory passwd:dir
5307 shell program passwd:shell
5308
5309*** There are new accessors for the vectors returned by `getgr',
5310`getgrnam', `getgrgid', and `getgrent', describing entries from the
5311system's group database:
5312
5313 Component Accessor
5314 ======================= ============
5315 group name group:name
5316 group password group:passwd
5317 group id group:gid
5318 group members group:mem
5319
5320*** There are new accessors for the vectors returned by `gethost',
5321`gethostbyaddr', `gethostbyname', and `gethostent', describing
5322internet hosts:
5323
5324 Component Accessor
5325 ========================= ===============
5326 official name of host hostent:name
5327 alias list hostent:aliases
5328 host address type hostent:addrtype
5329 length of address hostent:length
5330 list of addresses hostent:addr-list
5331
5332*** There are new accessors for the vectors returned by `getnet',
5333`getnetbyaddr', `getnetbyname', and `getnetent', describing internet
5334networks:
5335
5336 Component Accessor
5337 ========================= ===============
5338 official name of net netent:name
5339 alias list netent:aliases
5340 net number type netent:addrtype
5341 net number netent:net
5342
5343*** There are new accessors for the vectors returned by `getproto',
5344`getprotobyname', `getprotobynumber', and `getprotoent', describing
5345internet protocols:
5346
5347 Component Accessor
5348 ========================= ===============
5349 official protocol name protoent:name
5350 alias list protoent:aliases
5351 protocol number protoent:proto
5352
5353*** There are new accessors for the vectors returned by `getserv',
5354`getservbyname', `getservbyport', and `getservent', describing
5355internet protocols:
5356
5357 Component Accessor
5358 ========================= ===============
6c0201ad 5359 official service name servent:name
095936d2 5360 alias list servent:aliases
6c0201ad
TTN
5361 port number servent:port
5362 protocol to use servent:proto
095936d2
JB
5363
5364*** There are new accessors for the sockaddr structures returned by
5365`accept', `getsockname', `getpeername', `recvfrom!':
5366
5367 Component Accessor
5368 ======================================== ===============
6c0201ad 5369 address format (`family') sockaddr:fam
095936d2
JB
5370 path, for file domain addresses sockaddr:path
5371 address, for internet domain addresses sockaddr:addr
5372 TCP or UDP port, for internet sockaddr:port
5373
5374*** The `getpwent', `getgrent', `gethostent', `getnetent',
5375`getprotoent', and `getservent' functions now return #f at the end of
5376the user database. (They used to throw an exception.)
5377
5378Note that calling MUMBLEent function is equivalent to calling the
5379corresponding MUMBLE function with no arguments.
5380
5381*** The `setpwent', `setgrent', `sethostent', `setnetent',
5382`setprotoent', and `setservent' routines now take no arguments.
5383
5384*** The `gethost', `getproto', `getnet', and `getserv' functions now
5385provide more useful information when they throw an exception.
5386
5387*** The `lnaof' function has been renamed to `inet-lnaof'.
5388
5389*** Guile now claims to have the `current-time' feature.
5390
5391*** The `mktime' function now takes an optional second argument ZONE,
5392giving the time zone to use for the conversion. ZONE should be a
5393string, in the same format as expected for the "TZ" environment variable.
5394
5395*** The `strptime' function now returns a pair (TIME . COUNT), where
5396TIME is the parsed time as a vector, and COUNT is the number of
5397characters from the string left unparsed. This function used to
5398return the remaining characters as a string.
5399
5400*** The `gettimeofday' function has replaced the old `time+ticks' function.
5401The return value is now (SECONDS . MICROSECONDS); the fractional
5402component is no longer expressed in "ticks".
5403
5404*** The `ticks/sec' constant has been removed, in light of the above change.
6685dc83 5405
ea00ecba
MG
5406* Changes to the gh_ interface
5407
5408** gh_eval_str() now returns an SCM object which is the result of the
5409evaluation
5410
aaef0d2a
MG
5411** gh_scm2str() now copies the Scheme data to a caller-provided C
5412array
5413
5414** gh_scm2newstr() now makes a C array, copies the Scheme data to it,
5415and returns the array
5416
5417** gh_scm2str0() is gone: there is no need to distinguish
5418null-terminated from non-null-terminated, since gh_scm2newstr() allows
5419the user to interpret the data both ways.
5420
f3b1485f
JB
5421* Changes to the scm_ interface
5422
095936d2
JB
5423** The new function scm_symbol_value0 provides an easy way to get a
5424symbol's value from C code:
5425
5426SCM scm_symbol_value0 (char *NAME)
5427 Return the value of the symbol named by the null-terminated string
5428 NAME in the current module. If the symbol named NAME is unbound in
5429 the current module, return SCM_UNDEFINED.
5430
5431** The new function scm_sysintern0 creates new top-level variables,
5432without assigning them a value.
5433
5434SCM scm_sysintern0 (char *NAME)
5435 Create a new Scheme top-level variable named NAME. NAME is a
5436 null-terminated string. Return the variable's value cell.
5437
5438** The function scm_internal_catch is the guts of catch. It handles
5439all the mechanics of setting up a catch target, invoking the catch
5440body, and perhaps invoking the handler if the body does a throw.
5441
5442The function is designed to be usable from C code, but is general
5443enough to implement all the semantics Guile Scheme expects from throw.
5444
5445TAG is the catch tag. Typically, this is a symbol, but this function
5446doesn't actually care about that.
5447
5448BODY is a pointer to a C function which runs the body of the catch;
5449this is the code you can throw from. We call it like this:
5450 BODY (BODY_DATA, JMPBUF)
5451where:
5452 BODY_DATA is just the BODY_DATA argument we received; we pass it
5453 through to BODY as its first argument. The caller can make
5454 BODY_DATA point to anything useful that BODY might need.
5455 JMPBUF is the Scheme jmpbuf object corresponding to this catch,
5456 which we have just created and initialized.
5457
5458HANDLER is a pointer to a C function to deal with a throw to TAG,
5459should one occur. We call it like this:
5460 HANDLER (HANDLER_DATA, THROWN_TAG, THROW_ARGS)
5461where
5462 HANDLER_DATA is the HANDLER_DATA argument we recevied; it's the
5463 same idea as BODY_DATA above.
5464 THROWN_TAG is the tag that the user threw to; usually this is
5465 TAG, but it could be something else if TAG was #t (i.e., a
5466 catch-all), or the user threw to a jmpbuf.
5467 THROW_ARGS is the list of arguments the user passed to the THROW
5468 function.
5469
5470BODY_DATA is just a pointer we pass through to BODY. HANDLER_DATA
5471is just a pointer we pass through to HANDLER. We don't actually
5472use either of those pointers otherwise ourselves. The idea is
5473that, if our caller wants to communicate something to BODY or
5474HANDLER, it can pass a pointer to it as MUMBLE_DATA, which BODY and
5475HANDLER can then use. Think of it as a way to make BODY and
5476HANDLER closures, not just functions; MUMBLE_DATA points to the
5477enclosed variables.
5478
5479Of course, it's up to the caller to make sure that any data a
5480MUMBLE_DATA needs is protected from GC. A common way to do this is
5481to make MUMBLE_DATA a pointer to data stored in an automatic
5482structure variable; since the collector must scan the stack for
5483references anyway, this assures that any references in MUMBLE_DATA
5484will be found.
5485
5486** The new function scm_internal_lazy_catch is exactly like
5487scm_internal_catch, except:
5488
5489- It does not unwind the stack (this is the major difference).
5490- If handler returns, its value is returned from the throw.
5491- BODY always receives #f as its JMPBUF argument (since there's no
5492 jmpbuf associated with a lazy catch, because we don't unwind the
5493 stack.)
5494
5495** scm_body_thunk is a new body function you can pass to
5496scm_internal_catch if you want the body to be like Scheme's `catch'
5497--- a thunk, or a function of one argument if the tag is #f.
5498
5499BODY_DATA is a pointer to a scm_body_thunk_data structure, which
5500contains the Scheme procedure to invoke as the body, and the tag
5501we're catching. If the tag is #f, then we pass JMPBUF (created by
5502scm_internal_catch) to the body procedure; otherwise, the body gets
5503no arguments.
5504
5505** scm_handle_by_proc is a new handler function you can pass to
5506scm_internal_catch if you want the handler to act like Scheme's catch
5507--- call a procedure with the tag and the throw arguments.
5508
5509If the user does a throw to this catch, this function runs a handler
5510procedure written in Scheme. HANDLER_DATA is a pointer to an SCM
5511variable holding the Scheme procedure object to invoke. It ought to
5512be a pointer to an automatic variable (i.e., one living on the stack),
5513or the procedure object should be otherwise protected from GC.
5514
5515** scm_handle_by_message is a new handler function to use with
5516`scm_internal_catch' if you want Guile to print a message and die.
5517It's useful for dealing with throws to uncaught keys at the top level.
5518
5519HANDLER_DATA, if non-zero, is assumed to be a char * pointing to a
5520message header to print; if zero, we use "guile" instead. That
5521text is followed by a colon, then the message described by ARGS.
5522
5523** The return type of scm_boot_guile is now void; the function does
5524not return a value, and indeed, never returns at all.
5525
f3b1485f
JB
5526** The new function scm_shell makes it easy for user applications to
5527process command-line arguments in a way that is compatible with the
5528stand-alone guile interpreter (which is in turn compatible with SCSH,
5529the Scheme shell).
5530
5531To use the scm_shell function, first initialize any guile modules
5532linked into your application, and then call scm_shell with the values
7ed46dc8 5533of ARGC and ARGV your `main' function received. scm_shell will add
f3b1485f
JB
5534any SCSH-style meta-arguments from the top of the script file to the
5535argument vector, and then process the command-line arguments. This
5536generally means loading a script file or starting up an interactive
5537command interpreter. For details, see "Changes to the stand-alone
5538interpreter" above.
5539
095936d2 5540** The new functions scm_get_meta_args and scm_count_argv help you
6c0201ad 5541implement the SCSH-style meta-argument, `\'.
095936d2
JB
5542
5543char **scm_get_meta_args (int ARGC, char **ARGV)
5544 If the second element of ARGV is a string consisting of a single
5545 backslash character (i.e. "\\" in Scheme notation), open the file
5546 named by the following argument, parse arguments from it, and return
5547 the spliced command line. The returned array is terminated by a
5548 null pointer.
6c0201ad 5549
095936d2
JB
5550 For details of argument parsing, see above, under "guile now accepts
5551 command-line arguments compatible with SCSH..."
5552
5553int scm_count_argv (char **ARGV)
5554 Count the arguments in ARGV, assuming it is terminated by a null
5555 pointer.
5556
5557For an example of how these functions might be used, see the source
5558code for the function scm_shell in libguile/script.c.
5559
5560You will usually want to use scm_shell instead of calling this
5561function yourself.
5562
5563** The new function scm_compile_shell_switches turns an array of
5564command-line arguments into Scheme code to carry out the actions they
5565describe. Given ARGC and ARGV, it returns a Scheme expression to
5566evaluate, and calls scm_set_program_arguments to make any remaining
5567command-line arguments available to the Scheme code. For example,
5568given the following arguments:
5569
5570 -e main -s ekko a speckled gecko
5571
5572scm_set_program_arguments will return the following expression:
5573
5574 (begin (load "ekko") (main (command-line)) (quit))
5575
5576You will usually want to use scm_shell instead of calling this
5577function yourself.
5578
5579** The function scm_shell_usage prints a usage message appropriate for
5580an interpreter that uses scm_compile_shell_switches to handle its
5581command-line arguments.
5582
5583void scm_shell_usage (int FATAL, char *MESSAGE)
5584 Print a usage message to the standard error output. If MESSAGE is
5585 non-zero, write it before the usage message, followed by a newline.
5586 If FATAL is non-zero, exit the process, using FATAL as the
5587 termination status. (If you want to be compatible with Guile,
5588 always use 1 as the exit status when terminating due to command-line
5589 usage problems.)
5590
5591You will usually want to use scm_shell instead of calling this
5592function yourself.
48d224d7
JB
5593
5594** scm_eval_0str now returns SCM_UNSPECIFIED if the string contains no
095936d2
JB
5595expressions. It used to return SCM_EOL. Earth-shattering.
5596
5597** The macros for declaring scheme objects in C code have been
5598rearranged slightly. They are now:
5599
5600SCM_SYMBOL (C_NAME, SCHEME_NAME)
5601 Declare a static SCM variable named C_NAME, and initialize it to
5602 point to the Scheme symbol whose name is SCHEME_NAME. C_NAME should
5603 be a C identifier, and SCHEME_NAME should be a C string.
5604
5605SCM_GLOBAL_SYMBOL (C_NAME, SCHEME_NAME)
5606 Just like SCM_SYMBOL, but make C_NAME globally visible.
5607
5608SCM_VCELL (C_NAME, SCHEME_NAME)
5609 Create a global variable at the Scheme level named SCHEME_NAME.
5610 Declare a static SCM variable named C_NAME, and initialize it to
5611 point to the Scheme variable's value cell.
5612
5613SCM_GLOBAL_VCELL (C_NAME, SCHEME_NAME)
5614 Just like SCM_VCELL, but make C_NAME globally visible.
5615
5616The `guile-snarf' script writes initialization code for these macros
5617to its standard output, given C source code as input.
5618
5619The SCM_GLOBAL macro is gone.
5620
5621** The scm_read_line and scm_read_line_x functions have been replaced
5622by Scheme code based on the %read-delimited! procedure (known to C
5623code as scm_read_delimited_x). See its description above for more
5624information.
48d224d7 5625
095936d2
JB
5626** The function scm_sys_open has been renamed to scm_open. It now
5627returns a port instead of an FD object.
ea00ecba 5628
095936d2
JB
5629* The dynamic linking support has changed. For more information, see
5630libguile/DYNAMIC-LINKING.
ea00ecba 5631
f7b47737
JB
5632\f
5633Guile 1.0b3
3065a62a 5634
f3b1485f
JB
5635User-visible changes from Thursday, September 5, 1996 until Guile 1.0
5636(Sun 5 Jan 1997):
3065a62a 5637
4b521edb 5638* Changes to the 'guile' program:
3065a62a 5639
4b521edb
JB
5640** Guile now loads some new files when it starts up. Guile first
5641searches the load path for init.scm, and loads it if found. Then, if
5642Guile is not being used to execute a script, and the user's home
5643directory contains a file named `.guile', Guile loads that.
c6486f8a 5644
4b521edb 5645** You can now use Guile as a shell script interpreter.
3065a62a
JB
5646
5647To paraphrase the SCSH manual:
5648
5649 When Unix tries to execute an executable file whose first two
5650 characters are the `#!', it treats the file not as machine code to
5651 be directly executed by the native processor, but as source code
5652 to be executed by some interpreter. The interpreter to use is
5653 specified immediately after the #! sequence on the first line of
5654 the source file. The kernel reads in the name of the interpreter,
5655 and executes that instead. It passes the interpreter the source
5656 filename as its first argument, with the original arguments
5657 following. Consult the Unix man page for the `exec' system call
5658 for more information.
5659
1a1945be
JB
5660Now you can use Guile as an interpreter, using a mechanism which is a
5661compatible subset of that provided by SCSH.
5662
3065a62a
JB
5663Guile now recognizes a '-s' command line switch, whose argument is the
5664name of a file of Scheme code to load. It also treats the two
5665characters `#!' as the start of a comment, terminated by `!#'. Thus,
5666to make a file of Scheme code directly executable by Unix, insert the
5667following two lines at the top of the file:
5668
5669#!/usr/local/bin/guile -s
5670!#
5671
5672Guile treats the argument of the `-s' command-line switch as the name
5673of a file of Scheme code to load, and treats the sequence `#!' as the
5674start of a block comment, terminated by `!#'.
5675
5676For example, here's a version of 'echo' written in Scheme:
5677
5678#!/usr/local/bin/guile -s
5679!#
5680(let loop ((args (cdr (program-arguments))))
5681 (if (pair? args)
5682 (begin
5683 (display (car args))
5684 (if (pair? (cdr args))
5685 (display " "))
5686 (loop (cdr args)))))
5687(newline)
5688
5689Why does `#!' start a block comment terminated by `!#', instead of the
5690end of the line? That is the notation SCSH uses, and although we
5691don't yet support the other SCSH features that motivate that choice,
5692we would like to be backward-compatible with any existing Guile
3763761c
JB
5693scripts once we do. Furthermore, if the path to Guile on your system
5694is too long for your kernel, you can start the script with this
5695horrible hack:
5696
5697#!/bin/sh
5698exec /really/long/path/to/guile -s "$0" ${1+"$@"}
5699!#
3065a62a
JB
5700
5701Note that some very old Unix systems don't support the `#!' syntax.
5702
c6486f8a 5703
4b521edb 5704** You can now run Guile without installing it.
6685dc83
JB
5705
5706Previous versions of the interactive Guile interpreter (`guile')
5707couldn't start up unless Guile's Scheme library had been installed;
5708they used the value of the environment variable `SCHEME_LOAD_PATH'
5709later on in the startup process, but not to find the startup code
5710itself. Now Guile uses `SCHEME_LOAD_PATH' in all searches for Scheme
5711code.
5712
5713To run Guile without installing it, build it in the normal way, and
5714then set the environment variable `SCHEME_LOAD_PATH' to a
5715colon-separated list of directories, including the top-level directory
5716of the Guile sources. For example, if you unpacked Guile so that the
5717full filename of this NEWS file is /home/jimb/guile-1.0b3/NEWS, then
5718you might say
5719
5720 export SCHEME_LOAD_PATH=/home/jimb/my-scheme:/home/jimb/guile-1.0b3
5721
c6486f8a 5722
4b521edb
JB
5723** Guile's read-eval-print loop no longer prints #<unspecified>
5724results. If the user wants to see this, she can evaluate the
5725expression (assert-repl-print-unspecified #t), perhaps in her startup
48d224d7 5726file.
6685dc83 5727
4b521edb
JB
5728** Guile no longer shows backtraces by default when an error occurs;
5729however, it does display a message saying how to get one, and how to
5730request that they be displayed by default. After an error, evaluate
5731 (backtrace)
5732to see a backtrace, and
5733 (debug-enable 'backtrace)
5734to see them by default.
6685dc83 5735
6685dc83 5736
d9fb83d9 5737
4b521edb
JB
5738* Changes to Guile Scheme:
5739
5740** Guile now distinguishes between #f and the empty list.
5741
5742This is for compatibility with the IEEE standard, the (possibly)
5743upcoming Revised^5 Report on Scheme, and many extant Scheme
5744implementations.
5745
5746Guile used to have #f and '() denote the same object, to make Scheme's
5747type system more compatible with Emacs Lisp's. However, the change
5748caused too much trouble for Scheme programmers, and we found another
5749way to reconcile Emacs Lisp with Scheme that didn't require this.
5750
5751
5752** Guile's delq, delv, delete functions, and their destructive
c6486f8a
JB
5753counterparts, delq!, delv!, and delete!, now remove all matching
5754elements from the list, not just the first. This matches the behavior
5755of the corresponding Emacs Lisp functions, and (I believe) the Maclisp
5756functions which inspired them.
5757
5758I recognize that this change may break code in subtle ways, but it
5759seems best to make the change before the FSF's first Guile release,
5760rather than after.
5761
5762
4b521edb 5763** The compiled-library-path function has been deleted from libguile.
6685dc83 5764
4b521edb 5765** The facilities for loading Scheme source files have changed.
c6486f8a 5766
4b521edb 5767*** The variable %load-path now tells Guile which directories to search
6685dc83
JB
5768for Scheme code. Its value is a list of strings, each of which names
5769a directory.
5770
4b521edb
JB
5771*** The variable %load-extensions now tells Guile which extensions to
5772try appending to a filename when searching the load path. Its value
5773is a list of strings. Its default value is ("" ".scm").
5774
5775*** (%search-load-path FILENAME) searches the directories listed in the
5776value of the %load-path variable for a Scheme file named FILENAME,
5777with all the extensions listed in %load-extensions. If it finds a
5778match, then it returns its full filename. If FILENAME is absolute, it
5779returns it unchanged. Otherwise, it returns #f.
6685dc83 5780
4b521edb
JB
5781%search-load-path will not return matches that refer to directories.
5782
5783*** (primitive-load FILENAME :optional CASE-INSENSITIVE-P SHARP)
5784uses %seach-load-path to find a file named FILENAME, and loads it if
5785it finds it. If it can't read FILENAME for any reason, it throws an
5786error.
6685dc83
JB
5787
5788The arguments CASE-INSENSITIVE-P and SHARP are interpreted as by the
4b521edb
JB
5789`read' function.
5790
5791*** load uses the same searching semantics as primitive-load.
5792
5793*** The functions %try-load, try-load-with-path, %load, load-with-path,
5794basic-try-load-with-path, basic-load-with-path, try-load-module-with-
5795path, and load-module-with-path have been deleted. The functions
5796above should serve their purposes.
5797
5798*** If the value of the variable %load-hook is a procedure,
5799`primitive-load' applies its value to the name of the file being
5800loaded (without the load path directory name prepended). If its value
5801is #f, it is ignored. Otherwise, an error occurs.
5802
5803This is mostly useful for printing load notification messages.
5804
5805
5806** The function `eval!' is no longer accessible from the scheme level.
5807We can't allow operations which introduce glocs into the scheme level,
5808because Guile's type system can't handle these as data. Use `eval' or
5809`read-and-eval!' (see below) as replacement.
5810
5811** The new function read-and-eval! reads an expression from PORT,
5812evaluates it, and returns the result. This is more efficient than
5813simply calling `read' and `eval', since it is not necessary to make a
5814copy of the expression for the evaluator to munge.
5815
5816Its optional arguments CASE_INSENSITIVE_P and SHARP are interpreted as
5817for the `read' function.
5818
5819
5820** The function `int?' has been removed; its definition was identical
5821to that of `integer?'.
5822
5823** The functions `<?', `<?', `<=?', `=?', `>?', and `>=?'. Code should
5824use the R4RS names for these functions.
5825
5826** The function object-properties no longer returns the hash handle;
5827it simply returns the object's property list.
5828
5829** Many functions have been changed to throw errors, instead of
5830returning #f on failure. The point of providing exception handling in
5831the language is to simplify the logic of user code, but this is less
5832useful if Guile's primitives don't throw exceptions.
5833
5834** The function `fileno' has been renamed from `%fileno'.
5835
5836** The function primitive-mode->fdes returns #t or #f now, not 1 or 0.
5837
5838
5839* Changes to Guile's C interface:
5840
5841** The library's initialization procedure has been simplified.
5842scm_boot_guile now has the prototype:
5843
5844void scm_boot_guile (int ARGC,
5845 char **ARGV,
5846 void (*main_func) (),
5847 void *closure);
5848
5849scm_boot_guile calls MAIN_FUNC, passing it CLOSURE, ARGC, and ARGV.
5850MAIN_FUNC should do all the work of the program (initializing other
5851packages, reading user input, etc.) before returning. When MAIN_FUNC
5852returns, call exit (0); this function never returns. If you want some
5853other exit value, MAIN_FUNC may call exit itself.
5854
5855scm_boot_guile arranges for program-arguments to return the strings
5856given by ARGC and ARGV. If MAIN_FUNC modifies ARGC/ARGV, should call
5857scm_set_program_arguments with the final list, so Scheme code will
5858know which arguments have been processed.
5859
5860scm_boot_guile establishes a catch-all catch handler which prints an
5861error message and exits the process. This means that Guile exits in a
5862coherent way when system errors occur and the user isn't prepared to
5863handle it. If the user doesn't like this behavior, they can establish
5864their own universal catcher in MAIN_FUNC to shadow this one.
5865
5866Why must the caller do all the real work from MAIN_FUNC? The garbage
5867collector assumes that all local variables of type SCM will be above
5868scm_boot_guile's stack frame on the stack. If you try to manipulate
5869SCM values after this function returns, it's the luck of the draw
5870whether the GC will be able to find the objects you allocate. So,
5871scm_boot_guile function exits, rather than returning, to discourage
5872people from making that mistake.
5873
5874The IN, OUT, and ERR arguments were removed; there are other
5875convenient ways to override these when desired.
5876
5877The RESULT argument was deleted; this function should never return.
5878
5879The BOOT_CMD argument was deleted; the MAIN_FUNC argument is more
5880general.
5881
5882
5883** Guile's header files should no longer conflict with your system's
5884header files.
5885
5886In order to compile code which #included <libguile.h>, previous
5887versions of Guile required you to add a directory containing all the
5888Guile header files to your #include path. This was a problem, since
5889Guile's header files have names which conflict with many systems'
5890header files.
5891
5892Now only <libguile.h> need appear in your #include path; you must
5893refer to all Guile's other header files as <libguile/mumble.h>.
5894Guile's installation procedure puts libguile.h in $(includedir), and
5895the rest in $(includedir)/libguile.
5896
5897
5898** Two new C functions, scm_protect_object and scm_unprotect_object,
5899have been added to the Guile library.
5900
5901scm_protect_object (OBJ) protects OBJ from the garbage collector.
5902OBJ will not be freed, even if all other references are dropped,
5903until someone does scm_unprotect_object (OBJ). Both functions
5904return OBJ.
5905
5906Note that calls to scm_protect_object do not nest. You can call
5907scm_protect_object any number of times on a given object, and the
5908next call to scm_unprotect_object will unprotect it completely.
5909
5910Basically, scm_protect_object and scm_unprotect_object just
5911maintain a list of references to things. Since the GC knows about
5912this list, all objects it mentions stay alive. scm_protect_object
5913adds its argument to the list; scm_unprotect_object remove its
5914argument from the list.
5915
5916
5917** scm_eval_0str now returns the value of the last expression
5918evaluated.
5919
5920** The new function scm_read_0str reads an s-expression from a
5921null-terminated string, and returns it.
5922
5923** The new function `scm_stdio_to_port' converts a STDIO file pointer
5924to a Scheme port object.
5925
5926** The new function `scm_set_program_arguments' allows C code to set
e80c8fea 5927the value returned by the Scheme `program-arguments' function.
6685dc83 5928
6685dc83 5929\f
1a1945be
JB
5930Older changes:
5931
5932* Guile no longer includes sophisticated Tcl/Tk support.
5933
5934The old Tcl/Tk support was unsatisfying to us, because it required the
5935user to link against the Tcl library, as well as Tk and Guile. The
5936interface was also un-lispy, in that it preserved Tcl/Tk's practice of
5937referring to widgets by names, rather than exporting widgets to Scheme
5938code as a special datatype.
5939
5940In the Usenix Tk Developer's Workshop held in July 1996, the Tcl/Tk
5941maintainers described some very interesting changes in progress to the
5942Tcl/Tk internals, which would facilitate clean interfaces between lone
5943Tk and other interpreters --- even for garbage-collected languages
5944like Scheme. They expected the new Tk to be publicly available in the
5945fall of 1996.
5946
5947Since it seems that Guile might soon have a new, cleaner interface to
5948lone Tk, and that the old Guile/Tk glue code would probably need to be
5949completely rewritten, we (Jim Blandy and Richard Stallman) have
5950decided not to support the old code. We'll spend the time instead on
5951a good interface to the newer Tk, as soon as it is available.
5c54da76 5952
8512dea6 5953Until then, gtcltk-lib provides trivial, low-maintenance functionality.
deb95d71 5954
5c54da76
JB
5955\f
5956Copyright information:
5957
7e267da1 5958Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
5c54da76
JB
5959
5960 Permission is granted to anyone to make or distribute verbatim copies
5961 of this document as received, in any medium, provided that the
5962 copyright notice and this permission notice are preserved,
5963 thus giving the recipient permission to redistribute in turn.
5964
5965 Permission is granted to distribute modified versions
5966 of this document, or of portions of it,
5967 under the above conditions, provided also that they
5968 carry prominent notices stating who last changed them.
5969
48d224d7
JB
5970\f
5971Local variables:
5972mode: outline
5973paragraph-separate: "[ \f]*$"
5974end:
5975