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