*** empty log message ***
[bpt/guile.git] / NEWS
1 Guile NEWS --- history of user-visible changes. -*- text -*-
2 Copyright (C) 1996, 1997 Free Software Foundation, Inc.
3 See the end for copying conditions.
4
5 Please send Guile bug reports to bug-guile@gnu.org.
6 \f
7 Changes since Guile 1.2:
8
9 * Changes to the distribution
10
11 ** We renamed the SCHEME_LOAD_PATH environment variable to GUILE_LOAD_PATH.
12 To avoid conflicts, programs should name environment variables after
13 themselves, except when there's a common practice establishing some
14 other convention.
15
16 For now, Guile supports both GUILE_LOAD_PATH and SCHEME_LOAD_PATH,
17 giving the former precedence, and printing a warning message if the
18 latter is set. Guile 1.4 will not recognize SCHEME_LOAD_PATH at all.
19
20 ** The header files related to multi-byte characters have been removed.
21 They were: libguile/extchrs.h and libguile/mbstrings.h. Any C code
22 which referred to these explicitly will probably need to be rewritten,
23 since the support for the variant string types has been removed; see
24 below.
25
26 ** The header files append.h and sequences.h have been removed. These
27 files implemented non-R4RS operations which would encourage
28 non-portable programming style and less easy-to-read code.
29
30 * Changes to the stand-alone interpreter
31
32 ** New procedures have been added to implement a "batch mode":
33
34 *** Function: batch-mode?
35
36 Returns a boolean indicating whether the interpreter is in batch
37 mode.
38
39 *** Function: set-batch-mode?! ARG
40
41 If ARG is true, switches the interpreter to batch mode. The `#f'
42 case has not been implemented.
43
44 ** Guile now provides full command-line editing, when run interactively.
45 To use this feature, you must have the readline library installed.
46 The Guile build process will notice it, and automatically include
47 support for it.
48
49 The readline library is available via anonymous FTP from any GNU
50 mirror site; the canonical location is "ftp://prep.ai.mit.edu/pub/gnu".
51
52 ** the-last-stack is now a fluid.
53
54 * Changes to the procedure for linking libguile with your programs
55
56 ** You can now use the `guile-config' utility to link against Guile.
57
58 Guile now includes a command-line utility called `guile-config', which
59 writes to its standard output a list of flags which you must pass to
60 the linker to link against the Guile library. The flags include
61 '-lguile' itself, and any other libraries the Guile library depends
62 upon.
63
64 For example, here is a Makefile rule that builds a program named 'foo'
65 from the object files ${FOO_OBJECTS}, and links them against Guile:
66
67 foo: ${FOO_OBJECTS}
68 ${CC} ${CFLAGS} ${FOO_OBJECTS} `guile-config link` -o foo
69
70 Previous Guile releases recommended that you use autoconf to detect
71 which of a predefined set of libraries were present on your system.
72 It is more robust to use `guile-config', since it records exactly which
73 libraries the installed Guile library requires.
74
75 This was originally called `build-guile', but was renamed to
76 `guile-config' before Guile 1.3 was released, to be consistent with
77 the analogous script for the GTK+ GUI toolkit, which is called
78 `gtk-config'.
79
80
81 * Changes to Scheme functions and syntax
82
83 ** Multi-byte strings have been removed, as have multi-byte and wide
84 ports. We felt that these were the wrong approach to
85 internationalization support.
86
87 ** New function: readline [PROMPT]
88 Read a line from the terminal, and allow the user to edit it,
89 prompting with PROMPT. READLINE provides a large set of Emacs-like
90 editing commands, lets the user recall previously typed lines, and
91 works on almost every kind of terminal, including dumb terminals.
92
93 READLINE assumes that the cursor is at the beginning of the line when
94 it is invoked. Thus, you can't print a prompt yourself, and then call
95 READLINE; you need to package up your prompt as a string, pass it to
96 the function, and let READLINE print the prompt itself. This is
97 because READLINE needs to know the prompt's screen width.
98
99 For Guile to provide this function, you must have the readline library
100 installed on your system.
101
102 See also ADD-HISTORY function.
103
104 ** New function: add-history STRING
105 Add STRING as the most recent line in the history used by the READLINE
106 command. READLINE does not add lines to the history itself; you must
107 call ADD-HISTORY to make previous input available to the user.
108
109 ** New module (ice-9 getopt-gnu-style): Parse command-line arguments.
110
111 This module provides some simple argument parsing. It exports one
112 function:
113
114 Function: getopt-gnu-style ARG-LS
115 Parse a list of program arguments into an alist of option
116 descriptions.
117
118 Each item in the list of program arguments is examined to see if
119 it meets the syntax of a GNU long-named option. An argument like
120 `--MUMBLE' produces an element of the form (MUMBLE . #t) in the
121 returned alist, where MUMBLE is a keyword object with the same
122 name as the argument. An argument like `--MUMBLE=FROB' produces
123 an element of the form (MUMBLE . FROB), where FROB is a string.
124
125 As a special case, the returned alist also contains a pair whose
126 car is the symbol `rest'. The cdr of this pair is a list
127 containing all the items in the argument list that are not options
128 of the form mentioned above.
129
130 The argument `--' is treated specially: all items in the argument
131 list appearing after such an argument are not examined, and are
132 returned in the special `rest' list.
133
134 This function does not parse normal single-character switches.
135 You will need to parse them out of the `rest' list yourself.
136
137 ** macro-eval! is removed. Use local-eval instead.
138
139 ** Some magic has been added to the printer to better handle user
140 written printing routines (like record printers, closure printers).
141
142 The problem is that these user written routines must have access to
143 the current `print-state' to be able to handle fancy things like
144 detection of circular references. These print-states have to be
145 passed to the builtin printing routines (display, write, etc) to
146 properly continue the print chain.
147
148 We didn't want to change all existing print code so that it
149 explicitely passes thru a print state in addition to a port. Instead,
150 we extented the possible values that the builtin printing routines
151 accept as a `port'. In addition to a normal port, they now also take
152 a pair of a normal port and a print-state. Printing will go to the
153 port and the print-state will be used to control the detection of
154 circular references, etc. If the builtin function does not care for a
155 print-state, it is simply ignored.
156
157 User written callbacks are now called with such a pair as their
158 `port', but because every function now accepts this pair as a PORT
159 argument, you don't have to worry about that. In fact, it is probably
160 safest to not check for these pairs.
161
162 However, it is sometimes necessary to continue a print chain on a
163 different port, for example to get a intermediate string
164 representation of the printed value, mangle that string somehow, and
165 then to finally print the mangled string. Use the new function
166
167 inherit-print-state OLD-PORT NEW-PORT
168
169 for this. It constructs a new `port' that prints to NEW-PORT but
170 inherits the print-state of OLD-PORT.
171
172 ** struct-vtable-offset renamed to vtable-offset-user
173
174 ** New constants: vtable-index-layout, vtable-index-vtable, vtable-index-printer
175
176 ** There is now a fourth (optional) argument to make-vtable-vtable and
177 make-struct when constructing new types (vtables). This argument
178 initializes field vtable-index-printer of the vtable.
179
180 ** The detection of circular references has been extended to structs.
181 That is, a structure that -- in the process of being printed -- prints
182 itself does not lead to infinite recursion.
183
184 ** There is now some basic support for fluids. Please read
185 "libguile/fluid.h" to find out more. It is accessible from Scheme with
186 the following functions and macros:
187
188 Function: make-fluid
189
190 Create a new fluid object. Fluids are not special variables or
191 some other extension to the semantics of Scheme, but rather
192 ordinary Scheme objects. You can store them into variables (that
193 are still lexically scoped, of course) or into any other place you
194 like. Every fluid has a initial value of `#f'.
195
196 Function: fluid? OBJ
197
198 Test whether OBJ is a fluid.
199
200 Function: fluid-ref FLUID
201 Function: fluid-set! FLUID VAL
202
203 Access/modify the fluid FLUID. Modifications are only visible
204 within the current dynamic root (that includes threads).
205
206 Function: with-fluids* FLUIDS VALUES THUNK
207
208 FLUIDS is a list of fluids and VALUES a corresponding list of
209 values for these fluids. Before THUNK gets called the values are
210 installed in the fluids and the old values of the fluids are
211 saved in the VALUES list. When the flow of control leaves THUNK
212 or reenters it, the values get swapped again. You might think of
213 this as a `safe-fluid-excursion'. Note that the VALUES list is
214 modified by `with-fluids*'.
215
216 Macro: with-fluids ((FLUID VALUE) ...) FORM ...
217
218 The same as `with-fluids*' but with a different syntax. It looks
219 just like `let', but both FLUID and VALUE are evaluated. Remember,
220 fluids are not special variables but ordinary objects. FLUID
221 should evaluate to a fluid.
222
223 ** Changes to system call interfaces:
224
225 *** close-port, close-input-port and close-output-port now return a
226 boolean instead of an `unspecified' object. #t means that the port
227 was successfully closed, while #f means it was already closed. It is
228 also now possible for these procedures to raise an exception if an
229 error occurs (some errors from write can be delayed until close.)
230
231 *** the first argument to chmod, fcntl, ftell and fseek can now be a
232 file descriptor.
233
234 *** the third argument to fcntl is now optional.
235
236 *** the first argument to chown can now be a file descriptor or a port.
237
238 *** the argument to stat can now be a port.
239
240 *** The following new procedures have been added (most use scsh
241 interfaces):
242
243 *** procedure: close PORT/FD
244 Similar to close-port (*note close-port: Closing Ports.), but also
245 works on file descriptors. A side effect of closing a file
246 descriptor is that any ports using that file descriptor are moved
247 to a different file descriptor and have their revealed counts set
248 to zero.
249
250 *** procedure: port->fdes PORT
251 Returns the integer file descriptor underlying PORT. As a side
252 effect the revealed count of PORT is incremented.
253
254 *** procedure: fdes->ports FDES
255 Returns a list of existing ports which have FDES as an underlying
256 file descriptor, without changing their revealed counts.
257
258 *** procedure: fdes->inport FDES
259 Returns an existing input port which has FDES as its underlying
260 file descriptor, if one exists, and increments its revealed count.
261 Otherwise, returns a new input port with a revealed count of 1.
262
263 *** procedure: fdes->outport FDES
264 Returns an existing output port which has FDES as its underlying
265 file descriptor, if one exists, and increments its revealed count.
266 Otherwise, returns a new output port with a revealed count of 1.
267
268 The next group of procedures perform a `dup2' system call, if NEWFD
269 (an integer) is supplied, otherwise a `dup'. The file descriptor to be
270 duplicated can be supplied as an integer or contained in a port. The
271 type of value returned varies depending on which procedure is used.
272
273 All procedures also have the side effect when performing `dup2' that
274 any ports using NEWFD are moved to a different file descriptor and have
275 their revealed counts set to zero.
276
277 *** procedure: dup->fdes PORT/FD [NEWFD]
278 Returns an integer file descriptor.
279
280 *** procedure: dup->inport PORT/FD [NEWFD]
281 Returns a new input port using the new file descriptor.
282
283 *** procedure: dup->outport PORT/FD [NEWFD]
284 Returns a new output port using the new file descriptor.
285
286 *** procedure: dup PORT/FD [NEWFD]
287 Returns a new port if PORT/FD is a port, with the same mode as the
288 supplied port, otherwise returns an integer file descriptor.
289
290 *** procedure: dup->port PORT/FD MODE [NEWFD]
291 Returns a new port using the new file descriptor. MODE supplies a
292 mode string for the port (*note open-file: File Ports.).
293
294 *** procedure: setenv NAME VALUE
295 Modifies the environment of the current process, which is also the
296 default environment inherited by child processes.
297
298 If VALUE is `#f', then NAME is removed from the environment.
299 Otherwise, the string NAME=VALUE is added to the environment,
300 replacing any existing string with name matching NAME.
301
302 The return value is unspecified.
303
304 *** procedure: truncate-file OBJ SIZE
305 Truncates the file referred to by OBJ to at most SIZE bytes. OBJ
306 can be a string containing a file name or an integer file
307 descriptor or port open for output on the file. The underlying
308 system calls are `truncate' and `ftruncate'.
309
310 The return value is unspecified.
311
312 *** procedure: setvbuf PORT MODE [SIZE]
313 Set the buffering mode for PORT. MODE can be:
314 `_IONBF'
315 non-buffered
316
317 `_IOLBF'
318 line buffered
319
320 `_IOFBF'
321 block buffered, using a newly allocated buffer of SIZE bytes.
322 However if SIZE is zero or unspecified, the port will be made
323 non-buffered.
324
325 This procedure should not be used after I/O has been performed with
326 the port.
327
328 Ports are usually block buffered by default, with a default buffer
329 size. Procedures e.g., *Note open-file: File Ports, which accept a
330 mode string allow `0' to be added to request an unbuffered port.
331
332 *** procedure: fsync PORT/FD
333 Copies any unwritten data for the specified output file descriptor
334 to disk. If PORT/FD is a port, its buffer is flushed before the
335 underlying file descriptor is fsync'd. The return value is
336 unspecified.
337
338 *** procedure: open-fdes PATH FLAGS [MODES]
339 Similar to `open' but returns a file descriptor instead of a port.
340
341 *** procedure: execle PATH ENV [ARG] ...
342 Similar to `execl', but the environment of the new process is
343 specified by ENV, which must be a list of strings as returned by
344 the `environ' procedure.
345
346 This procedure is currently implemented using the `execve' system
347 call, but we call it `execle' because of its Scheme calling
348 interface.
349
350 *** procedure: strerror ERRNO
351 Returns the Unix error message corresponding to ERRNO, an integer.
352
353 *** procedure: primitive-exit [STATUS]
354 Terminate the current process without unwinding the Scheme stack.
355 This is would typically be useful after a fork. The exit status
356 is STATUS if supplied, otherwise zero.
357
358 *** procedure: times
359 Returns an object with information about real and processor time.
360 The following procedures accept such an object as an argument and
361 return a selected component:
362
363 `tms:clock'
364 The current real time, expressed as time units relative to an
365 arbitrary base.
366
367 `tms:utime'
368 The CPU time units used by the calling process.
369
370 `tms:stime'
371 The CPU time units used by the system on behalf of the
372 calling process.
373
374 `tms:cutime'
375 The CPU time units used by terminated child processes of the
376 calling process, whose status has been collected (e.g., using
377 `waitpid').
378
379 `tms:cstime'
380 Similarly, the CPU times units used by the system on behalf of
381 terminated child processes.
382
383 ** Removed: list-length
384 ** Removed: list-append, list-append!
385 ** Removed: list-reverse, list-reverse!
386
387 ** array-map renamed to array-map!
388
389 ** serial-array-map renamed to serial-array-map!
390
391 ** catch doesn't take #f as first argument any longer
392
393 Previously, it was possible to pass #f instead of a key to `catch'.
394 That would cause `catch' to pass a jump buffer object to the procedure
395 passed as second argument. The procedure could then use this jump
396 buffer objekt as an argument to throw.
397
398 This mechanism has been removed since its utility doesn't motivate the
399 extra complexity it introduces.
400
401 * Changes to the gh_ interface
402
403 ** The gh_enter function now takes care of loading the Guile startup files.
404 gh_enter works by calling scm_boot_guile; see the remarks below.
405
406 ** Function: void gh_write (SCM x)
407
408 Write the printed representation of the scheme object x to the current
409 output port. Corresponds to the scheme level `write'.
410
411 ** gh_list_length renamed to gh_length.
412
413 ** vector handling routines
414
415 Several major changes. In particular, gh_vector() now resembles
416 (vector ...) (with a caveat -- see manual), and gh_make_vector() now
417 exists and behaves like (make-vector ...). gh_vset() and gh_vref()
418 have been renamed gh_vector_set_x() and gh_vector_ref(). Some missing
419 vector-related gh_ functions have been implemented.
420
421 ** pair and list routines
422
423 Implemented several of the R4RS pair and list functions that were
424 missing.
425
426 ** gh_scm2doubles, gh_doubles2scm, gh_doubles2dvect
427
428 New function. Converts double arrays back and forth between Scheme
429 and C.
430
431 * Changes to the scm_ interface
432
433 ** The function scm_boot_guile now takes care of loading the startup files.
434
435 Guile's primary initialization function, scm_boot_guile, now takes
436 care of loading `boot-9.scm', in the `ice-9' module, to initialize
437 Guile, define the module system, and put together some standard
438 bindings. It also loads `init.scm', which is intended to hold
439 site-specific initialization code.
440
441 Since Guile cannot operate properly until boot-9.scm is loaded, there
442 is no reason to separate loading boot-9.scm from Guile's other
443 initialization processes.
444
445 This job used to be done by scm_compile_shell_switches, which didn't
446 make much sense; in particular, it meant that people using Guile for
447 non-shell-like applications had to jump through hoops to get Guile
448 initialized properly.
449
450 ** The function scm_compile_shell_switches no longer loads the startup files.
451 Now, Guile always loads the startup files, whenever it is initialized;
452 see the notes above for scm_boot_guile and scm_load_startup_files.
453
454 ** Function: scm_load_startup_files
455 This new function takes care of loading Guile's initialization file
456 (`boot-9.scm'), and the site initialization file, `init.scm'. Since
457 this is always called by the Guile initialization process, it's
458 probably not too useful to call this yourself, but it's there anyway.
459
460 ** The semantics of smob marking have changed slightly.
461
462 The smob marking function (the `mark' member of the scm_smobfuns
463 structure) is no longer responsible for setting the mark bit on the
464 smob. The generic smob handling code in the garbage collector will
465 set this bit. The mark function need only ensure that any other
466 objects the smob refers to get marked.
467
468 Note that this change means that the smob's GC8MARK bit is typically
469 already set upon entry to the mark function. Thus, marking functions
470 which look like this:
471
472 {
473 if (SCM_GC8MARKP (ptr))
474 return SCM_BOOL_F;
475 SCM_SETGC8MARK (ptr);
476 ... mark objects to which the smob refers ...
477 }
478
479 are now incorrect, since they will return early, and fail to mark any
480 other objects the smob refers to. Some code in the Guile library used
481 to work this way.
482
483
484 ** Function: int scm_internal_select (int fds,
485 SELECT_TYPE *rfds,
486 SELECT_TYPE *wfds,
487 SELECT_TYPE *efds,
488 struct timeval *timeout);
489
490 This is a replacement for the `select' function provided by the OS.
491 It enables I/O blocking and sleeping to happen for one cooperative
492 thread without blocking other threads. It also avoids busy-loops in
493 these situations. It is intended that all I/O blocking and sleeping
494 will finally go through this function. Currently, this function is
495 only available on systems providing `gettimeofday' and `select'.
496
497 ** Function: SCM scm_internal_stack_catch (SCM tag,
498 scm_catch_body_t body,
499 void *body_data,
500 scm_catch_handler_t handler,
501 void *handler_data)
502
503 A new sibling to the other two C level `catch' functions
504 scm_internal_catch and scm_internal_lazy_catch. Use it if you want
505 the stack to be saved automatically into the variable `the-last-stack'
506 (scm_the_last_stack_var) on error. This is necessary if you want to
507 use advanced error reporting, such as calling scm_display_error and
508 scm_display_backtrace. (They both take a stack object as argument.)
509
510 ** Function: SCM scm_spawn_thread (scm_catch_body_t body,
511 void *body_data,
512 scm_catch_handler_t handler,
513 void *handler_data)
514
515 Spawns a new thread. It does a job similar to
516 scm_call_with_new_thread but takes arguments more suitable when
517 spawning threads from application C code.
518
519 ** The hook scm_error_callback has been removed. It was originally
520 intended as a way for the user to install his own error handler. But
521 that method works badly since it intervenes between throw and catch,
522 thereby changing the semantics of expressions like (catch #t ...).
523 The correct way to do it is to use one of the C level catch functions
524 in throw.c: scm_internal_catch/lazy_catch/stack_catch.
525
526 ** Removed functions:
527
528 scm_obj_length, scm_list_length, scm_list_append, scm_list_append_x,
529 scm_list_reverse, scm_list_reverse_x
530
531 ** New macros: SCM_LISTn where n is one of the integers 0-9.
532
533 These can be used for pretty list creation from C. The idea is taken
534 from Erick Gallesio's STk.
535
536 ** scm_array_map renamed to scm_array_map_x
537
538 ** mbstrings are now removed
539
540 This means that the type codes scm_tc7_mb_string and
541 scm_tc7_mb_substring has been removed.
542
543 ** The macros SCM_TYP7D and SCM_TYP7SD has been removed.
544
545 ** The macro SCM_TYP7S has taken the role of the old SCM_TYP7D
546
547 SCM_TYP7S now masks away the bit which distinguishes substrings from
548 strings.
549
550 ** All genio functions changed names and interfaces; new functions are
551 scm_putc, scm_puts, scm_lfwrite, scm_getc, scm_ungetc, and
552 scm_do_read_line.
553
554 ** scm_catch_body_t: Backward incompatible change!
555
556 Body functions to scm_internal_catch and friends do not any longer
557 take a second argument. This is because it is no longer possible to
558 pass a #f arg to catch.
559
560 \f
561 Changes in Guile 1.2 (released Tuesday, June 24 1997):
562
563 * Changes to the distribution
564
565 ** Nightly snapshots are now available from ftp.red-bean.com.
566 The old server, ftp.cyclic.com, has been relinquished to its rightful
567 owner.
568
569 Nightly snapshots of the Guile development sources are now available via
570 anonymous FTP from ftp.red-bean.com, as /pub/guile/guile-snap.tar.gz.
571
572 Via the web, that's: ftp://ftp.red-bean.com/pub/guile/guile-snap.tar.gz
573 For getit, that's: ftp.red-bean.com:/pub/guile/guile-snap.tar.gz
574
575 ** To run Guile without installing it, the procedure has changed a bit.
576
577 If you used a separate build directory to compile Guile, you'll need
578 to include the build directory in SCHEME_LOAD_PATH, as well as the
579 source directory. See the `INSTALL' file for examples.
580
581 * Changes to the procedure for linking libguile with your programs
582
583 ** The standard Guile load path for Scheme code now includes
584 $(datadir)/guile (usually /usr/local/share/guile). This means that
585 you can install your own Scheme files there, and Guile will find them.
586 (Previous versions of Guile only checked a directory whose name
587 contained the Guile version number, so you had to re-install or move
588 your Scheme sources each time you installed a fresh version of Guile.)
589
590 The load path also includes $(datadir)/guile/site; we recommend
591 putting individual Scheme files there. If you want to install a
592 package with multiple source files, create a directory for them under
593 $(datadir)/guile.
594
595 ** Guile 1.2 will now use the Rx regular expression library, if it is
596 installed on your system. When you are linking libguile into your own
597 programs, this means you will have to link against -lguile, -lqt (if
598 you configured Guile with thread support), and -lrx.
599
600 If you are using autoconf to generate configuration scripts for your
601 application, the following lines should suffice to add the appropriate
602 libraries to your link command:
603
604 ### Find Rx, quickthreads and libguile.
605 AC_CHECK_LIB(rx, main)
606 AC_CHECK_LIB(qt, main)
607 AC_CHECK_LIB(guile, scm_shell)
608
609 The Guile 1.2 distribution does not contain sources for the Rx
610 library, as Guile 1.0 did. If you want to use Rx, you'll need to
611 retrieve it from a GNU FTP site and install it separately.
612
613 * Changes to Scheme functions and syntax
614
615 ** The dynamic linking features of Guile are now enabled by default.
616 You can disable them by giving the `--disable-dynamic-linking' option
617 to configure.
618
619 (dynamic-link FILENAME)
620
621 Find the object file denoted by FILENAME (a string) and link it
622 into the running Guile application. When everything works out,
623 return a Scheme object suitable for representing the linked object
624 file. Otherwise an error is thrown. How object files are
625 searched is system dependent.
626
627 (dynamic-object? VAL)
628
629 Determine whether VAL represents a dynamically linked object file.
630
631 (dynamic-unlink DYNOBJ)
632
633 Unlink the indicated object file from the application. DYNOBJ
634 should be one of the values returned by `dynamic-link'.
635
636 (dynamic-func FUNCTION DYNOBJ)
637
638 Search the C function indicated by FUNCTION (a string or symbol)
639 in DYNOBJ and return some Scheme object that can later be used
640 with `dynamic-call' to actually call this function. Right now,
641 these Scheme objects are formed by casting the address of the
642 function to `long' and converting this number to its Scheme
643 representation.
644
645 (dynamic-call FUNCTION DYNOBJ)
646
647 Call the C function indicated by FUNCTION and DYNOBJ. The
648 function is passed no arguments and its return value is ignored.
649 When FUNCTION is something returned by `dynamic-func', call that
650 function and ignore DYNOBJ. When FUNCTION is a string (or symbol,
651 etc.), look it up in DYNOBJ; this is equivalent to
652
653 (dynamic-call (dynamic-func FUNCTION DYNOBJ) #f)
654
655 Interrupts are deferred while the C function is executing (with
656 SCM_DEFER_INTS/SCM_ALLOW_INTS).
657
658 (dynamic-args-call FUNCTION DYNOBJ ARGS)
659
660 Call the C function indicated by FUNCTION and DYNOBJ, but pass it
661 some arguments and return its return value. The C function is
662 expected to take two arguments and return an `int', just like
663 `main':
664
665 int c_func (int argc, char **argv);
666
667 ARGS must be a list of strings and is converted into an array of
668 `char *'. The array is passed in ARGV and its size in ARGC. The
669 return value is converted to a Scheme number and returned from the
670 call to `dynamic-args-call'.
671
672 When dynamic linking is disabled or not supported on your system,
673 the above functions throw errors, but they are still available.
674
675 Here is a small example that works on GNU/Linux:
676
677 (define libc-obj (dynamic-link "libc.so"))
678 (dynamic-args-call 'rand libc-obj '())
679
680 See the file `libguile/DYNAMIC-LINKING' for additional comments.
681
682 ** The #/ syntax for module names is depreciated, and will be removed
683 in a future version of Guile. Instead of
684
685 #/foo/bar/baz
686
687 instead write
688
689 (foo bar baz)
690
691 The latter syntax is more consistent with existing Lisp practice.
692
693 ** Guile now does fancier printing of structures. Structures are the
694 underlying implementation for records, which in turn are used to
695 implement modules, so all of these object now print differently and in
696 a more informative way.
697
698 The Scheme printer will examine the builtin variable *struct-printer*
699 whenever it needs to print a structure object. When this variable is
700 not `#f' it is deemed to be a procedure and will be applied to the
701 structure object and the output port. When *struct-printer* is `#f'
702 or the procedure return `#f' the structure object will be printed in
703 the boring #<struct 80458270> form.
704
705 This hook is used by some routines in ice-9/boot-9.scm to implement
706 type specific printing routines. Please read the comments there about
707 "printing structs".
708
709 One of the more specific uses of structs are records. The printing
710 procedure that could be passed to MAKE-RECORD-TYPE is now actually
711 called. It should behave like a *struct-printer* procedure (described
712 above).
713
714 ** Guile now supports a new R4RS-compliant syntax for keywords. A
715 token of the form #:NAME, where NAME has the same syntax as a Scheme
716 symbol, is the external representation of the keyword named NAME.
717 Keyword objects print using this syntax as well, so values containing
718 keyword objects can be read back into Guile. When used in an
719 expression, keywords are self-quoting objects.
720
721 Guile suports this read syntax, and uses this print syntax, regardless
722 of the current setting of the `keyword' read option. The `keyword'
723 read option only controls whether Guile recognizes the `:NAME' syntax,
724 which is incompatible with R4RS. (R4RS says such token represent
725 symbols.)
726
727 ** Guile has regular expression support again. Guile 1.0 included
728 functions for matching regular expressions, based on the Rx library.
729 In Guile 1.1, the Guile/Rx interface was removed to simplify the
730 distribution, and thus Guile had no regular expression support. Guile
731 1.2 again supports the most commonly used functions, and supports all
732 of SCSH's regular expression functions.
733
734 If your system does not include a POSIX regular expression library,
735 and you have not linked Guile with a third-party regexp library such as
736 Rx, these functions will not be available. You can tell whether your
737 Guile installation includes regular expression support by checking
738 whether the `*features*' list includes the `regex' symbol.
739
740 *** regexp functions
741
742 By default, Guile supports POSIX extended regular expressions. That
743 means that the characters `(', `)', `+' and `?' are special, and must
744 be escaped if you wish to match the literal characters.
745
746 This regular expression interface was modeled after that implemented
747 by SCSH, the Scheme Shell. It is intended to be upwardly compatible
748 with SCSH regular expressions.
749
750 **** Function: string-match PATTERN STR [START]
751 Compile the string PATTERN into a regular expression and compare
752 it with STR. The optional numeric argument START specifies the
753 position of STR at which to begin matching.
754
755 `string-match' returns a "match structure" which describes what,
756 if anything, was matched by the regular expression. *Note Match
757 Structures::. If STR does not match PATTERN at all,
758 `string-match' returns `#f'.
759
760 Each time `string-match' is called, it must compile its PATTERN
761 argument into a regular expression structure. This operation is
762 expensive, which makes `string-match' inefficient if the same regular
763 expression is used several times (for example, in a loop). For better
764 performance, you can compile a regular expression in advance and then
765 match strings against the compiled regexp.
766
767 **** Function: make-regexp STR [FLAGS]
768 Compile the regular expression described by STR, and return the
769 compiled regexp structure. If STR does not describe a legal
770 regular expression, `make-regexp' throws a
771 `regular-expression-syntax' error.
772
773 FLAGS may be the bitwise-or of one or more of the following:
774
775 **** Constant: regexp/extended
776 Use POSIX Extended Regular Expression syntax when interpreting
777 STR. If not set, POSIX Basic Regular Expression syntax is used.
778 If the FLAGS argument is omitted, we assume regexp/extended.
779
780 **** Constant: regexp/icase
781 Do not differentiate case. Subsequent searches using the
782 returned regular expression will be case insensitive.
783
784 **** Constant: regexp/newline
785 Match-any-character operators don't match a newline.
786
787 A non-matching list ([^...]) not containing a newline matches a
788 newline.
789
790 Match-beginning-of-line operator (^) matches the empty string
791 immediately after a newline, regardless of whether the FLAGS
792 passed to regexp-exec contain regexp/notbol.
793
794 Match-end-of-line operator ($) matches the empty string
795 immediately before a newline, regardless of whether the FLAGS
796 passed to regexp-exec contain regexp/noteol.
797
798 **** Function: regexp-exec REGEXP STR [START [FLAGS]]
799 Match the compiled regular expression REGEXP against `str'. If
800 the optional integer START argument is provided, begin matching
801 from that position in the string. Return a match structure
802 describing the results of the match, or `#f' if no match could be
803 found.
804
805 FLAGS may be the bitwise-or of one or more of the following:
806
807 **** Constant: regexp/notbol
808 The match-beginning-of-line operator always fails to match (but
809 see the compilation flag regexp/newline above) This flag may be
810 used when different portions of a string are passed to
811 regexp-exec and the beginning of the string should not be
812 interpreted as the beginning of the line.
813
814 **** Constant: regexp/noteol
815 The match-end-of-line operator always fails to match (but see the
816 compilation flag regexp/newline above)
817
818 **** Function: regexp? OBJ
819 Return `#t' if OBJ is a compiled regular expression, or `#f'
820 otherwise.
821
822 Regular expressions are commonly used to find patterns in one string
823 and replace them with the contents of another string.
824
825 **** Function: regexp-substitute PORT MATCH [ITEM...]
826 Write to the output port PORT selected contents of the match
827 structure MATCH. Each ITEM specifies what should be written, and
828 may be one of the following arguments:
829
830 * A string. String arguments are written out verbatim.
831
832 * An integer. The submatch with that number is written.
833
834 * The symbol `pre'. The portion of the matched string preceding
835 the regexp match is written.
836
837 * The symbol `post'. The portion of the matched string
838 following the regexp match is written.
839
840 PORT may be `#f', in which case nothing is written; instead,
841 `regexp-substitute' constructs a string from the specified ITEMs
842 and returns that.
843
844 **** Function: regexp-substitute/global PORT REGEXP TARGET [ITEM...]
845 Similar to `regexp-substitute', but can be used to perform global
846 substitutions on STR. Instead of taking a match structure as an
847 argument, `regexp-substitute/global' takes two string arguments: a
848 REGEXP string describing a regular expression, and a TARGET string
849 which should be matched against this regular expression.
850
851 Each ITEM behaves as in REGEXP-SUBSTITUTE, with the following
852 exceptions:
853
854 * A function may be supplied. When this function is called, it
855 will be passed one argument: a match structure for a given
856 regular expression match. It should return a string to be
857 written out to PORT.
858
859 * The `post' symbol causes `regexp-substitute/global' to recurse
860 on the unmatched portion of STR. This *must* be supplied in
861 order to perform global search-and-replace on STR; if it is
862 not present among the ITEMs, then `regexp-substitute/global'
863 will return after processing a single match.
864
865 *** Match Structures
866
867 A "match structure" is the object returned by `string-match' and
868 `regexp-exec'. It describes which portion of a string, if any, matched
869 the given regular expression. Match structures include: a reference to
870 the string that was checked for matches; the starting and ending
871 positions of the regexp match; and, if the regexp included any
872 parenthesized subexpressions, the starting and ending positions of each
873 submatch.
874
875 In each of the regexp match functions described below, the `match'
876 argument must be a match structure returned by a previous call to
877 `string-match' or `regexp-exec'. Most of these functions return some
878 information about the original target string that was matched against a
879 regular expression; we will call that string TARGET for easy reference.
880
881 **** Function: regexp-match? OBJ
882 Return `#t' if OBJ is a match structure returned by a previous
883 call to `regexp-exec', or `#f' otherwise.
884
885 **** Function: match:substring MATCH [N]
886 Return the portion of TARGET matched by subexpression number N.
887 Submatch 0 (the default) represents the entire regexp match. If
888 the regular expression as a whole matched, but the subexpression
889 number N did not match, return `#f'.
890
891 **** Function: match:start MATCH [N]
892 Return the starting position of submatch number N.
893
894 **** Function: match:end MATCH [N]
895 Return the ending position of submatch number N.
896
897 **** Function: match:prefix MATCH
898 Return the unmatched portion of TARGET preceding the regexp match.
899
900 **** Function: match:suffix MATCH
901 Return the unmatched portion of TARGET following the regexp match.
902
903 **** Function: match:count MATCH
904 Return the number of parenthesized subexpressions from MATCH.
905 Note that the entire regular expression match itself counts as a
906 subexpression, and failed submatches are included in the count.
907
908 **** Function: match:string MATCH
909 Return the original TARGET string.
910
911 *** Backslash Escapes
912
913 Sometimes you will want a regexp to match characters like `*' or `$'
914 exactly. For example, to check whether a particular string represents
915 a menu entry from an Info node, it would be useful to match it against
916 a regexp like `^* [^:]*::'. However, this won't work; because the
917 asterisk is a metacharacter, it won't match the `*' at the beginning of
918 the string. In this case, we want to make the first asterisk un-magic.
919
920 You can do this by preceding the metacharacter with a backslash
921 character `\'. (This is also called "quoting" the metacharacter, and
922 is known as a "backslash escape".) When Guile sees a backslash in a
923 regular expression, it considers the following glyph to be an ordinary
924 character, no matter what special meaning it would ordinarily have.
925 Therefore, we can make the above example work by changing the regexp to
926 `^\* [^:]*::'. The `\*' sequence tells the regular expression engine
927 to match only a single asterisk in the target string.
928
929 Since the backslash is itself a metacharacter, you may force a
930 regexp to match a backslash in the target string by preceding the
931 backslash with itself. For example, to find variable references in a
932 TeX program, you might want to find occurrences of the string `\let\'
933 followed by any number of alphabetic characters. The regular expression
934 `\\let\\[A-Za-z]*' would do this: the double backslashes in the regexp
935 each match a single backslash in the target string.
936
937 **** Function: regexp-quote STR
938 Quote each special character found in STR with a backslash, and
939 return the resulting string.
940
941 *Very important:* Using backslash escapes in Guile source code (as
942 in Emacs Lisp or C) can be tricky, because the backslash character has
943 special meaning for the Guile reader. For example, if Guile encounters
944 the character sequence `\n' in the middle of a string while processing
945 Scheme code, it replaces those characters with a newline character.
946 Similarly, the character sequence `\t' is replaced by a horizontal tab.
947 Several of these "escape sequences" are processed by the Guile reader
948 before your code is executed. Unrecognized escape sequences are
949 ignored: if the characters `\*' appear in a string, they will be
950 translated to the single character `*'.
951
952 This translation is obviously undesirable for regular expressions,
953 since we want to be able to include backslashes in a string in order to
954 escape regexp metacharacters. Therefore, to make sure that a backslash
955 is preserved in a string in your Guile program, you must use *two*
956 consecutive backslashes:
957
958 (define Info-menu-entry-pattern (make-regexp "^\\* [^:]*"))
959
960 The string in this example is preprocessed by the Guile reader before
961 any code is executed. The resulting argument to `make-regexp' is the
962 string `^\* [^:]*', which is what we really want.
963
964 This also means that in order to write a regular expression that
965 matches a single backslash character, the regular expression string in
966 the source code must include *four* backslashes. Each consecutive pair
967 of backslashes gets translated by the Guile reader to a single
968 backslash, and the resulting double-backslash is interpreted by the
969 regexp engine as matching a single backslash character. Hence:
970
971 (define tex-variable-pattern (make-regexp "\\\\let\\\\=[A-Za-z]*"))
972
973 The reason for the unwieldiness of this syntax is historical. Both
974 regular expression pattern matchers and Unix string processing systems
975 have traditionally used backslashes with the special meanings described
976 above. The POSIX regular expression specification and ANSI C standard
977 both require these semantics. Attempting to abandon either convention
978 would cause other kinds of compatibility problems, possibly more severe
979 ones. Therefore, without extending the Scheme reader to support
980 strings with different quoting conventions (an ungainly and confusing
981 extension when implemented in other languages), we must adhere to this
982 cumbersome escape syntax.
983
984 * Changes to the gh_ interface
985
986 * Changes to the scm_ interface
987
988 * Changes to system call interfaces:
989
990 ** The value returned by `raise' is now unspecified. It throws an exception
991 if an error occurs.
992
993 *** A new procedure `sigaction' can be used to install signal handlers
994
995 (sigaction signum [action] [flags])
996
997 signum is the signal number, which can be specified using the value
998 of SIGINT etc.
999
1000 If action is omitted, sigaction returns a pair: the CAR is the current
1001 signal hander, which will be either an integer with the value SIG_DFL
1002 (default action) or SIG_IGN (ignore), or the Scheme procedure which
1003 handles the signal, or #f if a non-Scheme procedure handles the
1004 signal. The CDR contains the current sigaction flags for the handler.
1005
1006 If action is provided, it is installed as the new handler for signum.
1007 action can be a Scheme procedure taking one argument, or the value of
1008 SIG_DFL (default action) or SIG_IGN (ignore), or #f to restore
1009 whatever signal handler was installed before sigaction was first used.
1010 Flags can optionally be specified for the new handler (SA_RESTART is
1011 always used if the system provides it, so need not be specified.) The
1012 return value is a pair with information about the old handler as
1013 described above.
1014
1015 This interface does not provide access to the "signal blocking"
1016 facility. Maybe this is not needed, since the thread support may
1017 provide solutions to the problem of consistent access to data
1018 structures.
1019
1020 *** A new procedure `flush-all-ports' is equivalent to running
1021 `force-output' on every port open for output.
1022
1023 ** Guile now provides information on how it was built, via the new
1024 global variable, %guile-build-info. This variable records the values
1025 of the standard GNU makefile directory variables as an assocation
1026 list, mapping variable names (symbols) onto directory paths (strings).
1027 For example, to find out where the Guile link libraries were
1028 installed, you can say:
1029
1030 guile -c "(display (assq-ref %guile-build-info 'libdir)) (newline)"
1031
1032
1033 * Changes to the scm_ interface
1034
1035 ** The new function scm_handle_by_message_noexit is just like the
1036 existing scm_handle_by_message function, except that it doesn't call
1037 exit to terminate the process. Instead, it prints a message and just
1038 returns #f. This might be a more appropriate catch-all handler for
1039 new dynamic roots and threads.
1040
1041 \f
1042 Changes in Guile 1.1 (released Friday, May 16 1997):
1043
1044 * Changes to the distribution.
1045
1046 The Guile 1.0 distribution has been split up into several smaller
1047 pieces:
1048 guile-core --- the Guile interpreter itself.
1049 guile-tcltk --- the interface between the Guile interpreter and
1050 Tcl/Tk; Tcl is an interpreter for a stringy language, and Tk
1051 is a toolkit for building graphical user interfaces.
1052 guile-rgx-ctax --- the interface between Guile and the Rx regular
1053 expression matcher, and the translator for the Ctax
1054 programming language. These are packaged together because the
1055 Ctax translator uses Rx to parse Ctax source code.
1056
1057 This NEWS file describes the changes made to guile-core since the 1.0
1058 release.
1059
1060 We no longer distribute the documentation, since it was either out of
1061 date, or incomplete. As soon as we have current documentation, we
1062 will distribute it.
1063
1064
1065
1066 * Changes to the stand-alone interpreter
1067
1068 ** guile now accepts command-line arguments compatible with SCSH, Olin
1069 Shivers' Scheme Shell.
1070
1071 In general, arguments are evaluated from left to right, but there are
1072 exceptions. The following switches stop argument processing, and
1073 stash all remaining command-line arguments as the value returned by
1074 the (command-line) function.
1075 -s SCRIPT load Scheme source code from FILE, and exit
1076 -c EXPR evalute Scheme expression EXPR, and exit
1077 -- stop scanning arguments; run interactively
1078
1079 The switches below are processed as they are encountered.
1080 -l FILE load Scheme source code from FILE
1081 -e FUNCTION after reading script, apply FUNCTION to
1082 command line arguments
1083 -ds do -s script at this point
1084 --emacs enable Emacs protocol (experimental)
1085 -h, --help display this help and exit
1086 -v, --version display version information and exit
1087 \ read arguments from following script lines
1088
1089 So, for example, here is a Guile script named `ekko' (thanks, Olin)
1090 which re-implements the traditional "echo" command:
1091
1092 #!/usr/local/bin/guile -s
1093 !#
1094 (define (main args)
1095 (map (lambda (arg) (display arg) (display " "))
1096 (cdr args))
1097 (newline))
1098
1099 (main (command-line))
1100
1101 Suppose we invoke this script as follows:
1102
1103 ekko a speckled gecko
1104
1105 Through the magic of Unix script processing (triggered by the `#!'
1106 token at the top of the file), /usr/local/bin/guile receives the
1107 following list of command-line arguments:
1108
1109 ("-s" "./ekko" "a" "speckled" "gecko")
1110
1111 Unix inserts the name of the script after the argument specified on
1112 the first line of the file (in this case, "-s"), and then follows that
1113 with the arguments given to the script. Guile loads the script, which
1114 defines the `main' function, and then applies it to the list of
1115 remaining command-line arguments, ("a" "speckled" "gecko").
1116
1117 In Unix, the first line of a script file must take the following form:
1118
1119 #!INTERPRETER ARGUMENT
1120
1121 where INTERPRETER is the absolute filename of the interpreter
1122 executable, and ARGUMENT is a single command-line argument to pass to
1123 the interpreter.
1124
1125 You may only pass one argument to the interpreter, and its length is
1126 limited. These restrictions can be annoying to work around, so Guile
1127 provides a general mechanism (borrowed from, and compatible with,
1128 SCSH) for circumventing them.
1129
1130 If the ARGUMENT in a Guile script is a single backslash character,
1131 `\', Guile will open the script file, parse arguments from its second
1132 and subsequent lines, and replace the `\' with them. So, for example,
1133 here is another implementation of the `ekko' script:
1134
1135 #!/usr/local/bin/guile \
1136 -e main -s
1137 !#
1138 (define (main args)
1139 (for-each (lambda (arg) (display arg) (display " "))
1140 (cdr args))
1141 (newline))
1142
1143 If the user invokes this script as follows:
1144
1145 ekko a speckled gecko
1146
1147 Unix expands this into
1148
1149 /usr/local/bin/guile \ ekko a speckled gecko
1150
1151 When Guile sees the `\' argument, it replaces it with the arguments
1152 read from the second line of the script, producing:
1153
1154 /usr/local/bin/guile -e main -s ekko a speckled gecko
1155
1156 This tells Guile to load the `ekko' script, and apply the function
1157 `main' to the argument list ("a" "speckled" "gecko").
1158
1159 Here is how Guile parses the command-line arguments:
1160 - Each space character terminates an argument. This means that two
1161 spaces in a row introduce an empty-string argument.
1162 - The tab character is not permitted (unless you quote it with the
1163 backslash character, as described below), to avoid confusion.
1164 - The newline character terminates the sequence of arguments, and will
1165 also terminate a final non-empty argument. (However, a newline
1166 following a space will not introduce a final empty-string argument;
1167 it only terminates the argument list.)
1168 - The backslash character is the escape character. It escapes
1169 backslash, space, tab, and newline. The ANSI C escape sequences
1170 like \n and \t are also supported. These produce argument
1171 constituents; the two-character combination \n doesn't act like a
1172 terminating newline. The escape sequence \NNN for exactly three
1173 octal digits reads as the character whose ASCII code is NNN. As
1174 above, characters produced this way are argument constituents.
1175 Backslash followed by other characters is not allowed.
1176
1177 * Changes to the procedure for linking libguile with your programs
1178
1179 ** Guile now builds and installs a shared guile library, if your
1180 system support shared libraries. (It still builds a static library on
1181 all systems.) Guile automatically detects whether your system
1182 supports shared libraries. To prevent Guile from buildisg shared
1183 libraries, pass the `--disable-shared' flag to the configure script.
1184
1185 Guile takes longer to compile when it builds shared libraries, because
1186 it must compile every file twice --- once to produce position-
1187 independent object code, and once to produce normal object code.
1188
1189 ** The libthreads library has been merged into libguile.
1190
1191 To link a program against Guile, you now need only link against
1192 -lguile and -lqt; -lthreads is no longer needed. If you are using
1193 autoconf to generate configuration scripts for your application, the
1194 following lines should suffice to add the appropriate libraries to
1195 your link command:
1196
1197 ### Find quickthreads and libguile.
1198 AC_CHECK_LIB(qt, main)
1199 AC_CHECK_LIB(guile, scm_shell)
1200
1201 * Changes to Scheme functions
1202
1203 ** Guile Scheme's special syntax for keyword objects is now optional,
1204 and disabled by default.
1205
1206 The syntax variation from R4RS made it difficult to port some
1207 interesting packages to Guile. The routines which accepted keyword
1208 arguments (mostly in the module system) have been modified to also
1209 accept symbols whose names begin with `:'.
1210
1211 To change the keyword syntax, you must first import the (ice-9 debug)
1212 module:
1213 (use-modules (ice-9 debug))
1214
1215 Then you can enable the keyword syntax as follows:
1216 (read-set! keywords 'prefix)
1217
1218 To disable keyword syntax, do this:
1219 (read-set! keywords #f)
1220
1221 ** Many more primitive functions accept shared substrings as
1222 arguments. In the past, these functions required normal, mutable
1223 strings as arguments, although they never made use of this
1224 restriction.
1225
1226 ** The uniform array functions now operate on byte vectors. These
1227 functions are `array-fill!', `serial-array-copy!', `array-copy!',
1228 `serial-array-map', `array-map', `array-for-each', and
1229 `array-index-map!'.
1230
1231 ** The new functions `trace' and `untrace' implement simple debugging
1232 support for Scheme functions.
1233
1234 The `trace' function accepts any number of procedures as arguments,
1235 and tells the Guile interpreter to display each procedure's name and
1236 arguments each time the procedure is invoked. When invoked with no
1237 arguments, `trace' returns the list of procedures currently being
1238 traced.
1239
1240 The `untrace' function accepts any number of procedures as arguments,
1241 and tells the Guile interpreter not to trace them any more. When
1242 invoked with no arguments, `untrace' untraces all curretly traced
1243 procedures.
1244
1245 The tracing in Guile has an advantage over most other systems: we
1246 don't create new procedure objects, but mark the procedure objects
1247 themselves. This means that anonymous and internal procedures can be
1248 traced.
1249
1250 ** The function `assert-repl-prompt' has been renamed to
1251 `set-repl-prompt!'. It takes one argument, PROMPT.
1252 - If PROMPT is #f, the Guile read-eval-print loop will not prompt.
1253 - If PROMPT is a string, we use it as a prompt.
1254 - If PROMPT is a procedure accepting no arguments, we call it, and
1255 display the result as a prompt.
1256 - Otherwise, we display "> ".
1257
1258 ** The new function `eval-string' reads Scheme expressions from a
1259 string and evaluates them, returning the value of the last expression
1260 in the string. If the string contains no expressions, it returns an
1261 unspecified value.
1262
1263 ** The new function `thunk?' returns true iff its argument is a
1264 procedure of zero arguments.
1265
1266 ** `defined?' is now a builtin function, instead of syntax. This
1267 means that its argument should be quoted. It returns #t iff its
1268 argument is bound in the current module.
1269
1270 ** The new syntax `use-modules' allows you to add new modules to your
1271 environment without re-typing a complete `define-module' form. It
1272 accepts any number of module names as arguments, and imports their
1273 public bindings into the current module.
1274
1275 ** The new function (module-defined? NAME MODULE) returns true iff
1276 NAME, a symbol, is defined in MODULE, a module object.
1277
1278 ** The new function `builtin-bindings' creates and returns a hash
1279 table containing copies of all the root module's bindings.
1280
1281 ** The new function `builtin-weak-bindings' does the same as
1282 `builtin-bindings', but creates a doubly-weak hash table.
1283
1284 ** The `equal?' function now considers variable objects to be
1285 equivalent if they have the same name and the same value.
1286
1287 ** The new function `command-line' returns the command-line arguments
1288 given to Guile, as a list of strings.
1289
1290 When using guile as a script interpreter, `command-line' returns the
1291 script's arguments; those processed by the interpreter (like `-s' or
1292 `-c') are omitted. (In other words, you get the normal, expected
1293 behavior.) Any application that uses scm_shell to process its
1294 command-line arguments gets this behavior as well.
1295
1296 ** The new function `load-user-init' looks for a file called `.guile'
1297 in the user's home directory, and loads it if it exists. This is
1298 mostly for use by the code generated by scm_compile_shell_switches,
1299 but we thought it might also be useful in other circumstances.
1300
1301 ** The new function `log10' returns the base-10 logarithm of its
1302 argument.
1303
1304 ** Changes to I/O functions
1305
1306 *** The functions `read', `primitive-load', `read-and-eval!', and
1307 `primitive-load-path' no longer take optional arguments controlling
1308 case insensitivity and a `#' parser.
1309
1310 Case sensitivity is now controlled by a read option called
1311 `case-insensitive'. The user can add new `#' syntaxes with the
1312 `read-hash-extend' function (see below).
1313
1314 *** The new function `read-hash-extend' allows the user to change the
1315 syntax of Guile Scheme in a somewhat controlled way.
1316
1317 (read-hash-extend CHAR PROC)
1318 When parsing S-expressions, if we read a `#' character followed by
1319 the character CHAR, use PROC to parse an object from the stream.
1320 If PROC is #f, remove any parsing procedure registered for CHAR.
1321
1322 The reader applies PROC to two arguments: CHAR and an input port.
1323
1324 *** The new functions read-delimited and read-delimited! provide a
1325 general mechanism for doing delimited input on streams.
1326
1327 (read-delimited DELIMS [PORT HANDLE-DELIM])
1328 Read until we encounter one of the characters in DELIMS (a string),
1329 or end-of-file. PORT is the input port to read from; it defaults to
1330 the current input port. The HANDLE-DELIM parameter determines how
1331 the terminating character is handled; it should be one of the
1332 following symbols:
1333
1334 'trim omit delimiter from result
1335 'peek leave delimiter character in input stream
1336 'concat append delimiter character to returned value
1337 'split return a pair: (RESULT . TERMINATOR)
1338
1339 HANDLE-DELIM defaults to 'peek.
1340
1341 (read-delimited! DELIMS BUF [PORT HANDLE-DELIM START END])
1342 A side-effecting variant of `read-delimited'.
1343
1344 The data is written into the string BUF at the indices in the
1345 half-open interval [START, END); the default interval is the whole
1346 string: START = 0 and END = (string-length BUF). The values of
1347 START and END must specify a well-defined interval in BUF, i.e.
1348 0 <= START <= END <= (string-length BUF).
1349
1350 It returns NBYTES, the number of bytes read. If the buffer filled
1351 up without a delimiter character being found, it returns #f. If the
1352 port is at EOF when the read starts, it returns the EOF object.
1353
1354 If an integer is returned (i.e., the read is successfully terminated
1355 by reading a delimiter character), then the HANDLE-DELIM parameter
1356 determines how to handle the terminating character. It is described
1357 above, and defaults to 'peek.
1358
1359 (The descriptions of these functions were borrowed from the SCSH
1360 manual, by Olin Shivers and Brian Carlstrom.)
1361
1362 *** The `%read-delimited!' function is the primitive used to implement
1363 `read-delimited' and `read-delimited!'.
1364
1365 (%read-delimited! DELIMS BUF GOBBLE? [PORT START END])
1366
1367 This returns a pair of values: (TERMINATOR . NUM-READ).
1368 - TERMINATOR describes why the read was terminated. If it is a
1369 character or the eof object, then that is the value that terminated
1370 the read. If it is #f, the function filled the buffer without finding
1371 a delimiting character.
1372 - NUM-READ is the number of characters read into BUF.
1373
1374 If the read is successfully terminated by reading a delimiter
1375 character, then the gobble? parameter determines what to do with the
1376 terminating character. If true, the character is removed from the
1377 input stream; if false, the character is left in the input stream
1378 where a subsequent read operation will retrieve it. In either case,
1379 the character is also the first value returned by the procedure call.
1380
1381 (The descriptions of this function was borrowed from the SCSH manual,
1382 by Olin Shivers and Brian Carlstrom.)
1383
1384 *** The `read-line' and `read-line!' functions have changed; they now
1385 trim the terminator by default; previously they appended it to the
1386 returned string. For the old behavior, use (read-line PORT 'concat).
1387
1388 *** The functions `uniform-array-read!' and `uniform-array-write!' now
1389 take new optional START and END arguments, specifying the region of
1390 the array to read and write.
1391
1392 *** The `ungetc-char-ready?' function has been removed. We feel it's
1393 inappropriate for an interface to expose implementation details this
1394 way.
1395
1396 ** Changes to the Unix library and system call interface
1397
1398 *** The new fcntl function provides access to the Unix `fcntl' system
1399 call.
1400
1401 (fcntl PORT COMMAND VALUE)
1402 Apply COMMAND to PORT's file descriptor, with VALUE as an argument.
1403 Values for COMMAND are:
1404
1405 F_DUPFD duplicate a file descriptor
1406 F_GETFD read the descriptor's close-on-exec flag
1407 F_SETFD set the descriptor's close-on-exec flag to VALUE
1408 F_GETFL read the descriptor's flags, as set on open
1409 F_SETFL set the descriptor's flags, as set on open to VALUE
1410 F_GETOWN return the process ID of a socket's owner, for SIGIO
1411 F_SETOWN set the process that owns a socket to VALUE, for SIGIO
1412 FD_CLOEXEC not sure what this is
1413
1414 For details, see the documentation for the fcntl system call.
1415
1416 *** The arguments to `select' have changed, for compatibility with
1417 SCSH. The TIMEOUT parameter may now be non-integral, yielding the
1418 expected behavior. The MILLISECONDS parameter has been changed to
1419 MICROSECONDS, to more closely resemble the underlying system call.
1420 The RVEC, WVEC, and EVEC arguments can now be vectors; the type of the
1421 corresponding return set will be the same.
1422
1423 *** The arguments to the `mknod' system call have changed. They are
1424 now:
1425
1426 (mknod PATH TYPE PERMS DEV)
1427 Create a new file (`node') in the file system. PATH is the name of
1428 the file to create. TYPE is the kind of file to create; it should
1429 be 'fifo, 'block-special, or 'char-special. PERMS specifies the
1430 permission bits to give the newly created file. If TYPE is
1431 'block-special or 'char-special, DEV specifies which device the
1432 special file refers to; its interpretation depends on the kind of
1433 special file being created.
1434
1435 *** The `fork' function has been renamed to `primitive-fork', to avoid
1436 clashing with various SCSH forks.
1437
1438 *** The `recv' and `recvfrom' functions have been renamed to `recv!'
1439 and `recvfrom!'. They no longer accept a size for a second argument;
1440 you must pass a string to hold the received value. They no longer
1441 return the buffer. Instead, `recv' returns the length of the message
1442 received, and `recvfrom' returns a pair containing the packet's length
1443 and originating address.
1444
1445 *** The file descriptor datatype has been removed, as have the
1446 `read-fd', `write-fd', `close', `lseek', and `dup' functions.
1447 We plan to replace these functions with a SCSH-compatible interface.
1448
1449 *** The `create' function has been removed; it's just a special case
1450 of `open'.
1451
1452 *** There are new functions to break down process termination status
1453 values. In the descriptions below, STATUS is a value returned by
1454 `waitpid'.
1455
1456 (status:exit-val STATUS)
1457 If the child process exited normally, this function returns the exit
1458 code for the child process (i.e., the value passed to exit, or
1459 returned from main). If the child process did not exit normally,
1460 this function returns #f.
1461
1462 (status:stop-sig STATUS)
1463 If the child process was suspended by a signal, this function
1464 returns the signal that suspended the child. Otherwise, it returns
1465 #f.
1466
1467 (status:term-sig STATUS)
1468 If the child process terminated abnormally, this function returns
1469 the signal that terminated the child. Otherwise, this function
1470 returns false.
1471
1472 POSIX promises that exactly one of these functions will return true on
1473 a valid STATUS value.
1474
1475 These functions are compatible with SCSH.
1476
1477 *** There are new accessors and setters for the broken-out time vectors
1478 returned by `localtime', `gmtime', and that ilk. They are:
1479
1480 Component Accessor Setter
1481 ========================= ============ ============
1482 seconds tm:sec set-tm:sec
1483 minutes tm:min set-tm:min
1484 hours tm:hour set-tm:hour
1485 day of the month tm:mday set-tm:mday
1486 month tm:mon set-tm:mon
1487 year tm:year set-tm:year
1488 day of the week tm:wday set-tm:wday
1489 day in the year tm:yday set-tm:yday
1490 daylight saving time tm:isdst set-tm:isdst
1491 GMT offset, seconds tm:gmtoff set-tm:gmtoff
1492 name of time zone tm:zone set-tm:zone
1493
1494 *** There are new accessors for the vectors returned by `uname',
1495 describing the host system:
1496
1497 Component Accessor
1498 ============================================== ================
1499 name of the operating system implementation utsname:sysname
1500 network name of this machine utsname:nodename
1501 release level of the operating system utsname:release
1502 version level of the operating system utsname:version
1503 machine hardware platform utsname:machine
1504
1505 *** There are new accessors for the vectors returned by `getpw',
1506 `getpwnam', `getpwuid', and `getpwent', describing entries from the
1507 system's user database:
1508
1509 Component Accessor
1510 ====================== =================
1511 user name passwd:name
1512 user password passwd:passwd
1513 user id passwd:uid
1514 group id passwd:gid
1515 real name passwd:gecos
1516 home directory passwd:dir
1517 shell program passwd:shell
1518
1519 *** There are new accessors for the vectors returned by `getgr',
1520 `getgrnam', `getgrgid', and `getgrent', describing entries from the
1521 system's group database:
1522
1523 Component Accessor
1524 ======================= ============
1525 group name group:name
1526 group password group:passwd
1527 group id group:gid
1528 group members group:mem
1529
1530 *** There are new accessors for the vectors returned by `gethost',
1531 `gethostbyaddr', `gethostbyname', and `gethostent', describing
1532 internet hosts:
1533
1534 Component Accessor
1535 ========================= ===============
1536 official name of host hostent:name
1537 alias list hostent:aliases
1538 host address type hostent:addrtype
1539 length of address hostent:length
1540 list of addresses hostent:addr-list
1541
1542 *** There are new accessors for the vectors returned by `getnet',
1543 `getnetbyaddr', `getnetbyname', and `getnetent', describing internet
1544 networks:
1545
1546 Component Accessor
1547 ========================= ===============
1548 official name of net netent:name
1549 alias list netent:aliases
1550 net number type netent:addrtype
1551 net number netent:net
1552
1553 *** There are new accessors for the vectors returned by `getproto',
1554 `getprotobyname', `getprotobynumber', and `getprotoent', describing
1555 internet protocols:
1556
1557 Component Accessor
1558 ========================= ===============
1559 official protocol name protoent:name
1560 alias list protoent:aliases
1561 protocol number protoent:proto
1562
1563 *** There are new accessors for the vectors returned by `getserv',
1564 `getservbyname', `getservbyport', and `getservent', describing
1565 internet protocols:
1566
1567 Component Accessor
1568 ========================= ===============
1569 official service name servent:name
1570 alias list servent:aliases
1571 port number servent:port
1572 protocol to use servent:proto
1573
1574 *** There are new accessors for the sockaddr structures returned by
1575 `accept', `getsockname', `getpeername', `recvfrom!':
1576
1577 Component Accessor
1578 ======================================== ===============
1579 address format (`family') sockaddr:fam
1580 path, for file domain addresses sockaddr:path
1581 address, for internet domain addresses sockaddr:addr
1582 TCP or UDP port, for internet sockaddr:port
1583
1584 *** The `getpwent', `getgrent', `gethostent', `getnetent',
1585 `getprotoent', and `getservent' functions now return #f at the end of
1586 the user database. (They used to throw an exception.)
1587
1588 Note that calling MUMBLEent function is equivalent to calling the
1589 corresponding MUMBLE function with no arguments.
1590
1591 *** The `setpwent', `setgrent', `sethostent', `setnetent',
1592 `setprotoent', and `setservent' routines now take no arguments.
1593
1594 *** The `gethost', `getproto', `getnet', and `getserv' functions now
1595 provide more useful information when they throw an exception.
1596
1597 *** The `lnaof' function has been renamed to `inet-lnaof'.
1598
1599 *** Guile now claims to have the `current-time' feature.
1600
1601 *** The `mktime' function now takes an optional second argument ZONE,
1602 giving the time zone to use for the conversion. ZONE should be a
1603 string, in the same format as expected for the "TZ" environment variable.
1604
1605 *** The `strptime' function now returns a pair (TIME . COUNT), where
1606 TIME is the parsed time as a vector, and COUNT is the number of
1607 characters from the string left unparsed. This function used to
1608 return the remaining characters as a string.
1609
1610 *** The `gettimeofday' function has replaced the old `time+ticks' function.
1611 The return value is now (SECONDS . MICROSECONDS); the fractional
1612 component is no longer expressed in "ticks".
1613
1614 *** The `ticks/sec' constant has been removed, in light of the above change.
1615
1616 * Changes to the gh_ interface
1617
1618 ** gh_eval_str() now returns an SCM object which is the result of the
1619 evaluation
1620
1621 ** gh_scm2str() now copies the Scheme data to a caller-provided C
1622 array
1623
1624 ** gh_scm2newstr() now makes a C array, copies the Scheme data to it,
1625 and returns the array
1626
1627 ** gh_scm2str0() is gone: there is no need to distinguish
1628 null-terminated from non-null-terminated, since gh_scm2newstr() allows
1629 the user to interpret the data both ways.
1630
1631 * Changes to the scm_ interface
1632
1633 ** The new function scm_symbol_value0 provides an easy way to get a
1634 symbol's value from C code:
1635
1636 SCM scm_symbol_value0 (char *NAME)
1637 Return the value of the symbol named by the null-terminated string
1638 NAME in the current module. If the symbol named NAME is unbound in
1639 the current module, return SCM_UNDEFINED.
1640
1641 ** The new function scm_sysintern0 creates new top-level variables,
1642 without assigning them a value.
1643
1644 SCM scm_sysintern0 (char *NAME)
1645 Create a new Scheme top-level variable named NAME. NAME is a
1646 null-terminated string. Return the variable's value cell.
1647
1648 ** The function scm_internal_catch is the guts of catch. It handles
1649 all the mechanics of setting up a catch target, invoking the catch
1650 body, and perhaps invoking the handler if the body does a throw.
1651
1652 The function is designed to be usable from C code, but is general
1653 enough to implement all the semantics Guile Scheme expects from throw.
1654
1655 TAG is the catch tag. Typically, this is a symbol, but this function
1656 doesn't actually care about that.
1657
1658 BODY is a pointer to a C function which runs the body of the catch;
1659 this is the code you can throw from. We call it like this:
1660 BODY (BODY_DATA, JMPBUF)
1661 where:
1662 BODY_DATA is just the BODY_DATA argument we received; we pass it
1663 through to BODY as its first argument. The caller can make
1664 BODY_DATA point to anything useful that BODY might need.
1665 JMPBUF is the Scheme jmpbuf object corresponding to this catch,
1666 which we have just created and initialized.
1667
1668 HANDLER is a pointer to a C function to deal with a throw to TAG,
1669 should one occur. We call it like this:
1670 HANDLER (HANDLER_DATA, THROWN_TAG, THROW_ARGS)
1671 where
1672 HANDLER_DATA is the HANDLER_DATA argument we recevied; it's the
1673 same idea as BODY_DATA above.
1674 THROWN_TAG is the tag that the user threw to; usually this is
1675 TAG, but it could be something else if TAG was #t (i.e., a
1676 catch-all), or the user threw to a jmpbuf.
1677 THROW_ARGS is the list of arguments the user passed to the THROW
1678 function.
1679
1680 BODY_DATA is just a pointer we pass through to BODY. HANDLER_DATA
1681 is just a pointer we pass through to HANDLER. We don't actually
1682 use either of those pointers otherwise ourselves. The idea is
1683 that, if our caller wants to communicate something to BODY or
1684 HANDLER, it can pass a pointer to it as MUMBLE_DATA, which BODY and
1685 HANDLER can then use. Think of it as a way to make BODY and
1686 HANDLER closures, not just functions; MUMBLE_DATA points to the
1687 enclosed variables.
1688
1689 Of course, it's up to the caller to make sure that any data a
1690 MUMBLE_DATA needs is protected from GC. A common way to do this is
1691 to make MUMBLE_DATA a pointer to data stored in an automatic
1692 structure variable; since the collector must scan the stack for
1693 references anyway, this assures that any references in MUMBLE_DATA
1694 will be found.
1695
1696 ** The new function scm_internal_lazy_catch is exactly like
1697 scm_internal_catch, except:
1698
1699 - It does not unwind the stack (this is the major difference).
1700 - If handler returns, its value is returned from the throw.
1701 - BODY always receives #f as its JMPBUF argument (since there's no
1702 jmpbuf associated with a lazy catch, because we don't unwind the
1703 stack.)
1704
1705 ** scm_body_thunk is a new body function you can pass to
1706 scm_internal_catch if you want the body to be like Scheme's `catch'
1707 --- a thunk, or a function of one argument if the tag is #f.
1708
1709 BODY_DATA is a pointer to a scm_body_thunk_data structure, which
1710 contains the Scheme procedure to invoke as the body, and the tag
1711 we're catching. If the tag is #f, then we pass JMPBUF (created by
1712 scm_internal_catch) to the body procedure; otherwise, the body gets
1713 no arguments.
1714
1715 ** scm_handle_by_proc is a new handler function you can pass to
1716 scm_internal_catch if you want the handler to act like Scheme's catch
1717 --- call a procedure with the tag and the throw arguments.
1718
1719 If the user does a throw to this catch, this function runs a handler
1720 procedure written in Scheme. HANDLER_DATA is a pointer to an SCM
1721 variable holding the Scheme procedure object to invoke. It ought to
1722 be a pointer to an automatic variable (i.e., one living on the stack),
1723 or the procedure object should be otherwise protected from GC.
1724
1725 ** scm_handle_by_message is a new handler function to use with
1726 `scm_internal_catch' if you want Guile to print a message and die.
1727 It's useful for dealing with throws to uncaught keys at the top level.
1728
1729 HANDLER_DATA, if non-zero, is assumed to be a char * pointing to a
1730 message header to print; if zero, we use "guile" instead. That
1731 text is followed by a colon, then the message described by ARGS.
1732
1733 ** The return type of scm_boot_guile is now void; the function does
1734 not return a value, and indeed, never returns at all.
1735
1736 ** The new function scm_shell makes it easy for user applications to
1737 process command-line arguments in a way that is compatible with the
1738 stand-alone guile interpreter (which is in turn compatible with SCSH,
1739 the Scheme shell).
1740
1741 To use the scm_shell function, first initialize any guile modules
1742 linked into your application, and then call scm_shell with the values
1743 of ARGC and ARGV your `main' function received. scm_shell will add
1744 any SCSH-style meta-arguments from the top of the script file to the
1745 argument vector, and then process the command-line arguments. This
1746 generally means loading a script file or starting up an interactive
1747 command interpreter. For details, see "Changes to the stand-alone
1748 interpreter" above.
1749
1750 ** The new functions scm_get_meta_args and scm_count_argv help you
1751 implement the SCSH-style meta-argument, `\'.
1752
1753 char **scm_get_meta_args (int ARGC, char **ARGV)
1754 If the second element of ARGV is a string consisting of a single
1755 backslash character (i.e. "\\" in Scheme notation), open the file
1756 named by the following argument, parse arguments from it, and return
1757 the spliced command line. The returned array is terminated by a
1758 null pointer.
1759
1760 For details of argument parsing, see above, under "guile now accepts
1761 command-line arguments compatible with SCSH..."
1762
1763 int scm_count_argv (char **ARGV)
1764 Count the arguments in ARGV, assuming it is terminated by a null
1765 pointer.
1766
1767 For an example of how these functions might be used, see the source
1768 code for the function scm_shell in libguile/script.c.
1769
1770 You will usually want to use scm_shell instead of calling this
1771 function yourself.
1772
1773 ** The new function scm_compile_shell_switches turns an array of
1774 command-line arguments into Scheme code to carry out the actions they
1775 describe. Given ARGC and ARGV, it returns a Scheme expression to
1776 evaluate, and calls scm_set_program_arguments to make any remaining
1777 command-line arguments available to the Scheme code. For example,
1778 given the following arguments:
1779
1780 -e main -s ekko a speckled gecko
1781
1782 scm_set_program_arguments will return the following expression:
1783
1784 (begin (load "ekko") (main (command-line)) (quit))
1785
1786 You will usually want to use scm_shell instead of calling this
1787 function yourself.
1788
1789 ** The function scm_shell_usage prints a usage message appropriate for
1790 an interpreter that uses scm_compile_shell_switches to handle its
1791 command-line arguments.
1792
1793 void scm_shell_usage (int FATAL, char *MESSAGE)
1794 Print a usage message to the standard error output. If MESSAGE is
1795 non-zero, write it before the usage message, followed by a newline.
1796 If FATAL is non-zero, exit the process, using FATAL as the
1797 termination status. (If you want to be compatible with Guile,
1798 always use 1 as the exit status when terminating due to command-line
1799 usage problems.)
1800
1801 You will usually want to use scm_shell instead of calling this
1802 function yourself.
1803
1804 ** scm_eval_0str now returns SCM_UNSPECIFIED if the string contains no
1805 expressions. It used to return SCM_EOL. Earth-shattering.
1806
1807 ** The macros for declaring scheme objects in C code have been
1808 rearranged slightly. They are now:
1809
1810 SCM_SYMBOL (C_NAME, SCHEME_NAME)
1811 Declare a static SCM variable named C_NAME, and initialize it to
1812 point to the Scheme symbol whose name is SCHEME_NAME. C_NAME should
1813 be a C identifier, and SCHEME_NAME should be a C string.
1814
1815 SCM_GLOBAL_SYMBOL (C_NAME, SCHEME_NAME)
1816 Just like SCM_SYMBOL, but make C_NAME globally visible.
1817
1818 SCM_VCELL (C_NAME, SCHEME_NAME)
1819 Create a global variable at the Scheme level named SCHEME_NAME.
1820 Declare a static SCM variable named C_NAME, and initialize it to
1821 point to the Scheme variable's value cell.
1822
1823 SCM_GLOBAL_VCELL (C_NAME, SCHEME_NAME)
1824 Just like SCM_VCELL, but make C_NAME globally visible.
1825
1826 The `guile-snarf' script writes initialization code for these macros
1827 to its standard output, given C source code as input.
1828
1829 The SCM_GLOBAL macro is gone.
1830
1831 ** The scm_read_line and scm_read_line_x functions have been replaced
1832 by Scheme code based on the %read-delimited! procedure (known to C
1833 code as scm_read_delimited_x). See its description above for more
1834 information.
1835
1836 ** The function scm_sys_open has been renamed to scm_open. It now
1837 returns a port instead of an FD object.
1838
1839 * The dynamic linking support has changed. For more information, see
1840 libguile/DYNAMIC-LINKING.
1841
1842 \f
1843 Guile 1.0b3
1844
1845 User-visible changes from Thursday, September 5, 1996 until Guile 1.0
1846 (Sun 5 Jan 1997):
1847
1848 * Changes to the 'guile' program:
1849
1850 ** Guile now loads some new files when it starts up. Guile first
1851 searches the load path for init.scm, and loads it if found. Then, if
1852 Guile is not being used to execute a script, and the user's home
1853 directory contains a file named `.guile', Guile loads that.
1854
1855 ** You can now use Guile as a shell script interpreter.
1856
1857 To paraphrase the SCSH manual:
1858
1859 When Unix tries to execute an executable file whose first two
1860 characters are the `#!', it treats the file not as machine code to
1861 be directly executed by the native processor, but as source code
1862 to be executed by some interpreter. The interpreter to use is
1863 specified immediately after the #! sequence on the first line of
1864 the source file. The kernel reads in the name of the interpreter,
1865 and executes that instead. It passes the interpreter the source
1866 filename as its first argument, with the original arguments
1867 following. Consult the Unix man page for the `exec' system call
1868 for more information.
1869
1870 Now you can use Guile as an interpreter, using a mechanism which is a
1871 compatible subset of that provided by SCSH.
1872
1873 Guile now recognizes a '-s' command line switch, whose argument is the
1874 name of a file of Scheme code to load. It also treats the two
1875 characters `#!' as the start of a comment, terminated by `!#'. Thus,
1876 to make a file of Scheme code directly executable by Unix, insert the
1877 following two lines at the top of the file:
1878
1879 #!/usr/local/bin/guile -s
1880 !#
1881
1882 Guile treats the argument of the `-s' command-line switch as the name
1883 of a file of Scheme code to load, and treats the sequence `#!' as the
1884 start of a block comment, terminated by `!#'.
1885
1886 For example, here's a version of 'echo' written in Scheme:
1887
1888 #!/usr/local/bin/guile -s
1889 !#
1890 (let loop ((args (cdr (program-arguments))))
1891 (if (pair? args)
1892 (begin
1893 (display (car args))
1894 (if (pair? (cdr args))
1895 (display " "))
1896 (loop (cdr args)))))
1897 (newline)
1898
1899 Why does `#!' start a block comment terminated by `!#', instead of the
1900 end of the line? That is the notation SCSH uses, and although we
1901 don't yet support the other SCSH features that motivate that choice,
1902 we would like to be backward-compatible with any existing Guile
1903 scripts once we do. Furthermore, if the path to Guile on your system
1904 is too long for your kernel, you can start the script with this
1905 horrible hack:
1906
1907 #!/bin/sh
1908 exec /really/long/path/to/guile -s "$0" ${1+"$@"}
1909 !#
1910
1911 Note that some very old Unix systems don't support the `#!' syntax.
1912
1913
1914 ** You can now run Guile without installing it.
1915
1916 Previous versions of the interactive Guile interpreter (`guile')
1917 couldn't start up unless Guile's Scheme library had been installed;
1918 they used the value of the environment variable `SCHEME_LOAD_PATH'
1919 later on in the startup process, but not to find the startup code
1920 itself. Now Guile uses `SCHEME_LOAD_PATH' in all searches for Scheme
1921 code.
1922
1923 To run Guile without installing it, build it in the normal way, and
1924 then set the environment variable `SCHEME_LOAD_PATH' to a
1925 colon-separated list of directories, including the top-level directory
1926 of the Guile sources. For example, if you unpacked Guile so that the
1927 full filename of this NEWS file is /home/jimb/guile-1.0b3/NEWS, then
1928 you might say
1929
1930 export SCHEME_LOAD_PATH=/home/jimb/my-scheme:/home/jimb/guile-1.0b3
1931
1932
1933 ** Guile's read-eval-print loop no longer prints #<unspecified>
1934 results. If the user wants to see this, she can evaluate the
1935 expression (assert-repl-print-unspecified #t), perhaps in her startup
1936 file.
1937
1938 ** Guile no longer shows backtraces by default when an error occurs;
1939 however, it does display a message saying how to get one, and how to
1940 request that they be displayed by default. After an error, evaluate
1941 (backtrace)
1942 to see a backtrace, and
1943 (debug-enable 'backtrace)
1944 to see them by default.
1945
1946
1947
1948 * Changes to Guile Scheme:
1949
1950 ** Guile now distinguishes between #f and the empty list.
1951
1952 This is for compatibility with the IEEE standard, the (possibly)
1953 upcoming Revised^5 Report on Scheme, and many extant Scheme
1954 implementations.
1955
1956 Guile used to have #f and '() denote the same object, to make Scheme's
1957 type system more compatible with Emacs Lisp's. However, the change
1958 caused too much trouble for Scheme programmers, and we found another
1959 way to reconcile Emacs Lisp with Scheme that didn't require this.
1960
1961
1962 ** Guile's delq, delv, delete functions, and their destructive
1963 counterparts, delq!, delv!, and delete!, now remove all matching
1964 elements from the list, not just the first. This matches the behavior
1965 of the corresponding Emacs Lisp functions, and (I believe) the Maclisp
1966 functions which inspired them.
1967
1968 I recognize that this change may break code in subtle ways, but it
1969 seems best to make the change before the FSF's first Guile release,
1970 rather than after.
1971
1972
1973 ** The compiled-library-path function has been deleted from libguile.
1974
1975 ** The facilities for loading Scheme source files have changed.
1976
1977 *** The variable %load-path now tells Guile which directories to search
1978 for Scheme code. Its value is a list of strings, each of which names
1979 a directory.
1980
1981 *** The variable %load-extensions now tells Guile which extensions to
1982 try appending to a filename when searching the load path. Its value
1983 is a list of strings. Its default value is ("" ".scm").
1984
1985 *** (%search-load-path FILENAME) searches the directories listed in the
1986 value of the %load-path variable for a Scheme file named FILENAME,
1987 with all the extensions listed in %load-extensions. If it finds a
1988 match, then it returns its full filename. If FILENAME is absolute, it
1989 returns it unchanged. Otherwise, it returns #f.
1990
1991 %search-load-path will not return matches that refer to directories.
1992
1993 *** (primitive-load FILENAME :optional CASE-INSENSITIVE-P SHARP)
1994 uses %seach-load-path to find a file named FILENAME, and loads it if
1995 it finds it. If it can't read FILENAME for any reason, it throws an
1996 error.
1997
1998 The arguments CASE-INSENSITIVE-P and SHARP are interpreted as by the
1999 `read' function.
2000
2001 *** load uses the same searching semantics as primitive-load.
2002
2003 *** The functions %try-load, try-load-with-path, %load, load-with-path,
2004 basic-try-load-with-path, basic-load-with-path, try-load-module-with-
2005 path, and load-module-with-path have been deleted. The functions
2006 above should serve their purposes.
2007
2008 *** If the value of the variable %load-hook is a procedure,
2009 `primitive-load' applies its value to the name of the file being
2010 loaded (without the load path directory name prepended). If its value
2011 is #f, it is ignored. Otherwise, an error occurs.
2012
2013 This is mostly useful for printing load notification messages.
2014
2015
2016 ** The function `eval!' is no longer accessible from the scheme level.
2017 We can't allow operations which introduce glocs into the scheme level,
2018 because Guile's type system can't handle these as data. Use `eval' or
2019 `read-and-eval!' (see below) as replacement.
2020
2021 ** The new function read-and-eval! reads an expression from PORT,
2022 evaluates it, and returns the result. This is more efficient than
2023 simply calling `read' and `eval', since it is not necessary to make a
2024 copy of the expression for the evaluator to munge.
2025
2026 Its optional arguments CASE_INSENSITIVE_P and SHARP are interpreted as
2027 for the `read' function.
2028
2029
2030 ** The function `int?' has been removed; its definition was identical
2031 to that of `integer?'.
2032
2033 ** The functions `<?', `<?', `<=?', `=?', `>?', and `>=?'. Code should
2034 use the R4RS names for these functions.
2035
2036 ** The function object-properties no longer returns the hash handle;
2037 it simply returns the object's property list.
2038
2039 ** Many functions have been changed to throw errors, instead of
2040 returning #f on failure. The point of providing exception handling in
2041 the language is to simplify the logic of user code, but this is less
2042 useful if Guile's primitives don't throw exceptions.
2043
2044 ** The function `fileno' has been renamed from `%fileno'.
2045
2046 ** The function primitive-mode->fdes returns #t or #f now, not 1 or 0.
2047
2048
2049 * Changes to Guile's C interface:
2050
2051 ** The library's initialization procedure has been simplified.
2052 scm_boot_guile now has the prototype:
2053
2054 void scm_boot_guile (int ARGC,
2055 char **ARGV,
2056 void (*main_func) (),
2057 void *closure);
2058
2059 scm_boot_guile calls MAIN_FUNC, passing it CLOSURE, ARGC, and ARGV.
2060 MAIN_FUNC should do all the work of the program (initializing other
2061 packages, reading user input, etc.) before returning. When MAIN_FUNC
2062 returns, call exit (0); this function never returns. If you want some
2063 other exit value, MAIN_FUNC may call exit itself.
2064
2065 scm_boot_guile arranges for program-arguments to return the strings
2066 given by ARGC and ARGV. If MAIN_FUNC modifies ARGC/ARGV, should call
2067 scm_set_program_arguments with the final list, so Scheme code will
2068 know which arguments have been processed.
2069
2070 scm_boot_guile establishes a catch-all catch handler which prints an
2071 error message and exits the process. This means that Guile exits in a
2072 coherent way when system errors occur and the user isn't prepared to
2073 handle it. If the user doesn't like this behavior, they can establish
2074 their own universal catcher in MAIN_FUNC to shadow this one.
2075
2076 Why must the caller do all the real work from MAIN_FUNC? The garbage
2077 collector assumes that all local variables of type SCM will be above
2078 scm_boot_guile's stack frame on the stack. If you try to manipulate
2079 SCM values after this function returns, it's the luck of the draw
2080 whether the GC will be able to find the objects you allocate. So,
2081 scm_boot_guile function exits, rather than returning, to discourage
2082 people from making that mistake.
2083
2084 The IN, OUT, and ERR arguments were removed; there are other
2085 convenient ways to override these when desired.
2086
2087 The RESULT argument was deleted; this function should never return.
2088
2089 The BOOT_CMD argument was deleted; the MAIN_FUNC argument is more
2090 general.
2091
2092
2093 ** Guile's header files should no longer conflict with your system's
2094 header files.
2095
2096 In order to compile code which #included <libguile.h>, previous
2097 versions of Guile required you to add a directory containing all the
2098 Guile header files to your #include path. This was a problem, since
2099 Guile's header files have names which conflict with many systems'
2100 header files.
2101
2102 Now only <libguile.h> need appear in your #include path; you must
2103 refer to all Guile's other header files as <libguile/mumble.h>.
2104 Guile's installation procedure puts libguile.h in $(includedir), and
2105 the rest in $(includedir)/libguile.
2106
2107
2108 ** Two new C functions, scm_protect_object and scm_unprotect_object,
2109 have been added to the Guile library.
2110
2111 scm_protect_object (OBJ) protects OBJ from the garbage collector.
2112 OBJ will not be freed, even if all other references are dropped,
2113 until someone does scm_unprotect_object (OBJ). Both functions
2114 return OBJ.
2115
2116 Note that calls to scm_protect_object do not nest. You can call
2117 scm_protect_object any number of times on a given object, and the
2118 next call to scm_unprotect_object will unprotect it completely.
2119
2120 Basically, scm_protect_object and scm_unprotect_object just
2121 maintain a list of references to things. Since the GC knows about
2122 this list, all objects it mentions stay alive. scm_protect_object
2123 adds its argument to the list; scm_unprotect_object remove its
2124 argument from the list.
2125
2126
2127 ** scm_eval_0str now returns the value of the last expression
2128 evaluated.
2129
2130 ** The new function scm_read_0str reads an s-expression from a
2131 null-terminated string, and returns it.
2132
2133 ** The new function `scm_stdio_to_port' converts a STDIO file pointer
2134 to a Scheme port object.
2135
2136 ** The new function `scm_set_program_arguments' allows C code to set
2137 the value teruturned by the Scheme `program-arguments' function.
2138
2139 \f
2140 Older changes:
2141
2142 * Guile no longer includes sophisticated Tcl/Tk support.
2143
2144 The old Tcl/Tk support was unsatisfying to us, because it required the
2145 user to link against the Tcl library, as well as Tk and Guile. The
2146 interface was also un-lispy, in that it preserved Tcl/Tk's practice of
2147 referring to widgets by names, rather than exporting widgets to Scheme
2148 code as a special datatype.
2149
2150 In the Usenix Tk Developer's Workshop held in July 1996, the Tcl/Tk
2151 maintainers described some very interesting changes in progress to the
2152 Tcl/Tk internals, which would facilitate clean interfaces between lone
2153 Tk and other interpreters --- even for garbage-collected languages
2154 like Scheme. They expected the new Tk to be publicly available in the
2155 fall of 1996.
2156
2157 Since it seems that Guile might soon have a new, cleaner interface to
2158 lone Tk, and that the old Guile/Tk glue code would probably need to be
2159 completely rewritten, we (Jim Blandy and Richard Stallman) have
2160 decided not to support the old code. We'll spend the time instead on
2161 a good interface to the newer Tk, as soon as it is available.
2162
2163 Until then, gtcltk-lib provides trivial, low-maintenance functionality.
2164
2165 \f
2166 Copyright information:
2167
2168 Copyright (C) 1996,1997 Free Software Foundation, Inc.
2169
2170 Permission is granted to anyone to make or distribute verbatim copies
2171 of this document as received, in any medium, provided that the
2172 copyright notice and this permission notice are preserved,
2173 thus giving the recipient permission to redistribute in turn.
2174
2175 Permission is granted to distribute modified versions
2176 of this document, or of portions of it,
2177 under the above conditions, provided also that they
2178 carry prominent notices stating who last changed them.
2179
2180 \f
2181 Local variables:
2182 mode: outline
2183 paragraph-separate: "[ \f]*$"
2184 end:
2185