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