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