Commit | Line | Data |
---|---|---|
f7b47737 | 1 | Guile NEWS --- history of user-visible changes. -*- text -*- |
d21ffe26 | 2 | Copyright (C) 1996, 1997, 1998, 1999 Free Software Foundation, Inc. |
5c54da76 JB |
3 | See the end for copying conditions. |
4 | ||
e1b6c710 | 5 | Please send Guile bug reports to bug-guile@gnu.org. |
5c54da76 | 6 | \f |
43fa9a05 JB |
7 | Changes since Guile 1.3.2: |
8 | ||
6822fe53 MD |
9 | * Changes to Scheme functions and syntax |
10 | ||
bc848f7f MD |
11 | ** Hooks |
12 | ||
13 | *** New function: hook? OBJ | |
14 | ||
15 | Return #t if OBJ is a hook, otherwise #f. | |
16 | ||
17 | *** New function: hook-empty? HOOK | |
18 | ||
19 | Return #t if HOOK doesn't contain any procedures, otherwise #f. | |
20 | ||
21 | *** New function: hook->list HOOK | |
22 | ||
23 | Return a list of the procedures that are called when run-hook is | |
24 | applied to HOOK. | |
25 | ||
b074884f JB |
26 | ** `map' signals an error if its argument lists are not all the same length. |
27 | ||
28 | This is the behavior required by R5RS, so this change is really a bug | |
29 | fix. But it seems to affect a lot of people's code, so we're | |
30 | mentioning it here anyway. | |
31 | ||
6822fe53 MD |
32 | ** Print-state handling has been made more transparent |
33 | ||
34 | Under certain circumstances, ports are represented as a port with an | |
35 | associated print state. Earlier, this pair was represented as a pair | |
36 | (see "Some magic has been added to the printer" below). It is now | |
37 | indistinguishable (almost; see `get-print-state') from a port on the | |
38 | user level. | |
39 | ||
40 | *** New function: port-with-print-state OUTPUT-PORT PRINT-STATE | |
41 | ||
42 | Return a new port with the associated print state PRINT-STATE. | |
43 | ||
44 | *** New function: get-print-state OUTPUT-PORT | |
45 | ||
46 | Return the print state associated with this port if it exists, | |
47 | otherwise return #f. | |
48 | ||
77242ff9 GH |
49 | *** New function: directory? OBJECT |
50 | ||
51 | Returns a boolean indicating whether OBJECT is a directory port as | |
52 | returned by `opendir'. | |
53 | ||
49199eaa MD |
54 | * Changes to the scm_ interface |
55 | ||
56 | ** The internal representation of subr's has changed | |
57 | ||
58 | Instead of giving a hint to the subr name, the CAR field of the subr | |
59 | now contains an index to a subr entry in scm_subr_table. | |
60 | ||
61 | *** New variable: scm_subr_table | |
62 | ||
63 | An array of subr entries. A subr entry contains the name, properties | |
64 | and documentation associated with the subr. The properties and | |
65 | documentation slots are not yet used. | |
66 | ||
67 | ** A new scheme for "forwarding" calls to a builtin to a generic function | |
68 | ||
69 | It is now possible to extend the functionality of some Guile | |
70 | primitives by letting them defer a call to a GOOPS generic function on | |
71 | argument mismatch. This functionality is enabled with the GOOPS | |
72 | primitive | |
73 | ||
74 | enable-primitive-generic! PRIMITIVE ... | |
75 | ||
76 | It is then possible to extend the primitive(s) by defining methods for | |
77 | them without loss of efficiency in normal evaluation. | |
78 | ||
79 | Example: | |
80 | ||
81 | (use-modules (oop goops)) | |
82 | (enable-primitive-generic! +) | |
83 | (define-method + ((x <string>) (y <string>)) | |
84 | (string-append x y)) | |
85 | ||
86 | + will still be as efficient as usual in numerical calculations, but | |
87 | can also be used for concatenating strings. | |
88 | ||
89 | Who will be the first one to extend Guile's numerical tower to | |
90 | rationals? :) | |
91 | ||
92 | *** New snarf macros for defining primitives: SCM_GPROC, SCM_GPROC1 | |
93 | ||
94 | New macro: SCM_GPROC (CNAME, SNAME, REQ, OPT, VAR, CFUNC, GENERIC) | |
95 | ||
96 | New macro: SCM_GPROC1 (CNAME, SNAME, TYPE, CFUNC, GENERIC) | |
97 | ||
d02cafe7 | 98 | These do the same job as SCM_PROC and SCM_PROC1, but they also define |
49199eaa MD |
99 | a variable GENERIC which can be used by the dispatch macros below. |
100 | ||
101 | [This is experimental code which may change soon.] | |
102 | ||
103 | *** New macros for forwarding control to a generic on arg type error | |
104 | ||
105 | New macro: SCM_WTA_DISPATCH_1 (GENERIC, ARG1, POS, SUBR) | |
106 | ||
107 | New macro: SCM_WTA_DISPATCH_2 (GENERIC, ARG1, ARG2, POS, SUBR) | |
108 | ||
109 | These correspond to the scm_wta function call, and have the same | |
110 | behaviour until the user has called the GOOPS primitive | |
111 | `enable-primitive-generic!'. After that, these macros will apply the | |
112 | generic function GENERIC to the argument(s) instead of calling | |
113 | scm_wta. | |
114 | ||
115 | [This is experimental code which may change soon.] | |
116 | ||
117 | *** New macros for argument testing with generic dispatch | |
118 | ||
119 | New macro: SCM_GASSERT1 (COND, GENERIC, ARG1, POS, SUBR) | |
120 | ||
121 | New macro: SCM_GASSERT2 (COND, GENERIC, ARG1, ARG2, POS, SUBR) | |
122 | ||
123 | These correspond to the SCM_ASSERT macro, but will defer control to | |
124 | GENERIC on error after `enable-primitive-generic!' has been called. | |
125 | ||
126 | [This is experimental code which may change soon.] | |
127 | ||
128 | ** New function: SCM scm_eval_body (SCM body, SCM env) | |
129 | ||
130 | Evaluates the body of a special form. | |
131 | ||
132 | ** The internal representation of struct's has changed | |
133 | ||
134 | Previously, four slots were allocated for the procedure(s) of entities | |
135 | and operators. The motivation for this representation had to do with | |
136 | the structure of the evaluator, the wish to support tail-recursive | |
137 | generic functions, and efficiency. Since the generic function | |
138 | dispatch mechanism has changed, there is no longer a need for such an | |
139 | expensive representation, and the representation has been simplified. | |
140 | ||
141 | This should not make any difference for most users. | |
142 | ||
143 | ** GOOPS support has been cleaned up. | |
144 | ||
145 | Some code has been moved from eval.c to objects.c and code in both of | |
146 | these compilation units has been cleaned up and better structured. | |
147 | ||
148 | *** New functions for applying generic functions | |
149 | ||
150 | New function: SCM scm_apply_generic (GENERIC, ARGS) | |
151 | New function: SCM scm_call_generic_0 (GENERIC) | |
152 | New function: SCM scm_call_generic_1 (GENERIC, ARG1) | |
153 | New function: SCM scm_call_generic_2 (GENERIC, ARG1, ARG2) | |
154 | New function: SCM scm_call_generic_3 (GENERIC, ARG1, ARG2, ARG3) | |
155 | ||
43fa9a05 | 156 | \f |
f3227c7a JB |
157 | Changes since Guile 1.3: |
158 | ||
6ca345f3 JB |
159 | * Changes to mailing lists |
160 | ||
161 | ** Some of the Guile mailing lists have moved to sourceware.cygnus.com. | |
162 | ||
163 | See the README file to find current addresses for all the Guile | |
164 | mailing lists. | |
165 | ||
d77fb593 JB |
166 | * Changes to the distribution |
167 | ||
1d335863 JB |
168 | ** Readline support is no longer included with Guile by default. |
169 | ||
170 | Based on the different license terms of Guile and Readline, we | |
171 | concluded that Guile should not *by default* cause the linking of | |
172 | Readline into an application program. Readline support is now offered | |
173 | as a separate module, which is linked into an application only when | |
174 | you explicitly specify it. | |
175 | ||
176 | Although Guile is GNU software, its distribution terms add a special | |
177 | exception to the usual GNU General Public License (GPL). Guile's | |
178 | license includes a clause that allows you to link Guile with non-free | |
179 | programs. We add this exception so as not to put Guile at a | |
180 | disadvantage vis-a-vis other extensibility packages that support other | |
181 | languages. | |
182 | ||
183 | In contrast, the GNU Readline library is distributed under the GNU | |
184 | General Public License pure and simple. This means that you may not | |
185 | link Readline, even dynamically, into an application unless it is | |
186 | distributed under a free software license that is compatible the GPL. | |
187 | ||
188 | Because of this difference in distribution terms, an application that | |
189 | can use Guile may not be able to use Readline. Now users will be | |
190 | explicitly offered two independent decisions about the use of these | |
191 | two packages. | |
d77fb593 | 192 | |
0e8a8468 MV |
193 | You can activate the readline support by issuing |
194 | ||
195 | (use-modules (readline-activator)) | |
196 | (activate-readline) | |
197 | ||
198 | from your ".guile" file, for example. | |
199 | ||
e4eae9b1 MD |
200 | * Changes to the stand-alone interpreter |
201 | ||
67ad463a MD |
202 | ** All builtins now print as primitives. |
203 | Previously builtin procedures not belonging to the fundamental subr | |
204 | types printed as #<compiled closure #<primitive-procedure gsubr-apply>>. | |
205 | Now, they print as #<primitive-procedure NAME>. | |
206 | ||
207 | ** Backtraces slightly more intelligible. | |
208 | gsubr-apply and macro transformer application frames no longer appear | |
209 | in backtraces. | |
210 | ||
69c6acbb JB |
211 | * Changes to Scheme functions and syntax |
212 | ||
2a52b429 MD |
213 | ** Guile now correctly handles internal defines by rewriting them into |
214 | their equivalent letrec. Previously, internal defines would | |
215 | incrementally add to the innermost environment, without checking | |
216 | whether the restrictions specified in RnRS were met. This lead to the | |
217 | correct behaviour when these restriction actually were met, but didn't | |
218 | catch all illegal uses. Such an illegal use could lead to crashes of | |
219 | the Guile interpreter or or other unwanted results. An example of | |
220 | incorrect internal defines that made Guile behave erratically: | |
221 | ||
222 | (let () | |
223 | (define a 1) | |
224 | (define (b) a) | |
225 | (define c (1+ (b))) | |
226 | (define d 3) | |
227 | ||
228 | (b)) | |
229 | ||
230 | => 2 | |
231 | ||
232 | The problem with this example is that the definition of `c' uses the | |
233 | value of `b' directly. This confuses the meoization machine of Guile | |
234 | so that the second call of `b' (this time in a larger environment that | |
235 | also contains bindings for `c' and `d') refers to the binding of `c' | |
236 | instead of `a'. You could also make Guile crash with a variation on | |
237 | this theme: | |
238 | ||
239 | (define (foo flag) | |
240 | (define a 1) | |
241 | (define (b flag) (if flag a 1)) | |
242 | (define c (1+ (b flag))) | |
243 | (define d 3) | |
244 | ||
245 | (b #t)) | |
246 | ||
247 | (foo #f) | |
248 | (foo #t) | |
249 | ||
250 | From now on, Guile will issue an `Unbound variable: b' error message | |
251 | for both examples. | |
252 | ||
36d3d540 MD |
253 | ** Hooks |
254 | ||
255 | A hook contains a list of functions which should be called on | |
256 | particular occasions in an existing program. Hooks are used for | |
257 | customization. | |
258 | ||
259 | A window manager might have a hook before-window-map-hook. The window | |
260 | manager uses the function run-hooks to call all functions stored in | |
261 | before-window-map-hook each time a window is mapped. The user can | |
262 | store functions in the hook using add-hook!. | |
263 | ||
264 | In Guile, hooks are first class objects. | |
265 | ||
266 | *** New function: make-hook [N_ARGS] | |
267 | ||
268 | Return a hook for hook functions which can take N_ARGS arguments. | |
269 | The default value for N_ARGS is 0. | |
270 | ||
ad91d6c3 MD |
271 | (See also scm_make_named_hook below.) |
272 | ||
36d3d540 MD |
273 | *** New function: add-hook! HOOK PROC [APPEND_P] |
274 | ||
275 | Put PROC at the beginning of the list of functions stored in HOOK. | |
276 | If APPEND_P is supplied, and non-false, put PROC at the end instead. | |
277 | ||
278 | PROC must be able to take the number of arguments specified when the | |
279 | hook was created. | |
280 | ||
281 | If PROC already exists in HOOK, then remove it first. | |
282 | ||
283 | *** New function: remove-hook! HOOK PROC | |
284 | ||
285 | Remove PROC from the list of functions in HOOK. | |
286 | ||
287 | *** New function: reset-hook! HOOK | |
288 | ||
289 | Clear the list of hook functions stored in HOOK. | |
290 | ||
291 | *** New function: run-hook HOOK ARG1 ... | |
292 | ||
293 | Run all hook functions stored in HOOK with arguments ARG1 ... . | |
294 | The number of arguments supplied must correspond to the number given | |
295 | when the hook was created. | |
296 | ||
56a19408 MV |
297 | ** The function `dynamic-link' now takes optional keyword arguments. |
298 | The only keyword argument that is currently defined is `:global | |
299 | BOOL'. With it, you can control whether the shared library will be | |
300 | linked in global mode or not. In global mode, the symbols from the | |
301 | linked library can be used to resolve references from other | |
302 | dynamically linked libraries. In non-global mode, the linked | |
303 | library is essentially invisible and can only be accessed via | |
304 | `dynamic-func', etc. The default is now to link in global mode. | |
305 | Previously, the default has been non-global mode. | |
306 | ||
307 | The `#:global' keyword is only effective on platforms that support | |
308 | the dlopen family of functions. | |
309 | ||
ad226f25 | 310 | ** New function `provided?' |
b7e13f65 JB |
311 | |
312 | - Function: provided? FEATURE | |
313 | Return true iff FEATURE is supported by this installation of | |
314 | Guile. FEATURE must be a symbol naming a feature; the global | |
315 | variable `*features*' is a list of available features. | |
316 | ||
ad226f25 JB |
317 | ** Changes to the module (ice-9 expect): |
318 | ||
319 | *** The expect-strings macro now matches `$' in a regular expression | |
320 | only at a line-break or end-of-file by default. Previously it would | |
ab711359 JB |
321 | match the end of the string accumulated so far. The old behaviour |
322 | can be obtained by setting the variable `expect-strings-exec-flags' | |
323 | to 0. | |
ad226f25 JB |
324 | |
325 | *** The expect-strings macro now uses a variable `expect-strings-exec-flags' | |
326 | for the regexp-exec flags. If `regexp/noteol' is included, then `$' | |
327 | in a regular expression will still match before a line-break or | |
328 | end-of-file. The default is `regexp/noteol'. | |
329 | ||
330 | *** The expect-strings macro now uses a variable | |
331 | `expect-strings-compile-flags' for the flags to be supplied to | |
332 | `make-regexp'. The default is `regexp/newline', which was previously | |
333 | hard-coded. | |
334 | ||
335 | *** The expect macro now supplies two arguments to a match procedure: | |
ab711359 JB |
336 | the current accumulated string and a flag to indicate whether |
337 | end-of-file has been reached. Previously only the string was supplied. | |
338 | If end-of-file is reached, the match procedure will be called an | |
339 | additional time with the same accumulated string as the previous call | |
340 | but with the flag set. | |
ad226f25 | 341 | |
b7e13f65 JB |
342 | ** New module (ice-9 format), implementing the Common Lisp `format' function. |
343 | ||
344 | This code, and the documentation for it that appears here, was | |
345 | borrowed from SLIB, with minor adaptations for Guile. | |
346 | ||
347 | - Function: format DESTINATION FORMAT-STRING . ARGUMENTS | |
348 | An almost complete implementation of Common LISP format description | |
349 | according to the CL reference book `Common LISP' from Guy L. | |
350 | Steele, Digital Press. Backward compatible to most of the | |
351 | available Scheme format implementations. | |
352 | ||
353 | Returns `#t', `#f' or a string; has side effect of printing | |
354 | according to FORMAT-STRING. If DESTINATION is `#t', the output is | |
355 | to the current output port and `#t' is returned. If DESTINATION | |
356 | is `#f', a formatted string is returned as the result of the call. | |
357 | NEW: If DESTINATION is a string, DESTINATION is regarded as the | |
358 | format string; FORMAT-STRING is then the first argument and the | |
359 | output is returned as a string. If DESTINATION is a number, the | |
360 | output is to the current error port if available by the | |
361 | implementation. Otherwise DESTINATION must be an output port and | |
362 | `#t' is returned. | |
363 | ||
364 | FORMAT-STRING must be a string. In case of a formatting error | |
365 | format returns `#f' and prints a message on the current output or | |
366 | error port. Characters are output as if the string were output by | |
367 | the `display' function with the exception of those prefixed by a | |
368 | tilde (~). For a detailed description of the FORMAT-STRING syntax | |
369 | please consult a Common LISP format reference manual. For a test | |
370 | suite to verify this format implementation load `formatst.scm'. | |
371 | Please send bug reports to `lutzeb@cs.tu-berlin.de'. | |
372 | ||
373 | Note: `format' is not reentrant, i.e. only one `format'-call may | |
374 | be executed at a time. | |
375 | ||
376 | ||
377 | *** Format Specification (Format version 3.0) | |
378 | ||
379 | Please consult a Common LISP format reference manual for a detailed | |
380 | description of the format string syntax. For a demonstration of the | |
381 | implemented directives see `formatst.scm'. | |
382 | ||
383 | This implementation supports directive parameters and modifiers (`:' | |
384 | and `@' characters). Multiple parameters must be separated by a comma | |
385 | (`,'). Parameters can be numerical parameters (positive or negative), | |
386 | character parameters (prefixed by a quote character (`''), variable | |
387 | parameters (`v'), number of rest arguments parameter (`#'), empty and | |
388 | default parameters. Directive characters are case independent. The | |
389 | general form of a directive is: | |
390 | ||
391 | DIRECTIVE ::= ~{DIRECTIVE-PARAMETER,}[:][@]DIRECTIVE-CHARACTER | |
392 | ||
393 | DIRECTIVE-PARAMETER ::= [ [-|+]{0-9}+ | 'CHARACTER | v | # ] | |
394 | ||
395 | *** Implemented CL Format Control Directives | |
396 | ||
397 | Documentation syntax: Uppercase characters represent the | |
398 | corresponding control directive characters. Lowercase characters | |
399 | represent control directive parameter descriptions. | |
400 | ||
401 | `~A' | |
402 | Any (print as `display' does). | |
403 | `~@A' | |
404 | left pad. | |
405 | ||
406 | `~MINCOL,COLINC,MINPAD,PADCHARA' | |
407 | full padding. | |
408 | ||
409 | `~S' | |
410 | S-expression (print as `write' does). | |
411 | `~@S' | |
412 | left pad. | |
413 | ||
414 | `~MINCOL,COLINC,MINPAD,PADCHARS' | |
415 | full padding. | |
416 | ||
417 | `~D' | |
418 | Decimal. | |
419 | `~@D' | |
420 | print number sign always. | |
421 | ||
422 | `~:D' | |
423 | print comma separated. | |
424 | ||
425 | `~MINCOL,PADCHAR,COMMACHARD' | |
426 | padding. | |
427 | ||
428 | `~X' | |
429 | Hexadecimal. | |
430 | `~@X' | |
431 | print number sign always. | |
432 | ||
433 | `~:X' | |
434 | print comma separated. | |
435 | ||
436 | `~MINCOL,PADCHAR,COMMACHARX' | |
437 | padding. | |
438 | ||
439 | `~O' | |
440 | Octal. | |
441 | `~@O' | |
442 | print number sign always. | |
443 | ||
444 | `~:O' | |
445 | print comma separated. | |
446 | ||
447 | `~MINCOL,PADCHAR,COMMACHARO' | |
448 | padding. | |
449 | ||
450 | `~B' | |
451 | Binary. | |
452 | `~@B' | |
453 | print number sign always. | |
454 | ||
455 | `~:B' | |
456 | print comma separated. | |
457 | ||
458 | `~MINCOL,PADCHAR,COMMACHARB' | |
459 | padding. | |
460 | ||
461 | `~NR' | |
462 | Radix N. | |
463 | `~N,MINCOL,PADCHAR,COMMACHARR' | |
464 | padding. | |
465 | ||
466 | `~@R' | |
467 | print a number as a Roman numeral. | |
468 | ||
469 | `~:@R' | |
470 | print a number as an "old fashioned" Roman numeral. | |
471 | ||
472 | `~:R' | |
473 | print a number as an ordinal English number. | |
474 | ||
475 | `~:@R' | |
476 | print a number as a cardinal English number. | |
477 | ||
478 | `~P' | |
479 | Plural. | |
480 | `~@P' | |
481 | prints `y' and `ies'. | |
482 | ||
483 | `~:P' | |
484 | as `~P but jumps 1 argument backward.' | |
485 | ||
486 | `~:@P' | |
487 | as `~@P but jumps 1 argument backward.' | |
488 | ||
489 | `~C' | |
490 | Character. | |
491 | `~@C' | |
492 | prints a character as the reader can understand it (i.e. `#\' | |
493 | prefixing). | |
494 | ||
495 | `~:C' | |
496 | prints a character as emacs does (eg. `^C' for ASCII 03). | |
497 | ||
498 | `~F' | |
499 | Fixed-format floating-point (prints a flonum like MMM.NNN). | |
500 | `~WIDTH,DIGITS,SCALE,OVERFLOWCHAR,PADCHARF' | |
501 | `~@F' | |
502 | If the number is positive a plus sign is printed. | |
503 | ||
504 | `~E' | |
505 | Exponential floating-point (prints a flonum like MMM.NNN`E'EE). | |
506 | `~WIDTH,DIGITS,EXPONENTDIGITS,SCALE,OVERFLOWCHAR,PADCHAR,EXPONENTCHARE' | |
507 | `~@E' | |
508 | If the number is positive a plus sign is printed. | |
509 | ||
510 | `~G' | |
511 | General floating-point (prints a flonum either fixed or | |
512 | exponential). | |
513 | `~WIDTH,DIGITS,EXPONENTDIGITS,SCALE,OVERFLOWCHAR,PADCHAR,EXPONENTCHARG' | |
514 | `~@G' | |
515 | If the number is positive a plus sign is printed. | |
516 | ||
517 | `~$' | |
518 | Dollars floating-point (prints a flonum in fixed with signs | |
519 | separated). | |
520 | `~DIGITS,SCALE,WIDTH,PADCHAR$' | |
521 | `~@$' | |
522 | If the number is positive a plus sign is printed. | |
523 | ||
524 | `~:@$' | |
525 | A sign is always printed and appears before the padding. | |
526 | ||
527 | `~:$' | |
528 | The sign appears before the padding. | |
529 | ||
530 | `~%' | |
531 | Newline. | |
532 | `~N%' | |
533 | print N newlines. | |
534 | ||
535 | `~&' | |
536 | print newline if not at the beginning of the output line. | |
537 | `~N&' | |
538 | prints `~&' and then N-1 newlines. | |
539 | ||
540 | `~|' | |
541 | Page Separator. | |
542 | `~N|' | |
543 | print N page separators. | |
544 | ||
545 | `~~' | |
546 | Tilde. | |
547 | `~N~' | |
548 | print N tildes. | |
549 | ||
550 | `~'<newline> | |
551 | Continuation Line. | |
552 | `~:'<newline> | |
553 | newline is ignored, white space left. | |
554 | ||
555 | `~@'<newline> | |
556 | newline is left, white space ignored. | |
557 | ||
558 | `~T' | |
559 | Tabulation. | |
560 | `~@T' | |
561 | relative tabulation. | |
562 | ||
563 | `~COLNUM,COLINCT' | |
564 | full tabulation. | |
565 | ||
566 | `~?' | |
567 | Indirection (expects indirect arguments as a list). | |
568 | `~@?' | |
569 | extracts indirect arguments from format arguments. | |
570 | ||
571 | `~(STR~)' | |
572 | Case conversion (converts by `string-downcase'). | |
573 | `~:(STR~)' | |
574 | converts by `string-capitalize'. | |
575 | ||
576 | `~@(STR~)' | |
577 | converts by `string-capitalize-first'. | |
578 | ||
579 | `~:@(STR~)' | |
580 | converts by `string-upcase'. | |
581 | ||
582 | `~*' | |
583 | Argument Jumping (jumps 1 argument forward). | |
584 | `~N*' | |
585 | jumps N arguments forward. | |
586 | ||
587 | `~:*' | |
588 | jumps 1 argument backward. | |
589 | ||
590 | `~N:*' | |
591 | jumps N arguments backward. | |
592 | ||
593 | `~@*' | |
594 | jumps to the 0th argument. | |
595 | ||
596 | `~N@*' | |
597 | jumps to the Nth argument (beginning from 0) | |
598 | ||
599 | `~[STR0~;STR1~;...~;STRN~]' | |
600 | Conditional Expression (numerical clause conditional). | |
601 | `~N[' | |
602 | take argument from N. | |
603 | ||
604 | `~@[' | |
605 | true test conditional. | |
606 | ||
607 | `~:[' | |
608 | if-else-then conditional. | |
609 | ||
610 | `~;' | |
611 | clause separator. | |
612 | ||
613 | `~:;' | |
614 | default clause follows. | |
615 | ||
616 | `~{STR~}' | |
617 | Iteration (args come from the next argument (a list)). | |
618 | `~N{' | |
619 | at most N iterations. | |
620 | ||
621 | `~:{' | |
622 | args from next arg (a list of lists). | |
623 | ||
624 | `~@{' | |
625 | args from the rest of arguments. | |
626 | ||
627 | `~:@{' | |
628 | args from the rest args (lists). | |
629 | ||
630 | `~^' | |
631 | Up and out. | |
632 | `~N^' | |
633 | aborts if N = 0 | |
634 | ||
635 | `~N,M^' | |
636 | aborts if N = M | |
637 | ||
638 | `~N,M,K^' | |
639 | aborts if N <= M <= K | |
640 | ||
641 | *** Not Implemented CL Format Control Directives | |
642 | ||
643 | `~:A' | |
644 | print `#f' as an empty list (see below). | |
645 | ||
646 | `~:S' | |
647 | print `#f' as an empty list (see below). | |
648 | ||
649 | `~<~>' | |
650 | Justification. | |
651 | ||
652 | `~:^' | |
653 | (sorry I don't understand its semantics completely) | |
654 | ||
655 | *** Extended, Replaced and Additional Control Directives | |
656 | ||
657 | `~MINCOL,PADCHAR,COMMACHAR,COMMAWIDTHD' | |
658 | `~MINCOL,PADCHAR,COMMACHAR,COMMAWIDTHX' | |
659 | `~MINCOL,PADCHAR,COMMACHAR,COMMAWIDTHO' | |
660 | `~MINCOL,PADCHAR,COMMACHAR,COMMAWIDTHB' | |
661 | `~N,MINCOL,PADCHAR,COMMACHAR,COMMAWIDTHR' | |
662 | COMMAWIDTH is the number of characters between two comma | |
663 | characters. | |
664 | ||
665 | `~I' | |
666 | print a R4RS complex number as `~F~@Fi' with passed parameters for | |
667 | `~F'. | |
668 | ||
669 | `~Y' | |
670 | Pretty print formatting of an argument for scheme code lists. | |
671 | ||
672 | `~K' | |
673 | Same as `~?.' | |
674 | ||
675 | `~!' | |
676 | Flushes the output if format DESTINATION is a port. | |
677 | ||
678 | `~_' | |
679 | Print a `#\space' character | |
680 | `~N_' | |
681 | print N `#\space' characters. | |
682 | ||
683 | `~/' | |
684 | Print a `#\tab' character | |
685 | `~N/' | |
686 | print N `#\tab' characters. | |
687 | ||
688 | `~NC' | |
689 | Takes N as an integer representation for a character. No arguments | |
690 | are consumed. N is converted to a character by `integer->char'. N | |
691 | must be a positive decimal number. | |
692 | ||
693 | `~:S' | |
694 | Print out readproof. Prints out internal objects represented as | |
695 | `#<...>' as strings `"#<...>"' so that the format output can always | |
696 | be processed by `read'. | |
697 | ||
698 | `~:A' | |
699 | Print out readproof. Prints out internal objects represented as | |
700 | `#<...>' as strings `"#<...>"' so that the format output can always | |
701 | be processed by `read'. | |
702 | ||
703 | `~Q' | |
704 | Prints information and a copyright notice on the format | |
705 | implementation. | |
706 | `~:Q' | |
707 | prints format version. | |
708 | ||
709 | `~F, ~E, ~G, ~$' | |
710 | may also print number strings, i.e. passing a number as a string | |
711 | and format it accordingly. | |
712 | ||
713 | *** Configuration Variables | |
714 | ||
715 | The format module exports some configuration variables to suit the | |
716 | systems and users needs. There should be no modification necessary for | |
717 | the configuration that comes with Guile. Format detects automatically | |
718 | if the running scheme system implements floating point numbers and | |
719 | complex numbers. | |
720 | ||
721 | format:symbol-case-conv | |
722 | Symbols are converted by `symbol->string' so the case type of the | |
723 | printed symbols is implementation dependent. | |
724 | `format:symbol-case-conv' is a one arg closure which is either | |
725 | `#f' (no conversion), `string-upcase', `string-downcase' or | |
726 | `string-capitalize'. (default `#f') | |
727 | ||
728 | format:iobj-case-conv | |
729 | As FORMAT:SYMBOL-CASE-CONV but applies for the representation of | |
730 | implementation internal objects. (default `#f') | |
731 | ||
732 | format:expch | |
733 | The character prefixing the exponent value in `~E' printing. | |
734 | (default `#\E') | |
735 | ||
736 | *** Compatibility With Other Format Implementations | |
737 | ||
738 | SLIB format 2.x: | |
739 | See `format.doc'. | |
740 | ||
741 | SLIB format 1.4: | |
742 | Downward compatible except for padding support and `~A', `~S', | |
743 | `~P', `~X' uppercase printing. SLIB format 1.4 uses C-style | |
744 | `printf' padding support which is completely replaced by the CL | |
745 | `format' padding style. | |
746 | ||
747 | MIT C-Scheme 7.1: | |
748 | Downward compatible except for `~', which is not documented | |
749 | (ignores all characters inside the format string up to a newline | |
750 | character). (7.1 implements `~a', `~s', ~NEWLINE, `~~', `~%', | |
751 | numerical and variable parameters and `:/@' modifiers in the CL | |
752 | sense). | |
753 | ||
754 | Elk 1.5/2.0: | |
755 | Downward compatible except for `~A' and `~S' which print in | |
756 | uppercase. (Elk implements `~a', `~s', `~~', and `~%' (no | |
757 | directive parameters or modifiers)). | |
758 | ||
759 | Scheme->C 01nov91: | |
760 | Downward compatible except for an optional destination parameter: | |
761 | S2C accepts a format call without a destination which returns a | |
762 | formatted string. This is equivalent to a #f destination in S2C. | |
763 | (S2C implements `~a', `~s', `~c', `~%', and `~~' (no directive | |
764 | parameters or modifiers)). | |
765 | ||
766 | ||
e7d37b0a | 767 | ** Changes to string-handling functions. |
b7e13f65 | 768 | |
e7d37b0a | 769 | These functions were added to support the (ice-9 format) module, above. |
b7e13f65 | 770 | |
e7d37b0a JB |
771 | *** New function: string-upcase STRING |
772 | *** New function: string-downcase STRING | |
b7e13f65 | 773 | |
e7d37b0a JB |
774 | These are non-destructive versions of the existing string-upcase! and |
775 | string-downcase! functions. | |
b7e13f65 | 776 | |
e7d37b0a JB |
777 | *** New function: string-capitalize! STRING |
778 | *** New function: string-capitalize STRING | |
779 | ||
780 | These functions convert the first letter of each word in the string to | |
781 | upper case. Thus: | |
782 | ||
783 | (string-capitalize "howdy there") | |
784 | => "Howdy There" | |
785 | ||
786 | As with the other functions, string-capitalize! modifies the string in | |
787 | place, while string-capitalize returns a modified copy of its argument. | |
788 | ||
789 | *** New function: string-ci->symbol STRING | |
790 | ||
791 | Return a symbol whose name is STRING, but having the same case as if | |
792 | the symbol had be read by `read'. | |
793 | ||
794 | Guile can be configured to be sensitive or insensitive to case | |
795 | differences in Scheme identifiers. If Guile is case-insensitive, all | |
796 | symbols are converted to lower case on input. The `string-ci->symbol' | |
797 | function returns a symbol whose name in STRING, transformed as Guile | |
798 | would if STRING were input. | |
799 | ||
800 | *** New function: substring-move! STRING1 START END STRING2 START | |
801 | ||
802 | Copy the substring of STRING1 from START (inclusive) to END | |
803 | (exclusive) to STRING2 at START. STRING1 and STRING2 may be the same | |
804 | string, and the source and destination areas may overlap; in all | |
805 | cases, the function behaves as if all the characters were copied | |
806 | simultanously. | |
807 | ||
808 | *** Extended functions: substring-move-left! substring-move-right! | |
809 | ||
810 | These functions now correctly copy arbitrarily overlapping substrings; | |
811 | they are both synonyms for substring-move!. | |
b7e13f65 | 812 | |
b7e13f65 | 813 | |
deaceb4e JB |
814 | ** New module (ice-9 getopt-long), with the function `getopt-long'. |
815 | ||
816 | getopt-long is a function for parsing command-line arguments in a | |
817 | manner consistent with other GNU programs. | |
818 | ||
819 | (getopt-long ARGS GRAMMAR) | |
820 | Parse the arguments ARGS according to the argument list grammar GRAMMAR. | |
821 | ||
822 | ARGS should be a list of strings. Its first element should be the | |
823 | name of the program; subsequent elements should be the arguments | |
824 | that were passed to the program on the command line. The | |
825 | `program-arguments' procedure returns a list of this form. | |
826 | ||
827 | GRAMMAR is a list of the form: | |
828 | ((OPTION (PROPERTY VALUE) ...) ...) | |
829 | ||
830 | Each OPTION should be a symbol. `getopt-long' will accept a | |
831 | command-line option named `--OPTION'. | |
832 | Each option can have the following (PROPERTY VALUE) pairs: | |
833 | ||
834 | (single-char CHAR) --- Accept `-CHAR' as a single-character | |
835 | equivalent to `--OPTION'. This is how to specify traditional | |
836 | Unix-style flags. | |
837 | (required? BOOL) --- If BOOL is true, the option is required. | |
838 | getopt-long will raise an error if it is not found in ARGS. | |
839 | (value BOOL) --- If BOOL is #t, the option accepts a value; if | |
840 | it is #f, it does not; and if it is the symbol | |
841 | `optional', the option may appear in ARGS with or | |
842 | without a value. | |
843 | (predicate FUNC) --- If the option accepts a value (i.e. you | |
844 | specified `(value #t)' for this option), then getopt | |
845 | will apply FUNC to the value, and throw an exception | |
846 | if it returns #f. FUNC should be a procedure which | |
847 | accepts a string and returns a boolean value; you may | |
848 | need to use quasiquotes to get it into GRAMMAR. | |
849 | ||
850 | The (PROPERTY VALUE) pairs may occur in any order, but each | |
851 | property may occur only once. By default, options do not have | |
852 | single-character equivalents, are not required, and do not take | |
853 | values. | |
854 | ||
855 | In ARGS, single-character options may be combined, in the usual | |
856 | Unix fashion: ("-x" "-y") is equivalent to ("-xy"). If an option | |
857 | accepts values, then it must be the last option in the | |
858 | combination; the value is the next argument. So, for example, using | |
859 | the following grammar: | |
860 | ((apples (single-char #\a)) | |
861 | (blimps (single-char #\b) (value #t)) | |
862 | (catalexis (single-char #\c) (value #t))) | |
863 | the following argument lists would be acceptable: | |
864 | ("-a" "-b" "bang" "-c" "couth") ("bang" and "couth" are the values | |
865 | for "blimps" and "catalexis") | |
866 | ("-ab" "bang" "-c" "couth") (same) | |
867 | ("-ac" "couth" "-b" "bang") (same) | |
868 | ("-abc" "couth" "bang") (an error, since `-b' is not the | |
869 | last option in its combination) | |
870 | ||
871 | If an option's value is optional, then `getopt-long' decides | |
872 | whether it has a value by looking at what follows it in ARGS. If | |
873 | the next element is a string, and it does not appear to be an | |
874 | option itself, then that string is the option's value. | |
875 | ||
876 | The value of a long option can appear as the next element in ARGS, | |
877 | or it can follow the option name, separated by an `=' character. | |
878 | Thus, using the same grammar as above, the following argument lists | |
879 | are equivalent: | |
880 | ("--apples" "Braeburn" "--blimps" "Goodyear") | |
881 | ("--apples=Braeburn" "--blimps" "Goodyear") | |
882 | ("--blimps" "Goodyear" "--apples=Braeburn") | |
883 | ||
884 | If the option "--" appears in ARGS, argument parsing stops there; | |
885 | subsequent arguments are returned as ordinary arguments, even if | |
886 | they resemble options. So, in the argument list: | |
887 | ("--apples" "Granny Smith" "--" "--blimp" "Goodyear") | |
888 | `getopt-long' will recognize the `apples' option as having the | |
889 | value "Granny Smith", but it will not recognize the `blimp' | |
890 | option; it will return the strings "--blimp" and "Goodyear" as | |
891 | ordinary argument strings. | |
892 | ||
893 | The `getopt-long' function returns the parsed argument list as an | |
894 | assocation list, mapping option names --- the symbols from GRAMMAR | |
895 | --- onto their values, or #t if the option does not accept a value. | |
896 | Unused options do not appear in the alist. | |
897 | ||
898 | All arguments that are not the value of any option are returned | |
899 | as a list, associated with the empty list. | |
900 | ||
901 | `getopt-long' throws an exception if: | |
902 | - it finds an unrecognized option in ARGS | |
903 | - a required option is omitted | |
904 | - an option that requires an argument doesn't get one | |
905 | - an option that doesn't accept an argument does get one (this can | |
906 | only happen using the long option `--opt=value' syntax) | |
907 | - an option predicate fails | |
908 | ||
909 | So, for example: | |
910 | ||
911 | (define grammar | |
912 | `((lockfile-dir (required? #t) | |
913 | (value #t) | |
914 | (single-char #\k) | |
915 | (predicate ,file-is-directory?)) | |
916 | (verbose (required? #f) | |
917 | (single-char #\v) | |
918 | (value #f)) | |
919 | (x-includes (single-char #\x)) | |
920 | (rnet-server (single-char #\y) | |
921 | (predicate ,string?)))) | |
922 | ||
923 | (getopt-long '("my-prog" "-vk" "/tmp" "foo1" "--x-includes=/usr/include" | |
924 | "--rnet-server=lamprod" "--" "-fred" "foo2" "foo3") | |
925 | grammar) | |
926 | => ((() "foo1" "-fred" "foo2" "foo3") | |
927 | (rnet-server . "lamprod") | |
928 | (x-includes . "/usr/include") | |
929 | (lockfile-dir . "/tmp") | |
930 | (verbose . #t)) | |
931 | ||
932 | ** The (ice-9 getopt-gnu-style) module is obsolete; use (ice-9 getopt-long). | |
933 | ||
934 | It will be removed in a few releases. | |
935 | ||
08394899 MS |
936 | ** New syntax: lambda* |
937 | ** New syntax: define* | |
938 | ** New syntax: define*-public | |
939 | ** New syntax: defmacro* | |
940 | ** New syntax: defmacro*-public | |
941 | Guile now supports optional arguments. | |
942 | ||
943 | `lambda*', `define*', `define*-public', `defmacro*' and | |
944 | `defmacro*-public' are identical to the non-* versions except that | |
945 | they use an extended type of parameter list that has the following BNF | |
946 | syntax (parentheses are literal, square brackets indicate grouping, | |
947 | and `*', `+' and `?' have the usual meaning): | |
948 | ||
949 | ext-param-list ::= ( [identifier]* [#&optional [ext-var-decl]+]? | |
950 | [#&key [ext-var-decl]+ [#&allow-other-keys]?]? | |
951 | [[#&rest identifier]|[. identifier]]? ) | [identifier] | |
952 | ||
953 | ext-var-decl ::= identifier | ( identifier expression ) | |
954 | ||
955 | The semantics are best illustrated with the following documentation | |
956 | and examples for `lambda*': | |
957 | ||
958 | lambda* args . body | |
959 | lambda extended for optional and keyword arguments | |
960 | ||
961 | lambda* creates a procedure that takes optional arguments. These | |
962 | are specified by putting them inside brackets at the end of the | |
963 | paramater list, but before any dotted rest argument. For example, | |
964 | (lambda* (a b #&optional c d . e) '()) | |
965 | creates a procedure with fixed arguments a and b, optional arguments c | |
966 | and d, and rest argument e. If the optional arguments are omitted | |
967 | in a call, the variables for them are unbound in the procedure. This | |
968 | can be checked with the bound? macro. | |
969 | ||
970 | lambda* can also take keyword arguments. For example, a procedure | |
971 | defined like this: | |
972 | (lambda* (#&key xyzzy larch) '()) | |
973 | can be called with any of the argument lists (#:xyzzy 11) | |
974 | (#:larch 13) (#:larch 42 #:xyzzy 19) (). Whichever arguments | |
975 | are given as keywords are bound to values. | |
976 | ||
977 | Optional and keyword arguments can also be given default values | |
978 | which they take on when they are not present in a call, by giving a | |
979 | two-item list in place of an optional argument, for example in: | |
980 | (lambda* (foo #&optional (bar 42) #&key (baz 73)) (list foo bar baz)) | |
981 | foo is a fixed argument, bar is an optional argument with default | |
982 | value 42, and baz is a keyword argument with default value 73. | |
983 | Default value expressions are not evaluated unless they are needed | |
984 | and until the procedure is called. | |
985 | ||
986 | lambda* now supports two more special parameter list keywords. | |
987 | ||
988 | lambda*-defined procedures now throw an error by default if a | |
989 | keyword other than one of those specified is found in the actual | |
990 | passed arguments. However, specifying #&allow-other-keys | |
991 | immediately after the kyword argument declarations restores the | |
992 | previous behavior of ignoring unknown keywords. lambda* also now | |
993 | guarantees that if the same keyword is passed more than once, the | |
994 | last one passed is the one that takes effect. For example, | |
995 | ((lambda* (#&key (heads 0) (tails 0)) (display (list heads tails))) | |
996 | #:heads 37 #:tails 42 #:heads 99) | |
997 | would result in (99 47) being displayed. | |
998 | ||
999 | #&rest is also now provided as a synonym for the dotted syntax rest | |
1000 | argument. The argument lists (a . b) and (a #&rest b) are equivalent in | |
1001 | all respects to lambda*. This is provided for more similarity to DSSSL, | |
1002 | MIT-Scheme and Kawa among others, as well as for refugees from other | |
1003 | Lisp dialects. | |
1004 | ||
1005 | Further documentation may be found in the optargs.scm file itself. | |
1006 | ||
1007 | The optional argument module also exports the macros `let-optional', | |
1008 | `let-optional*', `let-keywords', `let-keywords*' and `bound?'. These | |
1009 | are not documented here because they may be removed in the future, but | |
1010 | full documentation is still available in optargs.scm. | |
1011 | ||
2e132553 JB |
1012 | ** New syntax: and-let* |
1013 | Guile now supports the `and-let*' form, described in the draft SRFI-2. | |
1014 | ||
1015 | Syntax: (land* (<clause> ...) <body> ...) | |
1016 | Each <clause> should have one of the following forms: | |
1017 | (<variable> <expression>) | |
1018 | (<expression>) | |
1019 | <bound-variable> | |
1020 | Each <variable> or <bound-variable> should be an identifier. Each | |
1021 | <expression> should be a valid expression. The <body> should be a | |
1022 | possibly empty sequence of expressions, like the <body> of a | |
1023 | lambda form. | |
1024 | ||
1025 | Semantics: A LAND* expression is evaluated by evaluating the | |
1026 | <expression> or <bound-variable> of each of the <clause>s from | |
1027 | left to right. The value of the first <expression> or | |
1028 | <bound-variable> that evaluates to a false value is returned; the | |
1029 | remaining <expression>s and <bound-variable>s are not evaluated. | |
1030 | The <body> forms are evaluated iff all the <expression>s and | |
1031 | <bound-variable>s evaluate to true values. | |
1032 | ||
1033 | The <expression>s and the <body> are evaluated in an environment | |
1034 | binding each <variable> of the preceding (<variable> <expression>) | |
1035 | clauses to the value of the <expression>. Later bindings | |
1036 | shadow earlier bindings. | |
1037 | ||
1038 | Guile's and-let* macro was contributed by Michael Livshin. | |
1039 | ||
36d3d540 MD |
1040 | ** New sorting functions |
1041 | ||
1042 | *** New function: sorted? SEQUENCE LESS? | |
ed8c8636 MD |
1043 | Returns `#t' when the sequence argument is in non-decreasing order |
1044 | according to LESS? (that is, there is no adjacent pair `... x y | |
1045 | ...' for which `(less? y x)'). | |
1046 | ||
1047 | Returns `#f' when the sequence contains at least one out-of-order | |
1048 | pair. It is an error if the sequence is neither a list nor a | |
1049 | vector. | |
1050 | ||
36d3d540 | 1051 | *** New function: merge LIST1 LIST2 LESS? |
ed8c8636 MD |
1052 | LIST1 and LIST2 are sorted lists. |
1053 | Returns the sorted list of all elements in LIST1 and LIST2. | |
1054 | ||
1055 | Assume that the elements a and b1 in LIST1 and b2 in LIST2 are "equal" | |
1056 | in the sense that (LESS? x y) --> #f for x, y in {a, b1, b2}, | |
1057 | and that a < b1 in LIST1. Then a < b1 < b2 in the result. | |
1058 | (Here "<" should read "comes before".) | |
1059 | ||
36d3d540 | 1060 | *** New procedure: merge! LIST1 LIST2 LESS? |
ed8c8636 MD |
1061 | Merges two lists, re-using the pairs of LIST1 and LIST2 to build |
1062 | the result. If the code is compiled, and LESS? constructs no new | |
1063 | pairs, no pairs at all will be allocated. The first pair of the | |
1064 | result will be either the first pair of LIST1 or the first pair of | |
1065 | LIST2. | |
1066 | ||
36d3d540 | 1067 | *** New function: sort SEQUENCE LESS? |
ed8c8636 MD |
1068 | Accepts either a list or a vector, and returns a new sequence |
1069 | which is sorted. The new sequence is the same type as the input. | |
1070 | Always `(sorted? (sort sequence less?) less?)'. The original | |
1071 | sequence is not altered in any way. The new sequence shares its | |
1072 | elements with the old one; no elements are copied. | |
1073 | ||
36d3d540 | 1074 | *** New procedure: sort! SEQUENCE LESS |
ed8c8636 MD |
1075 | Returns its sorted result in the original boxes. No new storage is |
1076 | allocated at all. Proper usage: (set! slist (sort! slist <)) | |
1077 | ||
36d3d540 | 1078 | *** New function: stable-sort SEQUENCE LESS? |
ed8c8636 MD |
1079 | Similar to `sort' but stable. That is, if "equal" elements are |
1080 | ordered a < b in the original sequence, they will have the same order | |
1081 | in the result. | |
1082 | ||
36d3d540 | 1083 | *** New function: stable-sort! SEQUENCE LESS? |
ed8c8636 MD |
1084 | Similar to `sort!' but stable. |
1085 | Uses temporary storage when sorting vectors. | |
1086 | ||
36d3d540 | 1087 | *** New functions: sort-list, sort-list! |
ed8c8636 MD |
1088 | Added for compatibility with scsh. |
1089 | ||
36d3d540 MD |
1090 | ** New built-in random number support |
1091 | ||
1092 | *** New function: random N [STATE] | |
3e8370c3 MD |
1093 | Accepts a positive integer or real N and returns a number of the |
1094 | same type between zero (inclusive) and N (exclusive). The values | |
1095 | returned have a uniform distribution. | |
1096 | ||
1097 | The optional argument STATE must be of the type produced by | |
416075f1 MD |
1098 | `copy-random-state' or `seed->random-state'. It defaults to the value |
1099 | of the variable `*random-state*'. This object is used to maintain the | |
1100 | state of the pseudo-random-number generator and is altered as a side | |
1101 | effect of the `random' operation. | |
3e8370c3 | 1102 | |
36d3d540 | 1103 | *** New variable: *random-state* |
3e8370c3 MD |
1104 | Holds a data structure that encodes the internal state of the |
1105 | random-number generator that `random' uses by default. The nature | |
1106 | of this data structure is implementation-dependent. It may be | |
1107 | printed out and successfully read back in, but may or may not | |
1108 | function correctly as a random-number state object in another | |
1109 | implementation. | |
1110 | ||
36d3d540 | 1111 | *** New function: copy-random-state [STATE] |
3e8370c3 MD |
1112 | Returns a new object of type suitable for use as the value of the |
1113 | variable `*random-state*' and as a second argument to `random'. | |
1114 | If argument STATE is given, a copy of it is returned. Otherwise a | |
1115 | copy of `*random-state*' is returned. | |
416075f1 | 1116 | |
36d3d540 | 1117 | *** New function: seed->random-state SEED |
416075f1 MD |
1118 | Returns a new object of type suitable for use as the value of the |
1119 | variable `*random-state*' and as a second argument to `random'. | |
1120 | SEED is a string or a number. A new state is generated and | |
1121 | initialized using SEED. | |
3e8370c3 | 1122 | |
36d3d540 | 1123 | *** New function: random:uniform [STATE] |
3e8370c3 MD |
1124 | Returns an uniformly distributed inexact real random number in the |
1125 | range between 0 and 1. | |
1126 | ||
36d3d540 | 1127 | *** New procedure: random:solid-sphere! VECT [STATE] |
3e8370c3 MD |
1128 | Fills VECT with inexact real random numbers the sum of whose |
1129 | squares is less than 1.0. Thinking of VECT as coordinates in | |
1130 | space of dimension N = `(vector-length VECT)', the coordinates are | |
1131 | uniformly distributed within the unit N-shere. The sum of the | |
1132 | squares of the numbers is returned. VECT can be either a vector | |
1133 | or a uniform vector of doubles. | |
1134 | ||
36d3d540 | 1135 | *** New procedure: random:hollow-sphere! VECT [STATE] |
3e8370c3 MD |
1136 | Fills VECT with inexact real random numbers the sum of whose squares |
1137 | is equal to 1.0. Thinking of VECT as coordinates in space of | |
1138 | dimension n = `(vector-length VECT)', the coordinates are uniformly | |
1139 | distributed over the surface of the unit n-shere. VECT can be either | |
1140 | a vector or a uniform vector of doubles. | |
1141 | ||
36d3d540 | 1142 | *** New function: random:normal [STATE] |
3e8370c3 MD |
1143 | Returns an inexact real in a normal distribution with mean 0 and |
1144 | standard deviation 1. For a normal distribution with mean M and | |
1145 | standard deviation D use `(+ M (* D (random:normal)))'. | |
1146 | ||
36d3d540 | 1147 | *** New procedure: random:normal-vector! VECT [STATE] |
3e8370c3 MD |
1148 | Fills VECT with inexact real random numbers which are independent and |
1149 | standard normally distributed (i.e., with mean 0 and variance 1). | |
1150 | VECT can be either a vector or a uniform vector of doubles. | |
1151 | ||
36d3d540 | 1152 | *** New function: random:exp STATE |
3e8370c3 MD |
1153 | Returns an inexact real in an exponential distribution with mean 1. |
1154 | For an exponential distribution with mean U use (* U (random:exp)). | |
1155 | ||
69c6acbb JB |
1156 | ** The range of logand, logior, logxor, logtest, and logbit? have changed. |
1157 | ||
1158 | These functions now operate on numbers in the range of a C unsigned | |
1159 | long. | |
1160 | ||
1161 | These functions used to operate on numbers in the range of a C signed | |
1162 | long; however, this seems inappropriate, because Guile integers don't | |
1163 | overflow. | |
1164 | ||
ba4ee0d6 MD |
1165 | ** New function: make-guardian |
1166 | This is an implementation of guardians as described in | |
1167 | R. Kent Dybvig, Carl Bruggeman, and David Eby (1993) "Guardians in a | |
1168 | Generation-Based Garbage Collector" ACM SIGPLAN Conference on | |
1169 | Programming Language Design and Implementation, June 1993 | |
1170 | ftp://ftp.cs.indiana.edu/pub/scheme-repository/doc/pubs/guardians.ps.gz | |
1171 | ||
88ceea5c MD |
1172 | ** New functions: delq1!, delv1!, delete1! |
1173 | These procedures behave similar to delq! and friends but delete only | |
1174 | one object if at all. | |
1175 | ||
55254a6a MD |
1176 | ** New function: unread-string STRING PORT |
1177 | Unread STRING to PORT, that is, push it back onto the port so that | |
1178 | next read operation will work on the pushed back characters. | |
1179 | ||
1180 | ** unread-char can now be called multiple times | |
1181 | If unread-char is called multiple times, the unread characters will be | |
1182 | read again in last-in first-out order. | |
1183 | ||
9e97c52d GH |
1184 | ** the procedures uniform-array-read! and uniform-array-write! now |
1185 | work on any kind of port, not just ports which are open on a file. | |
1186 | ||
b074884f | 1187 | ** Now 'l' in a port mode requests line buffering. |
9e97c52d | 1188 | |
69bc9ff3 GH |
1189 | ** The procedure truncate-file now works on string ports as well |
1190 | as file ports. If the size argument is omitted, the current | |
1b9c3dae | 1191 | file position is used. |
9e97c52d | 1192 | |
c94577b4 | 1193 | ** new procedure: seek PORT/FDES OFFSET WHENCE |
9e97c52d GH |
1194 | The arguments are the same as for the old fseek procedure, but it |
1195 | works on string ports as well as random-access file ports. | |
1196 | ||
1197 | ** the fseek procedure now works on string ports, since it has been | |
c94577b4 | 1198 | redefined using seek. |
9e97c52d GH |
1199 | |
1200 | ** the setvbuf procedure now uses a default size if mode is _IOFBF and | |
1201 | size is not supplied. | |
1202 | ||
1203 | ** the newline procedure no longer flushes the port if it's not | |
1204 | line-buffered: previously it did if it was the current output port. | |
1205 | ||
1206 | ** open-pipe and close-pipe are no longer primitive procedures, but | |
1207 | an emulation can be obtained using `(use-modules (ice-9 popen))'. | |
1208 | ||
1209 | ** the freopen procedure has been removed. | |
1210 | ||
1211 | ** new procedure: drain-input PORT | |
1212 | Drains PORT's read buffers (including any pushed-back characters) | |
1213 | and returns the contents as a single string. | |
1214 | ||
67ad463a | 1215 | ** New function: map-in-order PROC LIST1 LIST2 ... |
d41b3904 MD |
1216 | Version of `map' which guarantees that the procedure is applied to the |
1217 | lists in serial order. | |
1218 | ||
67ad463a MD |
1219 | ** Renamed `serial-array-copy!' and `serial-array-map!' to |
1220 | `array-copy-in-order!' and `array-map-in-order!'. The old names are | |
1221 | now obsolete and will go away in release 1.5. | |
1222 | ||
cf7132b3 | 1223 | ** New syntax: collect BODY1 ... |
d41b3904 MD |
1224 | Version of `begin' which returns a list of the results of the body |
1225 | forms instead of the result of the last body form. In contrast to | |
cf7132b3 | 1226 | `begin', `collect' allows an empty body. |
d41b3904 | 1227 | |
e4eae9b1 MD |
1228 | ** New functions: read-history FILENAME, write-history FILENAME |
1229 | Read/write command line history from/to file. Returns #t on success | |
1230 | and #f if an error occured. | |
1231 | ||
d21ffe26 JB |
1232 | ** `ls' and `lls' in module (ice-9 ls) now handle no arguments. |
1233 | ||
1234 | These procedures return a list of definitions available in the specified | |
1235 | argument, a relative module reference. In the case of no argument, | |
1236 | `(current-module)' is now consulted for definitions to return, instead | |
1237 | of simply returning #f, the former behavior. | |
1238 | ||
f8c9d497 JB |
1239 | ** The #/ syntax for lists is no longer supported. |
1240 | ||
1241 | Earlier versions of Scheme accepted this syntax, but printed a | |
1242 | warning. | |
1243 | ||
1244 | ** Guile no longer consults the SCHEME_LOAD_PATH environment variable. | |
1245 | ||
1246 | Instead, you should set GUILE_LOAD_PATH to tell Guile where to find | |
1247 | modules. | |
1248 | ||
3ffc7a36 MD |
1249 | * Changes to the gh_ interface |
1250 | ||
1251 | ** gh_scm2doubles | |
1252 | ||
1253 | Now takes a second argument which is the result array. If this | |
1254 | pointer is NULL, a new array is malloced (the old behaviour). | |
1255 | ||
1256 | ** gh_chars2byvect, gh_shorts2svect, gh_floats2fvect, gh_scm2chars, | |
1257 | gh_scm2shorts, gh_scm2longs, gh_scm2floats | |
1258 | ||
1259 | New functions. | |
1260 | ||
3e8370c3 MD |
1261 | * Changes to the scm_ interface |
1262 | ||
ad91d6c3 MD |
1263 | ** Function: scm_make_named_hook (char* name, int n_args) |
1264 | ||
1265 | Creates a hook in the same way as make-hook above but also | |
1266 | binds a variable named NAME to it. | |
1267 | ||
1268 | This is the typical way of creating a hook from C code. | |
1269 | ||
1270 | Currently, the variable is created in the root module. This will | |
1271 | change when we get the new module system. | |
1272 | ||
16a5a9a4 MD |
1273 | ** The smob interface |
1274 | ||
1275 | The interface for creating smobs has changed. For documentation, see | |
1276 | data-rep.info (made from guile-core/doc/data-rep.texi). | |
1277 | ||
1278 | *** Deprecated function: SCM scm_newsmob (scm_smobfuns *) | |
1279 | ||
1280 | >>> This function will be removed in 1.3.4. <<< | |
1281 | ||
1282 | It is replaced by: | |
1283 | ||
1284 | *** Function: SCM scm_make_smob_type (const char *name, scm_sizet size) | |
1285 | This function adds a new smob type, named NAME, with instance size | |
1286 | SIZE to the system. The return value is a tag that is used in | |
1287 | creating instances of the type. If SIZE is 0, then no memory will | |
1288 | be allocated when instances of the smob are created, and nothing | |
1289 | will be freed by the default free function. | |
1290 | ||
1291 | *** Function: void scm_set_smob_mark (long tc, SCM (*mark) (SCM)) | |
1292 | This function sets the smob marking procedure for the smob type | |
1293 | specified by the tag TC. TC is the tag returned by | |
1294 | `scm_make_smob_type'. | |
1295 | ||
1296 | *** Function: void scm_set_smob_free (long tc, SCM (*mark) (SCM)) | |
1297 | This function sets the smob freeing procedure for the smob type | |
1298 | specified by the tag TC. TC is the tag returned by | |
1299 | `scm_make_smob_type'. | |
1300 | ||
1301 | *** Function: void scm_set_smob_print (tc, print) | |
1302 | ||
1303 | - Function: void scm_set_smob_print (long tc, | |
1304 | scm_sizet (*print) (SCM, | |
1305 | SCM, | |
1306 | scm_print_state *)) | |
1307 | ||
1308 | This function sets the smob printing procedure for the smob type | |
1309 | specified by the tag TC. TC is the tag returned by | |
1310 | `scm_make_smob_type'. | |
1311 | ||
1312 | *** Function: void scm_set_smob_equalp (long tc, SCM (*equalp) (SCM, SCM)) | |
1313 | This function sets the smob equality-testing predicate for the | |
1314 | smob type specified by the tag TC. TC is the tag returned by | |
1315 | `scm_make_smob_type'. | |
1316 | ||
1317 | *** Macro: void SCM_NEWSMOB (SCM var, long tc, void *data) | |
1318 | Make VALUE contain a smob instance of the type with type code TC and | |
1319 | smob data DATA. VALUE must be previously declared as C type `SCM'. | |
1320 | ||
1321 | *** Macro: fn_returns SCM_RETURN_NEWSMOB (long tc, void *data) | |
1322 | This macro expands to a block of code that creates a smob instance | |
1323 | of the type with type code TC and smob data DATA, and returns that | |
1324 | `SCM' value. It should be the last piece of code in a block. | |
1325 | ||
9e97c52d GH |
1326 | ** The interfaces for using I/O ports and implementing port types |
1327 | (ptobs) have changed significantly. The new interface is based on | |
1328 | shared access to buffers and a new set of ptob procedures. | |
1329 | ||
16a5a9a4 MD |
1330 | *** scm_newptob has been removed |
1331 | ||
1332 | It is replaced by: | |
1333 | ||
1334 | *** Function: SCM scm_make_port_type (type_name, fill_buffer, write_flush) | |
1335 | ||
1336 | - Function: SCM scm_make_port_type (char *type_name, | |
1337 | int (*fill_buffer) (SCM port), | |
1338 | void (*write_flush) (SCM port)); | |
1339 | ||
1340 | Similarly to the new smob interface, there is a set of function | |
1341 | setters by which the user can customize the behaviour of his port | |
544e9093 | 1342 | type. See ports.h (scm_set_port_XXX). |
16a5a9a4 | 1343 | |
9e97c52d GH |
1344 | ** scm_strport_to_string: New function: creates a new string from |
1345 | a string port's buffer. | |
1346 | ||
3e8370c3 MD |
1347 | ** Plug in interface for random number generators |
1348 | The variable `scm_the_rng' in random.c contains a value and three | |
1349 | function pointers which together define the current random number | |
1350 | generator being used by the Scheme level interface and the random | |
1351 | number library functions. | |
1352 | ||
1353 | The user is free to replace the default generator with the generator | |
1354 | of his own choice. | |
1355 | ||
1356 | *** Variable: size_t scm_the_rng.rstate_size | |
1357 | The size of the random state type used by the current RNG | |
1358 | measured in chars. | |
1359 | ||
1360 | *** Function: unsigned long scm_the_rng.random_bits (scm_rstate *STATE) | |
1361 | Given the random STATE, return 32 random bits. | |
1362 | ||
1363 | *** Function: void scm_the_rng.init_rstate (scm_rstate *STATE, chars *S, int N) | |
1364 | Seed random state STATE using string S of length N. | |
1365 | ||
1366 | *** Function: scm_rstate *scm_the_rng.copy_rstate (scm_rstate *STATE) | |
1367 | Given random state STATE, return a malloced copy. | |
1368 | ||
1369 | ** Default RNG | |
1370 | The default RNG is the MWC (Multiply With Carry) random number | |
1371 | generator described by George Marsaglia at the Department of | |
1372 | Statistics and Supercomputer Computations Research Institute, The | |
1373 | Florida State University (http://stat.fsu.edu/~geo). | |
1374 | ||
1375 | It uses 64 bits, has a period of 4578426017172946943 (4.6e18), and | |
1376 | passes all tests in the DIEHARD test suite | |
1377 | (http://stat.fsu.edu/~geo/diehard.html). The generation of 32 bits | |
1378 | costs one multiply and one add on platforms which either supports long | |
1379 | longs (gcc does this on most systems) or have 64 bit longs. The cost | |
1380 | is four multiply on other systems but this can be optimized by writing | |
1381 | scm_i_uniform32 in assembler. | |
1382 | ||
1383 | These functions are provided through the scm_the_rng interface for use | |
1384 | by libguile and the application. | |
1385 | ||
1386 | *** Function: unsigned long scm_i_uniform32 (scm_i_rstate *STATE) | |
1387 | Given the random STATE, return 32 random bits. | |
1388 | Don't use this function directly. Instead go through the plugin | |
1389 | interface (see "Plug in interface" above). | |
1390 | ||
1391 | *** Function: void scm_i_init_rstate (scm_i_rstate *STATE, char *SEED, int N) | |
1392 | Initialize STATE using SEED of length N. | |
1393 | ||
1394 | *** Function: scm_i_rstate *scm_i_copy_rstate (scm_i_rstate *STATE) | |
1395 | Return a malloc:ed copy of STATE. This function can easily be re-used | |
1396 | in the interfaces to other RNGs. | |
1397 | ||
1398 | ** Random number library functions | |
1399 | These functions use the current RNG through the scm_the_rng interface. | |
1400 | It might be a good idea to use these functions from your C code so | |
1401 | that only one random generator is used by all code in your program. | |
1402 | ||
259529f2 | 1403 | The default random state is stored in: |
3e8370c3 MD |
1404 | |
1405 | *** Variable: SCM scm_var_random_state | |
1406 | Contains the vcell of the Scheme variable "*random-state*" which is | |
1407 | used as default state by all random number functions in the Scheme | |
1408 | level interface. | |
1409 | ||
1410 | Example: | |
1411 | ||
259529f2 | 1412 | double x = scm_c_uniform01 (SCM_RSTATE (SCM_CDR (scm_var_random_state))); |
3e8370c3 | 1413 | |
259529f2 MD |
1414 | *** Function: scm_rstate *scm_c_default_rstate (void) |
1415 | This is a convenience function which returns the value of | |
1416 | scm_var_random_state. An error message is generated if this value | |
1417 | isn't a random state. | |
1418 | ||
1419 | *** Function: scm_rstate *scm_c_make_rstate (char *SEED, int LENGTH) | |
1420 | Make a new random state from the string SEED of length LENGTH. | |
1421 | ||
1422 | It is generally not a good idea to use multiple random states in a | |
1423 | program. While subsequent random numbers generated from one random | |
1424 | state are guaranteed to be reasonably independent, there is no such | |
1425 | guarantee for numbers generated from different random states. | |
1426 | ||
1427 | *** Macro: unsigned long scm_c_uniform32 (scm_rstate *STATE) | |
1428 | Return 32 random bits. | |
1429 | ||
1430 | *** Function: double scm_c_uniform01 (scm_rstate *STATE) | |
3e8370c3 MD |
1431 | Return a sample from the uniform(0,1) distribution. |
1432 | ||
259529f2 | 1433 | *** Function: double scm_c_normal01 (scm_rstate *STATE) |
3e8370c3 MD |
1434 | Return a sample from the normal(0,1) distribution. |
1435 | ||
259529f2 | 1436 | *** Function: double scm_c_exp1 (scm_rstate *STATE) |
3e8370c3 MD |
1437 | Return a sample from the exp(1) distribution. |
1438 | ||
259529f2 MD |
1439 | *** Function: unsigned long scm_c_random (scm_rstate *STATE, unsigned long M) |
1440 | Return a sample from the discrete uniform(0,M) distribution. | |
1441 | ||
1442 | *** Function: SCM scm_c_random_bignum (scm_rstate *STATE, SCM M) | |
3e8370c3 | 1443 | Return a sample from the discrete uniform(0,M) distribution. |
259529f2 | 1444 | M must be a bignum object. The returned value may be an INUM. |
3e8370c3 | 1445 | |
9e97c52d | 1446 | |
f3227c7a | 1447 | \f |
d23bbf3e | 1448 | Changes in Guile 1.3 (released Monday, October 19, 1998): |
c484bf7f JB |
1449 | |
1450 | * Changes to the distribution | |
1451 | ||
e2d6569c JB |
1452 | ** We renamed the SCHEME_LOAD_PATH environment variable to GUILE_LOAD_PATH. |
1453 | To avoid conflicts, programs should name environment variables after | |
1454 | themselves, except when there's a common practice establishing some | |
1455 | other convention. | |
1456 | ||
1457 | For now, Guile supports both GUILE_LOAD_PATH and SCHEME_LOAD_PATH, | |
1458 | giving the former precedence, and printing a warning message if the | |
1459 | latter is set. Guile 1.4 will not recognize SCHEME_LOAD_PATH at all. | |
1460 | ||
1461 | ** The header files related to multi-byte characters have been removed. | |
1462 | They were: libguile/extchrs.h and libguile/mbstrings.h. Any C code | |
1463 | which referred to these explicitly will probably need to be rewritten, | |
1464 | since the support for the variant string types has been removed; see | |
1465 | below. | |
1466 | ||
1467 | ** The header files append.h and sequences.h have been removed. These | |
1468 | files implemented non-R4RS operations which would encourage | |
1469 | non-portable programming style and less easy-to-read code. | |
3a97e020 | 1470 | |
c484bf7f JB |
1471 | * Changes to the stand-alone interpreter |
1472 | ||
2e368582 | 1473 | ** New procedures have been added to implement a "batch mode": |
ec4ab4fd | 1474 | |
2e368582 | 1475 | *** Function: batch-mode? |
ec4ab4fd GH |
1476 | |
1477 | Returns a boolean indicating whether the interpreter is in batch | |
1478 | mode. | |
1479 | ||
2e368582 | 1480 | *** Function: set-batch-mode?! ARG |
ec4ab4fd GH |
1481 | |
1482 | If ARG is true, switches the interpreter to batch mode. The `#f' | |
1483 | case has not been implemented. | |
1484 | ||
2e368582 JB |
1485 | ** Guile now provides full command-line editing, when run interactively. |
1486 | To use this feature, you must have the readline library installed. | |
1487 | The Guile build process will notice it, and automatically include | |
1488 | support for it. | |
1489 | ||
1490 | The readline library is available via anonymous FTP from any GNU | |
1491 | mirror site; the canonical location is "ftp://prep.ai.mit.edu/pub/gnu". | |
1492 | ||
a5d6d578 MD |
1493 | ** the-last-stack is now a fluid. |
1494 | ||
c484bf7f JB |
1495 | * Changes to the procedure for linking libguile with your programs |
1496 | ||
71f20534 | 1497 | ** You can now use the `guile-config' utility to build programs that use Guile. |
2e368582 | 1498 | |
2adfe1c0 | 1499 | Guile now includes a command-line utility called `guile-config', which |
71f20534 JB |
1500 | can provide information about how to compile and link programs that |
1501 | use Guile. | |
1502 | ||
1503 | *** `guile-config compile' prints any C compiler flags needed to use Guile. | |
1504 | You should include this command's output on the command line you use | |
1505 | to compile C or C++ code that #includes the Guile header files. It's | |
1506 | usually just a `-I' flag to help the compiler find the Guile headers. | |
1507 | ||
1508 | ||
1509 | *** `guile-config link' prints any linker flags necessary to link with Guile. | |
8aa5c148 | 1510 | |
71f20534 | 1511 | This command writes to its standard output a list of flags which you |
8aa5c148 JB |
1512 | must pass to the linker to link your code against the Guile library. |
1513 | The flags include '-lguile' itself, any other libraries the Guile | |
1514 | library depends upon, and any `-L' flags needed to help the linker | |
1515 | find those libraries. | |
2e368582 JB |
1516 | |
1517 | For example, here is a Makefile rule that builds a program named 'foo' | |
1518 | from the object files ${FOO_OBJECTS}, and links them against Guile: | |
1519 | ||
1520 | foo: ${FOO_OBJECTS} | |
2adfe1c0 | 1521 | ${CC} ${CFLAGS} ${FOO_OBJECTS} `guile-config link` -o foo |
2e368582 | 1522 | |
e2d6569c JB |
1523 | Previous Guile releases recommended that you use autoconf to detect |
1524 | which of a predefined set of libraries were present on your system. | |
2adfe1c0 | 1525 | It is more robust to use `guile-config', since it records exactly which |
e2d6569c JB |
1526 | libraries the installed Guile library requires. |
1527 | ||
2adfe1c0 JB |
1528 | This was originally called `build-guile', but was renamed to |
1529 | `guile-config' before Guile 1.3 was released, to be consistent with | |
1530 | the analogous script for the GTK+ GUI toolkit, which is called | |
1531 | `gtk-config'. | |
1532 | ||
2e368582 | 1533 | |
8aa5c148 JB |
1534 | ** Use the GUILE_FLAGS macro in your configure.in file to find Guile. |
1535 | ||
1536 | If you are using the GNU autoconf package to configure your program, | |
1537 | you can use the GUILE_FLAGS autoconf macro to call `guile-config' | |
1538 | (described above) and gather the necessary values for use in your | |
1539 | Makefiles. | |
1540 | ||
1541 | The GUILE_FLAGS macro expands to configure script code which runs the | |
1542 | `guile-config' script, to find out where Guile's header files and | |
1543 | libraries are installed. It sets two variables, marked for | |
1544 | substitution, as by AC_SUBST. | |
1545 | ||
1546 | GUILE_CFLAGS --- flags to pass to a C or C++ compiler to build | |
1547 | code that uses Guile header files. This is almost always just a | |
1548 | -I flag. | |
1549 | ||
1550 | GUILE_LDFLAGS --- flags to pass to the linker to link a | |
1551 | program against Guile. This includes `-lguile' for the Guile | |
1552 | library itself, any libraries that Guile itself requires (like | |
1553 | -lqthreads), and so on. It may also include a -L flag to tell the | |
1554 | compiler where to find the libraries. | |
1555 | ||
1556 | GUILE_FLAGS is defined in the file guile.m4, in the top-level | |
1557 | directory of the Guile distribution. You can copy it into your | |
1558 | package's aclocal.m4 file, and then use it in your configure.in file. | |
1559 | ||
1560 | If you are using the `aclocal' program, distributed with GNU automake, | |
1561 | to maintain your aclocal.m4 file, the Guile installation process | |
1562 | installs guile.m4 where aclocal will find it. All you need to do is | |
1563 | use GUILE_FLAGS in your configure.in file, and then run `aclocal'; | |
1564 | this will copy the definition of GUILE_FLAGS into your aclocal.m4 | |
1565 | file. | |
1566 | ||
1567 | ||
c484bf7f | 1568 | * Changes to Scheme functions and syntax |
7ad3c1e7 | 1569 | |
02755d59 | 1570 | ** Multi-byte strings have been removed, as have multi-byte and wide |
e2d6569c JB |
1571 | ports. We felt that these were the wrong approach to |
1572 | internationalization support. | |
02755d59 | 1573 | |
2e368582 JB |
1574 | ** New function: readline [PROMPT] |
1575 | Read a line from the terminal, and allow the user to edit it, | |
1576 | prompting with PROMPT. READLINE provides a large set of Emacs-like | |
1577 | editing commands, lets the user recall previously typed lines, and | |
1578 | works on almost every kind of terminal, including dumb terminals. | |
1579 | ||
1580 | READLINE assumes that the cursor is at the beginning of the line when | |
1581 | it is invoked. Thus, you can't print a prompt yourself, and then call | |
1582 | READLINE; you need to package up your prompt as a string, pass it to | |
1583 | the function, and let READLINE print the prompt itself. This is | |
1584 | because READLINE needs to know the prompt's screen width. | |
1585 | ||
8cd57bd0 JB |
1586 | For Guile to provide this function, you must have the readline |
1587 | library, version 2.1 or later, installed on your system. Readline is | |
1588 | available via anonymous FTP from prep.ai.mit.edu in pub/gnu, or from | |
1589 | any GNU mirror site. | |
2e368582 JB |
1590 | |
1591 | See also ADD-HISTORY function. | |
1592 | ||
1593 | ** New function: add-history STRING | |
1594 | Add STRING as the most recent line in the history used by the READLINE | |
1595 | command. READLINE does not add lines to the history itself; you must | |
1596 | call ADD-HISTORY to make previous input available to the user. | |
1597 | ||
8cd57bd0 JB |
1598 | ** The behavior of the read-line function has changed. |
1599 | ||
1600 | This function now uses standard C library functions to read the line, | |
1601 | for speed. This means that it doesn not respect the value of | |
1602 | scm-line-incrementors; it assumes that lines are delimited with | |
1603 | #\newline. | |
1604 | ||
1605 | (Note that this is read-line, the function that reads a line of text | |
1606 | from a port, not readline, the function that reads a line from a | |
1607 | terminal, providing full editing capabilities.) | |
1608 | ||
1a0106ef JB |
1609 | ** New module (ice-9 getopt-gnu-style): Parse command-line arguments. |
1610 | ||
1611 | This module provides some simple argument parsing. It exports one | |
1612 | function: | |
1613 | ||
1614 | Function: getopt-gnu-style ARG-LS | |
1615 | Parse a list of program arguments into an alist of option | |
1616 | descriptions. | |
1617 | ||
1618 | Each item in the list of program arguments is examined to see if | |
1619 | it meets the syntax of a GNU long-named option. An argument like | |
1620 | `--MUMBLE' produces an element of the form (MUMBLE . #t) in the | |
1621 | returned alist, where MUMBLE is a keyword object with the same | |
1622 | name as the argument. An argument like `--MUMBLE=FROB' produces | |
1623 | an element of the form (MUMBLE . FROB), where FROB is a string. | |
1624 | ||
1625 | As a special case, the returned alist also contains a pair whose | |
1626 | car is the symbol `rest'. The cdr of this pair is a list | |
1627 | containing all the items in the argument list that are not options | |
1628 | of the form mentioned above. | |
1629 | ||
1630 | The argument `--' is treated specially: all items in the argument | |
1631 | list appearing after such an argument are not examined, and are | |
1632 | returned in the special `rest' list. | |
1633 | ||
1634 | This function does not parse normal single-character switches. | |
1635 | You will need to parse them out of the `rest' list yourself. | |
1636 | ||
8cd57bd0 JB |
1637 | ** The read syntax for byte vectors and short vectors has changed. |
1638 | ||
1639 | Instead of #bytes(...), write #y(...). | |
1640 | ||
1641 | Instead of #short(...), write #h(...). | |
1642 | ||
1643 | This may seem nutty, but, like the other uniform vectors, byte vectors | |
1644 | and short vectors want to have the same print and read syntax (and, | |
1645 | more basic, want to have read syntax!). Changing the read syntax to | |
1646 | use multiple characters after the hash sign breaks with the | |
1647 | conventions used in R5RS and the conventions used for the other | |
1648 | uniform vectors. It also introduces complexity in the current reader, | |
1649 | both on the C and Scheme levels. (The Right solution is probably to | |
1650 | change the syntax and prototypes for uniform vectors entirely.) | |
1651 | ||
1652 | ||
1653 | ** The new module (ice-9 session) provides useful interactive functions. | |
1654 | ||
1655 | *** New procedure: (apropos REGEXP OPTION ...) | |
1656 | ||
1657 | Display a list of top-level variables whose names match REGEXP, and | |
1658 | the modules they are imported from. Each OPTION should be one of the | |
1659 | following symbols: | |
1660 | ||
1661 | value --- Show the value of each matching variable. | |
1662 | shadow --- Show bindings shadowed by subsequently imported modules. | |
1663 | full --- Same as both `shadow' and `value'. | |
1664 | ||
1665 | For example: | |
1666 | ||
1667 | guile> (apropos "trace" 'full) | |
1668 | debug: trace #<procedure trace args> | |
1669 | debug: untrace #<procedure untrace args> | |
1670 | the-scm-module: display-backtrace #<compiled-closure #<primitive-procedure gsubr-apply>> | |
1671 | the-scm-module: before-backtrace-hook () | |
1672 | the-scm-module: backtrace #<primitive-procedure backtrace> | |
1673 | the-scm-module: after-backtrace-hook () | |
1674 | the-scm-module: has-shown-backtrace-hint? #f | |
1675 | guile> | |
1676 | ||
1677 | ** There are new functions and syntax for working with macros. | |
1678 | ||
1679 | Guile implements macros as a special object type. Any variable whose | |
1680 | top-level binding is a macro object acts as a macro. The macro object | |
1681 | specifies how the expression should be transformed before evaluation. | |
1682 | ||
1683 | *** Macro objects now print in a reasonable way, resembling procedures. | |
1684 | ||
1685 | *** New function: (macro? OBJ) | |
1686 | True iff OBJ is a macro object. | |
1687 | ||
1688 | *** New function: (primitive-macro? OBJ) | |
1689 | Like (macro? OBJ), but true only if OBJ is one of the Guile primitive | |
1690 | macro transformers, implemented in eval.c rather than Scheme code. | |
1691 | ||
dbdd0c16 JB |
1692 | Why do we have this function? |
1693 | - For symmetry with procedure? and primitive-procedure?, | |
1694 | - to allow custom print procedures to tell whether a macro is | |
1695 | primitive, and display it differently, and | |
1696 | - to allow compilers and user-written evaluators to distinguish | |
1697 | builtin special forms from user-defined ones, which could be | |
1698 | compiled. | |
1699 | ||
8cd57bd0 JB |
1700 | *** New function: (macro-type OBJ) |
1701 | Return a value indicating what kind of macro OBJ is. Possible return | |
1702 | values are: | |
1703 | ||
1704 | The symbol `syntax' --- a macro created by procedure->syntax. | |
1705 | The symbol `macro' --- a macro created by procedure->macro. | |
1706 | The symbol `macro!' --- a macro created by procedure->memoizing-macro. | |
1707 | The boolean #f --- if OBJ is not a macro object. | |
1708 | ||
1709 | *** New function: (macro-name MACRO) | |
1710 | Return the name of the macro object MACRO's procedure, as returned by | |
1711 | procedure-name. | |
1712 | ||
1713 | *** New function: (macro-transformer MACRO) | |
1714 | Return the transformer procedure for MACRO. | |
1715 | ||
1716 | *** New syntax: (use-syntax MODULE ... TRANSFORMER) | |
1717 | ||
1718 | Specify a new macro expander to use in the current module. Each | |
1719 | MODULE is a module name, with the same meaning as in the `use-modules' | |
1720 | form; each named module's exported bindings are added to the current | |
1721 | top-level environment. TRANSFORMER is an expression evaluated in the | |
1722 | resulting environment which must yield a procedure to use as the | |
1723 | module's eval transformer: every expression evaluated in this module | |
1724 | is passed to this function, and the result passed to the Guile | |
1725 | interpreter. | |
1726 | ||
1727 | *** macro-eval! is removed. Use local-eval instead. | |
29521173 | 1728 | |
8d9dcb3c MV |
1729 | ** Some magic has been added to the printer to better handle user |
1730 | written printing routines (like record printers, closure printers). | |
1731 | ||
1732 | The problem is that these user written routines must have access to | |
7fbd77df | 1733 | the current `print-state' to be able to handle fancy things like |
8d9dcb3c MV |
1734 | detection of circular references. These print-states have to be |
1735 | passed to the builtin printing routines (display, write, etc) to | |
1736 | properly continue the print chain. | |
1737 | ||
1738 | We didn't want to change all existing print code so that it | |
8cd57bd0 | 1739 | explicitly passes thru a print state in addition to a port. Instead, |
8d9dcb3c MV |
1740 | we extented the possible values that the builtin printing routines |
1741 | accept as a `port'. In addition to a normal port, they now also take | |
1742 | a pair of a normal port and a print-state. Printing will go to the | |
1743 | port and the print-state will be used to control the detection of | |
1744 | circular references, etc. If the builtin function does not care for a | |
1745 | print-state, it is simply ignored. | |
1746 | ||
1747 | User written callbacks are now called with such a pair as their | |
1748 | `port', but because every function now accepts this pair as a PORT | |
1749 | argument, you don't have to worry about that. In fact, it is probably | |
1750 | safest to not check for these pairs. | |
1751 | ||
1752 | However, it is sometimes necessary to continue a print chain on a | |
1753 | different port, for example to get a intermediate string | |
1754 | representation of the printed value, mangle that string somehow, and | |
1755 | then to finally print the mangled string. Use the new function | |
1756 | ||
1757 | inherit-print-state OLD-PORT NEW-PORT | |
1758 | ||
1759 | for this. It constructs a new `port' that prints to NEW-PORT but | |
1760 | inherits the print-state of OLD-PORT. | |
1761 | ||
ef1ea498 MD |
1762 | ** struct-vtable-offset renamed to vtable-offset-user |
1763 | ||
1764 | ** New constants: vtable-index-layout, vtable-index-vtable, vtable-index-printer | |
1765 | ||
1766 | ** There is now a fourth (optional) argument to make-vtable-vtable and | |
1767 | make-struct when constructing new types (vtables). This argument | |
1768 | initializes field vtable-index-printer of the vtable. | |
1769 | ||
4851dc57 MV |
1770 | ** The detection of circular references has been extended to structs. |
1771 | That is, a structure that -- in the process of being printed -- prints | |
1772 | itself does not lead to infinite recursion. | |
1773 | ||
1774 | ** There is now some basic support for fluids. Please read | |
1775 | "libguile/fluid.h" to find out more. It is accessible from Scheme with | |
1776 | the following functions and macros: | |
1777 | ||
9c3fb66f MV |
1778 | Function: make-fluid |
1779 | ||
1780 | Create a new fluid object. Fluids are not special variables or | |
1781 | some other extension to the semantics of Scheme, but rather | |
1782 | ordinary Scheme objects. You can store them into variables (that | |
1783 | are still lexically scoped, of course) or into any other place you | |
1784 | like. Every fluid has a initial value of `#f'. | |
04c76b58 | 1785 | |
9c3fb66f | 1786 | Function: fluid? OBJ |
04c76b58 | 1787 | |
9c3fb66f | 1788 | Test whether OBJ is a fluid. |
04c76b58 | 1789 | |
9c3fb66f MV |
1790 | Function: fluid-ref FLUID |
1791 | Function: fluid-set! FLUID VAL | |
04c76b58 MV |
1792 | |
1793 | Access/modify the fluid FLUID. Modifications are only visible | |
1794 | within the current dynamic root (that includes threads). | |
1795 | ||
9c3fb66f MV |
1796 | Function: with-fluids* FLUIDS VALUES THUNK |
1797 | ||
1798 | FLUIDS is a list of fluids and VALUES a corresponding list of | |
1799 | values for these fluids. Before THUNK gets called the values are | |
1800 | installed in the fluids and the old values of the fluids are | |
1801 | saved in the VALUES list. When the flow of control leaves THUNK | |
1802 | or reenters it, the values get swapped again. You might think of | |
1803 | this as a `safe-fluid-excursion'. Note that the VALUES list is | |
1804 | modified by `with-fluids*'. | |
1805 | ||
1806 | Macro: with-fluids ((FLUID VALUE) ...) FORM ... | |
1807 | ||
1808 | The same as `with-fluids*' but with a different syntax. It looks | |
1809 | just like `let', but both FLUID and VALUE are evaluated. Remember, | |
1810 | fluids are not special variables but ordinary objects. FLUID | |
1811 | should evaluate to a fluid. | |
04c76b58 | 1812 | |
e2d6569c | 1813 | ** Changes to system call interfaces: |
64d01d13 | 1814 | |
e2d6569c | 1815 | *** close-port, close-input-port and close-output-port now return a |
64d01d13 GH |
1816 | boolean instead of an `unspecified' object. #t means that the port |
1817 | was successfully closed, while #f means it was already closed. It is | |
1818 | also now possible for these procedures to raise an exception if an | |
1819 | error occurs (some errors from write can be delayed until close.) | |
1820 | ||
e2d6569c | 1821 | *** the first argument to chmod, fcntl, ftell and fseek can now be a |
6afcd3b2 GH |
1822 | file descriptor. |
1823 | ||
e2d6569c | 1824 | *** the third argument to fcntl is now optional. |
6afcd3b2 | 1825 | |
e2d6569c | 1826 | *** the first argument to chown can now be a file descriptor or a port. |
6afcd3b2 | 1827 | |
e2d6569c | 1828 | *** the argument to stat can now be a port. |
6afcd3b2 | 1829 | |
e2d6569c | 1830 | *** The following new procedures have been added (most use scsh |
64d01d13 GH |
1831 | interfaces): |
1832 | ||
e2d6569c | 1833 | *** procedure: close PORT/FD |
ec4ab4fd GH |
1834 | Similar to close-port (*note close-port: Closing Ports.), but also |
1835 | works on file descriptors. A side effect of closing a file | |
1836 | descriptor is that any ports using that file descriptor are moved | |
1837 | to a different file descriptor and have their revealed counts set | |
1838 | to zero. | |
1839 | ||
e2d6569c | 1840 | *** procedure: port->fdes PORT |
ec4ab4fd GH |
1841 | Returns the integer file descriptor underlying PORT. As a side |
1842 | effect the revealed count of PORT is incremented. | |
1843 | ||
e2d6569c | 1844 | *** procedure: fdes->ports FDES |
ec4ab4fd GH |
1845 | Returns a list of existing ports which have FDES as an underlying |
1846 | file descriptor, without changing their revealed counts. | |
1847 | ||
e2d6569c | 1848 | *** procedure: fdes->inport FDES |
ec4ab4fd GH |
1849 | Returns an existing input port which has FDES as its underlying |
1850 | file descriptor, if one exists, and increments its revealed count. | |
1851 | Otherwise, returns a new input port with a revealed count of 1. | |
1852 | ||
e2d6569c | 1853 | *** procedure: fdes->outport FDES |
ec4ab4fd GH |
1854 | Returns an existing output port which has FDES as its underlying |
1855 | file descriptor, if one exists, and increments its revealed count. | |
1856 | Otherwise, returns a new output port with a revealed count of 1. | |
1857 | ||
1858 | The next group of procedures perform a `dup2' system call, if NEWFD | |
1859 | (an integer) is supplied, otherwise a `dup'. The file descriptor to be | |
1860 | duplicated can be supplied as an integer or contained in a port. The | |
64d01d13 GH |
1861 | type of value returned varies depending on which procedure is used. |
1862 | ||
ec4ab4fd GH |
1863 | All procedures also have the side effect when performing `dup2' that |
1864 | any ports using NEWFD are moved to a different file descriptor and have | |
64d01d13 GH |
1865 | their revealed counts set to zero. |
1866 | ||
e2d6569c | 1867 | *** procedure: dup->fdes PORT/FD [NEWFD] |
ec4ab4fd | 1868 | Returns an integer file descriptor. |
64d01d13 | 1869 | |
e2d6569c | 1870 | *** procedure: dup->inport PORT/FD [NEWFD] |
ec4ab4fd | 1871 | Returns a new input port using the new file descriptor. |
64d01d13 | 1872 | |
e2d6569c | 1873 | *** procedure: dup->outport PORT/FD [NEWFD] |
ec4ab4fd | 1874 | Returns a new output port using the new file descriptor. |
64d01d13 | 1875 | |
e2d6569c | 1876 | *** procedure: dup PORT/FD [NEWFD] |
ec4ab4fd GH |
1877 | Returns a new port if PORT/FD is a port, with the same mode as the |
1878 | supplied port, otherwise returns an integer file descriptor. | |
64d01d13 | 1879 | |
e2d6569c | 1880 | *** procedure: dup->port PORT/FD MODE [NEWFD] |
ec4ab4fd GH |
1881 | Returns a new port using the new file descriptor. MODE supplies a |
1882 | mode string for the port (*note open-file: File Ports.). | |
64d01d13 | 1883 | |
e2d6569c | 1884 | *** procedure: setenv NAME VALUE |
ec4ab4fd GH |
1885 | Modifies the environment of the current process, which is also the |
1886 | default environment inherited by child processes. | |
64d01d13 | 1887 | |
ec4ab4fd GH |
1888 | If VALUE is `#f', then NAME is removed from the environment. |
1889 | Otherwise, the string NAME=VALUE is added to the environment, | |
1890 | replacing any existing string with name matching NAME. | |
64d01d13 | 1891 | |
ec4ab4fd | 1892 | The return value is unspecified. |
956055a9 | 1893 | |
e2d6569c | 1894 | *** procedure: truncate-file OBJ SIZE |
6afcd3b2 GH |
1895 | Truncates the file referred to by OBJ to at most SIZE bytes. OBJ |
1896 | can be a string containing a file name or an integer file | |
1897 | descriptor or port open for output on the file. The underlying | |
1898 | system calls are `truncate' and `ftruncate'. | |
1899 | ||
1900 | The return value is unspecified. | |
1901 | ||
e2d6569c | 1902 | *** procedure: setvbuf PORT MODE [SIZE] |
7a6f1ffa GH |
1903 | Set the buffering mode for PORT. MODE can be: |
1904 | `_IONBF' | |
1905 | non-buffered | |
1906 | ||
1907 | `_IOLBF' | |
1908 | line buffered | |
1909 | ||
1910 | `_IOFBF' | |
1911 | block buffered, using a newly allocated buffer of SIZE bytes. | |
1912 | However if SIZE is zero or unspecified, the port will be made | |
1913 | non-buffered. | |
1914 | ||
1915 | This procedure should not be used after I/O has been performed with | |
1916 | the port. | |
1917 | ||
1918 | Ports are usually block buffered by default, with a default buffer | |
1919 | size. Procedures e.g., *Note open-file: File Ports, which accept a | |
1920 | mode string allow `0' to be added to request an unbuffered port. | |
1921 | ||
e2d6569c | 1922 | *** procedure: fsync PORT/FD |
6afcd3b2 GH |
1923 | Copies any unwritten data for the specified output file descriptor |
1924 | to disk. If PORT/FD is a port, its buffer is flushed before the | |
1925 | underlying file descriptor is fsync'd. The return value is | |
1926 | unspecified. | |
1927 | ||
e2d6569c | 1928 | *** procedure: open-fdes PATH FLAGS [MODES] |
6afcd3b2 GH |
1929 | Similar to `open' but returns a file descriptor instead of a port. |
1930 | ||
e2d6569c | 1931 | *** procedure: execle PATH ENV [ARG] ... |
6afcd3b2 GH |
1932 | Similar to `execl', but the environment of the new process is |
1933 | specified by ENV, which must be a list of strings as returned by | |
1934 | the `environ' procedure. | |
1935 | ||
1936 | This procedure is currently implemented using the `execve' system | |
1937 | call, but we call it `execle' because of its Scheme calling | |
1938 | interface. | |
1939 | ||
e2d6569c | 1940 | *** procedure: strerror ERRNO |
ec4ab4fd GH |
1941 | Returns the Unix error message corresponding to ERRNO, an integer. |
1942 | ||
e2d6569c | 1943 | *** procedure: primitive-exit [STATUS] |
6afcd3b2 GH |
1944 | Terminate the current process without unwinding the Scheme stack. |
1945 | This is would typically be useful after a fork. The exit status | |
1946 | is STATUS if supplied, otherwise zero. | |
1947 | ||
e2d6569c | 1948 | *** procedure: times |
6afcd3b2 GH |
1949 | Returns an object with information about real and processor time. |
1950 | The following procedures accept such an object as an argument and | |
1951 | return a selected component: | |
1952 | ||
1953 | `tms:clock' | |
1954 | The current real time, expressed as time units relative to an | |
1955 | arbitrary base. | |
1956 | ||
1957 | `tms:utime' | |
1958 | The CPU time units used by the calling process. | |
1959 | ||
1960 | `tms:stime' | |
1961 | The CPU time units used by the system on behalf of the | |
1962 | calling process. | |
1963 | ||
1964 | `tms:cutime' | |
1965 | The CPU time units used by terminated child processes of the | |
1966 | calling process, whose status has been collected (e.g., using | |
1967 | `waitpid'). | |
1968 | ||
1969 | `tms:cstime' | |
1970 | Similarly, the CPU times units used by the system on behalf of | |
1971 | terminated child processes. | |
7ad3c1e7 | 1972 | |
e2d6569c JB |
1973 | ** Removed: list-length |
1974 | ** Removed: list-append, list-append! | |
1975 | ** Removed: list-reverse, list-reverse! | |
1976 | ||
1977 | ** array-map renamed to array-map! | |
1978 | ||
1979 | ** serial-array-map renamed to serial-array-map! | |
1980 | ||
660f41fa MD |
1981 | ** catch doesn't take #f as first argument any longer |
1982 | ||
1983 | Previously, it was possible to pass #f instead of a key to `catch'. | |
1984 | That would cause `catch' to pass a jump buffer object to the procedure | |
1985 | passed as second argument. The procedure could then use this jump | |
1986 | buffer objekt as an argument to throw. | |
1987 | ||
1988 | This mechanism has been removed since its utility doesn't motivate the | |
1989 | extra complexity it introduces. | |
1990 | ||
332d00f6 JB |
1991 | ** The `#/' notation for lists now provokes a warning message from Guile. |
1992 | This syntax will be removed from Guile in the near future. | |
1993 | ||
1994 | To disable the warning message, set the GUILE_HUSH environment | |
1995 | variable to any non-empty value. | |
1996 | ||
8cd57bd0 JB |
1997 | ** The newline character now prints as `#\newline', following the |
1998 | normal Scheme notation, not `#\nl'. | |
1999 | ||
c484bf7f JB |
2000 | * Changes to the gh_ interface |
2001 | ||
8986901b JB |
2002 | ** The gh_enter function now takes care of loading the Guile startup files. |
2003 | gh_enter works by calling scm_boot_guile; see the remarks below. | |
2004 | ||
5424b4f7 MD |
2005 | ** Function: void gh_write (SCM x) |
2006 | ||
2007 | Write the printed representation of the scheme object x to the current | |
2008 | output port. Corresponds to the scheme level `write'. | |
2009 | ||
3a97e020 MD |
2010 | ** gh_list_length renamed to gh_length. |
2011 | ||
8d6787b6 MG |
2012 | ** vector handling routines |
2013 | ||
2014 | Several major changes. In particular, gh_vector() now resembles | |
2015 | (vector ...) (with a caveat -- see manual), and gh_make_vector() now | |
956328d2 MG |
2016 | exists and behaves like (make-vector ...). gh_vset() and gh_vref() |
2017 | have been renamed gh_vector_set_x() and gh_vector_ref(). Some missing | |
8d6787b6 MG |
2018 | vector-related gh_ functions have been implemented. |
2019 | ||
7fee59bd MG |
2020 | ** pair and list routines |
2021 | ||
2022 | Implemented several of the R4RS pair and list functions that were | |
2023 | missing. | |
2024 | ||
171422a9 MD |
2025 | ** gh_scm2doubles, gh_doubles2scm, gh_doubles2dvect |
2026 | ||
2027 | New function. Converts double arrays back and forth between Scheme | |
2028 | and C. | |
2029 | ||
c484bf7f JB |
2030 | * Changes to the scm_ interface |
2031 | ||
8986901b JB |
2032 | ** The function scm_boot_guile now takes care of loading the startup files. |
2033 | ||
2034 | Guile's primary initialization function, scm_boot_guile, now takes | |
2035 | care of loading `boot-9.scm', in the `ice-9' module, to initialize | |
2036 | Guile, define the module system, and put together some standard | |
2037 | bindings. It also loads `init.scm', which is intended to hold | |
2038 | site-specific initialization code. | |
2039 | ||
2040 | Since Guile cannot operate properly until boot-9.scm is loaded, there | |
2041 | is no reason to separate loading boot-9.scm from Guile's other | |
2042 | initialization processes. | |
2043 | ||
2044 | This job used to be done by scm_compile_shell_switches, which didn't | |
2045 | make much sense; in particular, it meant that people using Guile for | |
2046 | non-shell-like applications had to jump through hoops to get Guile | |
2047 | initialized properly. | |
2048 | ||
2049 | ** The function scm_compile_shell_switches no longer loads the startup files. | |
2050 | Now, Guile always loads the startup files, whenever it is initialized; | |
2051 | see the notes above for scm_boot_guile and scm_load_startup_files. | |
2052 | ||
2053 | ** Function: scm_load_startup_files | |
2054 | This new function takes care of loading Guile's initialization file | |
2055 | (`boot-9.scm'), and the site initialization file, `init.scm'. Since | |
2056 | this is always called by the Guile initialization process, it's | |
2057 | probably not too useful to call this yourself, but it's there anyway. | |
2058 | ||
87148d9e JB |
2059 | ** The semantics of smob marking have changed slightly. |
2060 | ||
2061 | The smob marking function (the `mark' member of the scm_smobfuns | |
2062 | structure) is no longer responsible for setting the mark bit on the | |
2063 | smob. The generic smob handling code in the garbage collector will | |
2064 | set this bit. The mark function need only ensure that any other | |
2065 | objects the smob refers to get marked. | |
2066 | ||
2067 | Note that this change means that the smob's GC8MARK bit is typically | |
2068 | already set upon entry to the mark function. Thus, marking functions | |
2069 | which look like this: | |
2070 | ||
2071 | { | |
2072 | if (SCM_GC8MARKP (ptr)) | |
2073 | return SCM_BOOL_F; | |
2074 | SCM_SETGC8MARK (ptr); | |
2075 | ... mark objects to which the smob refers ... | |
2076 | } | |
2077 | ||
2078 | are now incorrect, since they will return early, and fail to mark any | |
2079 | other objects the smob refers to. Some code in the Guile library used | |
2080 | to work this way. | |
2081 | ||
1cf84ea5 JB |
2082 | ** The semantics of the I/O port functions in scm_ptobfuns have changed. |
2083 | ||
2084 | If you have implemented your own I/O port type, by writing the | |
2085 | functions required by the scm_ptobfuns and then calling scm_newptob, | |
2086 | you will need to change your functions slightly. | |
2087 | ||
2088 | The functions in a scm_ptobfuns structure now expect the port itself | |
2089 | as their argument; they used to expect the `stream' member of the | |
2090 | port's scm_port_table structure. This allows functions in an | |
2091 | scm_ptobfuns structure to easily access the port's cell (and any flags | |
2092 | it its CAR), and the port's scm_port_table structure. | |
2093 | ||
2094 | Guile now passes the I/O port itself as the `port' argument in the | |
2095 | following scm_ptobfuns functions: | |
2096 | ||
2097 | int (*free) (SCM port); | |
2098 | int (*fputc) (int, SCM port); | |
2099 | int (*fputs) (char *, SCM port); | |
2100 | scm_sizet (*fwrite) SCM_P ((char *ptr, | |
2101 | scm_sizet size, | |
2102 | scm_sizet nitems, | |
2103 | SCM port)); | |
2104 | int (*fflush) (SCM port); | |
2105 | int (*fgetc) (SCM port); | |
2106 | int (*fclose) (SCM port); | |
2107 | ||
2108 | The interfaces to the `mark', `print', `equalp', and `fgets' methods | |
2109 | are unchanged. | |
2110 | ||
2111 | If you have existing code which defines its own port types, it is easy | |
2112 | to convert your code to the new interface; simply apply SCM_STREAM to | |
2113 | the port argument to yield the value you code used to expect. | |
2114 | ||
2115 | Note that since both the port and the stream have the same type in the | |
2116 | C code --- they are both SCM values --- the C compiler will not remind | |
2117 | you if you forget to update your scm_ptobfuns functions. | |
2118 | ||
2119 | ||
933a7411 MD |
2120 | ** Function: int scm_internal_select (int fds, |
2121 | SELECT_TYPE *rfds, | |
2122 | SELECT_TYPE *wfds, | |
2123 | SELECT_TYPE *efds, | |
2124 | struct timeval *timeout); | |
2125 | ||
2126 | This is a replacement for the `select' function provided by the OS. | |
2127 | It enables I/O blocking and sleeping to happen for one cooperative | |
2128 | thread without blocking other threads. It also avoids busy-loops in | |
2129 | these situations. It is intended that all I/O blocking and sleeping | |
2130 | will finally go through this function. Currently, this function is | |
2131 | only available on systems providing `gettimeofday' and `select'. | |
2132 | ||
5424b4f7 MD |
2133 | ** Function: SCM scm_internal_stack_catch (SCM tag, |
2134 | scm_catch_body_t body, | |
2135 | void *body_data, | |
2136 | scm_catch_handler_t handler, | |
2137 | void *handler_data) | |
2138 | ||
2139 | A new sibling to the other two C level `catch' functions | |
2140 | scm_internal_catch and scm_internal_lazy_catch. Use it if you want | |
2141 | the stack to be saved automatically into the variable `the-last-stack' | |
2142 | (scm_the_last_stack_var) on error. This is necessary if you want to | |
2143 | use advanced error reporting, such as calling scm_display_error and | |
2144 | scm_display_backtrace. (They both take a stack object as argument.) | |
2145 | ||
df366c26 MD |
2146 | ** Function: SCM scm_spawn_thread (scm_catch_body_t body, |
2147 | void *body_data, | |
2148 | scm_catch_handler_t handler, | |
2149 | void *handler_data) | |
2150 | ||
2151 | Spawns a new thread. It does a job similar to | |
2152 | scm_call_with_new_thread but takes arguments more suitable when | |
2153 | spawning threads from application C code. | |
2154 | ||
88482b31 MD |
2155 | ** The hook scm_error_callback has been removed. It was originally |
2156 | intended as a way for the user to install his own error handler. But | |
2157 | that method works badly since it intervenes between throw and catch, | |
2158 | thereby changing the semantics of expressions like (catch #t ...). | |
2159 | The correct way to do it is to use one of the C level catch functions | |
2160 | in throw.c: scm_internal_catch/lazy_catch/stack_catch. | |
2161 | ||
3a97e020 MD |
2162 | ** Removed functions: |
2163 | ||
2164 | scm_obj_length, scm_list_length, scm_list_append, scm_list_append_x, | |
2165 | scm_list_reverse, scm_list_reverse_x | |
2166 | ||
2167 | ** New macros: SCM_LISTn where n is one of the integers 0-9. | |
2168 | ||
2169 | These can be used for pretty list creation from C. The idea is taken | |
2170 | from Erick Gallesio's STk. | |
2171 | ||
298aa6e3 MD |
2172 | ** scm_array_map renamed to scm_array_map_x |
2173 | ||
527da704 MD |
2174 | ** mbstrings are now removed |
2175 | ||
2176 | This means that the type codes scm_tc7_mb_string and | |
2177 | scm_tc7_mb_substring has been removed. | |
2178 | ||
8cd57bd0 JB |
2179 | ** scm_gen_putc, scm_gen_puts, scm_gen_write, and scm_gen_getc have changed. |
2180 | ||
2181 | Since we no longer support multi-byte strings, these I/O functions | |
2182 | have been simplified, and renamed. Here are their old names, and | |
2183 | their new names and arguments: | |
2184 | ||
2185 | scm_gen_putc -> void scm_putc (int c, SCM port); | |
2186 | scm_gen_puts -> void scm_puts (char *s, SCM port); | |
2187 | scm_gen_write -> void scm_lfwrite (char *ptr, scm_sizet size, SCM port); | |
2188 | scm_gen_getc -> void scm_getc (SCM port); | |
2189 | ||
2190 | ||
527da704 MD |
2191 | ** The macros SCM_TYP7D and SCM_TYP7SD has been removed. |
2192 | ||
2193 | ** The macro SCM_TYP7S has taken the role of the old SCM_TYP7D | |
2194 | ||
2195 | SCM_TYP7S now masks away the bit which distinguishes substrings from | |
2196 | strings. | |
2197 | ||
660f41fa MD |
2198 | ** scm_catch_body_t: Backward incompatible change! |
2199 | ||
2200 | Body functions to scm_internal_catch and friends do not any longer | |
2201 | take a second argument. This is because it is no longer possible to | |
2202 | pass a #f arg to catch. | |
2203 | ||
a8e05009 JB |
2204 | ** Calls to scm_protect_object and scm_unprotect now nest properly. |
2205 | ||
2206 | The function scm_protect_object protects its argument from being freed | |
2207 | by the garbage collector. scm_unprotect_object removes that | |
2208 | protection. | |
2209 | ||
2210 | These functions now nest properly. That is, for every object O, there | |
2211 | is a counter which scm_protect_object(O) increments and | |
2212 | scm_unprotect_object(O) decrements, if the counter is greater than | |
2213 | zero. Every object's counter is zero when it is first created. If an | |
2214 | object's counter is greater than zero, the garbage collector will not | |
2215 | reclaim its storage. | |
2216 | ||
2217 | This allows you to use scm_protect_object in your code without | |
2218 | worrying that some other function you call will call | |
2219 | scm_unprotect_object, and allow it to be freed. Assuming that the | |
2220 | functions you call are well-behaved, and unprotect only those objects | |
2221 | they protect, you can follow the same rule and have confidence that | |
2222 | objects will be freed only at appropriate times. | |
2223 | ||
c484bf7f JB |
2224 | \f |
2225 | Changes in Guile 1.2 (released Tuesday, June 24 1997): | |
cf78e9e8 | 2226 | |
737c9113 JB |
2227 | * Changes to the distribution |
2228 | ||
832b09ed JB |
2229 | ** Nightly snapshots are now available from ftp.red-bean.com. |
2230 | The old server, ftp.cyclic.com, has been relinquished to its rightful | |
2231 | owner. | |
2232 | ||
2233 | Nightly snapshots of the Guile development sources are now available via | |
2234 | anonymous FTP from ftp.red-bean.com, as /pub/guile/guile-snap.tar.gz. | |
2235 | ||
2236 | Via the web, that's: ftp://ftp.red-bean.com/pub/guile/guile-snap.tar.gz | |
2237 | For getit, that's: ftp.red-bean.com:/pub/guile/guile-snap.tar.gz | |
2238 | ||
0fcab5ed JB |
2239 | ** To run Guile without installing it, the procedure has changed a bit. |
2240 | ||
2241 | If you used a separate build directory to compile Guile, you'll need | |
2242 | to include the build directory in SCHEME_LOAD_PATH, as well as the | |
2243 | source directory. See the `INSTALL' file for examples. | |
2244 | ||
737c9113 JB |
2245 | * Changes to the procedure for linking libguile with your programs |
2246 | ||
94982a4e JB |
2247 | ** The standard Guile load path for Scheme code now includes |
2248 | $(datadir)/guile (usually /usr/local/share/guile). This means that | |
2249 | you can install your own Scheme files there, and Guile will find them. | |
2250 | (Previous versions of Guile only checked a directory whose name | |
2251 | contained the Guile version number, so you had to re-install or move | |
2252 | your Scheme sources each time you installed a fresh version of Guile.) | |
2253 | ||
2254 | The load path also includes $(datadir)/guile/site; we recommend | |
2255 | putting individual Scheme files there. If you want to install a | |
2256 | package with multiple source files, create a directory for them under | |
2257 | $(datadir)/guile. | |
2258 | ||
2259 | ** Guile 1.2 will now use the Rx regular expression library, if it is | |
2260 | installed on your system. When you are linking libguile into your own | |
2261 | programs, this means you will have to link against -lguile, -lqt (if | |
2262 | you configured Guile with thread support), and -lrx. | |
27590f82 JB |
2263 | |
2264 | If you are using autoconf to generate configuration scripts for your | |
2265 | application, the following lines should suffice to add the appropriate | |
2266 | libraries to your link command: | |
2267 | ||
2268 | ### Find Rx, quickthreads and libguile. | |
2269 | AC_CHECK_LIB(rx, main) | |
2270 | AC_CHECK_LIB(qt, main) | |
2271 | AC_CHECK_LIB(guile, scm_shell) | |
2272 | ||
94982a4e JB |
2273 | The Guile 1.2 distribution does not contain sources for the Rx |
2274 | library, as Guile 1.0 did. If you want to use Rx, you'll need to | |
2275 | retrieve it from a GNU FTP site and install it separately. | |
2276 | ||
b83b8bee JB |
2277 | * Changes to Scheme functions and syntax |
2278 | ||
e035e7e6 MV |
2279 | ** The dynamic linking features of Guile are now enabled by default. |
2280 | You can disable them by giving the `--disable-dynamic-linking' option | |
2281 | to configure. | |
2282 | ||
e035e7e6 MV |
2283 | (dynamic-link FILENAME) |
2284 | ||
2285 | Find the object file denoted by FILENAME (a string) and link it | |
2286 | into the running Guile application. When everything works out, | |
2287 | return a Scheme object suitable for representing the linked object | |
2288 | file. Otherwise an error is thrown. How object files are | |
2289 | searched is system dependent. | |
2290 | ||
2291 | (dynamic-object? VAL) | |
2292 | ||
2293 | Determine whether VAL represents a dynamically linked object file. | |
2294 | ||
2295 | (dynamic-unlink DYNOBJ) | |
2296 | ||
2297 | Unlink the indicated object file from the application. DYNOBJ | |
2298 | should be one of the values returned by `dynamic-link'. | |
2299 | ||
2300 | (dynamic-func FUNCTION DYNOBJ) | |
2301 | ||
2302 | Search the C function indicated by FUNCTION (a string or symbol) | |
2303 | in DYNOBJ and return some Scheme object that can later be used | |
2304 | with `dynamic-call' to actually call this function. Right now, | |
2305 | these Scheme objects are formed by casting the address of the | |
2306 | function to `long' and converting this number to its Scheme | |
2307 | representation. | |
2308 | ||
2309 | (dynamic-call FUNCTION DYNOBJ) | |
2310 | ||
2311 | Call the C function indicated by FUNCTION and DYNOBJ. The | |
2312 | function is passed no arguments and its return value is ignored. | |
2313 | When FUNCTION is something returned by `dynamic-func', call that | |
2314 | function and ignore DYNOBJ. When FUNCTION is a string (or symbol, | |
2315 | etc.), look it up in DYNOBJ; this is equivalent to | |
2316 | ||
2317 | (dynamic-call (dynamic-func FUNCTION DYNOBJ) #f) | |
2318 | ||
2319 | Interrupts are deferred while the C function is executing (with | |
2320 | SCM_DEFER_INTS/SCM_ALLOW_INTS). | |
2321 | ||
2322 | (dynamic-args-call FUNCTION DYNOBJ ARGS) | |
2323 | ||
2324 | Call the C function indicated by FUNCTION and DYNOBJ, but pass it | |
2325 | some arguments and return its return value. The C function is | |
2326 | expected to take two arguments and return an `int', just like | |
2327 | `main': | |
2328 | ||
2329 | int c_func (int argc, char **argv); | |
2330 | ||
2331 | ARGS must be a list of strings and is converted into an array of | |
2332 | `char *'. The array is passed in ARGV and its size in ARGC. The | |
2333 | return value is converted to a Scheme number and returned from the | |
2334 | call to `dynamic-args-call'. | |
2335 | ||
0fcab5ed JB |
2336 | When dynamic linking is disabled or not supported on your system, |
2337 | the above functions throw errors, but they are still available. | |
2338 | ||
e035e7e6 MV |
2339 | Here is a small example that works on GNU/Linux: |
2340 | ||
2341 | (define libc-obj (dynamic-link "libc.so")) | |
2342 | (dynamic-args-call 'rand libc-obj '()) | |
2343 | ||
2344 | See the file `libguile/DYNAMIC-LINKING' for additional comments. | |
2345 | ||
27590f82 JB |
2346 | ** The #/ syntax for module names is depreciated, and will be removed |
2347 | in a future version of Guile. Instead of | |
2348 | ||
2349 | #/foo/bar/baz | |
2350 | ||
2351 | instead write | |
2352 | ||
2353 | (foo bar baz) | |
2354 | ||
2355 | The latter syntax is more consistent with existing Lisp practice. | |
2356 | ||
5dade857 MV |
2357 | ** Guile now does fancier printing of structures. Structures are the |
2358 | underlying implementation for records, which in turn are used to | |
2359 | implement modules, so all of these object now print differently and in | |
2360 | a more informative way. | |
2361 | ||
161029df JB |
2362 | The Scheme printer will examine the builtin variable *struct-printer* |
2363 | whenever it needs to print a structure object. When this variable is | |
2364 | not `#f' it is deemed to be a procedure and will be applied to the | |
2365 | structure object and the output port. When *struct-printer* is `#f' | |
2366 | or the procedure return `#f' the structure object will be printed in | |
2367 | the boring #<struct 80458270> form. | |
5dade857 MV |
2368 | |
2369 | This hook is used by some routines in ice-9/boot-9.scm to implement | |
2370 | type specific printing routines. Please read the comments there about | |
2371 | "printing structs". | |
2372 | ||
2373 | One of the more specific uses of structs are records. The printing | |
2374 | procedure that could be passed to MAKE-RECORD-TYPE is now actually | |
2375 | called. It should behave like a *struct-printer* procedure (described | |
2376 | above). | |
2377 | ||
b83b8bee JB |
2378 | ** Guile now supports a new R4RS-compliant syntax for keywords. A |
2379 | token of the form #:NAME, where NAME has the same syntax as a Scheme | |
2380 | symbol, is the external representation of the keyword named NAME. | |
2381 | Keyword objects print using this syntax as well, so values containing | |
1e5afba0 JB |
2382 | keyword objects can be read back into Guile. When used in an |
2383 | expression, keywords are self-quoting objects. | |
b83b8bee JB |
2384 | |
2385 | Guile suports this read syntax, and uses this print syntax, regardless | |
2386 | of the current setting of the `keyword' read option. The `keyword' | |
2387 | read option only controls whether Guile recognizes the `:NAME' syntax, | |
2388 | which is incompatible with R4RS. (R4RS says such token represent | |
2389 | symbols.) | |
737c9113 JB |
2390 | |
2391 | ** Guile has regular expression support again. Guile 1.0 included | |
2392 | functions for matching regular expressions, based on the Rx library. | |
2393 | In Guile 1.1, the Guile/Rx interface was removed to simplify the | |
2394 | distribution, and thus Guile had no regular expression support. Guile | |
94982a4e JB |
2395 | 1.2 again supports the most commonly used functions, and supports all |
2396 | of SCSH's regular expression functions. | |
2409cdfa | 2397 | |
94982a4e JB |
2398 | If your system does not include a POSIX regular expression library, |
2399 | and you have not linked Guile with a third-party regexp library such as | |
2400 | Rx, these functions will not be available. You can tell whether your | |
2401 | Guile installation includes regular expression support by checking | |
2402 | whether the `*features*' list includes the `regex' symbol. | |
737c9113 | 2403 | |
94982a4e | 2404 | *** regexp functions |
161029df | 2405 | |
94982a4e JB |
2406 | By default, Guile supports POSIX extended regular expressions. That |
2407 | means that the characters `(', `)', `+' and `?' are special, and must | |
2408 | be escaped if you wish to match the literal characters. | |
e1a191a8 | 2409 | |
94982a4e JB |
2410 | This regular expression interface was modeled after that implemented |
2411 | by SCSH, the Scheme Shell. It is intended to be upwardly compatible | |
2412 | with SCSH regular expressions. | |
2413 | ||
2414 | **** Function: string-match PATTERN STR [START] | |
2415 | Compile the string PATTERN into a regular expression and compare | |
2416 | it with STR. The optional numeric argument START specifies the | |
2417 | position of STR at which to begin matching. | |
2418 | ||
2419 | `string-match' returns a "match structure" which describes what, | |
2420 | if anything, was matched by the regular expression. *Note Match | |
2421 | Structures::. If STR does not match PATTERN at all, | |
2422 | `string-match' returns `#f'. | |
2423 | ||
2424 | Each time `string-match' is called, it must compile its PATTERN | |
2425 | argument into a regular expression structure. This operation is | |
2426 | expensive, which makes `string-match' inefficient if the same regular | |
2427 | expression is used several times (for example, in a loop). For better | |
2428 | performance, you can compile a regular expression in advance and then | |
2429 | match strings against the compiled regexp. | |
2430 | ||
2431 | **** Function: make-regexp STR [FLAGS] | |
2432 | Compile the regular expression described by STR, and return the | |
2433 | compiled regexp structure. If STR does not describe a legal | |
2434 | regular expression, `make-regexp' throws a | |
2435 | `regular-expression-syntax' error. | |
2436 | ||
2437 | FLAGS may be the bitwise-or of one or more of the following: | |
2438 | ||
2439 | **** Constant: regexp/extended | |
2440 | Use POSIX Extended Regular Expression syntax when interpreting | |
2441 | STR. If not set, POSIX Basic Regular Expression syntax is used. | |
2442 | If the FLAGS argument is omitted, we assume regexp/extended. | |
2443 | ||
2444 | **** Constant: regexp/icase | |
2445 | Do not differentiate case. Subsequent searches using the | |
2446 | returned regular expression will be case insensitive. | |
2447 | ||
2448 | **** Constant: regexp/newline | |
2449 | Match-any-character operators don't match a newline. | |
2450 | ||
2451 | A non-matching list ([^...]) not containing a newline matches a | |
2452 | newline. | |
2453 | ||
2454 | Match-beginning-of-line operator (^) matches the empty string | |
2455 | immediately after a newline, regardless of whether the FLAGS | |
2456 | passed to regexp-exec contain regexp/notbol. | |
2457 | ||
2458 | Match-end-of-line operator ($) matches the empty string | |
2459 | immediately before a newline, regardless of whether the FLAGS | |
2460 | passed to regexp-exec contain regexp/noteol. | |
2461 | ||
2462 | **** Function: regexp-exec REGEXP STR [START [FLAGS]] | |
2463 | Match the compiled regular expression REGEXP against `str'. If | |
2464 | the optional integer START argument is provided, begin matching | |
2465 | from that position in the string. Return a match structure | |
2466 | describing the results of the match, or `#f' if no match could be | |
2467 | found. | |
2468 | ||
2469 | FLAGS may be the bitwise-or of one or more of the following: | |
2470 | ||
2471 | **** Constant: regexp/notbol | |
2472 | The match-beginning-of-line operator always fails to match (but | |
2473 | see the compilation flag regexp/newline above) This flag may be | |
2474 | used when different portions of a string are passed to | |
2475 | regexp-exec and the beginning of the string should not be | |
2476 | interpreted as the beginning of the line. | |
2477 | ||
2478 | **** Constant: regexp/noteol | |
2479 | The match-end-of-line operator always fails to match (but see the | |
2480 | compilation flag regexp/newline above) | |
2481 | ||
2482 | **** Function: regexp? OBJ | |
2483 | Return `#t' if OBJ is a compiled regular expression, or `#f' | |
2484 | otherwise. | |
2485 | ||
2486 | Regular expressions are commonly used to find patterns in one string | |
2487 | and replace them with the contents of another string. | |
2488 | ||
2489 | **** Function: regexp-substitute PORT MATCH [ITEM...] | |
2490 | Write to the output port PORT selected contents of the match | |
2491 | structure MATCH. Each ITEM specifies what should be written, and | |
2492 | may be one of the following arguments: | |
2493 | ||
2494 | * A string. String arguments are written out verbatim. | |
2495 | ||
2496 | * An integer. The submatch with that number is written. | |
2497 | ||
2498 | * The symbol `pre'. The portion of the matched string preceding | |
2499 | the regexp match is written. | |
2500 | ||
2501 | * The symbol `post'. The portion of the matched string | |
2502 | following the regexp match is written. | |
2503 | ||
2504 | PORT may be `#f', in which case nothing is written; instead, | |
2505 | `regexp-substitute' constructs a string from the specified ITEMs | |
2506 | and returns that. | |
2507 | ||
2508 | **** Function: regexp-substitute/global PORT REGEXP TARGET [ITEM...] | |
2509 | Similar to `regexp-substitute', but can be used to perform global | |
2510 | substitutions on STR. Instead of taking a match structure as an | |
2511 | argument, `regexp-substitute/global' takes two string arguments: a | |
2512 | REGEXP string describing a regular expression, and a TARGET string | |
2513 | which should be matched against this regular expression. | |
2514 | ||
2515 | Each ITEM behaves as in REGEXP-SUBSTITUTE, with the following | |
2516 | exceptions: | |
2517 | ||
2518 | * A function may be supplied. When this function is called, it | |
2519 | will be passed one argument: a match structure for a given | |
2520 | regular expression match. It should return a string to be | |
2521 | written out to PORT. | |
2522 | ||
2523 | * The `post' symbol causes `regexp-substitute/global' to recurse | |
2524 | on the unmatched portion of STR. This *must* be supplied in | |
2525 | order to perform global search-and-replace on STR; if it is | |
2526 | not present among the ITEMs, then `regexp-substitute/global' | |
2527 | will return after processing a single match. | |
2528 | ||
2529 | *** Match Structures | |
2530 | ||
2531 | A "match structure" is the object returned by `string-match' and | |
2532 | `regexp-exec'. It describes which portion of a string, if any, matched | |
2533 | the given regular expression. Match structures include: a reference to | |
2534 | the string that was checked for matches; the starting and ending | |
2535 | positions of the regexp match; and, if the regexp included any | |
2536 | parenthesized subexpressions, the starting and ending positions of each | |
2537 | submatch. | |
2538 | ||
2539 | In each of the regexp match functions described below, the `match' | |
2540 | argument must be a match structure returned by a previous call to | |
2541 | `string-match' or `regexp-exec'. Most of these functions return some | |
2542 | information about the original target string that was matched against a | |
2543 | regular expression; we will call that string TARGET for easy reference. | |
2544 | ||
2545 | **** Function: regexp-match? OBJ | |
2546 | Return `#t' if OBJ is a match structure returned by a previous | |
2547 | call to `regexp-exec', or `#f' otherwise. | |
2548 | ||
2549 | **** Function: match:substring MATCH [N] | |
2550 | Return the portion of TARGET matched by subexpression number N. | |
2551 | Submatch 0 (the default) represents the entire regexp match. If | |
2552 | the regular expression as a whole matched, but the subexpression | |
2553 | number N did not match, return `#f'. | |
2554 | ||
2555 | **** Function: match:start MATCH [N] | |
2556 | Return the starting position of submatch number N. | |
2557 | ||
2558 | **** Function: match:end MATCH [N] | |
2559 | Return the ending position of submatch number N. | |
2560 | ||
2561 | **** Function: match:prefix MATCH | |
2562 | Return the unmatched portion of TARGET preceding the regexp match. | |
2563 | ||
2564 | **** Function: match:suffix MATCH | |
2565 | Return the unmatched portion of TARGET following the regexp match. | |
2566 | ||
2567 | **** Function: match:count MATCH | |
2568 | Return the number of parenthesized subexpressions from MATCH. | |
2569 | Note that the entire regular expression match itself counts as a | |
2570 | subexpression, and failed submatches are included in the count. | |
2571 | ||
2572 | **** Function: match:string MATCH | |
2573 | Return the original TARGET string. | |
2574 | ||
2575 | *** Backslash Escapes | |
2576 | ||
2577 | Sometimes you will want a regexp to match characters like `*' or `$' | |
2578 | exactly. For example, to check whether a particular string represents | |
2579 | a menu entry from an Info node, it would be useful to match it against | |
2580 | a regexp like `^* [^:]*::'. However, this won't work; because the | |
2581 | asterisk is a metacharacter, it won't match the `*' at the beginning of | |
2582 | the string. In this case, we want to make the first asterisk un-magic. | |
2583 | ||
2584 | You can do this by preceding the metacharacter with a backslash | |
2585 | character `\'. (This is also called "quoting" the metacharacter, and | |
2586 | is known as a "backslash escape".) When Guile sees a backslash in a | |
2587 | regular expression, it considers the following glyph to be an ordinary | |
2588 | character, no matter what special meaning it would ordinarily have. | |
2589 | Therefore, we can make the above example work by changing the regexp to | |
2590 | `^\* [^:]*::'. The `\*' sequence tells the regular expression engine | |
2591 | to match only a single asterisk in the target string. | |
2592 | ||
2593 | Since the backslash is itself a metacharacter, you may force a | |
2594 | regexp to match a backslash in the target string by preceding the | |
2595 | backslash with itself. For example, to find variable references in a | |
2596 | TeX program, you might want to find occurrences of the string `\let\' | |
2597 | followed by any number of alphabetic characters. The regular expression | |
2598 | `\\let\\[A-Za-z]*' would do this: the double backslashes in the regexp | |
2599 | each match a single backslash in the target string. | |
2600 | ||
2601 | **** Function: regexp-quote STR | |
2602 | Quote each special character found in STR with a backslash, and | |
2603 | return the resulting string. | |
2604 | ||
2605 | *Very important:* Using backslash escapes in Guile source code (as | |
2606 | in Emacs Lisp or C) can be tricky, because the backslash character has | |
2607 | special meaning for the Guile reader. For example, if Guile encounters | |
2608 | the character sequence `\n' in the middle of a string while processing | |
2609 | Scheme code, it replaces those characters with a newline character. | |
2610 | Similarly, the character sequence `\t' is replaced by a horizontal tab. | |
2611 | Several of these "escape sequences" are processed by the Guile reader | |
2612 | before your code is executed. Unrecognized escape sequences are | |
2613 | ignored: if the characters `\*' appear in a string, they will be | |
2614 | translated to the single character `*'. | |
2615 | ||
2616 | This translation is obviously undesirable for regular expressions, | |
2617 | since we want to be able to include backslashes in a string in order to | |
2618 | escape regexp metacharacters. Therefore, to make sure that a backslash | |
2619 | is preserved in a string in your Guile program, you must use *two* | |
2620 | consecutive backslashes: | |
2621 | ||
2622 | (define Info-menu-entry-pattern (make-regexp "^\\* [^:]*")) | |
2623 | ||
2624 | The string in this example is preprocessed by the Guile reader before | |
2625 | any code is executed. The resulting argument to `make-regexp' is the | |
2626 | string `^\* [^:]*', which is what we really want. | |
2627 | ||
2628 | This also means that in order to write a regular expression that | |
2629 | matches a single backslash character, the regular expression string in | |
2630 | the source code must include *four* backslashes. Each consecutive pair | |
2631 | of backslashes gets translated by the Guile reader to a single | |
2632 | backslash, and the resulting double-backslash is interpreted by the | |
2633 | regexp engine as matching a single backslash character. Hence: | |
2634 | ||
2635 | (define tex-variable-pattern (make-regexp "\\\\let\\\\=[A-Za-z]*")) | |
2636 | ||
2637 | The reason for the unwieldiness of this syntax is historical. Both | |
2638 | regular expression pattern matchers and Unix string processing systems | |
2639 | have traditionally used backslashes with the special meanings described | |
2640 | above. The POSIX regular expression specification and ANSI C standard | |
2641 | both require these semantics. Attempting to abandon either convention | |
2642 | would cause other kinds of compatibility problems, possibly more severe | |
2643 | ones. Therefore, without extending the Scheme reader to support | |
2644 | strings with different quoting conventions (an ungainly and confusing | |
2645 | extension when implemented in other languages), we must adhere to this | |
2646 | cumbersome escape syntax. | |
2647 | ||
7ad3c1e7 GH |
2648 | * Changes to the gh_ interface |
2649 | ||
2650 | * Changes to the scm_ interface | |
2651 | ||
2652 | * Changes to system call interfaces: | |
94982a4e | 2653 | |
7ad3c1e7 | 2654 | ** The value returned by `raise' is now unspecified. It throws an exception |
e1a191a8 GH |
2655 | if an error occurs. |
2656 | ||
94982a4e | 2657 | *** A new procedure `sigaction' can be used to install signal handlers |
115b09a5 GH |
2658 | |
2659 | (sigaction signum [action] [flags]) | |
2660 | ||
2661 | signum is the signal number, which can be specified using the value | |
2662 | of SIGINT etc. | |
2663 | ||
2664 | If action is omitted, sigaction returns a pair: the CAR is the current | |
2665 | signal hander, which will be either an integer with the value SIG_DFL | |
2666 | (default action) or SIG_IGN (ignore), or the Scheme procedure which | |
2667 | handles the signal, or #f if a non-Scheme procedure handles the | |
2668 | signal. The CDR contains the current sigaction flags for the handler. | |
2669 | ||
2670 | If action is provided, it is installed as the new handler for signum. | |
2671 | action can be a Scheme procedure taking one argument, or the value of | |
2672 | SIG_DFL (default action) or SIG_IGN (ignore), or #f to restore | |
2673 | whatever signal handler was installed before sigaction was first used. | |
2674 | Flags can optionally be specified for the new handler (SA_RESTART is | |
2675 | always used if the system provides it, so need not be specified.) The | |
2676 | return value is a pair with information about the old handler as | |
2677 | described above. | |
2678 | ||
2679 | This interface does not provide access to the "signal blocking" | |
2680 | facility. Maybe this is not needed, since the thread support may | |
2681 | provide solutions to the problem of consistent access to data | |
2682 | structures. | |
e1a191a8 | 2683 | |
94982a4e | 2684 | *** A new procedure `flush-all-ports' is equivalent to running |
89ea5b7c GH |
2685 | `force-output' on every port open for output. |
2686 | ||
94982a4e JB |
2687 | ** Guile now provides information on how it was built, via the new |
2688 | global variable, %guile-build-info. This variable records the values | |
2689 | of the standard GNU makefile directory variables as an assocation | |
2690 | list, mapping variable names (symbols) onto directory paths (strings). | |
2691 | For example, to find out where the Guile link libraries were | |
2692 | installed, you can say: | |
2693 | ||
2694 | guile -c "(display (assq-ref %guile-build-info 'libdir)) (newline)" | |
2695 | ||
2696 | ||
2697 | * Changes to the scm_ interface | |
2698 | ||
2699 | ** The new function scm_handle_by_message_noexit is just like the | |
2700 | existing scm_handle_by_message function, except that it doesn't call | |
2701 | exit to terminate the process. Instead, it prints a message and just | |
2702 | returns #f. This might be a more appropriate catch-all handler for | |
2703 | new dynamic roots and threads. | |
2704 | ||
cf78e9e8 | 2705 | \f |
c484bf7f | 2706 | Changes in Guile 1.1 (released Friday, May 16 1997): |
f3b1485f JB |
2707 | |
2708 | * Changes to the distribution. | |
2709 | ||
2710 | The Guile 1.0 distribution has been split up into several smaller | |
2711 | pieces: | |
2712 | guile-core --- the Guile interpreter itself. | |
2713 | guile-tcltk --- the interface between the Guile interpreter and | |
2714 | Tcl/Tk; Tcl is an interpreter for a stringy language, and Tk | |
2715 | is a toolkit for building graphical user interfaces. | |
2716 | guile-rgx-ctax --- the interface between Guile and the Rx regular | |
2717 | expression matcher, and the translator for the Ctax | |
2718 | programming language. These are packaged together because the | |
2719 | Ctax translator uses Rx to parse Ctax source code. | |
2720 | ||
095936d2 JB |
2721 | This NEWS file describes the changes made to guile-core since the 1.0 |
2722 | release. | |
2723 | ||
48d224d7 JB |
2724 | We no longer distribute the documentation, since it was either out of |
2725 | date, or incomplete. As soon as we have current documentation, we | |
2726 | will distribute it. | |
2727 | ||
0fcab5ed JB |
2728 | |
2729 | ||
f3b1485f JB |
2730 | * Changes to the stand-alone interpreter |
2731 | ||
48d224d7 JB |
2732 | ** guile now accepts command-line arguments compatible with SCSH, Olin |
2733 | Shivers' Scheme Shell. | |
2734 | ||
2735 | In general, arguments are evaluated from left to right, but there are | |
2736 | exceptions. The following switches stop argument processing, and | |
2737 | stash all remaining command-line arguments as the value returned by | |
2738 | the (command-line) function. | |
2739 | -s SCRIPT load Scheme source code from FILE, and exit | |
2740 | -c EXPR evalute Scheme expression EXPR, and exit | |
2741 | -- stop scanning arguments; run interactively | |
2742 | ||
2743 | The switches below are processed as they are encountered. | |
2744 | -l FILE load Scheme source code from FILE | |
2745 | -e FUNCTION after reading script, apply FUNCTION to | |
2746 | command line arguments | |
2747 | -ds do -s script at this point | |
2748 | --emacs enable Emacs protocol (experimental) | |
2749 | -h, --help display this help and exit | |
2750 | -v, --version display version information and exit | |
2751 | \ read arguments from following script lines | |
2752 | ||
2753 | So, for example, here is a Guile script named `ekko' (thanks, Olin) | |
2754 | which re-implements the traditional "echo" command: | |
2755 | ||
2756 | #!/usr/local/bin/guile -s | |
2757 | !# | |
2758 | (define (main args) | |
2759 | (map (lambda (arg) (display arg) (display " ")) | |
2760 | (cdr args)) | |
2761 | (newline)) | |
2762 | ||
2763 | (main (command-line)) | |
2764 | ||
2765 | Suppose we invoke this script as follows: | |
2766 | ||
2767 | ekko a speckled gecko | |
2768 | ||
2769 | Through the magic of Unix script processing (triggered by the `#!' | |
2770 | token at the top of the file), /usr/local/bin/guile receives the | |
2771 | following list of command-line arguments: | |
2772 | ||
2773 | ("-s" "./ekko" "a" "speckled" "gecko") | |
2774 | ||
2775 | Unix inserts the name of the script after the argument specified on | |
2776 | the first line of the file (in this case, "-s"), and then follows that | |
2777 | with the arguments given to the script. Guile loads the script, which | |
2778 | defines the `main' function, and then applies it to the list of | |
2779 | remaining command-line arguments, ("a" "speckled" "gecko"). | |
2780 | ||
095936d2 JB |
2781 | In Unix, the first line of a script file must take the following form: |
2782 | ||
2783 | #!INTERPRETER ARGUMENT | |
2784 | ||
2785 | where INTERPRETER is the absolute filename of the interpreter | |
2786 | executable, and ARGUMENT is a single command-line argument to pass to | |
2787 | the interpreter. | |
2788 | ||
2789 | You may only pass one argument to the interpreter, and its length is | |
2790 | limited. These restrictions can be annoying to work around, so Guile | |
2791 | provides a general mechanism (borrowed from, and compatible with, | |
2792 | SCSH) for circumventing them. | |
2793 | ||
2794 | If the ARGUMENT in a Guile script is a single backslash character, | |
2795 | `\', Guile will open the script file, parse arguments from its second | |
2796 | and subsequent lines, and replace the `\' with them. So, for example, | |
2797 | here is another implementation of the `ekko' script: | |
2798 | ||
2799 | #!/usr/local/bin/guile \ | |
2800 | -e main -s | |
2801 | !# | |
2802 | (define (main args) | |
2803 | (for-each (lambda (arg) (display arg) (display " ")) | |
2804 | (cdr args)) | |
2805 | (newline)) | |
2806 | ||
2807 | If the user invokes this script as follows: | |
2808 | ||
2809 | ekko a speckled gecko | |
2810 | ||
2811 | Unix expands this into | |
2812 | ||
2813 | /usr/local/bin/guile \ ekko a speckled gecko | |
2814 | ||
2815 | When Guile sees the `\' argument, it replaces it with the arguments | |
2816 | read from the second line of the script, producing: | |
2817 | ||
2818 | /usr/local/bin/guile -e main -s ekko a speckled gecko | |
2819 | ||
2820 | This tells Guile to load the `ekko' script, and apply the function | |
2821 | `main' to the argument list ("a" "speckled" "gecko"). | |
2822 | ||
2823 | Here is how Guile parses the command-line arguments: | |
2824 | - Each space character terminates an argument. This means that two | |
2825 | spaces in a row introduce an empty-string argument. | |
2826 | - The tab character is not permitted (unless you quote it with the | |
2827 | backslash character, as described below), to avoid confusion. | |
2828 | - The newline character terminates the sequence of arguments, and will | |
2829 | also terminate a final non-empty argument. (However, a newline | |
2830 | following a space will not introduce a final empty-string argument; | |
2831 | it only terminates the argument list.) | |
2832 | - The backslash character is the escape character. It escapes | |
2833 | backslash, space, tab, and newline. The ANSI C escape sequences | |
2834 | like \n and \t are also supported. These produce argument | |
2835 | constituents; the two-character combination \n doesn't act like a | |
2836 | terminating newline. The escape sequence \NNN for exactly three | |
2837 | octal digits reads as the character whose ASCII code is NNN. As | |
2838 | above, characters produced this way are argument constituents. | |
2839 | Backslash followed by other characters is not allowed. | |
2840 | ||
48d224d7 JB |
2841 | * Changes to the procedure for linking libguile with your programs |
2842 | ||
2843 | ** Guile now builds and installs a shared guile library, if your | |
2844 | system support shared libraries. (It still builds a static library on | |
2845 | all systems.) Guile automatically detects whether your system | |
2846 | supports shared libraries. To prevent Guile from buildisg shared | |
2847 | libraries, pass the `--disable-shared' flag to the configure script. | |
2848 | ||
2849 | Guile takes longer to compile when it builds shared libraries, because | |
2850 | it must compile every file twice --- once to produce position- | |
2851 | independent object code, and once to produce normal object code. | |
2852 | ||
2853 | ** The libthreads library has been merged into libguile. | |
2854 | ||
2855 | To link a program against Guile, you now need only link against | |
2856 | -lguile and -lqt; -lthreads is no longer needed. If you are using | |
2857 | autoconf to generate configuration scripts for your application, the | |
2858 | following lines should suffice to add the appropriate libraries to | |
2859 | your link command: | |
2860 | ||
2861 | ### Find quickthreads and libguile. | |
2862 | AC_CHECK_LIB(qt, main) | |
2863 | AC_CHECK_LIB(guile, scm_shell) | |
f3b1485f JB |
2864 | |
2865 | * Changes to Scheme functions | |
2866 | ||
095936d2 JB |
2867 | ** Guile Scheme's special syntax for keyword objects is now optional, |
2868 | and disabled by default. | |
2869 | ||
2870 | The syntax variation from R4RS made it difficult to port some | |
2871 | interesting packages to Guile. The routines which accepted keyword | |
2872 | arguments (mostly in the module system) have been modified to also | |
2873 | accept symbols whose names begin with `:'. | |
2874 | ||
2875 | To change the keyword syntax, you must first import the (ice-9 debug) | |
2876 | module: | |
2877 | (use-modules (ice-9 debug)) | |
2878 | ||
2879 | Then you can enable the keyword syntax as follows: | |
2880 | (read-set! keywords 'prefix) | |
2881 | ||
2882 | To disable keyword syntax, do this: | |
2883 | (read-set! keywords #f) | |
2884 | ||
2885 | ** Many more primitive functions accept shared substrings as | |
2886 | arguments. In the past, these functions required normal, mutable | |
2887 | strings as arguments, although they never made use of this | |
2888 | restriction. | |
2889 | ||
2890 | ** The uniform array functions now operate on byte vectors. These | |
2891 | functions are `array-fill!', `serial-array-copy!', `array-copy!', | |
2892 | `serial-array-map', `array-map', `array-for-each', and | |
2893 | `array-index-map!'. | |
2894 | ||
2895 | ** The new functions `trace' and `untrace' implement simple debugging | |
2896 | support for Scheme functions. | |
2897 | ||
2898 | The `trace' function accepts any number of procedures as arguments, | |
2899 | and tells the Guile interpreter to display each procedure's name and | |
2900 | arguments each time the procedure is invoked. When invoked with no | |
2901 | arguments, `trace' returns the list of procedures currently being | |
2902 | traced. | |
2903 | ||
2904 | The `untrace' function accepts any number of procedures as arguments, | |
2905 | and tells the Guile interpreter not to trace them any more. When | |
2906 | invoked with no arguments, `untrace' untraces all curretly traced | |
2907 | procedures. | |
2908 | ||
2909 | The tracing in Guile has an advantage over most other systems: we | |
2910 | don't create new procedure objects, but mark the procedure objects | |
2911 | themselves. This means that anonymous and internal procedures can be | |
2912 | traced. | |
2913 | ||
2914 | ** The function `assert-repl-prompt' has been renamed to | |
2915 | `set-repl-prompt!'. It takes one argument, PROMPT. | |
2916 | - If PROMPT is #f, the Guile read-eval-print loop will not prompt. | |
2917 | - If PROMPT is a string, we use it as a prompt. | |
2918 | - If PROMPT is a procedure accepting no arguments, we call it, and | |
2919 | display the result as a prompt. | |
2920 | - Otherwise, we display "> ". | |
2921 | ||
2922 | ** The new function `eval-string' reads Scheme expressions from a | |
2923 | string and evaluates them, returning the value of the last expression | |
2924 | in the string. If the string contains no expressions, it returns an | |
2925 | unspecified value. | |
2926 | ||
2927 | ** The new function `thunk?' returns true iff its argument is a | |
2928 | procedure of zero arguments. | |
2929 | ||
2930 | ** `defined?' is now a builtin function, instead of syntax. This | |
2931 | means that its argument should be quoted. It returns #t iff its | |
2932 | argument is bound in the current module. | |
2933 | ||
2934 | ** The new syntax `use-modules' allows you to add new modules to your | |
2935 | environment without re-typing a complete `define-module' form. It | |
2936 | accepts any number of module names as arguments, and imports their | |
2937 | public bindings into the current module. | |
2938 | ||
2939 | ** The new function (module-defined? NAME MODULE) returns true iff | |
2940 | NAME, a symbol, is defined in MODULE, a module object. | |
2941 | ||
2942 | ** The new function `builtin-bindings' creates and returns a hash | |
2943 | table containing copies of all the root module's bindings. | |
2944 | ||
2945 | ** The new function `builtin-weak-bindings' does the same as | |
2946 | `builtin-bindings', but creates a doubly-weak hash table. | |
2947 | ||
2948 | ** The `equal?' function now considers variable objects to be | |
2949 | equivalent if they have the same name and the same value. | |
2950 | ||
2951 | ** The new function `command-line' returns the command-line arguments | |
2952 | given to Guile, as a list of strings. | |
2953 | ||
2954 | When using guile as a script interpreter, `command-line' returns the | |
2955 | script's arguments; those processed by the interpreter (like `-s' or | |
2956 | `-c') are omitted. (In other words, you get the normal, expected | |
2957 | behavior.) Any application that uses scm_shell to process its | |
2958 | command-line arguments gets this behavior as well. | |
2959 | ||
2960 | ** The new function `load-user-init' looks for a file called `.guile' | |
2961 | in the user's home directory, and loads it if it exists. This is | |
2962 | mostly for use by the code generated by scm_compile_shell_switches, | |
2963 | but we thought it might also be useful in other circumstances. | |
2964 | ||
2965 | ** The new function `log10' returns the base-10 logarithm of its | |
2966 | argument. | |
2967 | ||
2968 | ** Changes to I/O functions | |
2969 | ||
2970 | *** The functions `read', `primitive-load', `read-and-eval!', and | |
2971 | `primitive-load-path' no longer take optional arguments controlling | |
2972 | case insensitivity and a `#' parser. | |
2973 | ||
2974 | Case sensitivity is now controlled by a read option called | |
2975 | `case-insensitive'. The user can add new `#' syntaxes with the | |
2976 | `read-hash-extend' function (see below). | |
2977 | ||
2978 | *** The new function `read-hash-extend' allows the user to change the | |
2979 | syntax of Guile Scheme in a somewhat controlled way. | |
2980 | ||
2981 | (read-hash-extend CHAR PROC) | |
2982 | When parsing S-expressions, if we read a `#' character followed by | |
2983 | the character CHAR, use PROC to parse an object from the stream. | |
2984 | If PROC is #f, remove any parsing procedure registered for CHAR. | |
2985 | ||
2986 | The reader applies PROC to two arguments: CHAR and an input port. | |
2987 | ||
2988 | *** The new functions read-delimited and read-delimited! provide a | |
2989 | general mechanism for doing delimited input on streams. | |
2990 | ||
2991 | (read-delimited DELIMS [PORT HANDLE-DELIM]) | |
2992 | Read until we encounter one of the characters in DELIMS (a string), | |
2993 | or end-of-file. PORT is the input port to read from; it defaults to | |
2994 | the current input port. The HANDLE-DELIM parameter determines how | |
2995 | the terminating character is handled; it should be one of the | |
2996 | following symbols: | |
2997 | ||
2998 | 'trim omit delimiter from result | |
2999 | 'peek leave delimiter character in input stream | |
3000 | 'concat append delimiter character to returned value | |
3001 | 'split return a pair: (RESULT . TERMINATOR) | |
3002 | ||
3003 | HANDLE-DELIM defaults to 'peek. | |
3004 | ||
3005 | (read-delimited! DELIMS BUF [PORT HANDLE-DELIM START END]) | |
3006 | A side-effecting variant of `read-delimited'. | |
3007 | ||
3008 | The data is written into the string BUF at the indices in the | |
3009 | half-open interval [START, END); the default interval is the whole | |
3010 | string: START = 0 and END = (string-length BUF). The values of | |
3011 | START and END must specify a well-defined interval in BUF, i.e. | |
3012 | 0 <= START <= END <= (string-length BUF). | |
3013 | ||
3014 | It returns NBYTES, the number of bytes read. If the buffer filled | |
3015 | up without a delimiter character being found, it returns #f. If the | |
3016 | port is at EOF when the read starts, it returns the EOF object. | |
3017 | ||
3018 | If an integer is returned (i.e., the read is successfully terminated | |
3019 | by reading a delimiter character), then the HANDLE-DELIM parameter | |
3020 | determines how to handle the terminating character. It is described | |
3021 | above, and defaults to 'peek. | |
3022 | ||
3023 | (The descriptions of these functions were borrowed from the SCSH | |
3024 | manual, by Olin Shivers and Brian Carlstrom.) | |
3025 | ||
3026 | *** The `%read-delimited!' function is the primitive used to implement | |
3027 | `read-delimited' and `read-delimited!'. | |
3028 | ||
3029 | (%read-delimited! DELIMS BUF GOBBLE? [PORT START END]) | |
3030 | ||
3031 | This returns a pair of values: (TERMINATOR . NUM-READ). | |
3032 | - TERMINATOR describes why the read was terminated. If it is a | |
3033 | character or the eof object, then that is the value that terminated | |
3034 | the read. If it is #f, the function filled the buffer without finding | |
3035 | a delimiting character. | |
3036 | - NUM-READ is the number of characters read into BUF. | |
3037 | ||
3038 | If the read is successfully terminated by reading a delimiter | |
3039 | character, then the gobble? parameter determines what to do with the | |
3040 | terminating character. If true, the character is removed from the | |
3041 | input stream; if false, the character is left in the input stream | |
3042 | where a subsequent read operation will retrieve it. In either case, | |
3043 | the character is also the first value returned by the procedure call. | |
3044 | ||
3045 | (The descriptions of this function was borrowed from the SCSH manual, | |
3046 | by Olin Shivers and Brian Carlstrom.) | |
3047 | ||
3048 | *** The `read-line' and `read-line!' functions have changed; they now | |
3049 | trim the terminator by default; previously they appended it to the | |
3050 | returned string. For the old behavior, use (read-line PORT 'concat). | |
3051 | ||
3052 | *** The functions `uniform-array-read!' and `uniform-array-write!' now | |
3053 | take new optional START and END arguments, specifying the region of | |
3054 | the array to read and write. | |
3055 | ||
f348c807 JB |
3056 | *** The `ungetc-char-ready?' function has been removed. We feel it's |
3057 | inappropriate for an interface to expose implementation details this | |
3058 | way. | |
095936d2 JB |
3059 | |
3060 | ** Changes to the Unix library and system call interface | |
3061 | ||
3062 | *** The new fcntl function provides access to the Unix `fcntl' system | |
3063 | call. | |
3064 | ||
3065 | (fcntl PORT COMMAND VALUE) | |
3066 | Apply COMMAND to PORT's file descriptor, with VALUE as an argument. | |
3067 | Values for COMMAND are: | |
3068 | ||
3069 | F_DUPFD duplicate a file descriptor | |
3070 | F_GETFD read the descriptor's close-on-exec flag | |
3071 | F_SETFD set the descriptor's close-on-exec flag to VALUE | |
3072 | F_GETFL read the descriptor's flags, as set on open | |
3073 | F_SETFL set the descriptor's flags, as set on open to VALUE | |
3074 | F_GETOWN return the process ID of a socket's owner, for SIGIO | |
3075 | F_SETOWN set the process that owns a socket to VALUE, for SIGIO | |
3076 | FD_CLOEXEC not sure what this is | |
3077 | ||
3078 | For details, see the documentation for the fcntl system call. | |
3079 | ||
3080 | *** The arguments to `select' have changed, for compatibility with | |
3081 | SCSH. The TIMEOUT parameter may now be non-integral, yielding the | |
3082 | expected behavior. The MILLISECONDS parameter has been changed to | |
3083 | MICROSECONDS, to more closely resemble the underlying system call. | |
3084 | The RVEC, WVEC, and EVEC arguments can now be vectors; the type of the | |
3085 | corresponding return set will be the same. | |
3086 | ||
3087 | *** The arguments to the `mknod' system call have changed. They are | |
3088 | now: | |
3089 | ||
3090 | (mknod PATH TYPE PERMS DEV) | |
3091 | Create a new file (`node') in the file system. PATH is the name of | |
3092 | the file to create. TYPE is the kind of file to create; it should | |
3093 | be 'fifo, 'block-special, or 'char-special. PERMS specifies the | |
3094 | permission bits to give the newly created file. If TYPE is | |
3095 | 'block-special or 'char-special, DEV specifies which device the | |
3096 | special file refers to; its interpretation depends on the kind of | |
3097 | special file being created. | |
3098 | ||
3099 | *** The `fork' function has been renamed to `primitive-fork', to avoid | |
3100 | clashing with various SCSH forks. | |
3101 | ||
3102 | *** The `recv' and `recvfrom' functions have been renamed to `recv!' | |
3103 | and `recvfrom!'. They no longer accept a size for a second argument; | |
3104 | you must pass a string to hold the received value. They no longer | |
3105 | return the buffer. Instead, `recv' returns the length of the message | |
3106 | received, and `recvfrom' returns a pair containing the packet's length | |
3107 | and originating address. | |
3108 | ||
3109 | *** The file descriptor datatype has been removed, as have the | |
3110 | `read-fd', `write-fd', `close', `lseek', and `dup' functions. | |
3111 | We plan to replace these functions with a SCSH-compatible interface. | |
3112 | ||
3113 | *** The `create' function has been removed; it's just a special case | |
3114 | of `open'. | |
3115 | ||
3116 | *** There are new functions to break down process termination status | |
3117 | values. In the descriptions below, STATUS is a value returned by | |
3118 | `waitpid'. | |
3119 | ||
3120 | (status:exit-val STATUS) | |
3121 | If the child process exited normally, this function returns the exit | |
3122 | code for the child process (i.e., the value passed to exit, or | |
3123 | returned from main). If the child process did not exit normally, | |
3124 | this function returns #f. | |
3125 | ||
3126 | (status:stop-sig STATUS) | |
3127 | If the child process was suspended by a signal, this function | |
3128 | returns the signal that suspended the child. Otherwise, it returns | |
3129 | #f. | |
3130 | ||
3131 | (status:term-sig STATUS) | |
3132 | If the child process terminated abnormally, this function returns | |
3133 | the signal that terminated the child. Otherwise, this function | |
3134 | returns false. | |
3135 | ||
3136 | POSIX promises that exactly one of these functions will return true on | |
3137 | a valid STATUS value. | |
3138 | ||
3139 | These functions are compatible with SCSH. | |
3140 | ||
3141 | *** There are new accessors and setters for the broken-out time vectors | |
48d224d7 JB |
3142 | returned by `localtime', `gmtime', and that ilk. They are: |
3143 | ||
3144 | Component Accessor Setter | |
3145 | ========================= ============ ============ | |
3146 | seconds tm:sec set-tm:sec | |
3147 | minutes tm:min set-tm:min | |
3148 | hours tm:hour set-tm:hour | |
3149 | day of the month tm:mday set-tm:mday | |
3150 | month tm:mon set-tm:mon | |
3151 | year tm:year set-tm:year | |
3152 | day of the week tm:wday set-tm:wday | |
3153 | day in the year tm:yday set-tm:yday | |
3154 | daylight saving time tm:isdst set-tm:isdst | |
3155 | GMT offset, seconds tm:gmtoff set-tm:gmtoff | |
3156 | name of time zone tm:zone set-tm:zone | |
3157 | ||
095936d2 JB |
3158 | *** There are new accessors for the vectors returned by `uname', |
3159 | describing the host system: | |
48d224d7 JB |
3160 | |
3161 | Component Accessor | |
3162 | ============================================== ================ | |
3163 | name of the operating system implementation utsname:sysname | |
3164 | network name of this machine utsname:nodename | |
3165 | release level of the operating system utsname:release | |
3166 | version level of the operating system utsname:version | |
3167 | machine hardware platform utsname:machine | |
3168 | ||
095936d2 JB |
3169 | *** There are new accessors for the vectors returned by `getpw', |
3170 | `getpwnam', `getpwuid', and `getpwent', describing entries from the | |
3171 | system's user database: | |
3172 | ||
3173 | Component Accessor | |
3174 | ====================== ================= | |
3175 | user name passwd:name | |
3176 | user password passwd:passwd | |
3177 | user id passwd:uid | |
3178 | group id passwd:gid | |
3179 | real name passwd:gecos | |
3180 | home directory passwd:dir | |
3181 | shell program passwd:shell | |
3182 | ||
3183 | *** There are new accessors for the vectors returned by `getgr', | |
3184 | `getgrnam', `getgrgid', and `getgrent', describing entries from the | |
3185 | system's group database: | |
3186 | ||
3187 | Component Accessor | |
3188 | ======================= ============ | |
3189 | group name group:name | |
3190 | group password group:passwd | |
3191 | group id group:gid | |
3192 | group members group:mem | |
3193 | ||
3194 | *** There are new accessors for the vectors returned by `gethost', | |
3195 | `gethostbyaddr', `gethostbyname', and `gethostent', describing | |
3196 | internet hosts: | |
3197 | ||
3198 | Component Accessor | |
3199 | ========================= =============== | |
3200 | official name of host hostent:name | |
3201 | alias list hostent:aliases | |
3202 | host address type hostent:addrtype | |
3203 | length of address hostent:length | |
3204 | list of addresses hostent:addr-list | |
3205 | ||
3206 | *** There are new accessors for the vectors returned by `getnet', | |
3207 | `getnetbyaddr', `getnetbyname', and `getnetent', describing internet | |
3208 | networks: | |
3209 | ||
3210 | Component Accessor | |
3211 | ========================= =============== | |
3212 | official name of net netent:name | |
3213 | alias list netent:aliases | |
3214 | net number type netent:addrtype | |
3215 | net number netent:net | |
3216 | ||
3217 | *** There are new accessors for the vectors returned by `getproto', | |
3218 | `getprotobyname', `getprotobynumber', and `getprotoent', describing | |
3219 | internet protocols: | |
3220 | ||
3221 | Component Accessor | |
3222 | ========================= =============== | |
3223 | official protocol name protoent:name | |
3224 | alias list protoent:aliases | |
3225 | protocol number protoent:proto | |
3226 | ||
3227 | *** There are new accessors for the vectors returned by `getserv', | |
3228 | `getservbyname', `getservbyport', and `getservent', describing | |
3229 | internet protocols: | |
3230 | ||
3231 | Component Accessor | |
3232 | ========================= =============== | |
3233 | official service name servent:name | |
3234 | alias list servent:aliases | |
3235 | port number servent:port | |
3236 | protocol to use servent:proto | |
3237 | ||
3238 | *** There are new accessors for the sockaddr structures returned by | |
3239 | `accept', `getsockname', `getpeername', `recvfrom!': | |
3240 | ||
3241 | Component Accessor | |
3242 | ======================================== =============== | |
3243 | address format (`family') sockaddr:fam | |
3244 | path, for file domain addresses sockaddr:path | |
3245 | address, for internet domain addresses sockaddr:addr | |
3246 | TCP or UDP port, for internet sockaddr:port | |
3247 | ||
3248 | *** The `getpwent', `getgrent', `gethostent', `getnetent', | |
3249 | `getprotoent', and `getservent' functions now return #f at the end of | |
3250 | the user database. (They used to throw an exception.) | |
3251 | ||
3252 | Note that calling MUMBLEent function is equivalent to calling the | |
3253 | corresponding MUMBLE function with no arguments. | |
3254 | ||
3255 | *** The `setpwent', `setgrent', `sethostent', `setnetent', | |
3256 | `setprotoent', and `setservent' routines now take no arguments. | |
3257 | ||
3258 | *** The `gethost', `getproto', `getnet', and `getserv' functions now | |
3259 | provide more useful information when they throw an exception. | |
3260 | ||
3261 | *** The `lnaof' function has been renamed to `inet-lnaof'. | |
3262 | ||
3263 | *** Guile now claims to have the `current-time' feature. | |
3264 | ||
3265 | *** The `mktime' function now takes an optional second argument ZONE, | |
3266 | giving the time zone to use for the conversion. ZONE should be a | |
3267 | string, in the same format as expected for the "TZ" environment variable. | |
3268 | ||
3269 | *** The `strptime' function now returns a pair (TIME . COUNT), where | |
3270 | TIME is the parsed time as a vector, and COUNT is the number of | |
3271 | characters from the string left unparsed. This function used to | |
3272 | return the remaining characters as a string. | |
3273 | ||
3274 | *** The `gettimeofday' function has replaced the old `time+ticks' function. | |
3275 | The return value is now (SECONDS . MICROSECONDS); the fractional | |
3276 | component is no longer expressed in "ticks". | |
3277 | ||
3278 | *** The `ticks/sec' constant has been removed, in light of the above change. | |
6685dc83 | 3279 | |
ea00ecba MG |
3280 | * Changes to the gh_ interface |
3281 | ||
3282 | ** gh_eval_str() now returns an SCM object which is the result of the | |
3283 | evaluation | |
3284 | ||
aaef0d2a MG |
3285 | ** gh_scm2str() now copies the Scheme data to a caller-provided C |
3286 | array | |
3287 | ||
3288 | ** gh_scm2newstr() now makes a C array, copies the Scheme data to it, | |
3289 | and returns the array | |
3290 | ||
3291 | ** gh_scm2str0() is gone: there is no need to distinguish | |
3292 | null-terminated from non-null-terminated, since gh_scm2newstr() allows | |
3293 | the user to interpret the data both ways. | |
3294 | ||
f3b1485f JB |
3295 | * Changes to the scm_ interface |
3296 | ||
095936d2 JB |
3297 | ** The new function scm_symbol_value0 provides an easy way to get a |
3298 | symbol's value from C code: | |
3299 | ||
3300 | SCM scm_symbol_value0 (char *NAME) | |
3301 | Return the value of the symbol named by the null-terminated string | |
3302 | NAME in the current module. If the symbol named NAME is unbound in | |
3303 | the current module, return SCM_UNDEFINED. | |
3304 | ||
3305 | ** The new function scm_sysintern0 creates new top-level variables, | |
3306 | without assigning them a value. | |
3307 | ||
3308 | SCM scm_sysintern0 (char *NAME) | |
3309 | Create a new Scheme top-level variable named NAME. NAME is a | |
3310 | null-terminated string. Return the variable's value cell. | |
3311 | ||
3312 | ** The function scm_internal_catch is the guts of catch. It handles | |
3313 | all the mechanics of setting up a catch target, invoking the catch | |
3314 | body, and perhaps invoking the handler if the body does a throw. | |
3315 | ||
3316 | The function is designed to be usable from C code, but is general | |
3317 | enough to implement all the semantics Guile Scheme expects from throw. | |
3318 | ||
3319 | TAG is the catch tag. Typically, this is a symbol, but this function | |
3320 | doesn't actually care about that. | |
3321 | ||
3322 | BODY is a pointer to a C function which runs the body of the catch; | |
3323 | this is the code you can throw from. We call it like this: | |
3324 | BODY (BODY_DATA, JMPBUF) | |
3325 | where: | |
3326 | BODY_DATA is just the BODY_DATA argument we received; we pass it | |
3327 | through to BODY as its first argument. The caller can make | |
3328 | BODY_DATA point to anything useful that BODY might need. | |
3329 | JMPBUF is the Scheme jmpbuf object corresponding to this catch, | |
3330 | which we have just created and initialized. | |
3331 | ||
3332 | HANDLER is a pointer to a C function to deal with a throw to TAG, | |
3333 | should one occur. We call it like this: | |
3334 | HANDLER (HANDLER_DATA, THROWN_TAG, THROW_ARGS) | |
3335 | where | |
3336 | HANDLER_DATA is the HANDLER_DATA argument we recevied; it's the | |
3337 | same idea as BODY_DATA above. | |
3338 | THROWN_TAG is the tag that the user threw to; usually this is | |
3339 | TAG, but it could be something else if TAG was #t (i.e., a | |
3340 | catch-all), or the user threw to a jmpbuf. | |
3341 | THROW_ARGS is the list of arguments the user passed to the THROW | |
3342 | function. | |
3343 | ||
3344 | BODY_DATA is just a pointer we pass through to BODY. HANDLER_DATA | |
3345 | is just a pointer we pass through to HANDLER. We don't actually | |
3346 | use either of those pointers otherwise ourselves. The idea is | |
3347 | that, if our caller wants to communicate something to BODY or | |
3348 | HANDLER, it can pass a pointer to it as MUMBLE_DATA, which BODY and | |
3349 | HANDLER can then use. Think of it as a way to make BODY and | |
3350 | HANDLER closures, not just functions; MUMBLE_DATA points to the | |
3351 | enclosed variables. | |
3352 | ||
3353 | Of course, it's up to the caller to make sure that any data a | |
3354 | MUMBLE_DATA needs is protected from GC. A common way to do this is | |
3355 | to make MUMBLE_DATA a pointer to data stored in an automatic | |
3356 | structure variable; since the collector must scan the stack for | |
3357 | references anyway, this assures that any references in MUMBLE_DATA | |
3358 | will be found. | |
3359 | ||
3360 | ** The new function scm_internal_lazy_catch is exactly like | |
3361 | scm_internal_catch, except: | |
3362 | ||
3363 | - It does not unwind the stack (this is the major difference). | |
3364 | - If handler returns, its value is returned from the throw. | |
3365 | - BODY always receives #f as its JMPBUF argument (since there's no | |
3366 | jmpbuf associated with a lazy catch, because we don't unwind the | |
3367 | stack.) | |
3368 | ||
3369 | ** scm_body_thunk is a new body function you can pass to | |
3370 | scm_internal_catch if you want the body to be like Scheme's `catch' | |
3371 | --- a thunk, or a function of one argument if the tag is #f. | |
3372 | ||
3373 | BODY_DATA is a pointer to a scm_body_thunk_data structure, which | |
3374 | contains the Scheme procedure to invoke as the body, and the tag | |
3375 | we're catching. If the tag is #f, then we pass JMPBUF (created by | |
3376 | scm_internal_catch) to the body procedure; otherwise, the body gets | |
3377 | no arguments. | |
3378 | ||
3379 | ** scm_handle_by_proc is a new handler function you can pass to | |
3380 | scm_internal_catch if you want the handler to act like Scheme's catch | |
3381 | --- call a procedure with the tag and the throw arguments. | |
3382 | ||
3383 | If the user does a throw to this catch, this function runs a handler | |
3384 | procedure written in Scheme. HANDLER_DATA is a pointer to an SCM | |
3385 | variable holding the Scheme procedure object to invoke. It ought to | |
3386 | be a pointer to an automatic variable (i.e., one living on the stack), | |
3387 | or the procedure object should be otherwise protected from GC. | |
3388 | ||
3389 | ** scm_handle_by_message is a new handler function to use with | |
3390 | `scm_internal_catch' if you want Guile to print a message and die. | |
3391 | It's useful for dealing with throws to uncaught keys at the top level. | |
3392 | ||
3393 | HANDLER_DATA, if non-zero, is assumed to be a char * pointing to a | |
3394 | message header to print; if zero, we use "guile" instead. That | |
3395 | text is followed by a colon, then the message described by ARGS. | |
3396 | ||
3397 | ** The return type of scm_boot_guile is now void; the function does | |
3398 | not return a value, and indeed, never returns at all. | |
3399 | ||
f3b1485f JB |
3400 | ** The new function scm_shell makes it easy for user applications to |
3401 | process command-line arguments in a way that is compatible with the | |
3402 | stand-alone guile interpreter (which is in turn compatible with SCSH, | |
3403 | the Scheme shell). | |
3404 | ||
3405 | To use the scm_shell function, first initialize any guile modules | |
3406 | linked into your application, and then call scm_shell with the values | |
7ed46dc8 | 3407 | of ARGC and ARGV your `main' function received. scm_shell will add |
f3b1485f JB |
3408 | any SCSH-style meta-arguments from the top of the script file to the |
3409 | argument vector, and then process the command-line arguments. This | |
3410 | generally means loading a script file or starting up an interactive | |
3411 | command interpreter. For details, see "Changes to the stand-alone | |
3412 | interpreter" above. | |
3413 | ||
095936d2 JB |
3414 | ** The new functions scm_get_meta_args and scm_count_argv help you |
3415 | implement the SCSH-style meta-argument, `\'. | |
3416 | ||
3417 | char **scm_get_meta_args (int ARGC, char **ARGV) | |
3418 | If the second element of ARGV is a string consisting of a single | |
3419 | backslash character (i.e. "\\" in Scheme notation), open the file | |
3420 | named by the following argument, parse arguments from it, and return | |
3421 | the spliced command line. The returned array is terminated by a | |
3422 | null pointer. | |
3423 | ||
3424 | For details of argument parsing, see above, under "guile now accepts | |
3425 | command-line arguments compatible with SCSH..." | |
3426 | ||
3427 | int scm_count_argv (char **ARGV) | |
3428 | Count the arguments in ARGV, assuming it is terminated by a null | |
3429 | pointer. | |
3430 | ||
3431 | For an example of how these functions might be used, see the source | |
3432 | code for the function scm_shell in libguile/script.c. | |
3433 | ||
3434 | You will usually want to use scm_shell instead of calling this | |
3435 | function yourself. | |
3436 | ||
3437 | ** The new function scm_compile_shell_switches turns an array of | |
3438 | command-line arguments into Scheme code to carry out the actions they | |
3439 | describe. Given ARGC and ARGV, it returns a Scheme expression to | |
3440 | evaluate, and calls scm_set_program_arguments to make any remaining | |
3441 | command-line arguments available to the Scheme code. For example, | |
3442 | given the following arguments: | |
3443 | ||
3444 | -e main -s ekko a speckled gecko | |
3445 | ||
3446 | scm_set_program_arguments will return the following expression: | |
3447 | ||
3448 | (begin (load "ekko") (main (command-line)) (quit)) | |
3449 | ||
3450 | You will usually want to use scm_shell instead of calling this | |
3451 | function yourself. | |
3452 | ||
3453 | ** The function scm_shell_usage prints a usage message appropriate for | |
3454 | an interpreter that uses scm_compile_shell_switches to handle its | |
3455 | command-line arguments. | |
3456 | ||
3457 | void scm_shell_usage (int FATAL, char *MESSAGE) | |
3458 | Print a usage message to the standard error output. If MESSAGE is | |
3459 | non-zero, write it before the usage message, followed by a newline. | |
3460 | If FATAL is non-zero, exit the process, using FATAL as the | |
3461 | termination status. (If you want to be compatible with Guile, | |
3462 | always use 1 as the exit status when terminating due to command-line | |
3463 | usage problems.) | |
3464 | ||
3465 | You will usually want to use scm_shell instead of calling this | |
3466 | function yourself. | |
48d224d7 JB |
3467 | |
3468 | ** scm_eval_0str now returns SCM_UNSPECIFIED if the string contains no | |
095936d2 JB |
3469 | expressions. It used to return SCM_EOL. Earth-shattering. |
3470 | ||
3471 | ** The macros for declaring scheme objects in C code have been | |
3472 | rearranged slightly. They are now: | |
3473 | ||
3474 | SCM_SYMBOL (C_NAME, SCHEME_NAME) | |
3475 | Declare a static SCM variable named C_NAME, and initialize it to | |
3476 | point to the Scheme symbol whose name is SCHEME_NAME. C_NAME should | |
3477 | be a C identifier, and SCHEME_NAME should be a C string. | |
3478 | ||
3479 | SCM_GLOBAL_SYMBOL (C_NAME, SCHEME_NAME) | |
3480 | Just like SCM_SYMBOL, but make C_NAME globally visible. | |
3481 | ||
3482 | SCM_VCELL (C_NAME, SCHEME_NAME) | |
3483 | Create a global variable at the Scheme level named SCHEME_NAME. | |
3484 | Declare a static SCM variable named C_NAME, and initialize it to | |
3485 | point to the Scheme variable's value cell. | |
3486 | ||
3487 | SCM_GLOBAL_VCELL (C_NAME, SCHEME_NAME) | |
3488 | Just like SCM_VCELL, but make C_NAME globally visible. | |
3489 | ||
3490 | The `guile-snarf' script writes initialization code for these macros | |
3491 | to its standard output, given C source code as input. | |
3492 | ||
3493 | The SCM_GLOBAL macro is gone. | |
3494 | ||
3495 | ** The scm_read_line and scm_read_line_x functions have been replaced | |
3496 | by Scheme code based on the %read-delimited! procedure (known to C | |
3497 | code as scm_read_delimited_x). See its description above for more | |
3498 | information. | |
48d224d7 | 3499 | |
095936d2 JB |
3500 | ** The function scm_sys_open has been renamed to scm_open. It now |
3501 | returns a port instead of an FD object. | |
ea00ecba | 3502 | |
095936d2 JB |
3503 | * The dynamic linking support has changed. For more information, see |
3504 | libguile/DYNAMIC-LINKING. | |
ea00ecba | 3505 | |
f7b47737 JB |
3506 | \f |
3507 | Guile 1.0b3 | |
3065a62a | 3508 | |
f3b1485f JB |
3509 | User-visible changes from Thursday, September 5, 1996 until Guile 1.0 |
3510 | (Sun 5 Jan 1997): | |
3065a62a | 3511 | |
4b521edb | 3512 | * Changes to the 'guile' program: |
3065a62a | 3513 | |
4b521edb JB |
3514 | ** Guile now loads some new files when it starts up. Guile first |
3515 | searches the load path for init.scm, and loads it if found. Then, if | |
3516 | Guile is not being used to execute a script, and the user's home | |
3517 | directory contains a file named `.guile', Guile loads that. | |
c6486f8a | 3518 | |
4b521edb | 3519 | ** You can now use Guile as a shell script interpreter. |
3065a62a JB |
3520 | |
3521 | To paraphrase the SCSH manual: | |
3522 | ||
3523 | When Unix tries to execute an executable file whose first two | |
3524 | characters are the `#!', it treats the file not as machine code to | |
3525 | be directly executed by the native processor, but as source code | |
3526 | to be executed by some interpreter. The interpreter to use is | |
3527 | specified immediately after the #! sequence on the first line of | |
3528 | the source file. The kernel reads in the name of the interpreter, | |
3529 | and executes that instead. It passes the interpreter the source | |
3530 | filename as its first argument, with the original arguments | |
3531 | following. Consult the Unix man page for the `exec' system call | |
3532 | for more information. | |
3533 | ||
1a1945be JB |
3534 | Now you can use Guile as an interpreter, using a mechanism which is a |
3535 | compatible subset of that provided by SCSH. | |
3536 | ||
3065a62a JB |
3537 | Guile now recognizes a '-s' command line switch, whose argument is the |
3538 | name of a file of Scheme code to load. It also treats the two | |
3539 | characters `#!' as the start of a comment, terminated by `!#'. Thus, | |
3540 | to make a file of Scheme code directly executable by Unix, insert the | |
3541 | following two lines at the top of the file: | |
3542 | ||
3543 | #!/usr/local/bin/guile -s | |
3544 | !# | |
3545 | ||
3546 | Guile treats the argument of the `-s' command-line switch as the name | |
3547 | of a file of Scheme code to load, and treats the sequence `#!' as the | |
3548 | start of a block comment, terminated by `!#'. | |
3549 | ||
3550 | For example, here's a version of 'echo' written in Scheme: | |
3551 | ||
3552 | #!/usr/local/bin/guile -s | |
3553 | !# | |
3554 | (let loop ((args (cdr (program-arguments)))) | |
3555 | (if (pair? args) | |
3556 | (begin | |
3557 | (display (car args)) | |
3558 | (if (pair? (cdr args)) | |
3559 | (display " ")) | |
3560 | (loop (cdr args))))) | |
3561 | (newline) | |
3562 | ||
3563 | Why does `#!' start a block comment terminated by `!#', instead of the | |
3564 | end of the line? That is the notation SCSH uses, and although we | |
3565 | don't yet support the other SCSH features that motivate that choice, | |
3566 | we would like to be backward-compatible with any existing Guile | |
3763761c JB |
3567 | scripts once we do. Furthermore, if the path to Guile on your system |
3568 | is too long for your kernel, you can start the script with this | |
3569 | horrible hack: | |
3570 | ||
3571 | #!/bin/sh | |
3572 | exec /really/long/path/to/guile -s "$0" ${1+"$@"} | |
3573 | !# | |
3065a62a JB |
3574 | |
3575 | Note that some very old Unix systems don't support the `#!' syntax. | |
3576 | ||
c6486f8a | 3577 | |
4b521edb | 3578 | ** You can now run Guile without installing it. |
6685dc83 JB |
3579 | |
3580 | Previous versions of the interactive Guile interpreter (`guile') | |
3581 | couldn't start up unless Guile's Scheme library had been installed; | |
3582 | they used the value of the environment variable `SCHEME_LOAD_PATH' | |
3583 | later on in the startup process, but not to find the startup code | |
3584 | itself. Now Guile uses `SCHEME_LOAD_PATH' in all searches for Scheme | |
3585 | code. | |
3586 | ||
3587 | To run Guile without installing it, build it in the normal way, and | |
3588 | then set the environment variable `SCHEME_LOAD_PATH' to a | |
3589 | colon-separated list of directories, including the top-level directory | |
3590 | of the Guile sources. For example, if you unpacked Guile so that the | |
3591 | full filename of this NEWS file is /home/jimb/guile-1.0b3/NEWS, then | |
3592 | you might say | |
3593 | ||
3594 | export SCHEME_LOAD_PATH=/home/jimb/my-scheme:/home/jimb/guile-1.0b3 | |
3595 | ||
c6486f8a | 3596 | |
4b521edb JB |
3597 | ** Guile's read-eval-print loop no longer prints #<unspecified> |
3598 | results. If the user wants to see this, she can evaluate the | |
3599 | expression (assert-repl-print-unspecified #t), perhaps in her startup | |
48d224d7 | 3600 | file. |
6685dc83 | 3601 | |
4b521edb JB |
3602 | ** Guile no longer shows backtraces by default when an error occurs; |
3603 | however, it does display a message saying how to get one, and how to | |
3604 | request that they be displayed by default. After an error, evaluate | |
3605 | (backtrace) | |
3606 | to see a backtrace, and | |
3607 | (debug-enable 'backtrace) | |
3608 | to see them by default. | |
6685dc83 | 3609 | |
6685dc83 | 3610 | |
d9fb83d9 | 3611 | |
4b521edb JB |
3612 | * Changes to Guile Scheme: |
3613 | ||
3614 | ** Guile now distinguishes between #f and the empty list. | |
3615 | ||
3616 | This is for compatibility with the IEEE standard, the (possibly) | |
3617 | upcoming Revised^5 Report on Scheme, and many extant Scheme | |
3618 | implementations. | |
3619 | ||
3620 | Guile used to have #f and '() denote the same object, to make Scheme's | |
3621 | type system more compatible with Emacs Lisp's. However, the change | |
3622 | caused too much trouble for Scheme programmers, and we found another | |
3623 | way to reconcile Emacs Lisp with Scheme that didn't require this. | |
3624 | ||
3625 | ||
3626 | ** Guile's delq, delv, delete functions, and their destructive | |
c6486f8a JB |
3627 | counterparts, delq!, delv!, and delete!, now remove all matching |
3628 | elements from the list, not just the first. This matches the behavior | |
3629 | of the corresponding Emacs Lisp functions, and (I believe) the Maclisp | |
3630 | functions which inspired them. | |
3631 | ||
3632 | I recognize that this change may break code in subtle ways, but it | |
3633 | seems best to make the change before the FSF's first Guile release, | |
3634 | rather than after. | |
3635 | ||
3636 | ||
4b521edb | 3637 | ** The compiled-library-path function has been deleted from libguile. |
6685dc83 | 3638 | |
4b521edb | 3639 | ** The facilities for loading Scheme source files have changed. |
c6486f8a | 3640 | |
4b521edb | 3641 | *** The variable %load-path now tells Guile which directories to search |
6685dc83 JB |
3642 | for Scheme code. Its value is a list of strings, each of which names |
3643 | a directory. | |
3644 | ||
4b521edb JB |
3645 | *** The variable %load-extensions now tells Guile which extensions to |
3646 | try appending to a filename when searching the load path. Its value | |
3647 | is a list of strings. Its default value is ("" ".scm"). | |
3648 | ||
3649 | *** (%search-load-path FILENAME) searches the directories listed in the | |
3650 | value of the %load-path variable for a Scheme file named FILENAME, | |
3651 | with all the extensions listed in %load-extensions. If it finds a | |
3652 | match, then it returns its full filename. If FILENAME is absolute, it | |
3653 | returns it unchanged. Otherwise, it returns #f. | |
6685dc83 | 3654 | |
4b521edb JB |
3655 | %search-load-path will not return matches that refer to directories. |
3656 | ||
3657 | *** (primitive-load FILENAME :optional CASE-INSENSITIVE-P SHARP) | |
3658 | uses %seach-load-path to find a file named FILENAME, and loads it if | |
3659 | it finds it. If it can't read FILENAME for any reason, it throws an | |
3660 | error. | |
6685dc83 JB |
3661 | |
3662 | The arguments CASE-INSENSITIVE-P and SHARP are interpreted as by the | |
4b521edb JB |
3663 | `read' function. |
3664 | ||
3665 | *** load uses the same searching semantics as primitive-load. | |
3666 | ||
3667 | *** The functions %try-load, try-load-with-path, %load, load-with-path, | |
3668 | basic-try-load-with-path, basic-load-with-path, try-load-module-with- | |
3669 | path, and load-module-with-path have been deleted. The functions | |
3670 | above should serve their purposes. | |
3671 | ||
3672 | *** If the value of the variable %load-hook is a procedure, | |
3673 | `primitive-load' applies its value to the name of the file being | |
3674 | loaded (without the load path directory name prepended). If its value | |
3675 | is #f, it is ignored. Otherwise, an error occurs. | |
3676 | ||
3677 | This is mostly useful for printing load notification messages. | |
3678 | ||
3679 | ||
3680 | ** The function `eval!' is no longer accessible from the scheme level. | |
3681 | We can't allow operations which introduce glocs into the scheme level, | |
3682 | because Guile's type system can't handle these as data. Use `eval' or | |
3683 | `read-and-eval!' (see below) as replacement. | |
3684 | ||
3685 | ** The new function read-and-eval! reads an expression from PORT, | |
3686 | evaluates it, and returns the result. This is more efficient than | |
3687 | simply calling `read' and `eval', since it is not necessary to make a | |
3688 | copy of the expression for the evaluator to munge. | |
3689 | ||
3690 | Its optional arguments CASE_INSENSITIVE_P and SHARP are interpreted as | |
3691 | for the `read' function. | |
3692 | ||
3693 | ||
3694 | ** The function `int?' has been removed; its definition was identical | |
3695 | to that of `integer?'. | |
3696 | ||
3697 | ** The functions `<?', `<?', `<=?', `=?', `>?', and `>=?'. Code should | |
3698 | use the R4RS names for these functions. | |
3699 | ||
3700 | ** The function object-properties no longer returns the hash handle; | |
3701 | it simply returns the object's property list. | |
3702 | ||
3703 | ** Many functions have been changed to throw errors, instead of | |
3704 | returning #f on failure. The point of providing exception handling in | |
3705 | the language is to simplify the logic of user code, but this is less | |
3706 | useful if Guile's primitives don't throw exceptions. | |
3707 | ||
3708 | ** The function `fileno' has been renamed from `%fileno'. | |
3709 | ||
3710 | ** The function primitive-mode->fdes returns #t or #f now, not 1 or 0. | |
3711 | ||
3712 | ||
3713 | * Changes to Guile's C interface: | |
3714 | ||
3715 | ** The library's initialization procedure has been simplified. | |
3716 | scm_boot_guile now has the prototype: | |
3717 | ||
3718 | void scm_boot_guile (int ARGC, | |
3719 | char **ARGV, | |
3720 | void (*main_func) (), | |
3721 | void *closure); | |
3722 | ||
3723 | scm_boot_guile calls MAIN_FUNC, passing it CLOSURE, ARGC, and ARGV. | |
3724 | MAIN_FUNC should do all the work of the program (initializing other | |
3725 | packages, reading user input, etc.) before returning. When MAIN_FUNC | |
3726 | returns, call exit (0); this function never returns. If you want some | |
3727 | other exit value, MAIN_FUNC may call exit itself. | |
3728 | ||
3729 | scm_boot_guile arranges for program-arguments to return the strings | |
3730 | given by ARGC and ARGV. If MAIN_FUNC modifies ARGC/ARGV, should call | |
3731 | scm_set_program_arguments with the final list, so Scheme code will | |
3732 | know which arguments have been processed. | |
3733 | ||
3734 | scm_boot_guile establishes a catch-all catch handler which prints an | |
3735 | error message and exits the process. This means that Guile exits in a | |
3736 | coherent way when system errors occur and the user isn't prepared to | |
3737 | handle it. If the user doesn't like this behavior, they can establish | |
3738 | their own universal catcher in MAIN_FUNC to shadow this one. | |
3739 | ||
3740 | Why must the caller do all the real work from MAIN_FUNC? The garbage | |
3741 | collector assumes that all local variables of type SCM will be above | |
3742 | scm_boot_guile's stack frame on the stack. If you try to manipulate | |
3743 | SCM values after this function returns, it's the luck of the draw | |
3744 | whether the GC will be able to find the objects you allocate. So, | |
3745 | scm_boot_guile function exits, rather than returning, to discourage | |
3746 | people from making that mistake. | |
3747 | ||
3748 | The IN, OUT, and ERR arguments were removed; there are other | |
3749 | convenient ways to override these when desired. | |
3750 | ||
3751 | The RESULT argument was deleted; this function should never return. | |
3752 | ||
3753 | The BOOT_CMD argument was deleted; the MAIN_FUNC argument is more | |
3754 | general. | |
3755 | ||
3756 | ||
3757 | ** Guile's header files should no longer conflict with your system's | |
3758 | header files. | |
3759 | ||
3760 | In order to compile code which #included <libguile.h>, previous | |
3761 | versions of Guile required you to add a directory containing all the | |
3762 | Guile header files to your #include path. This was a problem, since | |
3763 | Guile's header files have names which conflict with many systems' | |
3764 | header files. | |
3765 | ||
3766 | Now only <libguile.h> need appear in your #include path; you must | |
3767 | refer to all Guile's other header files as <libguile/mumble.h>. | |
3768 | Guile's installation procedure puts libguile.h in $(includedir), and | |
3769 | the rest in $(includedir)/libguile. | |
3770 | ||
3771 | ||
3772 | ** Two new C functions, scm_protect_object and scm_unprotect_object, | |
3773 | have been added to the Guile library. | |
3774 | ||
3775 | scm_protect_object (OBJ) protects OBJ from the garbage collector. | |
3776 | OBJ will not be freed, even if all other references are dropped, | |
3777 | until someone does scm_unprotect_object (OBJ). Both functions | |
3778 | return OBJ. | |
3779 | ||
3780 | Note that calls to scm_protect_object do not nest. You can call | |
3781 | scm_protect_object any number of times on a given object, and the | |
3782 | next call to scm_unprotect_object will unprotect it completely. | |
3783 | ||
3784 | Basically, scm_protect_object and scm_unprotect_object just | |
3785 | maintain a list of references to things. Since the GC knows about | |
3786 | this list, all objects it mentions stay alive. scm_protect_object | |
3787 | adds its argument to the list; scm_unprotect_object remove its | |
3788 | argument from the list. | |
3789 | ||
3790 | ||
3791 | ** scm_eval_0str now returns the value of the last expression | |
3792 | evaluated. | |
3793 | ||
3794 | ** The new function scm_read_0str reads an s-expression from a | |
3795 | null-terminated string, and returns it. | |
3796 | ||
3797 | ** The new function `scm_stdio_to_port' converts a STDIO file pointer | |
3798 | to a Scheme port object. | |
3799 | ||
3800 | ** The new function `scm_set_program_arguments' allows C code to set | |
e80c8fea | 3801 | the value returned by the Scheme `program-arguments' function. |
6685dc83 | 3802 | |
6685dc83 | 3803 | \f |
1a1945be JB |
3804 | Older changes: |
3805 | ||
3806 | * Guile no longer includes sophisticated Tcl/Tk support. | |
3807 | ||
3808 | The old Tcl/Tk support was unsatisfying to us, because it required the | |
3809 | user to link against the Tcl library, as well as Tk and Guile. The | |
3810 | interface was also un-lispy, in that it preserved Tcl/Tk's practice of | |
3811 | referring to widgets by names, rather than exporting widgets to Scheme | |
3812 | code as a special datatype. | |
3813 | ||
3814 | In the Usenix Tk Developer's Workshop held in July 1996, the Tcl/Tk | |
3815 | maintainers described some very interesting changes in progress to the | |
3816 | Tcl/Tk internals, which would facilitate clean interfaces between lone | |
3817 | Tk and other interpreters --- even for garbage-collected languages | |
3818 | like Scheme. They expected the new Tk to be publicly available in the | |
3819 | fall of 1996. | |
3820 | ||
3821 | Since it seems that Guile might soon have a new, cleaner interface to | |
3822 | lone Tk, and that the old Guile/Tk glue code would probably need to be | |
3823 | completely rewritten, we (Jim Blandy and Richard Stallman) have | |
3824 | decided not to support the old code. We'll spend the time instead on | |
3825 | a good interface to the newer Tk, as soon as it is available. | |
5c54da76 | 3826 | |
8512dea6 | 3827 | Until then, gtcltk-lib provides trivial, low-maintenance functionality. |
deb95d71 | 3828 | |
5c54da76 JB |
3829 | \f |
3830 | Copyright information: | |
3831 | ||
ea00ecba | 3832 | Copyright (C) 1996,1997 Free Software Foundation, Inc. |
5c54da76 JB |
3833 | |
3834 | Permission is granted to anyone to make or distribute verbatim copies | |
3835 | of this document as received, in any medium, provided that the | |
3836 | copyright notice and this permission notice are preserved, | |
3837 | thus giving the recipient permission to redistribute in turn. | |
3838 | ||
3839 | Permission is granted to distribute modified versions | |
3840 | of this document, or of portions of it, | |
3841 | under the above conditions, provided also that they | |
3842 | carry prominent notices stating who last changed them. | |
3843 | ||
48d224d7 JB |
3844 | \f |
3845 | Local variables: | |
3846 | mode: outline | |
3847 | paragraph-separate: "[ \f]*$" | |
3848 | end: | |
3849 |