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