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