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